ravel

Documentation

Index

• type CreateGatewayOptions
• type Gateway
• type Ravel
  • func New(config config.RavelConfig) (*Ravel, error)
  • func (r *Ravel) CreateFleet(ctx context.Context, ns string, name string) (*api.Fleet, error)
  • func (r *Ravel) CreateGateway(ctx context.Context, namespace string, fleet string, ...) (Gateway, error)
  • func (r *Ravel) CreateMachine(ctx context.Context, namespace string, fleet string, ...) (*api.Machine, error)
  • func (r *Ravel) CreateNamespace(ctx context.Context, name string) (*api.Namespace, error)
  • func (r *Ravel) DeleteGateway(ctx context.Context, namespace string, fleet string, gateway string) error
  • func (r *Ravel) DeleteNamespace(ctx context.Context, name string) error
  • func (r *Ravel) DestroyFleet(ctx context.Context, namespace string, idOrName string) error
  • func (r *Ravel) DestroyMachine(ctx context.Context, ns, fleet, machineId string, force bool) error
  • func (r *Ravel) DisableMachineGateway(ctx context.Context, ns, fleet, machineId string) error
  • func (r *Ravel) EnableMachineGateway(ctx context.Context, ns, fleet, machineId string) error
  • func (r *Ravel) GetFleet(ctx context.Context, namespace string, idOrName string) (*api.Fleet, error)
  • func (r *Ravel) GetGateway(ctx context.Context, namespace string, fleet string, gateway string) (Gateway, error)
  • func (r *Ravel) GetMachine(ctx context.Context, ns, fleet, machineId string) (*api.Machine, error)
  • func (r *Ravel) GetMachineLogsRaw(ctx context.Context, ns, fleet, machineId string, follow bool) (io.ReadCloser, error)
  • func (r *Ravel) GetNamespace(ctx context.Context, name string) (*api.Namespace, error)
  • func (r *Ravel) ListFleets(ctx context.Context, namespace string) ([]api.Fleet, error)
  • func (r *Ravel) ListGateways(ctx context.Context, namespace string, fleet string) ([]Gateway, error)
  • func (r *Ravel) ListMachineEvents(ctx context.Context, ns, fleet, machineId string) ([]api.MachineEvent, error)
  • func (r *Ravel) ListMachineVersions(ctx context.Context, ns, fleet, machineId string) ([]api.MachineVersion, error)
  • func (r *Ravel) ListMachines(ctx context.Context, ns, fleet string, includeDestroyed bool) ([]api.Machine, error)
  • func (r *Ravel) ListNamespaces(ctx context.Context) ([]api.Namespace, error)
  • func (r *Ravel) ListNodes(ctx context.Context) ([]api.Node, error)
  • func (r *Ravel) MachineExec(ctx context.Context, ns, fleet, machineId string, execOpts *api.ExecOptions) (*api.ExecResult, error)
  • func (r *Ravel) Start() error
  • func (r *Ravel) StartMachine(ctx context.Context, ns, fleet, machineId string) error
  • func (r *Ravel) Stop() error
  • func (r *Ravel) StopMachine(ctx context.Context, ns, fleet, machineId string, stopConfig *api.StopConfig) error
  • func (r *Ravel) WaitMachineStatus(ctx context.Context, ns, fleet, machineId string, status api.MachineStatus, ...) error
• type WaitOpt
  • func WithInstanceId(instanceId string) WaitOpt
  • func WithTimeout(seconds int) WaitOpt

Types

type CreateGatewayOptions

type CreateGatewayOptions = api.CreateGatewayPayload

type Gateway

type Gateway = api.Gateway

type Ravel

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

func New

func New(config config.RavelConfig) (*Ravel, error)

func (*Ravel) CreateFleet

func (r *Ravel) CreateFleet(ctx context.Context, ns string, name string) (*api.Fleet, error)

func (*Ravel) CreateGateway

func (r *Ravel) CreateGateway(ctx context.Context, namespace string, fleet string, options CreateGatewayOptions) (Gateway, error)

func (*Ravel) CreateMachine

func (r *Ravel) CreateMachine(ctx context.Context, namespace string, fleet string, createOptions api.CreateMachinePayload) (*api.Machine, error)

func (*Ravel) CreateNamespace

func (r *Ravel) CreateNamespace(ctx context.Context, name string) (*api.Namespace, error)

func (*Ravel) DeleteGateway

func (r *Ravel) DeleteGateway(ctx context.Context, namespace string, fleet string, gateway string) error

func (*Ravel) DeleteNamespace

func (r *Ravel) DeleteNamespace(ctx context.Context, name string) error

func (*Ravel) DestroyFleet

func (r *Ravel) DestroyFleet(ctx context.Context, namespace string, idOrName string) error

func (*Ravel) DestroyMachine

func (r *Ravel) DestroyMachine(ctx context.Context, ns, fleet, machineId string, force bool) error

func (*Ravel) DisableMachineGateway

func (r *Ravel) DisableMachineGateway(ctx context.Context, ns, fleet, machineId string) error

func (*Ravel) EnableMachineGateway

func (r *Ravel) EnableMachineGateway(ctx context.Context, ns, fleet, machineId string) error

func (*Ravel) GetFleet

func (r *Ravel) GetFleet(ctx context.Context, namespace string, idOrName string) (*api.Fleet, error)

func (*Ravel) GetGateway

func (r *Ravel) GetGateway(ctx context.Context, namespace string, fleet string, gateway string) (Gateway, error)

func (*Ravel) GetMachine

func (r *Ravel) GetMachine(ctx context.Context, ns, fleet, machineId string) (*api.Machine, error)

func (*Ravel) GetMachineLogsRaw

func (r *Ravel) GetMachineLogsRaw(ctx context.Context, ns, fleet, machineId string, follow bool) (io.ReadCloser, error)

func (*Ravel) GetNamespace

func (r *Ravel) GetNamespace(ctx context.Context, name string) (*api.Namespace, error)

func (*Ravel) ListFleets

func (r *Ravel) ListFleets(ctx context.Context, namespace string) ([]api.Fleet, error)

func (*Ravel) ListGateways

func (r *Ravel) ListGateways(ctx context.Context, namespace string, fleet string) ([]Gateway, error)

func (*Ravel) ListMachineEvents

func (r *Ravel) ListMachineEvents(ctx context.Context, ns, fleet, machineId string) ([]api.MachineEvent, error)

func (*Ravel) ListMachineVersions

func (r *Ravel) ListMachineVersions(ctx context.Context, ns, fleet, machineId string) ([]api.MachineVersion, error)

func (*Ravel) ListMachines

func (r *Ravel) ListMachines(ctx context.Context, ns, fleet string, includeDestroyed bool) ([]api.Machine, error)

func (*Ravel) ListNamespaces

func (r *Ravel) ListNamespaces(ctx context.Context) ([]api.Namespace, error)

func (*Ravel) ListNodes

func (r *Ravel) ListNodes(ctx context.Context) ([]api.Node, error)

func (*Ravel) MachineExec

func (r *Ravel) MachineExec(ctx context.Context, ns, fleet, machineId string, execOpts *api.ExecOptions) (*api.ExecResult, error)

func (*Ravel) Start

func (r *Ravel) Start() error

func (*Ravel) StartMachine

func (r *Ravel) StartMachine(ctx context.Context, ns, fleet, machineId string) error

func (*Ravel) Stop

func (r *Ravel) Stop() error

func (*Ravel) StopMachine

func (r *Ravel) StopMachine(ctx context.Context, ns, fleet, machineId string, stopConfig *api.StopConfig) error

func (*Ravel) WaitMachineStatus

func (r *Ravel) WaitMachineStatus(ctx context.Context, ns, fleet, machineId string, status api.MachineStatus, timeout uint) error

type WaitOpt

type WaitOpt func(*waitOpt)

func WithInstanceId

func WithInstanceId(instanceId string) WaitOpt

func WithTimeout

func WithTimeout(seconds int) WaitOpt