BareMetalHost is the Schema for the baremetalhosts API
BareMetalHost is the Schema for the baremetalhosts API
object
Property | Type | Description |
---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
BareMetalHostSpec defines the desired state of BareMetalHost |
|
|
BareMetalHostStatus defines the observed state of BareMetalHost |
BareMetalHostSpec defines the desired state of BareMetalHost
object
online
Property | Type | Description |
---|---|---|
|
|
When set to disabled, automated cleaning will be avoided during provisioning and deprovisioning. |
|
|
How do we connect to the BMC? |
|
|
Which MAC address will PXE boot? This is optional for some types, but required for libvirt VMs driven by vbmc. |
|
|
Select the method of initializing the hardware during boot. Defaults to UEFI. |
|
|
ConsumerRef can be used to store information about something that is using a host. When it is not empty, the host is considered "in use". |
|
|
A custom deploy procedure. |
|
|
Description is a human-entered text used to help identify the host |
|
|
ExternallyProvisioned means something else is managing the image running on the host and the operator should only manage the power status and hardware inventory inspection. If the Image field is filled in, this field is ignored. |
|
|
BIOS configuration for bare metal server |
|
|
What is the name of the hardware profile for this host? It should only be necessary to set this when inspection cannot automatically determine the profile. |
|
|
Image holds the details of the image to be provisioned. |
|
|
MetaData holds the reference to the Secret containing host metadata (e.g. meta_data.json which is passed to Config Drive). |
|
|
NetworkData holds the reference to the Secret containing network configuration (e.g content of network_data.json which is passed to Config Drive). |
|
|
Should the server be online? |
|
|
RAID configuration for bare metal server |
|
|
Provide guidance about how to choose the device for the image being provisioned. |
|
|
Taints is the full, authoritative list of taints to apply to the corresponding Machine. This list will overwrite any modifications made to the Machine on an ongoing basis. |
|
|
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. |
|
|
UserData holds the reference to the Secret containing the user data to be passed to the host before it boots. |
How do we connect to the BMC?
object
address
credentialsName
Property | Type | Description |
---|---|---|
|
|
Address holds the URL for accessing the controller on the network. |
|
|
The name of the secret containing the BMC credentials (requires keys "username" and "password"). |
|
|
DisableCertificateVerification disables verification of server certificates when using HTTPS to connect to the BMC. This is required when the server certificate is self-signed, but is insecure because it allows a man-in-the-middle to intercept the connection. |
ConsumerRef can be used to store information about something that is using a host. When it is not empty, the host is considered "in use".
object
Property | Type | Description |
---|---|---|
|
|
API version of the referent. |
|
|
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. |
|
|
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
A custom deploy procedure.
object
method
Property | Type | Description |
---|---|---|
|
|
Custom deploy method name. This name is specific to the deploy ramdisk used. If you don’t have a custom deploy ramdisk, you shouldn’t use CustomDeploy. |
BIOS configuration for bare metal server
object
Property | Type | Description |
---|---|---|
|
|
Allows a single physical processor core to appear as several logical processors. This supports following options: true, false. |
|
|
SR-IOV support enables a hypervisor to create virtual instances of a PCI-express device, potentially increasing performance. This supports following options: true, false. |
|
|
Supports the virtualization of platform hardware. This supports following options: true, false. |
Image holds the details of the image to be provisioned.
object
url
Property | Type | Description |
---|---|---|
|
|
Checksum is the checksum for the image. |
|
|
ChecksumType is the checksum algorithm for the image. e.g md5, sha256, sha512 |
|
|
DiskFormat contains the format of the image (raw, qcow2, …). Needs to be set to raw for raw images streaming. Note live-iso means an iso referenced by the url will be live-booted and not deployed to disk, and in this case the checksum options are not required and if specified will be ignored. |
|
|
URL is a location of an image to deploy. |
MetaData holds the reference to the Secret containing host metadata (e.g. meta_data.json which is passed to Config Drive).
object
Property | Type | Description |
---|---|---|
|
|
Name is unique within a namespace to reference a secret resource. |
|
|
Namespace defines the space within which the secret name must be unique. |
NetworkData holds the reference to the Secret containing network configuration (e.g content of network_data.json which is passed to Config Drive).
object
Property | Type | Description |
---|---|---|
|
|
Name is unique within a namespace to reference a secret resource. |
|
|
Namespace defines the space within which the secret name must be unique. |
RAID configuration for bare metal server
object
Property | Type | Description |
---|---|---|
|
`` |
The list of logical disks for hardware RAID, if rootDeviceHints isn’t used, first volume is root volume. You can set the value of this field to |
|
`` |
The list of logical disks for software RAID, if rootDeviceHints isn’t used, first volume is root volume. If HardwareRAIDVolumes is set this item will be invalid. The number of created Software RAID devices must be 1 or 2. If there is only one Software RAID device, it has to be a RAID-1. If there are two, the first one has to be a RAID-1, while the RAID level for the second one can be 0, 1, or 1+0. As the first RAID device will be the deployment device, enforcing a RAID-1 reduces the risk of ending up with a non-booting node in case of a disk failure. Software RAID will always be deleted. |
Provide guidance about how to choose the device for the image being provisioned.
object
Property | Type | Description |
---|---|---|
|
|
A Linux device name like "/dev/vda". The hint must match the actual value exactly. |
|
|
A SCSI bus address like 0:0:0:0. The hint must match the actual value exactly. |
|
|
The minimum size of the device in Gigabytes. |
|
|
A vendor-specific device identifier. The hint can be a substring of the actual value. |
|
|
True if the device should use spinning media, false otherwise. |
|
|
Device serial number. The hint must match the actual value exactly. |
|
|
The name of the vendor or manufacturer of the device. The hint can be a substring of the actual value. |
|
|
Unique storage identifier. The hint must match the actual value exactly. |
|
|
Unique vendor storage identifier. The hint must match the actual value exactly. |
|
|
Unique storage identifier with the vendor extension appended. The hint must match the actual value exactly. |
Taints is the full, authoritative list of taints to apply to the corresponding Machine. This list will overwrite any modifications made to the Machine on an ongoing basis.
array
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
object
effect
key
Property | Type | Description |
---|---|---|
|
|
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. |
|
|
Required. The taint key to be applied to a node. |
|
|
TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. |
|
|
The taint value corresponding to the taint key. |
UserData holds the reference to the Secret containing the user data to be passed to the host before it boots.
object
Property | Type | Description |
---|---|---|
|
|
Name is unique within a namespace to reference a secret resource. |
|
|
Namespace defines the space within which the secret name must be unique. |
BareMetalHostStatus defines the observed state of BareMetalHost
object
errorCount
errorMessage
hardwareProfile
operationalStatus
poweredOn
provisioning
Property | Type | Description |
---|---|---|
|
|
ErrorCount records how many times the host has encoutered an error since the last successful operation |
|
|
the last error message reported by the provisioning subsystem |
|
|
ErrorType indicates the type of failure encountered when the OperationalStatus is OperationalStatusError |
|
|
the last credentials we were able to validate as working |
|
|
The hardware discovered to exist on the host. |
|
|
The name of the profile matching the hardware details. |
|
|
LastUpdated identifies when this status was last observed. |
|
|
OperationHistory holds information about operations performed on this host. |
|
|
OperationalStatus holds the status of the host |
|
|
indicator for whether or not the host is powered on |
|
|
Information tracked by the provisioner. |
|
|
the last credentials we sent to the provisioning backend |
the last credentials we were able to validate as working
object
Property | Type | Description |
---|---|---|
|
|
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace |
|
|
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
object
Property | Type | Description |
---|---|---|
|
|
Name is unique within a namespace to reference a secret resource. |
|
|
Namespace defines the space within which the secret name must be unique. |
The hardware discovered to exist on the host.
object
Property | Type | Description |
---|---|---|
|
|
CPU describes one processor on the host. |
|
|
Firmware describes the firmware on the host. |
|
|
|
|
|
|
|
|
NIC describes one network interface on the host. |
|
|
|
|
|
|
|
|
Storage describes one storage device (disk, SSD, etc.) on the host. |
|
|
HardwareSystemVendor stores details about the whole hardware system. |