services

Documentation

Index

• Constants
• type Handler
  • func Handlers() []Handler
• type Service
• type ServiceCreateRequest
• type ServiceGroup
• type ServicesService
  • func NewServicesClientFromOptions(opts *options.Options) ServicesService

Constants

const (
	// Terminate the TLS connection at the KraftCloud gateway using our wildcard
	// certificate issued for the kraft.cloud domain. The gateway forwards the
	// unencrypted traffic to your application.
	HandlerTLS = Handler("tls")

	// Enable HTTP mode on the load balancer to load balance on the level of
	// individual HTTP requests. In this mode, only HTTP connections are accepted.
	// If this option is not set the load balancer works in TCP mode and
	// distributes TCP connections.
	HandlerHTTP = Handler("http")

	// Redirect traffic from the source port to the destination port.
	HandlerRedirect = Handler("redirect")
)

const (
	// Endpoint is the public path for the services service.
	Endpoint = "/services"
)

Types

type Handler

type Handler string

Connection Handlers. KraftCloud uses connection handlers to decide how to forward connections from the Internet to your application. You configure the handlers for every published service port individually.

Currently, there is a set of constraints when publishing ports:

• Port 80: Must have http and must not have tls set;
• Port 443: Must have http and tls set;
• The `redirect` handler can only be set on port 80 (HTTP) to redirect to port 443 (HTTPS);
• All other ports must have tls and must not have http set.

func Handlers

func Handlers() []Handler

Handlers returns all possible service handlers.

type Service

type Service struct {
	// Public-facing port.
	Port int `json:"port"`

	// Application port to which inbound traffic is redirected.
	DestinationPort int `json:"destination_port,omitempty"`

	// List of handlers.
	Handlers []Handler `json:"handlers,omitempty"`
}

A service helps describe the the load balancing and autoscale groups.

type ServiceCreateRequest

type ServiceCreateRequest struct {
	// Services is a list of descriptiosn of exposed network services.
	Services []Service `json:"services"`

	// Name is the name of the service.
	Name string `json:"name,omitempty"`

	// DNSName is the DNS name of the service.
	DNSName string `json:"dns_name,omitempty"`
}

type ServiceGroup

type ServiceGroup struct {
	// The status of the service group.
	Status string `json:"status,omitempty"`

	// Name of the service group.
	Name string `json:"name,omitempty"`

	// UUID of the group.
	UUID string `json:"uuid,omitempty"`

	// The Fully Qualified Domain Name which the service is accessible from.
	FQDN string `json:"fqdn,omitempty"`

	// Instances contains a list of UUID representing instances attached to this
	// group.
	Instances []string `json:"instances,omitempty"`

	// Services contains the descriptions of exposed network services.
	Services []Service `json:"services,omitempty"`

	// Message contains the error message either on `partial_success` or `error`.
	Message string `json:"message,omitempty"`

	// Persistent indicates if the group will stay alive even after the last
	// instance detached.
	Persistent bool `json:"persistent,omitempty"`

	// Date and time of creation in ISO8601.
	CreatedAt string `json:"created_at,omitempty"`
}

A service group has a public DNS name such as young-monkey-uq6dxq0u.fra0.kraft.cloud. When you assign an instance to a service group, the instance becomes accessible from the Internet using this DNS name. KraftCloud generates a random DNS name of that form for every service group.

Except for unencrypted HTTP traffic on port 80, KraftCloud accepts only TLS connections from the Internet. It uses Server Name Indication (SNI) to forward inbound traffic to your application.

By default, a service group does not publish any services. To allow traffic to pass to the instances in the service group, you specify the network ports to publish. For example, if you run a web server you would publish port 80 (HTTP) and/or port 443 (HTTPS).

type ServicesService

type ServicesService interface {
	client.ServiceClient[ServicesService]

	// Creates one or more service groups with the given configuration. Note that,
	// the service group properties like published ports can only be defined
	// during creation. They cannot be changed later.
	//
	// Each port in a service group can specify a list of handlers that determine
	// how traffic arriving at the port is handled. See Connection Handlers for a
	// complete overview.
	//
	// You can specify an array of service group descriptions to create multiple
	// groups with different properties with the same call.
	//
	// See: https://docs.kraft.cloud/003-rest-api-v1-services.html#creating-new-service-groups
	Create(ctx context.Context, req ServiceCreateRequest) (*ServiceGroup, error)

	// GetByUUID returns the current state and the configuration of a service group.
	//
	// See: https://docs.kraft.cloud/003-rest-api-v1-services.html#getting-the-state-of-a-service-group
	GetByUUID(ctx context.Context, uuid string) (*ServiceGroup, error)

	// GetByName returns the current state and the configuration of a service group.
	//
	// See: https://docs.kraft.cloud/003-rest-api-v1-services.html#getting-the-state-of-a-service-group
	GetByName(ctx context.Context, name string) (*ServiceGroup, error)

	// Lists all existing service groups. You can filter by persistence and DNS
	// name. The latter can be used to lookup the UUID of the service group that
	// owns a certain DNS name. The returned groups fulfill all provided filter
	// criteria. No particular value is assumed if a filter is not part of the
	// request.
	//
	// The array of groups in the response can be directly fed into the other
	// endpoints, for example, to delete (empty) groups.
	//
	// See: https://docs.kraft.cloud/003-rest-api-v1-services.html#list-existing-service-groups
	List(ctx context.Context) ([]ServiceGroup, error)

	// DeleteByUUID the specified service group based on its UUID.  Fails if there
	// are still instances attached to group. After this call the UUID of the
	// group is no longer valid.
	//
	// This operation cannot be undone.
	//
	// See:
	// https://docs.kraft.cloud/003-rest-api-v1-services.html#deleting-a-service-group
	DeleteByUUID(ctx context.Context, uuid string) error

	// DeleteByName the specified service group based on its name.  Fails if there
	// are still instances attached to group. After this call the UUID of the
	// group is no longer valid.
	//
	// This operation cannot be undone.
	//
	// See:
	// https://docs.kraft.cloud/003-rest-api-v1-services.html#deleting-a-service-group
	DeleteByName(ctx context.Context, name string) error
}

func NewServicesClientFromOptions

func NewServicesClientFromOptions(opts *options.Options) ServicesService

NewServicesClientFromOptions instantiates a new image services client based on the provided pre-existing options.