machine

Documentation

Index

• func AcquireAllLeases(ctx context.Context) ([]*fly.Machine, releaseLeaseFunc, error)
• func AcquireLease(ctx context.Context, machine *fly.Machine) (*fly.Machine, releaseLeaseFunc, error)
• func AcquireLeases(ctx context.Context, machines []*fly.Machine) ([]*fly.Machine, releaseLeaseFunc, error)
• func CloneConfig(orig *fly.MachineConfig) *fly.MachineConfig
• func ConfirmConfigChanges(ctx context.Context, machine *fly.Machine, targetConfig fly.MachineConfig, ...) (bool, error)
• func LaunchEphemeral(ctx context.Context, input *EphemeralInput) (*fly.Machine, func(), error)
• func ListActive(ctx context.Context) ([]*fly.Machine, error)
• func NewMachineSet(flapsClient flapsutil.FlapsClient, io *iostreams.IOStreams, ...) *machineSet
• func Restart(ctx context.Context, m *fly.Machine, input *fly.RestartMachineInput, ...) error
• func Update(ctx context.Context, m *fly.Machine, input *fly.LaunchMachineInput) error
• func WaitForStartOrStop(ctx context.Context, machine *fly.Machine, action string, ...) error
• type EphemeralInput
• type ErrNoConfigChangesFound
  • func (e *ErrNoConfigChangesFound) Error() string
• type InvalidConfigErr
  • func (e InvalidConfigErr) Description() string
  • func (e InvalidConfigErr) DocURL() string
  • func (e InvalidConfigErr) Error() string
  • func (e InvalidConfigErr) Suggestion() string
• type LeasableMachine
  • func NewLeasableMachine(flapsClient flapsutil.FlapsClient, io *iostreams.IOStreams, ...) LeasableMachine
• type MachineSet
• type WaitTimeoutErr
  • func (e WaitTimeoutErr) Description() string
  • func (e WaitTimeoutErr) DesiredState() string
  • func (e WaitTimeoutErr) Error() string

Functions

func AcquireAllLeases

func AcquireAllLeases(ctx context.Context) ([]*fly.Machine, releaseLeaseFunc, error)

AcquireAllLeases works to acquire/attach a lease for each active machine.

func AcquireLease

func AcquireLease(ctx context.Context, machine *fly.Machine) (*fly.Machine, releaseLeaseFunc, error)

AcquireLease works to acquire/attach a lease for the specified machine. WARNING: Make sure you defer the lease release process.

func AcquireLeases

func AcquireLeases(ctx context.Context, machines []*fly.Machine) ([]*fly.Machine, releaseLeaseFunc, error)

AcquireLeases works to acquire/attach a lease for each machine specified.

func CloneConfig

func CloneConfig(orig *fly.MachineConfig) *fly.MachineConfig

CloneConfig deep-copies a MachineConfig. If CloneConfig is called on a nil config, nil is returned.

func ConfirmConfigChanges

func ConfirmConfigChanges(ctx context.Context, machine *fly.Machine, targetConfig fly.MachineConfig, customPrompt string) (bool, error)

func LaunchEphemeral

func LaunchEphemeral(ctx context.Context, input *EphemeralInput) (*fly.Machine, func(), error)

func ListActive

func ListActive(ctx context.Context) ([]*fly.Machine, error)

func NewMachineSet

func NewMachineSet(flapsClient flapsutil.FlapsClient, io *iostreams.IOStreams, machines []*fly.Machine, showLogs bool) *machineSet

func Restart

func Restart(ctx context.Context, m *fly.Machine, input *fly.RestartMachineInput, nonce string) error

func Update

func Update(ctx context.Context, m *fly.Machine, input *fly.LaunchMachineInput) error

func WaitForStartOrStop

func WaitForStartOrStop(ctx context.Context, machine *fly.Machine, action string, timeout time.Duration) error

Types

type EphemeralInput

type EphemeralInput struct {
	LaunchInput fly.LaunchMachineInput
	What        string
}

type ErrNoConfigChangesFound

type ErrNoConfigChangesFound struct{}

func (*ErrNoConfigChangesFound) Error

func (e *ErrNoConfigChangesFound) Error() string

type InvalidConfigErr

type InvalidConfigErr struct {
	Reason invalidConfigReason
	// contains filtered or unexported fields
}

func (InvalidConfigErr) Description

func (e InvalidConfigErr) Description() string

func (InvalidConfigErr) DocURL

func (e InvalidConfigErr) DocURL() string

func (InvalidConfigErr) Error

func (e InvalidConfigErr) Error() string

func (InvalidConfigErr) Suggestion

func (e InvalidConfigErr) Suggestion() string

type LeasableMachine

type LeasableMachine interface {
	Machine() *fly.Machine
	HasLease() bool
	AcquireLease(context.Context, time.Duration) error
	RefreshLease(context.Context, time.Duration) error
	ReleaseLease(context.Context) error
	StartBackgroundLeaseRefresh(context.Context, time.Duration, time.Duration)
	Update(context.Context, fly.LaunchMachineInput) error
	Start(context.Context) error
	Stop(context.Context, string) error
	Destroy(context.Context, bool) error
	Cordon(context.Context) error
	WaitForState(context.Context, string, time.Duration, bool) error
	WaitForSmokeChecksToPass(context.Context) error
	WaitForHealthchecksToPass(context.Context, time.Duration) error
	WaitForEventType(context.Context, string, time.Duration, bool) (*fly.MachineEvent, error)
	WaitForEventTypeAfterType(context.Context, string, string, time.Duration, bool) (*fly.MachineEvent, error)
	FormattedMachineId() string
	GetMinIntervalAndMinGracePeriod() (time.Duration, time.Duration)
	SetMetadata(ctx context.Context, k, v string) error
	GetMetadata(ctx context.Context) (map[string]string, error)
}

func NewLeasableMachine

func NewLeasableMachine(flapsClient flapsutil.FlapsClient, io *iostreams.IOStreams, machine *fly.Machine, showLogs bool) LeasableMachine

NewLeasableMachine creates a wrapper for the given machine. A lease must be held before calling this function.

type MachineSet

type MachineSet interface {
	AcquireLeases(context.Context, time.Duration) error
	ReleaseLeases(context.Context) error
	RemoveMachines(ctx context.Context, machines []LeasableMachine) error
	StartBackgroundLeaseRefresh(context.Context, time.Duration, time.Duration)
	IsEmpty() bool
	GetMachines() []LeasableMachine
	WaitForMachineSetState(context.Context, string, time.Duration, bool, bool) ([]string, error)
}

type WaitTimeoutErr

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

func (WaitTimeoutErr) Description

func (e WaitTimeoutErr) Description() string

func (WaitTimeoutErr) DesiredState

func (e WaitTimeoutErr) DesiredState() string

func (WaitTimeoutErr) Error

func (e WaitTimeoutErr) Error() string