api

Documentation

Index

• func WithClient(ctx context.Context, client *Depot) context.Context
• type Depot
  • func GetContextClient(ctx context.Context) *Depot
  • func New(baseURL string, token string) *Depot
  • func NewFromEnv(token string) *Depot
  • func (d *Depot) Example(id string) error
  • func (d *Depot) RegisterMachine(request RegisterMachineRequest) (*RegisterMachineResponse, error)
  • func (d *Depot) ReportHealth(request ReportHealthRequest) (*ReportHealthResponse, error)
• type ErrorResponse
• type ExampleResponse
• type Mount
• type RegisterMachineRequest
• type RegisterMachineResponse
• type ReportHealthRequest
• type ReportHealthResponse

Functions

func WithClient

func WithClient(ctx context.Context, client *Depot) context.Context

Types

type Depot

type Depot struct {
	BaseURL string
	// contains filtered or unexported fields
}

func GetContextClient

func GetContextClient(ctx context.Context) *Depot

func New

func New(baseURL string, token string) *Depot

func NewFromEnv

func NewFromEnv(token string) *Depot

func (*Depot) Example

func (d *Depot) Example(id string) error

func (*Depot) RegisterMachine

func (d *Depot) RegisterMachine(request RegisterMachineRequest) (*RegisterMachineResponse, error)

func (*Depot) ReportHealth

func (d *Depot) ReportHealth(request ReportHealthRequest) (*ReportHealthResponse, error)

type ErrorResponse

type ErrorResponse struct {
	OK    bool   `json:"ok"`
	Error string `json:"error"`
}

type ExampleResponse

type ExampleResponse struct {
	OK bool `json:"ok"`
}

type Mount

type Mount struct {
	Path   string `json:"path"`
	Device string `json:"device"`
}

type RegisterMachineRequest

type RegisterMachineRequest struct {
	Cloud     string `json:"cloud"`
	Document  string `json:"document"`
	Signature string `json:"signature"`
}

type RegisterMachineResponse

type RegisterMachineResponse struct {
	OK     bool    `json:"ok"`
	Role   string  `json:"role"`
	Mounts []Mount `json:"mounts"`
	Token  string  `json:"token,omitempty"`
	CaCert string  `json:"caCert,omitempty"`
	Cert   string  `json:"cert,omitempty"`
	Key    string  `json:"key,omitempty"`
}

type ReportHealthRequest

type ReportHealthRequest struct {
	Cloud     string `json:"cloud"`
	Document  string `json:"document"`
	Signature string `json:"signature"`
	State     string `json:"state"`
}

type ReportHealthResponse

type ReportHealthResponse struct {
	OK           bool   `json:"ok"`
	DesiredState string `json:"desiredState"`
}