machine

package

v0.0.521 Latest Latest Go to latest Published: Apr 14, 2023 License: Apache-2.0 Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/superfly/flyctl

Links

Open Source Insights

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 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
- func NewMachineSet(flapsClient *flaps.Client, io *iostreams.IOStreams, machines []*api.Machine) MachineSet

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AcquireAllLeases ¶ added in v0.0.434

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 ¶ added in v0.0.434

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 ¶ added in v0.0.434

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 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 ¶ added in v0.0.434

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 ¶ added in v0.0.434

type ErrNoConfigChangesFound struct{}

func (*ErrNoConfigChangesFound) Error ¶ added in v0.0.434

func (e *ErrNoConfigChangesFound) Error() string

type LeasableMachine ¶ added in v0.0.452

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) error
	WaitForHealthchecksToPass(context.Context, time.Duration, string) error
	WaitForEventTypeAfterType(context.Context, string, string, time.Duration) (*api.MachineEvent, error)
	FormattedMachineId() string
}

func NewLeasableMachine ¶ added in v0.0.452

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

type MachineSet ¶ added in v0.0.452

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
}

func NewMachineSet ¶ added in v0.0.452

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL