provisioner

Documentation

Index

• Variables
• type AdoptData
• type EventPublisher
• type Factory
• type HTTPHeaders
• type HardwareState
• type HostConfigData
• type HostData
  • func BuildHostData(host metal3api.BareMetalHost, bmcCreds bmc.Credentials) HostData
  • func BuildHostDataNoBMC(host metal3api.BareMetalHost) HostData
• type InspectData
• type ManagementAccessData
• type PrepareData
• type PreprovisioningImage
• type ProvisionData
• type Provisioner
• type Result
• type ServicingData

Variables

var ErrFirmwareUpdateUnsupported = errors.New("host does not support Firmware Updates")

ErrFirmwareUpdateUnsupported is returned if the host can't execute firmware updates.

var ErrNeedsPreprovisioningImage = errors.New("no suitable Preprovisioning image available")

ErrNeedsPreprovisioningImage is returned if a preprovisioning image is required.

var ErrNeedsRegistration = errors.New("host not registered")

ErrNeedsRegistration is returned if the host is not registered.

Types

type AdoptData

type AdoptData struct {
	State metal3api.ProvisioningState
}

type EventPublisher

type EventPublisher func(reason, message string)

EventPublisher is a function type for publishing events associated with provisioning.

type Factory

type Factory interface {
	NewProvisioner(ctx context.Context, hostData HostData, publish EventPublisher) (Provisioner, error)
}

Factory is the interface for creating new Provisioner objects.

type HTTPHeaders

type HTTPHeaders []map[string]string

type HardwareState

type HardwareState struct {
	// PoweredOn is a pointer to a bool indicating whether the Host is currently
	// powered on. The value is nil if the power state cannot be determined.
	PoweredOn *bool
}

HardwareState holds the response from an UpdateHardwareState call.

type HostConfigData

type HostConfigData interface {
	// UserData is the interface for a function to retrieve user
	// data for a host being provisioned.
	UserData() (string, error)

	// NetworkData is the interface for a function to retrieve netwok
	// configuration for a host.
	NetworkData() (string, error)

	// MetaData is the interface for a function to retrieve metadata
	// configuration for a host.
	MetaData() (string, error)
}

HostConfigData retrieves host configuration data.

type HostData

type HostData struct {
	ObjectMeta                     metav1.ObjectMeta
	BMCAddress                     string
	BMCCredentials                 bmc.Credentials
	DisableCertificateVerification bool
	BootMACAddress                 string
	ProvisionerID                  string
}

func BuildHostData

func BuildHostData(host metal3api.BareMetalHost, bmcCreds bmc.Credentials) HostData

func BuildHostDataNoBMC

func BuildHostDataNoBMC(host metal3api.BareMetalHost) HostData

For controllers that do not need to manage the BMC just set the host and node ID to use with Ironic API.

type InspectData

type InspectData struct {
	BootMode metal3api.BootMode
}

type ManagementAccessData

type ManagementAccessData struct {
	BootMode                   metal3api.BootMode
	AutomatedCleaningMode      metal3api.AutomatedCleaningMode
	State                      metal3api.ProvisioningState
	CurrentImage               *metal3api.Image
	PreprovisioningImage       *PreprovisioningImage
	PreprovisioningNetworkData string
	HasCustomDeploy            bool
}

type PrepareData

type PrepareData struct {
	TargetRAIDConfig         *metal3api.RAIDConfig
	ActualRAIDConfig         *metal3api.RAIDConfig
	RootDeviceHints          *metal3api.RootDeviceHints
	FirmwareConfig           *metal3api.FirmwareConfig
	TargetFirmwareSettings   metal3api.DesiredSettingsMap
	ActualFirmwareSettings   metal3api.SettingsMap
	TargetFirmwareComponents []metal3api.FirmwareUpdate
}

FirmwareConfig and FirmwareSettings are used for implementation of similar functionality FirmwareConfig contains a small subset of common names/values for the BIOS settings and the BMC driver converts them to vendor specific name/values. ActualFirmwareSettings are the complete settings retrieved from the BMC, the names and values are vendor specific. TargetFirmwareSettings contains values that the user has changed.

type PreprovisioningImage

type PreprovisioningImage struct {
	imageprovider.GeneratedImage
	Format metal3api.ImageFormat
}

type ProvisionData

type ProvisionData struct {
	Image           metal3api.Image
	HostConfig      HostConfigData
	BootMode        metal3api.BootMode
	HardwareProfile profile.Profile
	RootDeviceHints *metal3api.RootDeviceHints
	CustomDeploy    *metal3api.CustomDeploy
	CPUArchitecture string
}

type Provisioner

type Provisioner interface {
	// ValidateManagementAccess tests the connection information for
	// the host to verify that the location and credentials work. The
	// boolean argument tells the provisioner whether the current set
	// of credentials it has are different from the credentials it has
	// previously been using, without implying that either set of
	// credentials is correct.
	ValidateManagementAccess(data ManagementAccessData, credentialsChanged, restartOnFailure bool) (result Result, provID string, err error)

	// PreprovisioningImageFormats returns a list of acceptable formats for a
	// pre-provisioning image to be built by a PreprovisioningImage object. The
	// list should be nil if no image build is requested.
	PreprovisioningImageFormats() ([]metal3api.ImageFormat, error)

	// InspectHardware updates the HardwareDetails field of the host with
	// details of devices discovered on the hardware. It may be called
	// multiple times, and should return true for its dirty flag until the
	// inspection is completed.
	InspectHardware(data InspectData, restartOnFailure, refresh, forceReboot bool) (result Result, started bool, details *metal3api.HardwareDetails, err error)

	// UpdateHardwareState fetches the latest hardware state of the
	// server and updates the HardwareDetails field of the host with
	// details. It is expected to do this in the least expensive way
	// possible, such as reading from a cache.
	UpdateHardwareState() (hwState HardwareState, err error)

	// Adopt brings an externally-provisioned host under management by
	// the provisioner.
	Adopt(data AdoptData, restartOnFailure bool) (result Result, err error)

	// Prepare remove existing configuration and set new configuration
	Prepare(data PrepareData, unprepared bool, restartOnFailure bool) (result Result, started bool, err error)

	// Servicing updates configuration for a provisioned host.
	Service(data ServicingData, unprepared, restartOnFailure bool) (result Result, started bool, err error)

	// Provision writes the image from the host spec to the host. It
	// may be called multiple times, and should return true for its
	// dirty flag until the provisioning operation is completed.
	Provision(data ProvisionData, forceReboot bool) (result Result, err error)

	// Deprovision removes the host from the image. It may be called
	// multiple times, and should return true for its dirty flag until
	// the deprovisioning operation is completed.
	Deprovision(restartOnFailure bool) (result Result, err error)

	// Delete removes the host from the provisioning system. It may be
	// called multiple times, and should return true for its dirty
	// flag until the deletion operation is completed.
	Delete() (result Result, err error)

	// Detach removes the host from the provisioning system.
	// Similar to Delete, but ensures non-interruptive behavior
	// for the target system.  It may be called multiple times,
	// and should return true for its dirty  flag until the
	// deletion operation is completed.
	Detach() (result Result, err error)

	// PowerOn ensures the server is powered on independently of any image
	// provisioning operation.
	PowerOn(force bool) (result Result, err error)

	// PowerOff ensures the server is powered off independently of any image
	// provisioning operation. The boolean argument may be used to specify
	// if a hard reboot (force power off) is required - true if so.
	PowerOff(rebootMode metal3api.RebootMode, force bool) (result Result, err error)

	// TryInit checks if the provisioning backend is available to accept
	// all the incoming requests and configures the available features.
	TryInit() (ready bool, err error)

	// HasCapacity checks if the backend has a free (de)provisioning slot for the current host
	HasCapacity() (result bool, err error)

	// GetFirmwareSettings gets the BIOS settings and optional schema from the host and returns maps
	GetFirmwareSettings(includeSchema bool) (settings metal3api.SettingsMap, schema map[string]metal3api.SettingSchema, err error)

	// AddBMCEventSubscriptionForNode creates the subscription, and updates Status.SubscriptionID
	AddBMCEventSubscriptionForNode(subscription *metal3api.BMCEventSubscription, httpHeaders HTTPHeaders) (result Result, err error)

	// RemoveBMCEventSubscriptionForNode delete the subscription
	RemoveBMCEventSubscriptionForNode(subscription metal3api.BMCEventSubscription) (result Result, err error)

	// GetFirmwareComponents gets all firmware components available from a note
	GetFirmwareComponents() (components []metal3api.FirmwareComponentStatus, err error)

	// Check if DataImage attach/detach was successful
	IsDataImageReady() (isNodeBusy bool, nodeError error)

	// Attach DataImage
	AttachDataImage(URL string) (err error)

	// Detach DataImage
	DetachDataImage() (err error)
}

Provisioner holds the state information for talking to the provisioning backend.

type Result

type Result struct {
	// Dirty indicates whether the host object needs to be saved.
	Dirty bool
	// RequeueAfter indicates how long to wait before making the same
	// Provisioner call again. The request should only be requeued if
	// Dirty is also true.
	RequeueAfter time.Duration
	// Any error message produced by the provisioner.
	ErrorMessage string
}

Result holds the response from a call in the Provsioner API.

type ServicingData

type ServicingData struct {
	FirmwareConfig           *metal3api.FirmwareConfig
	TargetFirmwareSettings   metal3api.DesiredSettingsMap
	ActualFirmwareSettings   metal3api.SettingsMap
	TargetFirmwareComponents []metal3api.FirmwareUpdate
}