API Reference
Packages
metal.ironcore.dev/v1alpha1
Package v1alpha1 contains API Schema definitions for the metal.ironcore.dev API group
Package v1alpha1 contains API Schema definitions for the metal v1alpha1 API group
Resource Types
- BIOSSettings
- BIOSSettingsSet
- BIOSVersion
- BIOSVersionSet
- BMC
- BMCSecret
- BMCSettings
- BMCVersion
- BMCVersionSet
- Endpoint
- Server
- ServerBootConfiguration
- ServerClaim
- ServerMaintenance
BIOSSettings
BIOSSettings is the Schema for the biossettings API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BIOSSettings | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BIOSSettingsSpec | |||
status BIOSSettingsStatus |
BIOSSettingsFlowState
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Pending | BIOSSettingsFlowStatePending specifies that the BIOSSetting Controller is updating the settings for current Priority |
InProgress | BIOSSettingsFlowStateInProgress specifies that the BIOSSetting Controller is updating the settings for current Priority |
Applied | BIOSSettingsFlowStateApplied specifies that the bios setting has been completed for current Priority |
Failed | BIOSSettingsFlowStateFailed specifies that the bios setting update has failed. |
BIOSSettingsFlowStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
flowState BIOSSettingsFlowState | State represents the current state of the bios configuration task for current priority. | ||
name string | Name identifies current priority settings from the Spec | ||
priority integer | Priority identifies the settings priority from the Spec | ||
conditions Condition array | Conditions represents the latest available observations of the BIOSSettings's current Flowstate. | ||
lastAppliedTime Time | LastAppliedTime represents the timestamp when the last setting was successfully applied. |
BIOSSettingsSet
BIOSSettingsSet is the Schema for the biossettingssets API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BIOSSettingsSet | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BIOSSettingsSetSpec | |||
status BIOSSettingsSetStatus |
BIOSSettingsSetSpec
BIOSSettingsSetSpec defines the desired state of BIOSSettingsSet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
biosSettingsTemplate BIOSSettingsTemplate | BiosSettingsTemplate defines the template for the BIOSSettings Resource to be applied to the servers. | ||
serverSelector LabelSelector | ServerSelector specifies a label selector to identify the servers that are to be selected. |
BIOSSettingsSetStatus
BIOSSettingsSetStatus defines the observed state of BIOSSettingsSet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
fullyLabeledServers integer | FullyLabeledServers is the number of server in the set. | ||
availableBIOSSettings integer | AvailableBIOSVersion is the number of Settings current created by the set. | ||
pendingBIOSSettings integer | PendingBIOSSettings is the total number of pending server in the set. | ||
inProgressBIOSSettings integer | InProgressBIOSSettings is the total number of server in the set that are currently in InProgress. | ||
completedBIOSSettings integer | CompletedBIOSSettings is the total number of completed server in the set. | ||
failedBIOSSettings integer | FailedBIOSSettings is the total number of failed server in the set. |
BIOSSettingsSpec
BIOSSettingsSpec defines the desired state of BIOSSettings.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string | Version contains software (eg: BIOS, BMC) version this settings applies to | ||
settingsFlow SettingsFlowItem array | SettingsFlow contains BIOS settings sequence to apply on the BIOS in given order | ||
serverMaintenancePolicy ServerMaintenancePolicy | ServerMaintenancePolicy is a maintenance policy to be enforced on the server. | ||
serverMaintenanceRef ObjectReference | ServerMaintenanceRef is a reference to a ServerMaintenance object that BiosSetting has requested for the referred server. | ||
serverRef LocalObjectReference | ServerRef is a reference to a specific server to apply bios setting on. |
BIOSSettingsState
Underlying type: string
BIOSSettingsState specifies the current state of the BIOS Settings update.
Appears in:
| Field | Description |
|---|---|
Pending | BIOSSettingsStatePending specifies that the bios setting update is waiting |
InProgress | BIOSSettingsStateInProgress specifies that the BIOSSetting Controller is updating the settings |
Applied | BIOSSettingsStateApplied specifies that the bios setting update has been completed. |
Failed | BIOSSettingsStateFailed specifies that the bios setting update has failed. |
BIOSSettingsStatus
BIOSSettingsStatus defines the observed state of BIOSSettings.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
state BIOSSettingsState | State represents the current state of the bios configuration task. | ||
flowState BIOSSettingsFlowStatus array | FlowState is a list of individual BIOSSettings operation flows. | ||
lastAppliedTime Time | LastAppliedTime represents the timestamp when the last setting was successfully applied. | ||
conditions Condition array | Conditions represents the latest available observations of the BIOSSettings's current state. |
BIOSSettingsTemplate
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string | Version contains software (eg: BIOS, BMC) version this settings applies to | ||
settingsFlow SettingsFlowItem array | SettingsFlow contains BIOS settings sequence to apply on the BIOS in given order | ||
serverMaintenancePolicy ServerMaintenancePolicy | ServerMaintenancePolicy is a maintenance policy to be enforced on the server. |
BIOSVersion
BIOSVersion is the Schema for the biosversions API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BIOSVersion | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BIOSVersionSpec | |||
status BIOSVersionStatus |
BIOSVersionSet
BIOSVersionSet is the Schema for the biosversionsets API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BIOSVersionSet | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BIOSVersionSetSpec | |||
status BIOSVersionSetStatus |
BIOSVersionSetSpec
BIOSVersionSetSpec defines the desired state of BIOSVersionSet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
serverSelector LabelSelector | ServerSelector specifies a label selector to identify the servers that are to be selected. | ||
biosVersionTemplate BIOSVersionTemplate | BIOSVersionTemplate defines the template for the BIOSversion Resource to be applied to the servers. |
BIOSVersionSetStatus
BIOSVersionSetStatus defines the observed state of BIOSVersionSet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
fullyLabeledServers integer | FullyLabeledServers is the number of servers in the set. | ||
availableBIOSVersion integer | AvailableBIOSVersion is the number of BIOSVersion created by the set. | ||
pendingBIOSVersion integer | PendingBIOSVersion is the total number of pending BIOSVersion in the set. | ||
inProgressBIOSVersion integer | InProgressBIOSVersion is the total number of BIOSVersion in the set that are currently in InProgress. | ||
completedBIOSVersion integer | CompletedBIOSVersion is the total number of completed BIOSVersion in the set. | ||
failedBIOSVersion integer | FailedBIOSVersion is the total number of failed BIOSVersion in the set. |
BIOSVersionSpec
BIOSVersionSpec defines the desired state of BIOSVersion.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string | Version contains a BIOS version to upgrade to | ||
updatePolicy UpdatePolicy | UpdatePolicy An indication of whether the server's upgrade service should bypass vendor update policies | ||
image ImageSpec | details regarding the image to use to upgrade to given BIOS version | ||
serverMaintenancePolicy ServerMaintenancePolicy | ServerMaintenancePolicy is a maintenance policy to be enforced on the server. | ||
serverMaintenanceRef ObjectReference | ServerMaintenanceRef is a reference to a ServerMaintenance object that that Controller has requested for the referred server. | ||
serverRef LocalObjectReference | ServerRef is a reference to a specific server to apply bios upgrade on. |
BIOSVersionState
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Pending | BIOSVersionStatePending specifies that the bios upgrade maintenance is waiting |
Processing | BIOSVersionStateInProgress specifies that upgrading bios is in progress. |
Completed | BIOSVersionStateCompleted specifies that the bios upgrade maintenance has been completed. |
Failed | BIOSVersionStateFailed specifies that the bios upgrade maintenance has failed. |
BIOSVersionStatus
BIOSVersionStatus defines the observed state of BIOSVersion.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
state BIOSVersionState | State represents the current state of the bios configuration task. | ||
upgradeTask Task | UpgradeTask contains the state of the Upgrade Task created by the BMC | ||
conditions Condition array | Conditions represents the latest available observations of the Bios version upgrade state. |
BIOSVersionTemplate
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string | Version contains a BIOS version to upgrade to | ||
updatePolicy UpdatePolicy | UpdatePolicy An indication of whether the server's upgrade service should bypass vendor update policies | ||
image ImageSpec | details regarding the image to use to upgrade to given BIOS version | ||
serverMaintenancePolicy ServerMaintenancePolicy | ServerMaintenancePolicy is a maintenance policy to be enforced on the server. |
BMC
BMC is the Schema for the bmcs API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BMC | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BMCSpec | |||
status BMCStatus |
BMCAccess
BMCAccess defines the access details for the BMC.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
protocol Protocol | Protocol specifies the protocol to be used for communicating with the BMC. | ||
address string | Address is the address of the BMC. | ||
bmcSecretRef LocalObjectReference | BMCSecretRef is a reference to the Kubernetes Secret object that contains the credentials required to access the BMC. This secret includes sensitive information such as usernames and passwords. |
BMCPowerState
Underlying type: string
BMCPowerState defines the possible power states for a BMC.
Appears in:
| Field | Description |
|---|---|
On | OnPowerState the system is powered on. |
Off | OffPowerState the system is powered off, although some components may continue to have AUX power such as management controller. |
Paused | PausedPowerState the system is paused. |
PoweringOn | PoweringOnPowerState A temporary state between Off and On. This temporary state can be very short. |
PoweringOff | PoweringOffPowerState A temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. |
BMCSecret
BMCSecret is the Schema for the bmcsecrets API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BMCSecret | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
immutable boolean | Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. | ||
data object (keys:string, values:integer array) | Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 | ||
stringData object (keys:string, values:string) | stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API. | ||
type SecretType | Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types |
BMCSettings
BMCSettings is the Schema for the BMCSettings API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BMCSettings | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BMCSettingsSpec | |||
status BMCSettingsStatus |
BMCSettingsSpec
BMCSettingsSpec defines the desired state of BMCSettings.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string | Version defines the BMC firmware for which the settings should be applied. | ||
settings object (keys:string, values:string) | SettingsMap contains bmc settings as map | ||
BMCRef LocalObjectReference | BMCRef is a reference to a specific BMC to apply setting to. | ||
serverMaintenancePolicy ServerMaintenancePolicy | ServerMaintenancePolicy is a maintenance policy to be applied on the server. | ||
serverMaintenanceRefs ServerMaintenanceRefItem array | ServerMaintenanceRefs are references to ServerMaintenance objects which are created by the controller for each server that needs to be updated with the BMC settings. |
BMCSettingsState
Underlying type: string
BMCSettingsState specifies the current state of the server maintenance.
Appears in:
| Field | Description |
|---|---|
Pending | BMCSettingsStatePending specifies that the BMC maintenance is waiting |
InProgress | BMCSettingsStateInProgress specifies that the BMC setting changes are in progress |
Applied | BMCSettingsStateApplied specifies that the BMC maintenance has been completed. |
Failed | BMCSettingsStateFailed specifies that the BMC maintenance has failed. |
BMCSettingsStatus
BMCSettingsStatus defines the observed state of BMCSettings.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
state BMCSettingsState | State represents the current state of the BMC configuration task. | ||
conditions Condition array | Conditions represents the latest available observations of the BMC Settings Resource state. |
BMCSpec
BMCSpec defines the desired state of BMC
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bmcUUID string | BMCUUID is the unique identifier for the BMC as defined in Redfish API. | Optional: {} | |
endpointRef LocalObjectReference | EndpointRef is a reference to the Kubernetes object that contains the endpoint information for the BMC. This reference is typically used to locate the BMC endpoint within the cluster. | Optional: {} | |
access InlineEndpoint | Endpoint allows inline configuration of network access details for the BMC. Use this field if access settings like address are to be configured directly within the BMC resource. | Optional: {} | |
bmcSecretRef LocalObjectReference | BMCSecretRef is a reference to the Kubernetes Secret object that contains the credentials required to access the BMC. This secret includes sensitive information such as usernames and passwords. | ||
protocol Protocol | Protocol specifies the protocol to be used for communicating with the BMC. It could be a standard protocol such as IPMI or Redfish. | ||
consoleProtocol ConsoleProtocol | ConsoleProtocol specifies the protocol to be used for console access to the BMC. This field is optional and can be omitted if console access is not required. | ||
bmcSettingsRef LocalObjectReference | BMCSettingRef is a reference to a BMCSettings object that specifies the BMC configuration for this BMC. |
BMCState
Underlying type: string
BMCState defines the possible states of a BMC.
Appears in:
| Field | Description |
|---|---|
Enabled | BMCStateEnabled indicates that the BMC is enabled and functioning correctly. |
Error | BMCStateError indicates that there is an error with the BMC. |
Pending | BMCStatePending indicates that there is an error connecting with the BMC. |
BMCStatus
BMCStatus defines the observed state of BMC.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
macAddress string | MACAddress is the MAC address of the BMC. The format is validated using a regular expression pattern. | Pattern: ^([0-9A-Fa-f]\{2\}[:-])\{5\}([0-9A-Fa-f]\{2\})$ | |
ip IP | IP is the IP address of the BMC. The type is specified as string and is schemaless. | Format: ip Schemaless: {} Type: string | |
manufacturer string | Manufacturer is the name of the BMC manufacturer. | ||
model string | Model is the model number or name of the BMC. | ||
sku string | SKU is the stock keeping unit identifier for the BMC. | ||
serialNumber string | SerialNumber is the serial number of the BMC. | ||
firmwareVersion string | FirmwareVersion is the version of the firmware currently running on the BMC. | ||
state BMCState | State represents the current state of the BMC. kubebuilder:validation:Enum=Enabled;Error;Pending | Pending | |
powerState BMCPowerState | PowerState represents the current power state of the BMC. | ||
lastResetTime Time | LastResetTime is the timestamp of the last reset operation performed on the BMC. | ||
conditions Condition array | Conditions represents the latest available observations of the BMC's current state. |
BMCVersion
BMCVersion is the Schema for the bmcversions API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BMCVersion | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BMCVersionSpec | |||
status BMCVersionStatus |
BMCVersionSet
BMCVersionSet is the Schema for the bmcversionsets API.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | BMCVersionSet | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec BMCVersionSetSpec | |||
status BMCVersionSetStatus |
BMCVersionSetSpec
BMCVersionSetSpec defines the desired state of BMCVersionSet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
bmcSelector LabelSelector | BMCSelector specifies a label selector to identify the BMC that are to be selected. | ||
bmcVersionTemplate BMCVersionTemplate | BMCVersionTemplate defines the template for the BMCversion Resource to be applied to the servers. |
BMCVersionSetStatus
BMCVersionSetStatus defines the observed state of BMCVersionSet.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
fullyLabeledBMCs integer | FullyLabeledBMCs is the number of server in the set. | ||
availableBMCVersion integer | AvailableBMCVersion is the number of BMCVersion current created by the set. | ||
pendingBMCVersion integer | PendingBMCVersion is the total number of pending BMCVersion in the set. | ||
inProgressBMCVersion integer | InProgressBMCVersion is the total number of BMCVersion in the set that are currently in InProgress. | ||
completedBMCVersion integer | CompletedBMCVersion is the total number of completed BMCVersion in the set. | ||
failedBMCVersion integer | FailedBMCVersion is the total number of failed BMCVersion in the set. |
BMCVersionSpec
BMCVersionSpec defines the desired state of BMCVersion.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string | Version contains a BMC version to upgrade to | ||
updatePolicy UpdatePolicy | UpdatePolicy is an indication of whether the server's upgrade service should bypass vendor update policies | ||
image ImageSpec | details regarding the image to use to upgrade to given BMC version | ||
serverMaintenancePolicy ServerMaintenancePolicy | ServerMaintenancePolicy is a maintenance policy to be enforced on the server managed by referred BMC. | ||
serverMaintenanceRefs ObjectReference array | ServerMaintenanceRefs are references to a ServerMaintenance objects that Controller has requested for the each of the related server. | ||
bmcRef LocalObjectReference | BMCRef is a reference to a specific BMC to apply BMC upgrade on. |
BMCVersionState
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Pending | BMCVersionStatePending specifies that the BMC upgrade maintenance is waiting |
InProgress | BMCVersionStateInProgress specifies that upgrading BMC is in progress. |
Completed | BMCVersionStateCompleted specifies that the BMC upgrade maintenance has been completed. |
Failed | BMCVersionStateFailed specifies that the BMC upgrade maintenance has failed. |
BMCVersionStatus
BMCVersionStatus defines the observed state of BMCVersion.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
state BMCVersionState | State represents the current state of the BMC configuration task. | ||
upgradeTask Task | UpgradeTask contains the state of the Upgrade Task created by the BMC | ||
conditions Condition array | Conditions represents the latest available observations of the BMC version upgrade state. |
BMCVersionTemplate
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string | Version contains a BMC version to upgrade to | ||
updatePolicy UpdatePolicy | UpdatePolicy is an indication of whether the server's upgrade service should bypass vendor update policies | ||
image ImageSpec | details regarding the image to use to upgrade to given BMC version | ||
serverMaintenancePolicy ServerMaintenancePolicy | ServerMaintenancePolicy is a maintenance policy to be enforced on the server managed by referred BMC. |
BootOrder
BootOrder represents the boot order of the server.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is the name of the boot device. | ||
priority integer | Priority is the priority of the boot device. | ||
device string | Device is the device to boot from. |
ConsoleProtocol
ConsoleProtocol defines the protocol and port used for console access to the BMC.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name ConsoleProtocolName | Name specifies the name of the console protocol. This could be a protocol such as "SSH", "Telnet", etc. | Enum: [IPMI SSH SSHLenovo] | |
port integer | Port specifies the port number used for console access. This port is used by the specified console protocol to establish connections. |
ConsoleProtocolName
Underlying type: string
ConsoleProtocolName defines the possible names for console protocols.
Appears in:
| Field | Description |
|---|---|
IPMI | ConsoleProtocolNameIPMI represents the IPMI console protocol. |
SSH | ConsoleProtocolNameSSH represents the SSH console protocol. |
SSHLenovo | ConsoleProtocolNameSSHLenovo represents the SSH console protocol specific to Lenovo hardware. |
Endpoint
Endpoint is the Schema for the endpoints API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | Endpoint | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec EndpointSpec | |||
status EndpointStatus |
EndpointSpec
EndpointSpec defines the desired state of Endpoint
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
macAddress string | MACAddress is the MAC address of the endpoint. | ||
ip IP | IP is the IP address of the endpoint. | Format: ip Schemaless: {} Type: string |
EndpointStatus
EndpointStatus defines the observed state of Endpoint
Appears in:
IP
IP is an IP address.
Validation:
- Format: ip
- Type: string
Appears in:
ImageSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
secretRef SecretReference | ImageSecretRef is a reference to the Kubernetes Secret (of type SecretTypeBasicAuth) object that contains the credentials to access the ImageURI. This secret includes sensitive information such as usernames and passwords. | ||
transferProtocol string | The network protocol that the server's update service uses to retrieve 'ImageURI' | ||
URI string | The URI of the software image to update/install." |
IndicatorLED
Underlying type: string
IndicatorLED represents LED indicator states
Appears in:
| Field | Description |
|---|---|
Unknown | UnknownIndicatorLED indicates the state of the Indicator LED cannot be determined. |
Lit | LitIndicatorLED indicates the Indicator LED is lit. |
Blinking | BlinkingIndicatorLED indicates the Indicator LED is blinking. |
Off | OffIndicatorLED indicates the Indicator LED is off. |
InlineEndpoint
InlineEndpoint defines inline network access configuration for the BMC.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
macAddress string | MACAddress is the MAC address of the endpoint. | ||
ip IP | IP is the IP address of the BMC. | Format: ip Schemaless: {} Type: string |
LLDPNeighbor
LLDPNeighbor defines the details of an LLDP neighbor.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
macAddress string | MACAddress is the MAC address of the LLDP neighbor. | ||
portID string | PortID is the port identifier of the LLDP neighbor. | ||
portDescription string | PortDescription is the port description of the LLDP neighbor. | ||
systemName string | SystemName is the system name of the LLDP neighbor. | ||
systemDescription string | SystemDescription is the system description of the LLDP neighbor. |
NetworkInterface
NetworkInterface defines the details of a network interface.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is the name of the network interface. | ||
ip IP | IP is the IP address assigned to the network interface. Deprecated: Use IPs instead. Kept for backward compatibility, always nil. | Format: ip Schemaless: {} Type: string | |
ips IP array | IPs is a list of IP addresses (both IPv4 and IPv6) assigned to the network interface. | Format: ip Type: string | |
macAddress string | MACAddress is the MAC address of the network interface. | ||
carrierStatus string | CarrierStatus is the operational carrier status of the network interface. | ||
neighbors LLDPNeighbor array | Neighbors contains the LLDP neighbors discovered on this interface. |
ObjectReference
ObjectReference is the namespaced name reference to an object.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | APIVersion is the API version of the referenced object. | ||
kind string | Kind is the kind of the referenced object. | ||
namespace string | Namespace is the namespace of the referenced object. | ||
name string | Name is the name of the referenced object. | ||
uid UID | UID is the uid of the referenced object. |
Phase
Underlying type: string
Phase defines the possible phases of a ServerClaim.
Appears in:
| Field | Description |
|---|---|
Bound | PhaseBound indicates that the server claim is bound to a server. |
Unbound | PhaseUnbound indicates that the server claim is not bound to any server. |
Power
Underlying type: string
Power defines the possible power states for a device.
Appears in:
| Field | Description |
|---|---|
On | PowerOn indicates that the device is powered on. |
Off | PowerOff indicates that the device is powered off. |
Processor
Processor defines the details of a Processor.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string | ID is the name of the Processor. | ||
type string | Type is the type of the Processor. | ||
architecture string | Architecture is the architecture of the Processor. | ||
instructionSet string | InstructionSet is the instruction set of the Processor. | ||
manufacturer string | Manufacturer is the manufacturer of the Processor. | ||
model string | Model is the model of the Processor. | ||
maxSpeedMHz integer | MaxSpeedMHz is the maximum speed of the Processor in MHz. | ||
totalCores integer | TotalCores is the total number of cores in the Processor. | ||
totalThreads integer | TotalThreads is the total number of threads in the Processor. |
Protocol
Protocol defines the protocol and port used for communicating with the BMC.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name ProtocolName | Name specifies the name of the protocol. This could be a protocol such as "IPMI", "Redfish", etc. | ||
port integer | Port specifies the port number used for communication. This port is used by the specified protocol to establish connections. | ||
scheme ProtocolScheme | Scheme specifies the scheme used for communication. |
ProtocolName
Underlying type: string
ProtocolName defines the possible names for protocols used for communicating with the BMC.
Appears in:
| Field | Description |
|---|---|
Redfish | ProtocolNameRedfish represents the Redfish protocol. |
IPMI | ProtocolNameIPMI represents the IPMI protocol. |
SSH | ProtocolNameSSH represents the SSH protocol. |
ProtocolScheme
Underlying type: string
ProtocolScheme is a string that contains the protocol scheme
Appears in:
| Field | Description |
|---|---|
http | HTTPProtocolScheme is the http protocol scheme |
https | HTTPSProtocolScheme is the https protocol scheme |
Server
Server is the Schema for the servers API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | Server | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServerSpec | |||
status ServerStatus |
ServerBootConfiguration
ServerBootConfiguration is the Schema for the serverbootconfigurations API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | ServerBootConfiguration | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServerBootConfigurationSpec | |||
status ServerBootConfigurationStatus |
ServerBootConfigurationSpec
ServerBootConfigurationSpec defines the desired state of ServerBootConfiguration.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
serverRef LocalObjectReference | ServerRef is a reference to the server for which this boot configuration is intended. | ||
image string | Image specifies the boot image to be used for the server. This field is optional and can be omitted if not specified. | ||
ignitionSecretRef LocalObjectReference | IgnitionSecretRef is a reference to the Kubernetes Secret object that contains the ignition configuration for the server. This field is optional and can be omitted if not specified. |
ServerBootConfigurationState
Underlying type: string
ServerBootConfigurationState defines the possible states of a ServerBootConfiguration.
Appears in:
| Field | Description |
|---|---|
Pending | ServerBootConfigurationStatePending indicates that the boot configuration is pending and not yet ready. |
Ready | ServerBootConfigurationStateReady indicates that the boot configuration is ready for use. |
Error | ServerBootConfigurationStateError indicates that there is an error with the boot configuration. |
ServerBootConfigurationStatus
ServerBootConfigurationStatus defines the observed state of ServerBootConfiguration.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
state ServerBootConfigurationState | State represents the current state of the boot configuration. | ||
conditions Condition array | Conditions represents the latest available observations of the ServerBootConfig's current state. |
ServerBootConfigurationTemplate
ServerBootConfigurationTemplate defines the parameters to be used for rendering a boot configuration.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name specifies the name of the boot configuration. | ||
spec ServerBootConfigurationSpec | Parameters specify the parameters to be used for rendering the boot configuration. |
ServerClaim
ServerClaim is the Schema for the serverclaims API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | ServerClaim | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServerClaimSpec | |||
status ServerClaimStatus |
ServerClaimSpec
ServerClaimSpec defines the desired state of ServerClaim.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
power Power | Power specifies the desired power state of the server. | ||
serverRef LocalObjectReference | ServerRef is a reference to a specific server to be claimed. This field is optional and can be omitted if the server is to be selected using ServerSelector. | Optional: {} | |
serverSelector LabelSelector | ServerSelector specifies a label selector to identify the server to be claimed. This field is optional and can be omitted if a specific server is referenced using ServerRef. | Optional: {} | |
ignitionSecretRef LocalObjectReference | IgnitionSecretRef is a reference to the Kubernetes Secret object that contains the ignition configuration for the server. This field is optional and can be omitted if not specified. | ||
image string | Image specifies the boot image to be used for the server. |
ServerClaimStatus
ServerClaimStatus defines the observed state of ServerClaim.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
phase Phase | Phase represents the current phase of the server claim. |
ServerMaintenance
ServerMaintenance is the Schema for the ServerMaintenance API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | ServerMaintenance | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServerMaintenanceSpec | |||
status ServerMaintenanceStatus |
ServerMaintenancePolicy
Underlying type: string
ServerMaintenancePolicy specifies the maintenance policy to be enforced on the server.
Appears in:
- BIOSSettingsSpec
- BIOSSettingsTemplate
- BIOSVersionSpec
- BIOSVersionTemplate
- BMCSettingsSpec
- BMCVersionSpec
- BMCVersionTemplate
- ServerMaintenanceSpec
| Field | Description |
|---|---|
OwnerApproval | ServerMaintenancePolicyOwnerApproval specifies that the maintenance policy requires owner approval. |
Enforced | ServerMaintenancePolicyEnforced specifies that the maintenance policy is enforced. |
ServerMaintenanceRefItem
ServerMaintenanceRefItem is a reference to a ServerMaintenance object.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
serverMaintenanceRef ObjectReference | ServerMaintenanceRef is a reference to a ServerMaintenance object that the BMCSettings has requested for the referred server. |
ServerMaintenanceSpec
ServerMaintenanceSpec defines the desired state of a ServerMaintenance
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
policy ServerMaintenancePolicy | Policy specifies the maintenance policy to be enforced on the server. | ||
serverRef LocalObjectReference | ServerRef is a reference to the server that is to be maintained. | ||
serverPower Power | ServerPower specifies the power state of the server during maintenance. | ||
serverBootConfigurationTemplate ServerBootConfigurationTemplate | ServerBootConfigurationTemplate specifies the boot configuration to be applied to the server during maintenance. |
ServerMaintenanceState
Underlying type: string
ServerMaintenanceState specifies the current state of the server maintenance.
Appears in:
| Field | Description |
|---|---|
Pending | ServerMaintenanceStatePending specifies that the server maintenance is pending. |
InMaintenance | ServerMaintenanceStateInMaintenance specifies that the server is in maintenance. |
Failed | ServerMaintenanceStateFailed specifies that the server maintenance has failed. |
ServerMaintenanceStatus
ServerMaintenanceStatus defines the observed state of a ServerMaintenance
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
state ServerMaintenanceState | State specifies the current state of the server maintenance. |
ServerPowerState
Underlying type: string
ServerPowerState defines the possible power states for a server.
Appears in:
| Field | Description |
|---|---|
On | ServerOnPowerState indicates that the system is powered on. |
Off | ServerOffPowerState indicates that the system is powered off, although some components may continue to have auxiliary power such as the management controller. |
Paused | ServerPausedPowerState indicates that the system is paused. |
PoweringOn | ServerPoweringOnPowerState indicates a temporary state between Off and On. This temporary state can be very short. |
PoweringOff | ServerPoweringOffPowerState indicates a temporary state between On and Off. The power off action can take time while the OS is in the shutdown process. |
ServerSpec
ServerSpec defines the desired state of a Server.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
uuid string | UUID is the unique identifier for the server. Deprecated in favor of systemUUID. | ||
systemUUID string | SystemUUID is the unique identifier for the server. | ||
systemURI string | SystemURI is the unique URI for the server resource in REDFISH API. | ||
power Power | Power specifies the desired power state of the server. | ||
indicatorLED IndicatorLED | IndicatorLED specifies the desired state of the server's indicator LED. | ||
serverClaimRef ObjectReference | ServerClaimRef is a reference to a ServerClaim object that claims this server. This field is optional and can be omitted if no claim is associated with this server. | Optional: {} | |
serverMaintenanceRef ObjectReference | ServerMaintenanceRef is a reference to a ServerMaintenance object that maintains this server. | ||
bmcRef LocalObjectReference | BMCRef is a reference to the BMC object associated with this server. This field is optional and can be omitted if no BMC is associated with this server. | ||
bmc BMCAccess | BMC contains the access details for the BMC. This field is optional and can be omitted if no BMC access is specified. | ||
bootConfigurationRef ObjectReference | BootConfigurationRef is a reference to a BootConfiguration object that specifies the boot configuration for this server. This field is optional and can be omitted if no boot configuration is specified. | ||
maintenanceBootConfigurationRef ObjectReference | MaintenanceBootConfigurationRef is a reference to a BootConfiguration object that specifies the boot configuration for this server during maintenance. This field is optional and can be omitted | ||
bootOrder BootOrder array | BootOrder specifies the boot order of the server. | ||
biosSettingsRef LocalObjectReference | BIOSSettingsRef is a reference to a biossettings object that specifies the BIOS configuration for this server. |
ServerState
Underlying type: string
ServerState defines the possible states of a server.
Appears in:
| Field | Description |
|---|---|
Initial | ServerStateInitial indicates that the server is in its initial state. |
Discovery | ServerStateDiscovery indicates that the server is in its discovery state. |
Available | ServerStateAvailable indicates that the server is available for use. |
Reserved | ServerStateReserved indicates that the server is reserved for a specific use or user. |
Error | ServerStateError indicates that there is an error with the server. |
Maintenance | ServerStateMaintenance indicates that the server is in maintenance. |
ServerStatus
ServerStatus defines the observed state of Server.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
manufacturer string | Manufacturer is the name of the server manufacturer. | ||
biosVersion string | BIOSVersion is the version of the server's BIOS. | ||
model string | Model is the model of the server. | ||
sku string | SKU is the stock keeping unit identifier for the server. | ||
serialNumber string | SerialNumber is the serial number of the server. | ||
powerState ServerPowerState | PowerState represents the current power state of the server. | ||
indicatorLED IndicatorLED | IndicatorLED specifies the current state of the server's indicator LED. | ||
state ServerState | State represents the current state of the server. | ||
networkInterfaces NetworkInterface array | NetworkInterfaces is a list of network interfaces associated with the server. | ||
totalSystemMemory Quantity | TotalSystemMemory is the total amount of memory in bytes available on the server. | ||
processors Processor array | Processors is a list of Processors associated with the server. | ||
storages Storage array | Storages is a list of storages associated with the server. | ||
conditions Condition array | Conditions represents the latest available observations of the server's current state. |
SettingsFlowItem
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is the name of the flow item | MaxLength: 1000 MinLength: 1 | |
settings object (keys:string, values:string) | Settings contains software (eg: BIOS, BMC) settings as map | ||
priority integer | Priority defines the order of applying the settings any int greater than 0. lower number have higher Priority (ie; lower number is applied first) | Maximum: 2.147483645e+09 Minimum: 1 |
Storage
Storage defines the details of one storage device
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is the name of the storage interface. | ||
state StorageState | State specifies the state of the storage device. | ||
volumes StorageVolume array | Volumes is a collection of volumes associated with this storage. | ||
drives StorageDrive array | Drives is a collection of drives associated with this storage. |
StorageDrive
StorageDrive defines the details of one storage drive
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is the name of the storage interface. | ||
mediaType string | MediaType specifies the media type of the storage device. | ||
type string | Type specifies the type of the storage device. | ||
capacity Quantity | Capacity specifies the size of the storage device in bytes. | ||
vendor string | Vendor specifies the vendor of the storage device. | ||
model string | Model specifies the model of the storage device. | ||
state StorageState | State specifies the state of the storage device. |
StorageState
Underlying type: string
StorageState represents Storage states
Appears in:
| Field | Description |
|---|---|
Enabled | StorageStateEnabled indicates that the storage device is enabled. |
Disabled | StorageStateDisabled indicates that the storage device is disabled. |
Absent | StorageStateAbsent indicates that the storage device is absent. |
StorageVolume
StorageVolume defines the details of one storage volume
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is the name of the storage interface. | ||
capacity Quantity | Capacity specifies the size of the storage device in bytes. | ||
state StorageState | Status specifies the status of the volume. | ||
raidType string | RAIDType specifies the RAID type of the associated Volume. | ||
volumeUsage string | VolumeUsage specifies the volume usage type for the Volume. |
Task
Task contains the status of the task created by the BMC for the BIOS upgrade.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
URI string | URI is the URI of the task created by the BMC for the BIOS upgrade. | ||
state TaskState | State is the current state of the task. | ||
status Health | Status is the current status of the task. | ||
percentageComplete integer | PercentComplete is the percentage of completion of the task. |
UpdatePolicy
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Force |