libwait

Documentation

Index

• func WaitForMigrationToDisappearWithTimeout(migration *v1.VirtualMachineInstanceMigration, seconds int)
• func WaitForSuccessfulVMIStart(vmi *v1.VirtualMachineInstance, opts ...Option) *v1.VirtualMachineInstance
• func WaitForVMIPhase(vmi *v1.VirtualMachineInstance, phases []v1.VirtualMachineInstancePhase, ...) *v1.VirtualMachineInstance
• func WaitForVirtualMachineToDisappearWithTimeout(vmi *v1.VirtualMachineInstance, seconds int)
• func WaitUntilVMIReady(vmi *v1.VirtualMachineInstance, loginTo console.LoginToFunction, ...) *v1.VirtualMachineInstance
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithFailOnWarnings(failOnWarnings bool) Option
  • func WithTimeout(seconds int) Option
  • func WithWaitForFail(waitForFail bool) Option
  • func WithWarningsIgnoreList(warningIgnoreList []string) Option
  • func WithWarningsPolicy(wp *watcher.WarningsPolicy) Option
• type Waiting

Functions

func WaitForMigrationToDisappearWithTimeout

func WaitForMigrationToDisappearWithTimeout(migration *v1.VirtualMachineInstanceMigration, seconds int)

WaitForMigrationToDisappearWithTimeout blocks for the passed seconds until the specified VirtualMachineInstanceMigration disappears

func WaitForSuccessfulVMIStart

func WaitForSuccessfulVMIStart(vmi *v1.VirtualMachineInstance, opts ...Option) *v1.VirtualMachineInstance

WaitForSuccessfulVMIStart blocks until the specified VirtualMachineInstance reaches the Running state using the passed options

func WaitForVMIPhase

func WaitForVMIPhase(vmi *v1.VirtualMachineInstance, phases []v1.VirtualMachineInstancePhase, opts ...Option) *v1.VirtualMachineInstance

WaitForVMIPhase blocks until the specified VirtualMachineInstance reaches any of the phases. By default, the waiting will fail if a warning is captured and a default timeout will be used. These properties can be customized using With* options. If no context is provided, a new one will be created.

func WaitForVirtualMachineToDisappearWithTimeout

func WaitForVirtualMachineToDisappearWithTimeout(vmi *v1.VirtualMachineInstance, seconds int)

WaitForVirtualMachineToDisappearWithTimeout blocks for the passed seconds until the specified VirtualMachineInstance disappears

func WaitUntilVMIReady

func WaitUntilVMIReady(vmi *v1.VirtualMachineInstance, loginTo console.LoginToFunction, opts ...Option) *v1.VirtualMachineInstance

WaitUntilVMIReady blocks until the specified VirtualMachineInstance reaches the Running state using the passed options, and the login succeed

Types

type Option

type Option func(waiting *Waiting)

Option represents an action that enables an option.

func WithContext

func WithContext(ctx context.Context) Option

WithContext adds a specific context to the waiting struct

func WithFailOnWarnings

func WithFailOnWarnings(failOnWarnings bool) Option

WithFailOnWarnings sets if the waiting should fail on warning or not

func WithTimeout

func WithTimeout(seconds int) Option

WithTimeout adds a specific timeout to the waiting struct

func WithWaitForFail

func WithWaitForFail(waitForFail bool) Option

WithWaitForFail adds the specific waitForFail to the waiting struct

func WithWarningsIgnoreList

func WithWarningsIgnoreList(warningIgnoreList []string) Option

WithWarningsIgnoreList sets the warnings that will be ignored during the waiting for phase This option will be ignored if a warning policy has been set before and the failOnWarnings is false If no warning policy has been set before, a new one will be set implicitly with fail on warnings enabled and the ignore list added

func WithWarningsPolicy

func WithWarningsPolicy(wp *watcher.WarningsPolicy) Option

WithWarningsPolicy adds a specific warningPolicy to the waiting struct

type Waiting

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

Waiting represents the waiting struct.