v1alpha1

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 6, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the settings.gardener.cloud API group +groupName=boot.ironcore.dev +kubebuilder:object:generate=true

Package v1alpha1 contains API Schema definitions for the boot v1alpha1 API group +kubebuilder:object:generate=true +groupName=boot.ironcore.dev

Index

Constants

View Source 
const (
	DefaultIgnitionKey   = "ignition"        // Key for accessing Ignition configuration data within a Kubernetes Secret object.
	DefaultIPXEScriptKey = "ipxe-script"     // Key for accessing iPXE script data within the iPXE-specific Secret object.
	SystemUUIDIndexKey   = "spec.systemUUID" // Field to index resources by their system UUID.
	SystemIPIndexKey     = "spec.systemIPs"  // Field to index resources by their system IP addresses.
	DefaultFormatKey     = "format"          // Key for determining the format of the data stored in a Secret, such as fcos or plain-ignition.
	IgnitionV2Format     = "ignitionv2"      // Specifies the format value corresponding to Ignition config version 2.
	IgnitionV3Format     = "ignitionv3"      // Specifies the format value corresponding to Ignition config version 3.
	FCOSFormat           = "fcos"            // Specifies the format value used for Fedora CoreOS specific configurations.
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "boot.ironcore.dev", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type HTTPBootConfig 

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

	Spec   HTTPBootConfigSpec   `json:"spec,omitempty"`
	Status HTTPBootConfigStatus `json:"status,omitempty"`
}

HTTPBootConfig is the Schema for the httpbootconfigs API

func (*HTTPBootConfig) DeepCopy 

func (in *HTTPBootConfig) DeepCopy() *HTTPBootConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPBootConfig.

func (*HTTPBootConfig) DeepCopyInto 

func (in *HTTPBootConfig) DeepCopyInto(out *HTTPBootConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*HTTPBootConfig) DeepCopyObject 

func (in *HTTPBootConfig) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type HTTPBootConfigList 

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

HTTPBootConfigList contains a list of HTTPBootConfig

func (*HTTPBootConfigList) DeepCopy 

func (in *HTTPBootConfigList) DeepCopy() *HTTPBootConfigList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPBootConfigList.

func (*HTTPBootConfigList) DeepCopyInto 

func (in *HTTPBootConfigList) DeepCopyInto(out *HTTPBootConfigList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*HTTPBootConfigList) DeepCopyObject 

func (in *HTTPBootConfigList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type HTTPBootConfigSpec 

type HTTPBootConfigSpec struct {
	// SystemUUID is the unique identifier (UUID) of the server.
	SystemUUID string `json:"systemUUID,omitempty"`

	// IgnitionSecretRef is a reference to the secret containing Ignition configuration.
	IgnitionSecretRef *corev1.LocalObjectReference `json:"ignitionSecretRef,omitempty"`

	// SystemIPs is a list of IP addresses assigned to the server.
	SystemIPs []string `json:"systemIPs,omitempty"`

	// UKIURL is the URL where the UKI (Unified Kernel Image) is hosted.
	UKIURL string `json:"ukiURL,omitempty"`
}

HTTPBootConfigSpec defines the desired state of HTTPBootConfig

func (*HTTPBootConfigSpec) DeepCopy 

func (in *HTTPBootConfigSpec) DeepCopy() *HTTPBootConfigSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPBootConfigSpec.

func (*HTTPBootConfigSpec) DeepCopyInto 

func (in *HTTPBootConfigSpec) DeepCopyInto(out *HTTPBootConfigSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HTTPBootConfigState 

type HTTPBootConfigState string
const (
	// HTTPBootConfigStateReady indicates that the HTTPBootConfig has been successfully processed, and the next step (e.g., booting the server) can proceed.
	HTTPBootConfigStateReady HTTPBootConfigState = "Ready"

	// HTTPBootConfigStatePending indicates that the HTTPBootConfig has not been processed yet.
	HTTPBootConfigStatePending HTTPBootConfigState = "Pending"

	// HTTPBootConfigStateError indicates that an error occurred while processing the HTTPBootConfig.
	HTTPBootConfigStateError HTTPBootConfigState = "Error"
)

type HTTPBootConfigStatus 

type HTTPBootConfigStatus struct {
	State HTTPBootConfigState `json:"state,omitempty"`
}

HTTPBootConfigStatus defines the observed state of HTTPBootConfig

func (*HTTPBootConfigStatus) DeepCopy 

func (in *HTTPBootConfigStatus) DeepCopy() *HTTPBootConfigStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPBootConfigStatus.

func (*HTTPBootConfigStatus) DeepCopyInto 

func (in *HTTPBootConfigStatus) DeepCopyInto(out *HTTPBootConfigStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IPXEBootConfig 

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

	Spec   IPXEBootConfigSpec   `json:"spec,omitempty"`
	Status IPXEBootConfigStatus `json:"status,omitempty"`
}

IPXEBootConfig is the Schema for the ipxebootconfigs API

func (*IPXEBootConfig) DeepCopy 

func (in *IPXEBootConfig) DeepCopy() *IPXEBootConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPXEBootConfig.

func (*IPXEBootConfig) DeepCopyInto 

func (in *IPXEBootConfig) DeepCopyInto(out *IPXEBootConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*IPXEBootConfig) DeepCopyObject 

func (in *IPXEBootConfig) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type IPXEBootConfigList 

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

IPXEBootConfigList contains a list of IPXEBootConfig

func (*IPXEBootConfigList) DeepCopy 

func (in *IPXEBootConfigList) DeepCopy() *IPXEBootConfigList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPXEBootConfigList.

func (*IPXEBootConfigList) DeepCopyInto 

func (in *IPXEBootConfigList) DeepCopyInto(out *IPXEBootConfigList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*IPXEBootConfigList) DeepCopyObject 

func (in *IPXEBootConfigList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type IPXEBootConfigSpec 

type IPXEBootConfigSpec struct {
	// SystemUUID is the unique identifier (UUID) of the server.
	SystemUUID string `json:"systemUUID,omitempty"`

	// SystemIPs is a list of IP addresses assigned to the server.
	SystemIPs []string `json:"systemIPs,omitempty"` // TODO: Implement custom serialization. Currently, validation should occur at the controller.

	// Image is deprecated and will be removed.
	Image string `json:"image,omitempty"`

	// KernelURL is the URL where the kernel of the OS is hosted, eg. the URL to the Kernel layer of the OS OCI image.
	KernelURL string `json:"kernelURL,omitempty"`

	// 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.
	InitrdURL string `json:"initrdURL,omitempty"`

	// SquashfsURL is the URL where the Squashfs of the OS is hosted, eg.  the URL to the Squashfs layer of the OS OCI image.
	SquashfsURL string `json:"squashfsURL,omitempty"`

	// IPXEServerURL is deprecated and will be removed.
	IPXEServerURL string `json:"ipxeServerURL,omitempty"`

	// IgnitionSecretRef is a reference to the secret containing the Ignition configuration.
	IgnitionSecretRef *corev1.LocalObjectReference `json:"ignitionSecretRef,omitempty"`

	// IPXEScriptSecretRef is a reference to the secret containing the custom IPXE script.
	IPXEScriptSecretRef *corev1.LocalObjectReference `json:"ipxeScriptSecretRef,omitempty"`
}

IPXEBootConfigSpec defines the desired state of IPXEBootConfig

func (*IPXEBootConfigSpec) DeepCopy 

func (in *IPXEBootConfigSpec) DeepCopy() *IPXEBootConfigSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPXEBootConfigSpec.

func (*IPXEBootConfigSpec) DeepCopyInto 

func (in *IPXEBootConfigSpec) DeepCopyInto(out *IPXEBootConfigSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IPXEBootConfigState 

type IPXEBootConfigState string
const (
	// IPXEBootConfigStateReady indicates that the IPXEBootConfig has been successfully processed, and the next step (e.g., booting the server) can proceed.
	IPXEBootConfigStateReady IPXEBootConfigState = "Ready"

	// IPXEBootConfigStatePending indicates that the IPXEBootConfig has not been processed yet.
	IPXEBootConfigStatePending IPXEBootConfigState = "Pending"

	// IPXEBootConfigStateError indicates that an error occurred while processing the IPXEBootConfig.
	IPXEBootConfigStateError IPXEBootConfigState = "Error"
)

type IPXEBootConfigStatus 

type IPXEBootConfigStatus struct {
	// Important: Run "make" to regenerate code after modifying this file
	State IPXEBootConfigState `json:"state,omitempty"`
}

IPXEBootConfigStatus defines the observed state of IPXEBootConfig

func (*IPXEBootConfigStatus) DeepCopy 

func (in *IPXEBootConfigStatus) DeepCopy() *IPXEBootConfigStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPXEBootConfigStatus.

func (*IPXEBootConfigStatus) DeepCopyInto 

func (in *IPXEBootConfigStatus) DeepCopyInto(out *IPXEBootConfigStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.