API Reference

Packages:

metal.ironcore.dev/v1alpha1

metal.ironcore.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the settings.gardener.cloud API group

Resource Types:

HTTPBootConfig
IPXEBootConfig

HTTPBootConfig

HTTPBootConfig is the Schema for the httpbootconfigs API

Field Description

apiVersion
string metal.ironcore.dev/v1alpha1

kind
string HTTPBootConfig

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
HTTPBootConfigSpec

`systemUUID` string	SystemUUID is the unique identifier (UUID) of the server.
`ignitionSecretRef` Kubernetes core/v1.LocalObjectReference	IgnitionSecretRef is a reference to the secret containing Ignition configuration.
`systemIPs` []string	SystemIPs is a list of IP addresses assigned to the server.
`ukiURL` string	UKIURL is the URL where the UKI (Unified Kernel Image) is hosted.

status
HTTPBootConfigStatus

IPXEBootConfig

IPXEBootConfig is the Schema for the ipxebootconfigs API

Field Description

apiVersion
string metal.ironcore.dev/v1alpha1

kind
string IPXEBootConfig

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
IPXEBootConfigSpec

`systemUUID` string	SystemUUID is the unique identifier (UUID) of the server.
`systemIPs` []string	SystemIPs is a list of IP addresses assigned to the server.
`image` string	Image is deprecated and will be removed.
`kernelURL` string	KernelURL is the URL where the kernel of the OS is hosted, eg. the URL to the Kernel layer of the OS OCI image.
`initrdURL` string	InitrdURL is the URL where the Initrd (initial RAM disk) of the OS is hosted, eg. the URL to the Initrd layer of the OS OCI image.
`squashfsURL` string	SquashfsURL is the URL where the Squashfs of the OS is hosted, eg. the URL to the Squashfs layer of the OS OCI image.
`ipxeServerURL` string	IPXEServerURL is deprecated and will be removed.
`ignitionSecretRef` Kubernetes core/v1.LocalObjectReference	IgnitionSecretRef is a reference to the secret containing the Ignition configuration.
`ipxeScriptSecretRef` Kubernetes core/v1.LocalObjectReference	IPXEScriptSecretRef is a reference to the secret containing the custom IPXE script.

status
IPXEBootConfigStatus

HTTPBootConfigSpec

(Appears on:HTTPBootConfig)

HTTPBootConfigSpec defines the desired state of HTTPBootConfig

Field	Description
`systemUUID` string	SystemUUID is the unique identifier (UUID) of the server.
`ignitionSecretRef` Kubernetes core/v1.LocalObjectReference	IgnitionSecretRef is a reference to the secret containing Ignition configuration.
`systemIPs` []string	SystemIPs is a list of IP addresses assigned to the server.
`ukiURL` string	UKIURL is the URL where the UKI (Unified Kernel Image) is hosted.

HTTPBootConfigState (`string` alias)

(Appears on:HTTPBootConfigStatus)

Value	Description
"Error"	HTTPBootConfigStateError indicates that an error occurred while processing the HTTPBootConfig.
"Pending"	HTTPBootConfigStatePending indicates that the HTTPBootConfig has not been processed yet.
"Ready"	HTTPBootConfigStateReady indicates that the HTTPBootConfig has been successfully processed, and the next step (e.g., booting the server) can proceed.

HTTPBootConfigStatus

(Appears on:HTTPBootConfig)

HTTPBootConfigStatus defines the observed state of HTTPBootConfig

Field	Description
`state` HTTPBootConfigState

IPXEBootConfigSpec

(Appears on:IPXEBootConfig)

IPXEBootConfigSpec defines the desired state of IPXEBootConfig

Field	Description
`systemUUID` string	SystemUUID is the unique identifier (UUID) of the server.
`systemIPs` []string	SystemIPs is a list of IP addresses assigned to the server.
`image` string	Image is deprecated and will be removed.
`kernelURL` string	KernelURL is the URL where the kernel of the OS is hosted, eg. the URL to the Kernel layer of the OS OCI image.
`initrdURL` string	InitrdURL is the URL where the Initrd (initial RAM disk) of the OS is hosted, eg. the URL to the Initrd layer of the OS OCI image.
`squashfsURL` string	SquashfsURL is the URL where the Squashfs of the OS is hosted, eg. the URL to the Squashfs layer of the OS OCI image.
`ipxeServerURL` string	IPXEServerURL is deprecated and will be removed.
`ignitionSecretRef` Kubernetes core/v1.LocalObjectReference	IgnitionSecretRef is a reference to the secret containing the Ignition configuration.
`ipxeScriptSecretRef` Kubernetes core/v1.LocalObjectReference	IPXEScriptSecretRef is a reference to the secret containing the custom IPXE script.

IPXEBootConfigState (`string` alias)

(Appears on:IPXEBootConfigStatus)

Value	Description
"Error"	IPXEBootConfigStateError indicates that an error occurred while processing the IPXEBootConfig.
"Pending"	IPXEBootConfigStatePending indicates that the IPXEBootConfig has not been processed yet.
"Ready"	IPXEBootConfigStateReady indicates that the IPXEBootConfig has been successfully processed, and the next step (e.g., booting the server) can proceed.

IPXEBootConfigStatus