rufiounreleased

Documentation

Overview

Package rufiounreleased contains types that never became a formal release but were included in EKSA releases. Given we have clusters deployed containing these types it is necessary to keep them so we can perform conversions.

nolint

Index

• Constants
• type BaseboardManagement
  • func (bm *BaseboardManagement) SetCondition(cType BaseboardManagementConditionType, status ConditionStatus, ...)
• type BaseboardManagementCondition
• type BaseboardManagementConditionType
• type BaseboardManagementList
• type BaseboardManagementRef
• type BaseboardManagementSetConditionOption
  • func WithBaseboardManagementConditionMessage(m string) BaseboardManagementSetConditionOption
• type BaseboardManagementSpec
• type BaseboardManagementStatus
• type BootDevice
• type ConditionStatus
• type Connection
• type PowerState

Constants

const BaseboardManagementResourceName = "baseboardmanagements.bmc.tinkerbell.org"

Types

type BaseboardManagement

type BaseboardManagement struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BaseboardManagementSpec   `json:"spec,omitempty"`
	Status BaseboardManagementStatus `json:"status,omitempty"`
}

BaseboardManagement is the Schema for the baseboardmanagements API.

func (*BaseboardManagement) SetCondition

func (bm *BaseboardManagement) SetCondition(cType BaseboardManagementConditionType, status ConditionStatus, opts ...BaseboardManagementSetConditionOption)

SetCondition applies the cType condition to bm. If the condition already exists, it is updated.

type BaseboardManagementCondition

type BaseboardManagementCondition struct {
	// Type of the BaseboardManagement condition.
	Type BaseboardManagementConditionType `json:"type"`

	// Status is the status of the BaseboardManagement condition.
	// Can be True or False.
	Status ConditionStatus `json:"status"`

	// Last time the BaseboardManagement condition was updated.
	LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"`

	// Message represents human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

type BaseboardManagementConditionType

type BaseboardManagementConditionType string

BaseboardManagementConditionType represents the condition of the BaseboardManagement.

const (
	// Contactable defines that a connection can be made to the BaseboardManagement.
	Contactable BaseboardManagementConditionType = "Contactable"
)

type BaseboardManagementList

type BaseboardManagementList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BaseboardManagement `json:"items"`
}

BaseboardManagementList contains a list of BaseboardManagement.

type BaseboardManagementRef

type BaseboardManagementRef struct {
	// Name is unique within a namespace to reference a BaseboardManagement resource.
	Name string `json:"name"`

	// Namespace defines the space within which the BaseboardManagement name must be unique.
	Namespace string `json:"namespace"`
}

BaseboardManagementRef defines the reference information to a BaseboardManagement resource.

type BaseboardManagementSetConditionOption

type BaseboardManagementSetConditionOption func(*BaseboardManagementCondition)

+kubebuilder:object:generate=false

func WithBaseboardManagementConditionMessage

func WithBaseboardManagementConditionMessage(m string) BaseboardManagementSetConditionOption

WithBaseboardManagementConditionMessage sets message m to the BaseboardManagementCondition.

type BaseboardManagementSpec

type BaseboardManagementSpec struct {
	// Connection represents the BaseboardManagement connectivity information.
	Connection Connection `json:"connection"`
}

BaseboardManagementSpec defines the desired state of BaseboardManagement.

type BaseboardManagementStatus

type BaseboardManagementStatus struct {
	// Power is the current power state of the BaseboardManagement.
	// +kubebuilder:validation:Enum=on;off
	// +optional
	Power PowerState `json:"powerState,omitempty"`

	// Conditions represents the latest available observations of an object's current state.
	// +optional
	Conditions []BaseboardManagementCondition `json:"conditions,omitempty"`
}

BaseboardManagementStatus defines the observed state of BaseboardManagement.

type BootDevice

type BootDevice string

BootDevice represents boot device of the BaseboardManagement.

const (
	PXE   BootDevice = "pxe"
	Disk  BootDevice = "disk"
	BIOS  BootDevice = "bios"
	CDROM BootDevice = "cdrom"
	Safe  BootDevice = "safe"
)

type ConditionStatus

type ConditionStatus string

ConditionStatus represents the status of a Condition.

const (
	ConditionTrue  ConditionStatus = "True"
	ConditionFalse ConditionStatus = "False"
)

type Connection

type Connection struct {
	// Host is the host IP address or hostname of the BaseboardManagement.
	// +kubebuilder:validation:MinLength=1
	Host string `json:"host"`

	// Port is the port number for connecting with the BaseboardManagement.
	// +kubebuilder:default:=623
	Port int `json:"port"`

	// AuthSecretRef is the SecretReference that contains authentication information of the BaseboardManagement.
	// The Secret must contain username and password keys.
	AuthSecretRef corev1.SecretReference `json:"authSecretRef"`

	// InsecureTLS specifies trusted TLS connections.
	InsecureTLS bool `json:"insecureTLS"`
}

type PowerState

type PowerState string

PowerState represents power state the BaseboardManagement.

const (
	On  PowerState = "on"
	Off PowerState = "off"
)