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. |
CPU describes one processor on the host.
object
Property | Type | Description |
---|---|---|
|
|
|
|
|
ClockSpeed is a clock speed in MHz |
|
|
|
|
|
|
|
|
Firmware describes the firmware on the host.
object
Property | Type | Description |
---|---|---|
|
|
The BIOS for this firmware |
The BIOS for this firmware
object
Property | Type | Description |
---|---|---|
|
|
The release/build date for this BIOS |
|
|
The vendor name for this BIOS |
|
|
The version of the BIOS |
NIC describes one network interface on the host.
object
Property | Type | Description |
---|---|---|
|
|
The IP address of the interface. This will be an IPv4 or IPv6 address if one is present. If both IPv4 and IPv6 addresses are present in a dual-stack environment, two nics will be output, one with each IP. |
|
|
The device MAC address |
|
|
The vendor and product IDs of the NIC, e.g. "0x8086 0x1572" |
|
|
The name of the network interface, e.g. "en0" |
|
|
Whether the NIC is PXE Bootable |
|
|
The speed of the device in Gigabits per second |
|
|
The untagged VLAN ID |
|
|
The VLANs available |
|
|
VLAN represents the name and ID of a VLAN |
VLAN represents the name and ID of a VLAN
object
Property | Type | Description |
---|---|---|
|
|
VLANID is a 12-bit 802.1Q VLAN identifier |
|
|
Storage describes one storage device (disk, SSD, etc.) on the host.
object
Property | Type | Description |
---|---|---|
|
|
The SCSI location of the device |
|
|
Hardware model |
|
|
The Linux device name of the disk, e.g. "/dev/sda". Note that this may not be stable across reboots. |
|
|
Whether this disk represents rotational storage. This field is not recommended for usage, please prefer using 'Type' field instead, this field will be deprecated eventually. |
|
|
The serial number of the device |
|
|
The size of the disk in Bytes |
|
|
Device type, one of: HDD, SSD, NVME. |
|
|
The name of the vendor of the device |
|
|
The WWN of the device |
|
|
The WWN Vendor extension of the device |
|
|
The WWN with the extension |
HardwareSystemVendor stores details about the whole hardware system.
object
Property | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
OperationHistory holds information about operations performed on this host.
object
Property | Type | Description |
---|---|---|
|
|
OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics. |
|
|
OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics. |
|
|
OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics. |
|
|
OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics. |
OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics.
object
Property | Type | Description |
---|---|---|
|
`` |
|
|
`` |
OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics.
object
Property | Type | Description |
---|---|---|
|
`` |
|
|
`` |
OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics.
object
Property | Type | Description |
---|---|---|
|
`` |
|
|
`` |
OperationMetric contains metadata about an operation (inspection, provisioning, etc.) used for tracking metrics.
object
Property | Type | Description |
---|---|---|
|
`` |
|
|
`` |
Information tracked by the provisioner.
object
ID
state
Property | Type | Description |
---|---|---|
|
|
The machine’s UUID from the underlying provisioning tool |
|
|
BootMode indicates the boot mode used to provision the node |
|
|
Custom deploy procedure applied to the host. |
|
|
The Bios set by the user |
|
|
Image holds the details of the last image successfully provisioned to the host. |
|
|
The Raid set by the user |
|
|
The RootDevicehints set by the user |
|
|
An indiciator for what the provisioner is doing with the host. |
Custom deploy procedure applied to the host.
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. |
The Bios set by the user
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 last image successfully provisioned to the host.
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. |
The Raid set by the user
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. |
The RootDevicehints set by the user
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. |
the last credentials we sent to the provisioning backend
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 following API endpoints are available:
/apis/metal3.io/v1alpha1/baremetalhosts
GET
: list objects of kind BareMetalHost
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts
DELETE
: delete collection of BareMetalHost
GET
: list objects of kind BareMetalHost
POST
: create a BareMetalHost
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}
DELETE
: delete a BareMetalHost
GET
: read the specified BareMetalHost
PATCH
: partially update the specified BareMetalHost
PUT
: replace the specified BareMetalHost
/apis/metal3.io/v1alpha1/namespaces/{namespace}/baremetalhosts/{name}/status
GET
: read status of the specified BareMetalHost
PATCH
: partially update status of the specified BareMetalHost
PUT
: replace status of the specified BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
If 'true', then the output is pretty printed. |
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
GET
list objects of kind BareMetalHost
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete collection of BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list objects of kind BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. |
|
|
The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
|
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
|
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
|
limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
|
|
Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
|
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create a BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the BareMetalHost |
|
|
object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
DELETE
delete a BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
|
|
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
|
|
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
GET
read the specified BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the BareMetalHost |
|
|
object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
|
If 'true', then the output is pretty printed. |
GET
read status of the specified BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update status of the specified BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace status of the specified BareMetalHost
Parameter | Type | Description |
---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |