bmh

Documentation

Index

• func WaitForAllBareMetalHostsInGoodOperationalState(apiClient *clients.Settings, nsname string, timeout time.Duration, ...) (bool, error)
• type AdditionalOptions
• type BmhBuilder
  • func List(apiClient *clients.Settings, nsname string, options ...goclient.ListOptions) ([]*BmhBuilder, error)
  • func NewBuilder(apiClient *clients.Settings, name string, nsname string, bmcAddress string, ...) *BmhBuilder
  • func Pull(apiClient *clients.Settings, name, nsname string) (*BmhBuilder, error)
  • func (builder *BmhBuilder) Create() (*BmhBuilder, error)
  • func (builder *BmhBuilder) CreateAndWaitUntilProvisioned(timeout time.Duration) (*BmhBuilder, error)
  • func (builder *BmhBuilder) Delete() (*BmhBuilder, error)
  • func (builder *BmhBuilder) DeleteAndWaitUntilDeleted(timeout time.Duration) (*BmhBuilder, error)
  • func (builder *BmhBuilder) Exists() bool
  • func (builder *BmhBuilder) Get() (*bmhv1alpha1.BareMetalHost, error)
  • func (builder *BmhBuilder) GetBmhOperationalState() bmhv1alpha1.OperationalStatus
  • func (builder *BmhBuilder) GetBmhPowerOnStatus() bool
  • func (builder *BmhBuilder) WaitUntilAvailable(timeout time.Duration) error
  • func (builder *BmhBuilder) WaitUntilDeleted(timeout time.Duration) error
  • func (builder *BmhBuilder) WaitUntilInStatus(status bmhv1alpha1.ProvisioningState, timeout time.Duration) error
  • func (builder *BmhBuilder) WaitUntilProvisioned(timeout time.Duration) error
  • func (builder *BmhBuilder) WaitUntilProvisioning(timeout time.Duration) error
  • func (builder *BmhBuilder) WaitUntilReady(timeout time.Duration) error
  • func (builder *BmhBuilder) WithOptions(options ...AdditionalOptions) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceDeviceName(deviceName string) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceHTCL(hctl string) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceMinSizeGigabytes(size int) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceModel(model string) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceRotationalDisk(rotational bool) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceSerialNumber(serialNumber string) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceVendor(vendor string) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceWWN(wwn string) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceWWNVendorExtension(wwnVendorExtension string) *BmhBuilder
  • func (builder *BmhBuilder) WithRootDeviceWWNWithExtension(wwnWithExtension string) *BmhBuilder

Functions

func WaitForAllBareMetalHostsInGoodOperationalState

func WaitForAllBareMetalHostsInGoodOperationalState(apiClient *clients.Settings,
	nsname string,
	timeout time.Duration,
	options ...goclient.ListOptions) (bool, error)

WaitForAllBareMetalHostsInGoodOperationalState waits for all baremetalhosts to be in good Operational State for a time duration up to the timeout.

Types

type AdditionalOptions

type AdditionalOptions func(builder *BmhBuilder) (*BmhBuilder, error)

AdditionalOptions additional options for bmh object.

type BmhBuilder

type BmhBuilder struct {
	Definition *bmhv1alpha1.BareMetalHost
	Object     *bmhv1alpha1.BareMetalHost
	// contains filtered or unexported fields
}

BmhBuilder provides struct for the bmh object containing connection to the cluster and the bmh definitions.

func List

func List(apiClient *clients.Settings, nsname string, options ...goclient.ListOptions) ([]*BmhBuilder, error)

List returns bareMetalHosts inventory in the given namespace.

func NewBuilder

func NewBuilder(
	apiClient *clients.Settings,
	name string,
	nsname string,
	bmcAddress string,
	bmcSecretName string,
	bootMacAddress string,
	bootMode string) *BmhBuilder

NewBuilder creates a new instance of BmhBuilder.

func Pull

func Pull(apiClient *clients.Settings, name, nsname string) (*BmhBuilder, error)

Pull pulls existing baremetalhost from cluster.

func (*BmhBuilder) Create

func (builder *BmhBuilder) Create() (*BmhBuilder, error)

Create makes a bmh in the cluster and stores the created object in struct.

func (*BmhBuilder) CreateAndWaitUntilProvisioned

func (builder *BmhBuilder) CreateAndWaitUntilProvisioned(timeout time.Duration) (*BmhBuilder, error)

CreateAndWaitUntilProvisioned creates bmh object and waits until bmh is provisioned.

func (*BmhBuilder) Delete

func (builder *BmhBuilder) Delete() (*BmhBuilder, error)

Delete removes bmh from a cluster.

func (*BmhBuilder) DeleteAndWaitUntilDeleted

func (builder *BmhBuilder) DeleteAndWaitUntilDeleted(timeout time.Duration) (*BmhBuilder, error)

DeleteAndWaitUntilDeleted delete bmh object and waits until deleted.

func (*BmhBuilder) Exists

func (builder *BmhBuilder) Exists() bool

Exists checks whether the given bmh exists.

func (*BmhBuilder) Get

func (builder *BmhBuilder) Get() (*bmhv1alpha1.BareMetalHost, error)

Get returns bmh object if found.

func (*BmhBuilder) GetBmhOperationalState

func (builder *BmhBuilder) GetBmhOperationalState() bmhv1alpha1.OperationalStatus

GetBmhOperationalState returns the current OperationalStatus of the bmh.

func (*BmhBuilder) GetBmhPowerOnStatus

func (builder *BmhBuilder) GetBmhPowerOnStatus() bool

GetBmhPowerOnStatus checks BareMetalHost PowerOn status.

func (*BmhBuilder) WaitUntilAvailable

func (builder *BmhBuilder) WaitUntilAvailable(timeout time.Duration) error

WaitUntilAvailable waits for timeout duration or until bmh is available.

func (*BmhBuilder) WaitUntilDeleted

func (builder *BmhBuilder) WaitUntilDeleted(timeout time.Duration) error

WaitUntilDeleted waits for timeout duration or until bmh is deleted.

func (*BmhBuilder) WaitUntilInStatus

func (builder *BmhBuilder) WaitUntilInStatus(status bmhv1alpha1.ProvisioningState, timeout time.Duration) error

WaitUntilInStatus waits for timeout duration or until bmh gets to a specific status.

func (*BmhBuilder) WaitUntilProvisioned

func (builder *BmhBuilder) WaitUntilProvisioned(timeout time.Duration) error

WaitUntilProvisioned waits for timeout duration or until bmh is provisioned.

func (*BmhBuilder) WaitUntilProvisioning

func (builder *BmhBuilder) WaitUntilProvisioning(timeout time.Duration) error

WaitUntilProvisioning waits for timeout duration or until bmh is provisioning.

func (*BmhBuilder) WaitUntilReady

func (builder *BmhBuilder) WaitUntilReady(timeout time.Duration) error

WaitUntilReady waits for timeout duration or until bmh is ready.

func (*BmhBuilder) WithOptions

func (builder *BmhBuilder) WithOptions(options ...AdditionalOptions) *BmhBuilder

WithOptions creates bmh with generic mutation options.

func (*BmhBuilder) WithRootDeviceDeviceName

func (builder *BmhBuilder) WithRootDeviceDeviceName(deviceName string) *BmhBuilder

WithRootDeviceDeviceName sets rootDeviceHints DeviceName to specified value.

func (*BmhBuilder) WithRootDeviceHTCL

func (builder *BmhBuilder) WithRootDeviceHTCL(hctl string) *BmhBuilder

WithRootDeviceHTCL sets rootDeviceHints HTCL to specified value.

func (*BmhBuilder) WithRootDeviceMinSizeGigabytes

func (builder *BmhBuilder) WithRootDeviceMinSizeGigabytes(size int) *BmhBuilder

WithRootDeviceMinSizeGigabytes sets rootDeviceHints MinSizeGigabytes to specified value.

func (*BmhBuilder) WithRootDeviceModel

func (builder *BmhBuilder) WithRootDeviceModel(model string) *BmhBuilder

WithRootDeviceModel sets rootDeviceHints Model to specified value.

func (*BmhBuilder) WithRootDeviceRotationalDisk

func (builder *BmhBuilder) WithRootDeviceRotationalDisk(rotational bool) *BmhBuilder

WithRootDeviceRotationalDisk sets rootDeviceHint Rotational to specified value.

func (*BmhBuilder) WithRootDeviceSerialNumber

func (builder *BmhBuilder) WithRootDeviceSerialNumber(serialNumber string) *BmhBuilder

WithRootDeviceSerialNumber sets rootDeviceHints serialNumber to specified value.

func (*BmhBuilder) WithRootDeviceVendor

func (builder *BmhBuilder) WithRootDeviceVendor(vendor string) *BmhBuilder

WithRootDeviceVendor sets rootDeviceHints Vendor to specified value.

func (*BmhBuilder) WithRootDeviceWWN

func (builder *BmhBuilder) WithRootDeviceWWN(wwn string) *BmhBuilder

WithRootDeviceWWN sets rootDeviceHints WWN to specified value.

func (*BmhBuilder) WithRootDeviceWWNVendorExtension

func (builder *BmhBuilder) WithRootDeviceWWNVendorExtension(wwnVendorExtension string) *BmhBuilder

WithRootDeviceWWNVendorExtension sets rootDeviceHint WWNVendorExtension to specified value.

func (*BmhBuilder) WithRootDeviceWWNWithExtension

func (builder *BmhBuilder) WithRootDeviceWWNWithExtension(wwnWithExtension string) *BmhBuilder

WithRootDeviceWWNWithExtension sets rootDeviceHints WWNWithExtension to specified value.