client

README

KraftCloud Go SDK

This SDK is an early version of a Go-based client designed to interface with the KraftCloud API.

📖 Documentation

For a comprehensive list of all API endpoints and detailed usage, refer to the official KraftCloud documentation.

Requirements

• Go 1.20 or higher.
• Valid KraftCloud authentication credentials. Sign up for the beta!

Quick start

package main

import (
	"fmt"
	"context"

	kraftcloud "sdk.kraft.cloud"
)

func main() {
	client := kraftcloud.NewClient(
		kraftcloud.WithToken("token"),
	)

	images, err := client.Images().List(context.Background())
	if err != nil {
		fmt.Printf("failed: %v", err)
		return
	}

	for _, i := range images {
		fmt.Println(i.Digest)
	}
}

Examples

For additional practical implementations, check out the examples directory:

• Image Listing

This example lists all images in your project

• Instance Management

Here, you'll learn how to create an instance and display its console output. Subsequent actions include stopping and starting the instance, listing all instances in the project, and, ultimately, deleting the created instance.

Documentation

Index

• func NewAutoscaleClient(opts ...Option) scale.AutoscaleService
• func NewDefaultOptions(opts ...Option) *options.Options
• func NewImagesClient(opts ...Option) images.ImagesService
• func NewInstancesClient(opts ...Option) instances.InstancesService
• func NewServicesClient(opts ...Option) services.ServicesService
• func NewUsersClient(opts ...Option) users.UsersService
• func NewVolumesClient(opts ...Option) volumes.VolumesService
• type Client
  • func (client *Client) Autoscale() scale.AutoscaleService
  • func (client *Client) Images() images.ImagesService
  • func (client *Client) Instances() instances.InstancesService
  • func (client *Client) Services() services.ServicesService
  • func (client *Client) Users() users.UsersService
  • func (client *Client) Volumes() volumes.VolumesService
• type KraftCloud
  • func NewClient(copts ...Option) KraftCloud
  • func NewClientFromOptions(opts *options.Options) KraftCloud
• type Option
  • func WithDefaultMetro(metro string) Option
  • func WithHTTPClient(httpClient httpclient.HTTPClient) Option
  • func WithToken(token string) Option

Functions

func NewAutoscaleClient

func NewAutoscaleClient(opts ...Option) scale.AutoscaleService

NewAutoscaleCLient instantiates a client which interfaces with KraftCloud's autoscale API.

func NewDefaultOptions

func NewDefaultOptions(opts ...Option) *options.Options

NewDefaultOptions is a constructor method for instantiation a new set of default options for underlying requests to the KraftCloud API.

func NewImagesClient

func NewImagesClient(opts ...Option) images.ImagesService

NewImagesClient instantiates a new image services client based on the provided options.

func NewInstancesClient

func NewInstancesClient(opts ...Option) instances.InstancesService

NewInstancesClient instantiates a client which interfaces with KraftCloud's instances API.

func NewServicesClient

func NewServicesClient(opts ...Option) services.ServicesService

NewServicesClient instantiates a client which interfaces with KraftCloud's volumes API.

func NewUsersClient

func NewUsersClient(opts ...Option) users.UsersService

NewUsersClient instantiates a client which interfaces with KraftCloud's users API.

func NewVolumesClient

func NewVolumesClient(opts ...Option) volumes.VolumesService

NewVolumesClient instantiates a client which interfaces with KraftCloud's volumes API.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides access to the KraftCloud API.

func (*Client) Autoscale

func (client *Client) Autoscale() scale.AutoscaleService

Autoscale returns AutoscaleService.

func (*Client) Images

func (client *Client) Images() images.ImagesService

Images returns ImagesService.

func (*Client) Instances

func (client *Client) Instances() instances.InstancesService

Instances returns InstancesService.

func (*Client) Services

func (client *Client) Services() services.ServicesService

Services returns ServicesService.

func (*Client) Users

func (client *Client) Users() users.UsersService

Users returns UsersService.

func (*Client) Volumes

func (client *Client) Volumes() volumes.VolumesService

Volumes returns VolumesService.

type KraftCloud

type KraftCloud interface {
	Autoscale() scale.AutoscaleService
	Instances() instances.InstancesService
	Images() images.ImagesService
	Services() services.ServicesService
	Users() users.UsersService
	Volumes() volumes.VolumesService
}

KraftCloud are the public endpoint categories for the KraftCloud API.

func NewClient

func NewClient(copts ...Option) KraftCloud

NewClient is the top-level KraftCloud Services client used to speak with the API.

func NewClientFromOptions

func NewClientFromOptions(opts *options.Options) KraftCloud

NewClientFromOptions is the top-level KraftCloud Services client used to speak with the API with pre-defined options.

type Option

type Option func(*options.Options)

Option is an option function used during initialization of a client.

func WithDefaultMetro

func WithDefaultMetro(metro string) Option

WithDefaultMetro sets a KraftCloud metro, e.g. `fra0` which is based in Frankfurt.

func WithHTTPClient

func WithHTTPClient(httpClient httpclient.HTTPClient) Option

WithHTTPClient sets the HTTP client that's used to customize the connection to KraftCloud's API.

func WithToken

func WithToken(token string) Option

WithToken sets the access token of the client connecting to KraftCloud.