service

Documentation

Index

• Variables
• type Api
• type Node
• type Provider
• type Tailnet

Variables

var (
	ErrInvalidInputError = errors.New("invalid input")
	ErrUnknownExecution  = errors.New("unknown execution")
)

var (
	ErrUnknownNode = errors.New("unknown node")
)

var (
	ErrUnknownProvider = errors.New("unknown provider")
)

var (
	ErrUnknownTailnet = errors.New("unknown tailnet")
)

Types

type Api

type Api interface {
	GetNode(context.Context, node.Identifier) (*node.Node, error)
	GetNodeStatus(context.Context, node.Identifier) (node.Status, error)
	ListNodes(context.Context) ([]*node.Node, error)
	ProvisionNode(context.Context, provider.Identifier, provider.Location, tailnet.Identifier, node.Size, bool) (workflow.ExecutionIdentifier, error)
	DeprovisionNode(context.Context, node.Identifier) (workflow.ExecutionIdentifier, error)
	StartNode(context.Context, node.Identifier) error
	StopNode(context.Context, node.Identifier) error

	GetExecution(context.Context, workflow.ExecutionIdentifier) (*workflow.Execution, error)

	GetProvider(ctx context.Context, id provider.Identifier) (*provider.Provider, error)
	ListProviders(ctx context.Context) ([]*provider.Provider, error)

	GetTailnet(ctx context.Context, id tailnet.Identifier) (*tailnet.Tailnet, error)
	ListTailnets(ctx context.Context) ([]*tailnet.Tailnet, error)

	ListNotifiers(ctx context.Context) ([]*notification.Notifier, error)

	CheckServerHealth(ctx context.Context) error
}

type Node

type Node interface {
	DescribeNode(context.Context, cnode.Identifier) (*node.Node, error)
	ListNodes(context.Context) ([]*node.Node, error)
}

type Provider

type Provider interface {
	DescribeProvider(context.Context, provider.Identifier) (*provider.Provider, error)
	ListProviders(context.Context) ([]*provider.Provider, error)
}

type Tailnet

type Tailnet interface {
	DescribeTailnet(context.Context, tailnet.Identifier) (*tailnet.Tailnet, error)
	ListTailnets(context.Context) ([]*tailnet.Tailnet, error)
}