Skip to main content
Version: v5.0 Stable

Machine

A machine mirrors one physical machine in a bare metal provider's inventory, such as Metal3, NICo, or NetBox through Metal3. The platform inventory sync creates, updates, and deletes machines.

Through this API you can read machines and edit their labels and annotations, for example to assign a machine to a tenant. Creating and deleting machines is refused, and spec, status, and platform-owned labels can't be changed.

Machine example​

An example Machine:

apiVersion: management.loft.sh/v1
kind: Machine
metadata:
name: metal3.worker-01
spec:
displayName: worker-01
providerRef: metal3
status:
lastSyncTime: null
phase: Available
powerState: "Off"

Machine reference​

kind string ​

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

apiVersion string ​

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

metadata object ​

name string ​

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

generateName string ​

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

namespace string ​

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

uid string ​

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

resourceVersion string ​

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

generation integer ​

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

creationTimestamp object ​

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionTimestamp object ​

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

deletionGracePeriodSeconds integer ​

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

labels object ​

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

annotations object ​

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

ownerReferences object[] ​

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

apiVersion required string ​

API version of the referent.

kind required string ​

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name required string ​

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

uid required string ​

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

controller boolean ​

If true, this reference points to the managing controller.

blockOwnerDeletion boolean ​

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

finalizers string[] ​

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

managedFields object[] ​

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

manager string ​

Manager is an identifier of the workflow managing these fields.

operation string ​

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

apiVersion string ​

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

time object ​

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

fieldsType string ​

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

fieldsV1 object ​

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

subresource string ​

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

spec object ​

displayName string ​

DisplayName is shown in the UI; providers fill it from their native naming (metal3: the BareMetalHost name, NICo: the machine hostname).

providerRef string ​

ProviderRef is the NodeProvider whose inventory this machine mirrors.

status object ​

phase string ​

Phase is the machine's state at the provider, normalized across providers. It says nothing about platform NodeClaims: the node-claim annotation answers which claim, if any, holds the machine.

reason string ​

Reason is the provider's own name for the state behind the phase, kept verbatim: a metal3 provisioning state or errorType, a NICo machine status or health alert id.

message string ​

Message is what the provider says about it, when it says anything: a metal3 errorMessage, a NICo alert or maintenance message.

conditions object ​

Conditions holds the sync conditions of the machine.

hardware object ​

Hardware is the machine's discovered hardware inventory.

cpu object ​

CPU aggregates all CPU capabilities of the machine (sockets, cores and threads summed across every CPU entry in Capabilities).

architecture string ​

Architecture is the CPU architecture (e.g. x86_64, aarch64).

sockets integer ​

Sockets is the number of CPU packages.

cores integer ​

Cores is the number of physical cores.

threads integer ​

Threads is the number of logical CPUs.

memory object ​

Memory aggregates all Memory capabilities of the machine (capacity summed across every Memory entry in Capabilities).

Format required string ​

storage object ​

Storage aggregates all Storage capabilities of the machine (capacity summed across every Storage entry in Capabilities).

Format required string ​

capabilities object[] ​

Capabilities lists the machine's discovered devices, one entry per device model.

type required string ​

Type is the device kind.

name string ​

Name is the device model name.

vendor string ​

Vendor is the device vendor.

count integer ​

Count is how many devices of this model the machine has.

resources object ​

Resources holds the device resources this capability provides, per device kind (CPU topology for CPU entries, capacity for the rest).

capacity object ​

Capacity is the per-device capacity when the provider reports one (Memory size, GPU memory, disk size).

Format required string ​
architecture string ​

Architecture is the CPU architecture (e.g. x86_64, aarch64).

sockets integer ​

Sockets is the number of CPU packages.

cores integer ​

Cores is the number of physical cores.

threads integer ​

Threads is the number of logical CPUs.

vendor string ​

Vendor is the machine's hardware vendor when the provider reports it.

product string ​

Product is the machine's product name when the provider reports it.

serial string ​

Serial is the machine's serial number when the provider reports it.

system object ​

System is the machine's observed runtime state (assigned addressing and similar), as opposed to the physical inventory in Hardware.

network object ​

Network is the machine's network runtime state.

interfaces object[] ​

Interfaces lists the machine's network interfaces and their current addressing.

name string ​

Name is the interface name when the provider reports it (e.g. enp1s0).

mac string ​

MAC is the interface's hardware address.

primary boolean ​

Primary marks the interface the machine's traffic goes through (NICo: the primary interface; metal3: the PXE/provisioning interface).

ips string[] ​

IPs are the addresses currently assigned to the interface; empty for a machine waiting unprovisioned in the pool.

powerState string ​

PowerState is the machine's normalized power state: On, Off, or Unknown when the provider reports a state that maps to neither (e.g. an error). Empty when the provider does not report power at all.

lastSyncTime object ​

LastSyncTime is when this state was last confirmed against the provider.

Retrieve: Machines​

You can either use curl or kubectl to retrieve Machines.

Retrieve a list of Machines​

Run the following command to list all Machines:

kubectl get machines.management.loft.sh -o yaml

Retrieve a single Machine by name​

Run the following kubectl command to get Machine metal3.worker-01:

kubectl get machines.management.loft.sh metal3.worker-01 -o yaml

Update: Machine​

You can either use curl or kubectl to update Machines.

Update Machine​

Run the following command to update Machine metal3.worker-01:

kubectl edit machines.management.loft.sh metal3.worker-01

Then edit the object and upon save, kubectl will update the resource.

Patch Machine​

Patching a resource is useful if you want to generically exchange only a small portion of the object instead of retrieving the whole object first and then modifying it. To learn more about patches in Kubernetes, please take a look at the official docs.

Run the following kubectl command to add a new annotation my-annotation: my-value to the Machine metal3.worker-01 via a patch:

kubectl patch machines.management.loft.sh metal3.worker-01 \
--type json \
-p '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'