API Reference¶

Packages¶

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

Package v1alpha1 contains API Schema definitions for the boot v1alpha1 API group

HTTPBootConfig is the Schema for the httpbootconfigs API

Field	Description	Default	Validation
`apiVersion` string	`boot.ironcore.dev/v1alpha1`
`kind` string	`HTTPBootConfig`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` HTTPBootConfigSpec
`status` HTTPBootConfigStatus

HTTPBootConfigSpec defines the desired state of HTTPBootConfig

Appears in: - HTTPBootConfig

Field	Description	Default	Validation
`systemUUID` string	SystemUUID is the unique identifier (UUID) of the server.
`ignitionSecretRef` LocalObjectReference	IgnitionSecretRef is a reference to the secret containing Ignition configuration.
`networkIdentifiers` string array	NetworkIdentifiers is a list of IP addresses and MAC Addresses assigned to the server.
`ukiURL` string	UKIURL is the URL where the UKI (Unified Kernel Image) is hosted.

Underlying type: string

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

HTTPBootConfigStatus defines the observed state of HTTPBootConfig

Appears in: - HTTPBootConfig

Field	Description	Default	Validation
`state` HTTPBootConfigState
`conditions` Condition array	Conditions represent the latest available observations of the IPXEBootConfig's state

IPXEBootConfig is the Schema for the ipxebootconfigs API

Field	Description	Default	Validation
`apiVersion` string	`boot.ironcore.dev/v1alpha1`
`kind` string	`IPXEBootConfig`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` IPXEBootConfigSpec
`status` IPXEBootConfigStatus

IPXEBootConfigSpec defines the desired state of IPXEBootConfig

Appears in: - IPXEBootConfig

Field	Description	Default	Validation
`systemUUID` string	SystemUUID is the unique identifier (UUID) of the server.
`systemIPs` string array	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` LocalObjectReference	IgnitionSecretRef is a reference to the secret containing the Ignition configuration.
`ipxeScriptSecretRef` LocalObjectReference	IPXEScriptSecretRef is a reference to the secret containing the custom IPXE script.

Underlying type: string

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

IPXEBootConfigStatus defines the observed state of IPXEBootConfig

Appears in: - IPXEBootConfig

Field	Description	Default	Validation
`state` IPXEBootConfigState	Important: Run "make" to regenerate code after modifying this file
`conditions` Condition array	Conditions represent the latest available observations of the IPXEBootConfig's state