gateway

Documentation

Index

• Variables
• type Api

Variables

var (
	ErrInvalidInputError     = errors.New("invalid input")
	ErrResourceNotFoundError = errors.New("resource not found")
	ErrUnauthorizedError     = errors.New("unauthorized")
	ErrInternalServerError   = errors.New("internal server error")
)

Types

type Api

type Api interface {
	DescribeNode(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)

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

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

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

	HealthCheck(ctx context.Context) error
}