Packages:

• compute.ironcore.dev/v1alpha1

compute.ironcore.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

• Machine
• MachineClass
• MachinePool

Machine

Machine is the Schema for the machines API

Field	Description
apiVersion string	compute.ironcore.dev/v1alpha1
kind string	Machine
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec MachineSpec	machineClassRef Kubernetes core/v1.LocalObjectReference MachineClassRef is a reference to the machine class/flavor of the machine. machinePoolSelector map[string]string MachinePoolSelector selects a suitable MachinePoolRef by the given labels. machinePoolRef Kubernetes core/v1.LocalObjectReference MachinePoolRef defines machine pool to run the machine in. If empty, a scheduler will figure out an appropriate pool to run the machine in. power Power Power is the desired machine power state. Defaults to PowerOn. image string (Optional) Deprecated: Use LocalDisk to provide a bootable disk Image is the optional URL providing the operating system image of the machine. imagePullSecret Kubernetes core/v1.LocalObjectReference ImagePullSecretRef is an optional secret for pulling the image of a machine. networkInterfaces []NetworkInterface (Optional) NetworkInterfaces define a list of network interfaces present on the machine volumes []Volume (Optional) Volumes are volumes attached to this machine. ignitionRef github.com/ironcore-dev/ironcore/api/common/v1alpha1.SecretKeySelector IgnitionRef is a reference to a secret containing the ignition YAML for the machine to boot up. If key is empty, DefaultIgnitionKey will be used as fallback. efiVars []EFIVar (Optional) EFIVars are variables to pass to EFI while booting up. tolerations []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration Tolerations define tolerations the Machine has. Only MachinePools whose taints covered by Tolerations will be considered to run the Machine.
status MachineStatus

MachineClass

MachineClass is the Schema for the machineclasses API

Field	Description
apiVersion string	compute.ironcore.dev/v1alpha1
kind string	MachineClass
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
capabilities github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList

MachinePool

MachinePool is the Schema for the machinepools API

Field	Description
apiVersion string	compute.ironcore.dev/v1alpha1
kind string	MachinePool
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec MachinePoolSpec	providerID string ProviderID identifies the MachinePool on provider side. taints []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint Taints of the MachinePool. Only Machines who tolerate all the taints will land in the MachinePool.
status MachinePoolStatus

DaemonEndpoint

(Appears on:MachinePoolDaemonEndpoints)

DaemonEndpoint contains information about a single Daemon endpoint.

Field	Description
port int32	Port number of the given endpoint.

EFIVar

(Appears on:MachineSpec)

EFIVar is a variable to pass to EFI while booting up.

Field	Description
name string	Name is the name of the EFIVar.
uuid string	UUID is the uuid of the EFIVar.
value string	Value is the value of the EFIVar.

EmptyDiskVolumeSource

(Appears on:VolumeSource)

EmptyDiskVolumeSource is a volume that’s offered by the machine pool provider. Usually ephemeral (i.e. deleted when the surrounding entity is deleted), with varying performance characteristics. Potentially not recoverable.

Field	Description
sizeLimit k8s.io/apimachinery/pkg/api/resource.Quantity	SizeLimit is the total amount of local storage required for this EmptyDisk volume. The default is nil which means that the limit is undefined.

EphemeralNetworkInterfaceSource

(Appears on:NetworkInterfaceSource)

EphemeralNetworkInterfaceSource is a definition for an ephemeral (i.e. coupled to the lifetime of the surrounding object) networking.NetworkInterface.

Field	Description
networkInterfaceTemplate github.com/ironcore-dev/ironcore/api/networking/v1alpha1.NetworkInterfaceTemplateSpec	NetworkInterfaceTemplate is the template definition of the networking.NetworkInterface.

EphemeralVolumeSource

(Appears on:VolumeSource)

EphemeralVolumeSource is a definition for an ephemeral (i.e. coupled to the lifetime of the surrounding object) storage.Volume.

Field	Description
volumeTemplate github.com/ironcore-dev/ironcore/api/storage/v1alpha1.VolumeTemplateSpec	VolumeTemplate is the template definition of the storage.Volume.

LocalDiskVolumeSource

(Appears on:VolumeSource)

LocalDiskVolumeSource is a volume that’s offered by the machine pool provider. Usually ephemeral (i.e. deleted when the surrounding entity is deleted), with varying performance characteristics. Potentially not recoverable.

Field	Description
sizeLimit k8s.io/apimachinery/pkg/api/resource.Quantity	SizeLimit is the total amount of local storage required for this LocalDisk volume. The default is nil which means that the limit is undefined.
image string	(Optional) Image is the optional URL providing the operating system image of the machine.

MachineExecOptions

MachineExecOptions is the query options to a Machine’s remote exec call

Field	Description
insecureSkipTLSVerifyBackend bool

MachinePoolAddress

(Appears on:MachinePoolStatus)

Field	Description
type MachinePoolAddressType
address string

MachinePoolAddressType (string alias)

(Appears on:MachinePoolAddress)

Value	Description
"ExternalDNS"	MachinePoolExternalDNS identifies a DNS name which resolves to an IP address which has the characteristics of MachinePoolExternalIP. The IP it resolves to may or may not be a listed MachineExternalIP address.
"ExternalIP"	MachinePoolExternalIP identifies an IP address which is, in some way, intended to be more usable from outside the cluster than an internal IP, though no specific semantics are defined.
"Hostname"	MachinePoolHostName identifies a name of the machine pool. Although every machine pool can be assumed to have a MachinePoolAddress of this type, its exact syntax and semantics are not defined, and are not consistent between different clusters.
"InternalDNS"	MachinePoolInternalDNS identifies a DNS name which resolves to an IP address which has the characteristics of a MachinePoolInternalIP. The IP it resolves to may or may not be a listed MachinePoolInternalIP address.
"InternalIP"	MachinePoolInternalIP identifies an IP address which may not be visible to hosts outside the cluster. By default, it is assumed that ironcore-apiserver can reach machine pool internal IPs, though it is possible to configure clusters where this is not the case. MachinePoolInternalIP is the default type of machine pool IP, and does not necessarily imply that the IP is ONLY reachable internally. If a machine pool has multiple internal IPs, no specific semantics are assigned to the additional IPs.

MachinePoolCondition

(Appears on:MachinePoolStatus)

MachinePoolCondition is one of the conditions of a volume.

Field	Description
type MachinePoolConditionType	Type is the type of the condition.
status Kubernetes core/v1.ConditionStatus	Status is the status of the condition.
reason string	Reason is a machine-readable indication of why the condition is in a certain state.
message string	Message is a human-readable explanation of why the condition has a certain reason / state.
observedGeneration int64	ObservedGeneration represents the .metadata.generation that the condition was set based upon.
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime is the last time the status of a condition has transitioned from one state to another.

MachinePoolConditionType (string alias)

(Appears on:MachinePoolCondition)

MachinePoolConditionType is a type a MachinePoolCondition can have.

MachinePoolDaemonEndpoints

(Appears on:MachinePoolStatus)

MachinePoolDaemonEndpoints lists ports opened by daemons running on the MachinePool.

Field	Description
machinepoolletEndpoint DaemonEndpoint	(Optional) Endpoint on which machinepoollet is listening.

MachinePoolSpec

(Appears on:MachinePool)

MachinePoolSpec defines the desired state of MachinePool

Field	Description
providerID string	ProviderID identifies the MachinePool on provider side.
taints []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Taint	Taints of the MachinePool. Only Machines who tolerate all the taints will land in the MachinePool.

MachinePoolState (string alias)

(Appears on:MachinePoolStatus)

MachinePoolState is a state a MachinePool can be in.

Value	Description
"Error"	MachinePoolStateError marks a MachinePool in an error state.
"Offline"	MachinePoolStateOffline marks a MachinePool as offline.
"Pending"	MachinePoolStatePending marks a MachinePool as pending readiness.
"Ready"	MachinePoolStateReady marks a MachinePool as ready for accepting a Machine.

MachinePoolStatus

(Appears on:MachinePool)

MachinePoolStatus defines the observed state of MachinePool

Field	Description
state MachinePoolState
conditions []MachinePoolCondition
availableMachineClasses []Kubernetes core/v1.LocalObjectReference
addresses []MachinePoolAddress
daemonEndpoints MachinePoolDaemonEndpoints
capacity github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList	Capacity represents the total resources of a machine pool.
allocatable github.com/ironcore-dev/ironcore/api/core/v1alpha1.ResourceList	Allocatable represents the resources of a machine pool that are available for scheduling.

MachineSpec

(Appears on:Machine)

MachineSpec defines the desired state of Machine

Field	Description
machineClassRef Kubernetes core/v1.LocalObjectReference	MachineClassRef is a reference to the machine class/flavor of the machine.
machinePoolSelector map[string]string	MachinePoolSelector selects a suitable MachinePoolRef by the given labels.
machinePoolRef Kubernetes core/v1.LocalObjectReference	MachinePoolRef defines machine pool to run the machine in. If empty, a scheduler will figure out an appropriate pool to run the machine in.
power Power	Power is the desired machine power state. Defaults to PowerOn.
image string	(Optional) Deprecated: Use LocalDisk to provide a bootable disk Image is the optional URL providing the operating system image of the machine.
imagePullSecret Kubernetes core/v1.LocalObjectReference	ImagePullSecretRef is an optional secret for pulling the image of a machine.
networkInterfaces []NetworkInterface	(Optional) NetworkInterfaces define a list of network interfaces present on the machine
volumes []Volume	(Optional) Volumes are volumes attached to this machine.
ignitionRef github.com/ironcore-dev/ironcore/api/common/v1alpha1.SecretKeySelector	IgnitionRef is a reference to a secret containing the ignition YAML for the machine to boot up. If key is empty, DefaultIgnitionKey will be used as fallback.
efiVars []EFIVar	(Optional) EFIVars are variables to pass to EFI while booting up.
tolerations []github.com/ironcore-dev/ironcore/api/common/v1alpha1.Toleration	Tolerations define tolerations the Machine has. Only MachinePools whose taints covered by Tolerations will be considered to run the Machine.

MachineState (string alias)

(Appears on:MachineStatus)

MachineState is the state of a machine.

Value	Description
"Pending"	MachineStatePending means the Machine has been accepted by the system, but not yet completely started. This includes time before being bound to a MachinePool, as well as time spent setting up the Machine on that MachinePool.
"Running"	MachineStateRunning means the machine is running on a MachinePool.
"Shutdown"	MachineStateShutdown means the machine is shut down.
"Terminated"	MachineStateTerminated means the machine has been permanently stopped and cannot be started.
"Terminating"	MachineStateTerminating means the machine that is terminating.

MachineStatus

(Appears on:Machine)

MachineStatus defines the observed state of Machine

Field	Description
machineID string	MachineID is the provider specific machine ID in the format ‘TYPE://MACHINE_ID’.
observedGeneration int64	ObservedGeneration is the last generation the MachinePool observed of the Machine.
state MachineState	State is the infrastructure state of the machine.
networkInterfaces []NetworkInterfaceStatus	NetworkInterfaces is the list of network interface states for the machine.
volumes []VolumeStatus	Volumes is the list of volume states for the machine.

NetworkInterface

(Appears on:MachineSpec)

NetworkInterface is the definition of a single interface

Field	Description
name string	Name is the name of the network interface.
NetworkInterfaceSource NetworkInterfaceSource	(Members of NetworkInterfaceSource are embedded into this type.) NetworkInterfaceSource is where to obtain the interface from.

NetworkInterfaceSource

(Appears on:NetworkInterface)

Field	Description
networkInterfaceRef Kubernetes core/v1.LocalObjectReference	NetworkInterfaceRef instructs to use the NetworkInterface at the target reference.
ephemeral EphemeralNetworkInterfaceSource	Ephemeral instructs to create an ephemeral (i.e. coupled to the lifetime of the surrounding object) NetworkInterface to use.

NetworkInterfaceState (string alias)

(Appears on:NetworkInterfaceStatus)

NetworkInterfaceState is the infrastructure attachment state a NetworkInterface can be in.

Value	Description
"Attached"	NetworkInterfaceStateAttached indicates that a network interface has been successfully attached.
"Pending"	NetworkInterfaceStatePending indicates that the attachment of a network interface is pending.

NetworkInterfaceStatus

(Appears on:MachineStatus)

NetworkInterfaceStatus reports the status of a NetworkInterfaceSource.

Field	Description
name string	Name is the name of the NetworkInterface to whom the status belongs to.
handle string	Handle is the MachinePool internal handle of the NetworkInterface.
state NetworkInterfaceState	State represents the attachment state of a NetworkInterface.
networkInterfaceRef Kubernetes core/v1.LocalObjectReference	networkInterfaceRef is the reference to the networkinterface attached to the machine
lastStateTransitionTime Kubernetes meta/v1.Time	LastStateTransitionTime is the last time the State transitioned.

Power (string alias)

(Appears on:MachineSpec)

Power is the desired power state of a Machine.

Value	Description
"Off"	PowerOff indicates that a Machine should be powered off.
"On"	PowerOn indicates that a Machine should be powered on.

Volume

(Appears on:MachineSpec)

Volume defines a volume attachment of a machine

Field	Description
name string	Name is the name of the Volume
device string	Device is the device name where the volume should be attached. Pointer to distinguish between explicit zero and not specified. If empty, an unused device name will be determined if possible.
VolumeSource VolumeSource	(Members of VolumeSource are embedded into this type.) VolumeSource is the source where the storage for the Volume resides at.

VolumeSource

(Appears on:Volume)

VolumeSource specifies the source to use for a Volume.

Field	Description
volumeRef Kubernetes core/v1.LocalObjectReference	VolumeRef instructs to use the specified Volume as source for the attachment.
emptyDisk EmptyDiskVolumeSource	Deprecated: Use LocalDisk instead EmptyDisk instructs to use a Volume offered by the machine pool provider.
localDisk LocalDiskVolumeSource	LocalDisk instructs to use a Volume offered by the machine pool provider.
ephemeral EphemeralVolumeSource	Ephemeral instructs to create an ephemeral (i.e. coupled to the lifetime of the surrounding object) Volume to use.

VolumeState (string alias)

(Appears on:VolumeStatus)

VolumeState is the infrastructure attachment state a Volume can be in.

Value	Description
"Attached"	VolumeStateAttached indicates that a volume has been successfully attached.
"Pending"	VolumeStatePending indicates that the attachment of a volume is pending.

VolumeStatus

(Appears on:MachineStatus)

VolumeStatus is the status of a Volume.

Field	Description
name string	Name is the name of a volume attachment.
handle string	Handle is the MachinePool internal handle of the volume.
state VolumeState	State represents the attachment state of a Volume.
lastStateTransitionTime Kubernetes meta/v1.Time	LastStateTransitionTime is the last time the State transitioned.
volumeRef Kubernetes core/v1.LocalObjectReference	VolumeRef reference to the claimed Volume

---

Generated with gen-crd-api-reference-docs