machine

Documentation

Index

• func AcquireAllLeases(ctx context.Context) ([]*api.Machine, releaseLeasesFunc, error)
• func AcquireLease(ctx context.Context, machine *api.Machine) (*api.Machine, releaseLeaseFunc, error)
• func AcquireLeases(ctx context.Context, machines []*api.Machine) ([]*api.Machine, releaseLeasesFunc, error)
• func CloneConfig(orig *api.MachineConfig) *api.MachineConfig
• func ConfirmConfigChanges(ctx context.Context, machine *api.Machine, targetConfig api.MachineConfig, ...) (bool, error)
• func ListActive(ctx context.Context) ([]*api.Machine, error)
• func NewMachineSet(flapsClient *flaps.Client, io *iostreams.IOStreams, machines []*api.Machine) *machineSet
• func Restart(ctx context.Context, m *api.Machine, input *api.RestartMachineInput, ...) error
• func RollingRestart(ctx context.Context, input *api.RestartMachineInput) error
• func Update(ctx context.Context, m *api.Machine, input *api.LaunchMachineInput) error
• func WaitForStartOrStop(ctx context.Context, machine *api.Machine, action string, ...) error
• type ErrNoConfigChangesFound
  • func (e *ErrNoConfigChangesFound) Error() string
• type LeasableMachine
  • func NewLeasableMachine(flapsClient *flaps.Client, io *iostreams.IOStreams, machine *api.Machine) LeasableMachine
• type MachineSet

Functions

func AcquireAllLeases

func AcquireAllLeases(ctx context.Context) ([]*api.Machine, releaseLeasesFunc, error)

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

func AcquireLease

func AcquireLease(ctx context.Context, machine *api.Machine) (*api.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 []*api.Machine) ([]*api.Machine, releaseLeasesFunc, error)

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

func CloneConfig

func CloneConfig(orig *api.MachineConfig) *api.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 *api.Machine, targetConfig api.MachineConfig, customPrompt string) (bool, error)

func ListActive

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

func NewMachineSet

func NewMachineSet(flapsClient *flaps.Client, io *iostreams.IOStreams, machines []*api.Machine) *machineSet

func Restart

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

func RollingRestart

func RollingRestart(ctx context.Context, input *api.RestartMachineInput) error

func Update

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

func WaitForStartOrStop

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

Types

type ErrNoConfigChangesFound

type ErrNoConfigChangesFound struct{}

func (*ErrNoConfigChangesFound) Error

func (e *ErrNoConfigChangesFound) Error() string

type LeasableMachine

type LeasableMachine interface {
	Machine() *api.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, api.LaunchMachineInput) error
	Start(context.Context) error
	Destroy(context.Context, bool) error
	WaitForState(context.Context, string, time.Duration, string, bool) error
	WaitForSmokeChecksToPass(context.Context, string) error
	WaitForHealthchecksToPass(context.Context, time.Duration, string) error
	WaitForEventTypeAfterType(context.Context, string, string, time.Duration, bool) (*api.MachineEvent, error)
	FormattedMachineId() string
	GetMinIntervalAndMinGracePeriod() (time.Duration, time.Duration)
}

func NewLeasableMachine

func NewLeasableMachine(flapsClient *flaps.Client, io *iostreams.IOStreams, machine *api.Machine) LeasableMachine

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
}