package
0.0.0-20241217081519-3f646dd559d3
Repository: https://github.com/ironcore-dev/metal-operator.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

BlinkingIndicatorLED indicates the Indicator LED is blinking.
BMCSecretPasswordKeyName is the secret key name for the password.F.
BMCSecretUsernameKeyName is the secret key name for the username.
BMCStateEnabled indicates that the BMC is enabled and functioning correctly.
BMCStateError indicates that there is an error with the BMC.
No description provided by the author
ConsoleProtocolNameIPMI represents the IPMI console protocol.
ConsoleProtocolNameSSH represents the SSH console protocol.
ConsoleProtocolNameSSHLenovo represents the SSH console protocol specific to Lenovo hardware.
LitIndicatorLED indicates the Indicator LED is lit.
OffIndicatorLED indicates the Indicator LED is off.
OffPowerState the system is powered off, although some components may continue to have AUX power such as management controller.
OnPowerState the system is powered on.
OperationAnnotation indicates which operation should be performed outside the current spec definition flow.
OperationAnnotationIgnore skips the reconciliation of a resource if set to true.
PausedPowerState the system is paused.
PhaseBound indicates that the server claim is bound to a server.
PhaseUnbound indicates that the server claim is not bound to any server.
PoweringOffPowerState A temporary state between On and Off.
PoweringOnPowerState A temporary state between Off and On.
PowerOff indicates that the device is powered off.
PowerOn indicates that the device is powered on.
ProtocolNameIPMI represents the IPMI protocol.
ProtocolNameRedfish represents the Redfish protocol.
ProtocolNameSSH represents the SSH protocol.
No description provided by the author
No description provided by the author
No description provided by the author
ServerBootConfigurationStateError indicates that there is an error with the boot configuration.
ServerBootConfigurationStatePending indicates that the boot configuration is pending and not yet ready.
ServerBootConfigurationStateReady indicates that the boot configuration is ready for use.
ServerOffPowerState indicates that the system is powered off, although some components may continue to have auxiliary power such as the management controller.
ServerOnPowerState indicates that the system is powered on.
ServerPausedPowerState indicates that the system is paused.
ServerPoweringOffPowerState indicates a temporary state between On and Off.
ServerPoweringOnPowerState indicates a temporary state between Off and On.
ServerStateAvailable indicates that the server is available for use.
ServerStateDiscovery indicates that the server is in its discovery state.
ServerStateError indicates that there is an error with the server.
ServerStateInitial indicates that the server is in its initial state.
ServerStateReserved indicates that the server is reserved for a specific use or user.
StorageStateAbsent indicates that the storage device is absent.
StorageStateDisabled indicates that the storage device is disabled.
StorageStateEnabled indicates that the storage device is enabled.
UnknownIndicatorLED indicates the state of the Indicator LED cannot be determined.

# Variables

AddToScheme adds the types in this group-version to the given scheme.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.

# Structs

BIOSSettings represents the BIOS settings for a server.
BMC is the Schema for the bmcs API.
BMCAccess defines the access details for the BMC.
BMCList contains a list of BMC.
BMCSecret is the Schema for the bmcsecrets API.
BMCSecretList contains a list of BMCSecret.
BMCSpec defines the desired state of BMC +kubebuilder:validation:XValidation:rule="has(self.access) != has(self.endpointRef)",message="exactly one of access or endpointRef needs to be set".
BMCStatus defines the observed state of BMC.
BootOrder represents the boot order of the server.
ConsoleProtocol defines the protocol and port used for console access to the BMC.
Endpoint is the Schema for the endpoints API.
EndpointList contains a list of Endpoint.
EndpointSpec defines the desired state of Endpoint.
EndpointStatus defines the observed state of Endpoint.
InlineEndpoint defines inline network access configuration for the BMC.
IP is an IP address.
IPPrefix represents a network prefix.
NetworkInterface defines the details of a network interface.
Protocol defines the protocol and port used for communicating with the BMC.
Server is the Schema for the servers API.
ServerBootConfiguration is the Schema for the serverbootconfigurations API.
ServerBootConfigurationList contains a list of ServerBootConfiguration.
ServerBootConfigurationSpec defines the desired state of ServerBootConfiguration.
ServerBootConfigurationStatus defines the observed state of ServerBootConfiguration.
ServerClaim is the Schema for the serverclaims API.
ServerClaimList contains a list of ServerClaim.
ServerClaimSpec defines the desired state of ServerClaim.
ServerClaimStatus defines the observed state of ServerClaim.
ServerList contains a list of Server.
ServerSpec defines the desired state of a Server.
ServerStatus defines the observed state of Server.
Storage defines the details of one storage device.
StorageDrive defines the details of one storage drive.
StorageVolume defines the details of one storage volume.

# Type aliases

BMCPowerState defines the possible power states for a BMC.
BMCState defines the possible states of a BMC.
ConsoleProtocolName defines the possible names for console protocols.
IndicatorLED represents LED indicator states.
Phase defines the possible phases of a ServerClaim.
Power defines the possible power states for a device.
ProtocolName defines the possible names for protocols used for communicating with the BMC.
ServerBootConfigurationState defines the possible states of a ServerBootConfiguration.
ServerPowerState defines the possible power states for a server.
ServerState defines the possible states of a server.
StorageState represents Storage states.