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
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 BMCSecret object that contains the credentials required to access the BMC. |
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. |
Unknown | UnknownPowerState indicates that power state is unknown for this BMC. |
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 |
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 Endpoint object that contains the network access information for the BMC. Deprecated: The Endpoint resource is deprecated. Specify the network access inline via access (an InlineEndpoint carrying the MAC address and IP) instead of referencing an Endpoint object. | Optional: {} | |
access InlineEndpoint | Endpoint specifies inline network access details for the BMC. | Optional: {} | |
bmcSecretRef LocalObjectReference | BMCSecretRef is a reference to the BMCSecret object that contains the credentials required to access the BMC. | ||
protocol Protocol | Protocol specifies the protocol to be used for communicating with the BMC. | ||
consoleProtocol ConsoleProtocol | ConsoleProtocol specifies the protocol to be used for console access to the BMC. | ||
hostname string | Hostname is the hostname of the 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. | Pattern: ^([0-9A-Fa-f]\{2\}[:-])\{5\}([0-9A-Fa-f]\{2\})$ | |
ip IP | IP is the IP address of the BMC. | 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. |
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. |
ConditionRequirement
ConditionRequirement defines a specific Server condition and the status value required to trigger the controller's action.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type string | Type of server condition Following kubebuilder validation is referred from https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Condition | MaxLength: 316 MinLength: 1 | |
requiredStatus ConditionStatus | RequiredStatus is status of the condition, one of True, False, Unknown. | Enum: [True False Unknown] |
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. | Enum: [IPMI SSH SSHLenovo] | |
port integer | Port specifies the port number used for console access. |
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
Deprecated: The Endpoint resource is deprecated. Model the same information inline via BMC.spec.access (an InlineEndpoint carrying the MAC address and IP) instead of creating a separate Endpoint object.
| 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:
EnforcementMode
Underlying type: string
EnforcementMode specifies how the controller maintains the desired state.
Validation:
- Enum: [BootstrapOnly Continuous]
Appears in:
| Field | Description |
|---|---|
BootstrapOnly | EnforcementModeBootstrapOnly applies configuration only during the first reconcile. |
Continuous | EnforcementModeContinuous continuously monitors and enforces the configuration. |
IP
IP is an IP address.
Validation:
- Format: ip
- Type: string
Appears in:
ImmutableObjectReference
ImmutableObjectReference is a namespaced name reference whose name and namespace cannot be changed once set (the entire reference can still be set or cleared).
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
namespace string | Namespace is the namespace of the referenced object. | MaxLength: 63 | |
name string | Name is the name of the referenced object. | MaxLength: 253 |
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 |
|---|---|---|---|
namespace string | Namespace is the namespace of the referenced object. | ||
name string | Name is the name 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. | ||
port integer | Port specifies the port number used for communication. | ||
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. | ||
ignitionSecretRef LocalObjectReference | IgnitionSecretRef is a reference to the Secret object that contains the ignition configuration for the server. |
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. |
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. | Optional: {} | |
serverSelector LabelSelector | ServerSelector specifies a label selector to identify the server to be claimed. | Optional: {} | |
ignitionSecretRef LocalObjectReference | IgnitionSecretRef is a reference to the Secret object that contains the ignition configuration for the server. | ||
userDataRef LocalObjectReference | UserDataRef references a Secret in the same namespace as this ServerClaim containing user-data exposed to the claimed server via the metaldata service. The referenced Secret must be of type metal.ironcore.dev/user-data. | ||
image string | Image specifies the boot image to be used for the server. | ||
tolerations Toleration array | Tolerations allow a ServerClaim to bind to a Server with matching taints. |
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. |
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. |
ServerReadinessRule
ServerReadinessRule is the Schema for the serverreadinessrules API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | metal.ironcore.dev/v1alpha1 | ||
kind string | ServerReadinessRule | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec ServerReadinessRuleSpec | spec defines the desired state of ServerReadinessRule | ||
status ServerReadinessRuleStatus | status defines the observed state of ServerReadinessRule |
ServerReadinessRuleSpec
ServerReadinessRuleSpec defines the desired state of ServerReadinessRule
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions ConditionRequirement array | Conditions contains a list of the Server conditions that defines the specific criteria that must be met for taints to be managed on the target Server. The presence or status of these conditions directly triggers the application or removal of Server taints. | MaxItems: 32 MinItems: 1 | |
enforcementMode EnforcementMode | EnforcementMode specifies how the controller maintains the desired state. enforcementMode is one of BootstrapOnly, Continuous. "BootstrapOnly" applies the configuration once during initial setup. "Continuous" ensures the state is monitored and corrected throughout the resource lifecycle. | Enum: [BootstrapOnly Continuous] | |
taint Taint | Taint defines the specific Taint (Key, Value, and Effect) to be managed on Servers that meet the defined condition criteria. | ||
serverSelector LabelSelector | ServerSelector limits the scope of this rule to a specific subset of Servers. |
ServerReadinessRuleStatus
ServerReadinessRuleStatus defines the observed state of ServerReadinessRule.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | conditions represent the current state of the ServerReadinessRule resource. Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - "Available": the resource is fully functional - "Progressing": the resource is being created or updated - "Degraded": the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
ServerReclaimPolicy
Underlying type: string
Appears in:
| Field | Description |
|---|---|
Recycle | |
Retain |
ServerSpec
ServerSpec defines the desired state of a Server.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
systemUUID string | SystemUUID is the unique identifier for the server. | ||
systemURI string | SystemURI is the unique URI for the server resource in REDFISH API. | ||
indicatorLED IndicatorLED | IndicatorLED specifies the desired state of the server's indicator LED. | ||
reclaimPolicy ServerReclaimPolicy | ReclaimPolicy specifies how the server is reclaimed after use. Can be - Recycle (default), immediately transitioning the server to Available after use.- Retain, transitioning the server to Released after use, leaving spec.serverClaimRef set,transitioning to Available once spec.serverClaimRef is removed. | Recycle | Enum: [Recycle Retain] |
serverClaimRef ImmutableObjectReference | ServerClaimRef is a reference to a ServerClaim object that claims this server. | Optional: {} | |
bmcRef LocalObjectReference | BMCRef is a reference to the BMC object associated with this server. | ||
bmc BMCAccess | BMC contains the access details for the BMC. | ||
bootConfigurationRef ObjectReference | BootConfigurationRef is a reference to a BootConfiguration object that specifies the boot configuration for this server. | ||
bootOrder BootOrder array | BootOrder specifies the boot order of the server. | ||
taints Taint array | Taints control which ServerClaims can be bound to this server. | ||
unclaimable boolean | Unclaimable, when true, prevents new ServerClaims from being bound to this Server. Already-bound claims are unaffected. | false |
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. |
Released | ServerStateReleased indicates that the server is released after use. |
Error | ServerStateError indicates that there is an error with the server. |
Parked | ServerStateParked indicates that the server is parked out of the ServerClaim lifecycle so an external component can run out-of-band day-2 operations. Parked is an overlay state: while active, normal state-machine progression, boot, and power healing are suspended. |
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. |
Storage
Storage defines the details of one storage device.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is the name of the storage device. | ||
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 drive. | ||
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 volume. | ||
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. |
Taint
Taint represents a taint applied to a Server that restricts which ServerClaims can be bound to it.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
key string | Key is the taint key to be applied to a server. | MinLength: 1 | |
value string | Value is the taint value corresponding to the taint key. | ||
effect TaintEffect | Effect indicates the effect of the taint on ServerClaims that do not tolerate the taint. | NoBind | Enum: [NoBind Evict] |
TaintEffect
Underlying type: string
TaintEffect defines the effect of a taint on a ServerClaim.
Validation:
- Enum: [NoBind Evict]
Appears in:
| Field | Description |
|---|---|
NoBind | TaintEffectNoBind prevents new ServerClaims from binding to the server unless they have a matching toleration. |
Evict | TaintEffectEvict is reserved for future use. It does not currently trigger eviction of existing ServerClaims bound to the server. |
Toleration
Toleration allows a ServerClaim to tolerate taints on a Server so that the claim can be bound to a server that would otherwise be restricted.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
key string | Key is the taint key that the toleration applies to. | MinLength: 1 | |
operator TolerationOperator | Operator represents the key's relationship to the value. | Enum: [Equal Exists] | |
value string | Value is the taint value the toleration matches to. | ||
effect TaintEffect | Effect indicates the taint effect to tolerate. | Enum: [NoBind Evict] |
TolerationOperator
Underlying type: string
TolerationOperator represents a key's relationship to a value in a Toleration.
Validation:
- Enum: [Equal Exists]
Appears in:
| Field | Description |
|---|---|
Equal | TolerationOperatorEqual requires that the key and value of the toleration match those of the taint exactly. |
Exists | TolerationOperatorExists matches any taint with the specified key, regardless of value. |