flaps

Documentation

Index

• Variables
• func NewContext(ctx context.Context, c *Client) context.Context
• type Client
  • func FromContext(ctx context.Context) *Client
  • func New(ctx context.Context, app *api.AppCompact) (*Client, error)
  • func NewFromAppName(ctx context.Context, appName string) (*Client, error)
  • func NewWithOptions(ctx context.Context, opts NewClientOpts) (*Client, error)
  • func (f *Client) AcquireLease(ctx context.Context, machineID string, ttl *int) (*api.MachineLease, error)
  • func (f *Client) Cordon(ctx context.Context, machineID string) (err error)
  • func (f *Client) CreateApp(ctx context.Context, name string, org string) (err error)
  • func (f *Client) Destroy(ctx context.Context, input api.RemoveMachineInput, nonce string) (err error)
  • func (f *Client) Exec(ctx context.Context, machineID string, in *api.MachineExecRequest) (*api.MachineExecResponse, error)
  • func (f *Client) FindLease(ctx context.Context, machineID string) (*api.MachineLease, error)
  • func (f *Client) Get(ctx context.Context, machineID string) (*api.Machine, error)
  • func (f *Client) GetMany(ctx context.Context, machineIDs []string) ([]*api.Machine, error)
  • func (f *Client) GetProcesses(ctx context.Context, machineID string) (api.MachinePsResponse, error)
  • func (f *Client) Kill(ctx context.Context, machineID string) (err error)
  • func (f *Client) Launch(ctx context.Context, builder api.LaunchMachineInput) (out *api.Machine, err error)
  • func (f *Client) List(ctx context.Context, state string) ([]*api.Machine, error)
  • func (f *Client) ListActive(ctx context.Context) ([]*api.Machine, error)
  • func (f *Client) ListFlyAppsMachines(ctx context.Context) ([]*api.Machine, *api.Machine, error)
  • func (f *Client) NewRequest(ctx context.Context, method, path string, in interface{}, ...) (*http.Request, error)
  • func (f *Client) RefreshLease(ctx context.Context, machineID string, ttl *int, nonce string) (*api.MachineLease, error)
  • func (f *Client) ReleaseLease(ctx context.Context, machineID, nonce string) error
  • func (f *Client) Restart(ctx context.Context, in api.RestartMachineInput, nonce string) (err error)
  • func (f *Client) Start(ctx context.Context, machineID string, nonce string) (out *api.MachineStartResponse, err error)
  • func (f *Client) Stop(ctx context.Context, in api.StopMachineInput, nonce string) (err error)
  • func (f *Client) UnCordon(ctx context.Context, machineID string) (err error)
  • func (f *Client) Update(ctx context.Context, builder api.LaunchMachineInput, nonce string) (out *api.Machine, err error)
  • func (f *Client) Wait(ctx context.Context, machine *api.Machine, state string, timeout time.Duration) (err error)
• type FlapsError
  • func (fe *FlapsError) Error() string
  • func (fe *FlapsError) Is(target error) bool
  • func (fe *FlapsError) ResponseBodyString() string
  • func (fe *FlapsError) Unwrap() error
• type NewClientOpts

Variables

var (
	FlapsErrorNotFound = &FlapsError{ResponseStatusCode: http.StatusNotFound}
)

var NonceHeader = "fly-machine-lease-nonce"

Functions

func NewContext

func NewContext(ctx context.Context, c *Client) context.Context

NewContext derives a Context that carries c from ctx.

Types

type Client

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

func FromContext

func FromContext(ctx context.Context) *Client

FromContext returns the Client ctx carries. It panics in case ctx carries no Client.

func New

func New(ctx context.Context, app *api.AppCompact) (*Client, error)

func NewFromAppName

func NewFromAppName(ctx context.Context, appName string) (*Client, error)

func NewWithOptions

func NewWithOptions(ctx context.Context, opts NewClientOpts) (*Client, error)

func (*Client) AcquireLease

func (f *Client) AcquireLease(ctx context.Context, machineID string, ttl *int) (*api.MachineLease, error)

func (*Client) Cordon

func (f *Client) Cordon(ctx context.Context, machineID string) (err error)

func (*Client) CreateApp

func (f *Client) CreateApp(ctx context.Context, name string, org string) (err error)

func (*Client) Destroy

func (f *Client) Destroy(ctx context.Context, input api.RemoveMachineInput, nonce string) (err error)

func (*Client) Exec

func (f *Client) Exec(ctx context.Context, machineID string, in *api.MachineExecRequest) (*api.MachineExecResponse, error)

func (*Client) FindLease

func (f *Client) FindLease(ctx context.Context, machineID string) (*api.MachineLease, error)

func (*Client) Get

func (f *Client) Get(ctx context.Context, machineID string) (*api.Machine, error)

func (*Client) GetMany

func (f *Client) GetMany(ctx context.Context, machineIDs []string) ([]*api.Machine, error)

func (*Client) GetProcesses

func (f *Client) GetProcesses(ctx context.Context, machineID string) (api.MachinePsResponse, error)

func (*Client) Kill

func (f *Client) Kill(ctx context.Context, machineID string) (err error)

func (*Client) Launch

func (f *Client) Launch(ctx context.Context, builder api.LaunchMachineInput) (out *api.Machine, err error)

func (*Client) List

func (f *Client) List(ctx context.Context, state string) ([]*api.Machine, error)

func (*Client) ListActive

func (f *Client) ListActive(ctx context.Context) ([]*api.Machine, error)

ListActive returns only non-destroyed that aren't in a reserved process group.

func (*Client) ListFlyAppsMachines

func (f *Client) ListFlyAppsMachines(ctx context.Context) ([]*api.Machine, *api.Machine, error)

ListFlyAppsMachines returns apps that are part of the Fly apps platform. Destroyed machines and console machines are excluded. Unlike other List functions, this function retries multiple times.

func (*Client) NewRequest

func (f *Client) NewRequest(ctx context.Context, method, path string, in interface{}, headers map[string][]string) (*http.Request, error)

func (*Client) RefreshLease

func (f *Client) RefreshLease(ctx context.Context, machineID string, ttl *int, nonce string) (*api.MachineLease, error)

func (*Client) ReleaseLease

func (f *Client) ReleaseLease(ctx context.Context, machineID, nonce string) error

func (*Client) Restart

func (f *Client) Restart(ctx context.Context, in api.RestartMachineInput, nonce string) (err error)

func (*Client) Start

func (f *Client) Start(ctx context.Context, machineID string, nonce string) (out *api.MachineStartResponse, err error)

func (*Client) Stop

func (f *Client) Stop(ctx context.Context, in api.StopMachineInput, nonce string) (err error)

func (*Client) UnCordon

func (f *Client) UnCordon(ctx context.Context, machineID string) (err error)

func (*Client) Update

func (f *Client) Update(ctx context.Context, builder api.LaunchMachineInput, nonce string) (out *api.Machine, err error)

func (*Client) Wait

func (f *Client) Wait(ctx context.Context, machine *api.Machine, state string, timeout time.Duration) (err error)

type FlapsError

type FlapsError struct {
	OriginalError      error
	ResponseStatusCode int
	ResponseBody       []byte
	FlyRequestId       string
}

func (*FlapsError) Error

func (fe *FlapsError) Error() string

func (*FlapsError) Is

func (fe *FlapsError) Is(target error) bool

func (*FlapsError) ResponseBodyString

func (fe *FlapsError) ResponseBodyString() string

func (*FlapsError) Unwrap

func (fe *FlapsError) Unwrap() error

type NewClientOpts

type NewClientOpts struct {
	// required:
	AppName string

	// optional, avoids API roundtrip when connecting to flaps by wireguard:
	AppCompact *api.AppCompact

	// optional:
	Logger api.Logger
}