#MachineInventory [elemental.cattle.io/v1beta1]

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

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

IPAddressClaims is a map of IPAddressClaim associated to this machine. The map key is the ipAddressPool.name.

IPAddressPools is a list of IPAddressPool associated to this machine.

MachineHash the hash of the identifier used by the host to identify to the operator. This is used when the host authenticates without TPM. Both the authentication method and the identifier used to derive the hash depend upon the MachineRegistration spec.config.elemental.registration.auth value.

NetworkConfig is the final NetworkConfig.

ObservedNetwork is a live-ISO-side snapshot of the host's actual network configuration uploaded by elemental-register during initial registration (Alauda fork). It is informational only and is intentionally kept separate from Network (the target/template network). Consumers such as baremetal providers can read this to know what the host looked like before install-time network reconfiguration.

Storage is the explicit desired state for Inventory-owned data volumes. Devices omitted from this list remain unmanaged.

TPMHash the hash of the TPM EK public key. This is used if you are using TPM2 to identifiy nodes. You can obtain the TPM by running rancherd get-tpm-hash on the node. Or nodes can report their TPM hash by using the MachineRegister.

Config contains the network config template (nmc, nmstate, or nmconnections formats)

Configurator

IPAddresses contains a map of claimed IPAddresses

DNSServers observed (typically from /etc/resolv.conf).

Interfaces observed on the host.

Routes observed in the host's routing table.

SearchDomains observed.

Addresses assigned to the interface, in CIDR form (e.g. 10.0.0.5/24, fe80::1/64). Both IPv4 and IPv6 may appear.

MAC is the hardware address.

MTU in bytes.

Name is the OS-level interface name (e.g. eth0, ens3).

Destination CIDR, or the literal string "default" for the default route.

Gateway is the next-hop IP, if any.

Interface is the outgoing device name, if any.

Metric of the route.

RetryNonce is a monotonic operator-controlled retry counter. It is not part of the normalized storage content hash.

Volumes are the only block devices the platform may manage.

StorageVolumeFilesystem declares filesystem adoption/initialization intent.

StorageVolumeMount declares the business mount path and readiness policy.

Name is the stable logical identity inside this Inventory.

StorageVolumeSource selects one observer-reported logical block device.

ExpectedUUID is mandatory for Adopt and forbidden for a new blank initialization.

StorageFilesystemPolicy declares whether an existing filesystem is adopted or an entirely blank logical device may be initialized.

StorageFilesystemType is a supported ordinary single-host filesystem.

Options contains individual, admission-whitelisted mount options.

Path is a normalized absolute path accepted by provider admission.

Required defaults to true. Optional volumes are still prepared and activated; only Machine readiness is relaxed.

DeviceID must exactly reference status.observedStorage.devices[].id. Dynamic kernel paths such as /dev/sdb are not accepted.

MinimumSize is a non-destructive capacity assertion.

Multipath is valid only for a wwid: aggregate map.

MinimumActivePaths defaults to one.

Conditions describe the state of the machine inventory object.

ObservedStorage is objective host state written only by the authenticated periodic observer channel.

PlanStatus reflect the status of the plan owned by the machine inventory object.

Storage is desired-state convergence written only by the baremetal provider Inventory Storage Reconciler.

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status of the condition, one of True, False, Unknown.

type of condition in CamelCase or in foo.example.com/CamelCase.

BootID is the host's current Linux boot ID.

Devices contains facts for all discovered logical block devices.

ObservedAt is set by the operator when it accepts the report.

ReportEpoch is allocated by the operator for an observer session.

Sequence strictly increases within ReportEpoch.

Consumers contains descendant block devices layered on this logical device (for example partitions, dm-crypt, LVM or RAID). These are objective topology facts; provider policy decides whether they make the device ineligible for management.

ObservedStorageFilesystem describes an existing filesystem.

ObservedStorageMultipathHealth reports aggregate path health.

ID is the canonical management identity (wwn:, nvme-eui:, nvme-nguid:, serial:, partuuid:, or wwid:).

ObservedStorageDeviceKind identifies the logical object represented by a report record.

MemberIDs lists Multipath member-path diagnostic identities. Members are never valid desired device IDs.

ParentID links a partition to its direct parent disk.

Path is diagnostic only and must never be persisted as desired identity.

StablePaths are current udev aliases for diagnostics/resolution.

StartBytes is populated for partitions.

ObservedStorageSystemRole is an objective system-disk classification. Unknown is intentionally fail-closed in provider policy.

Transport and identity evidence are informational and support safe serial fallback classification.

Checksum checksum of the created plan.

PlanSecretRef a reference to the created plan secret.

State reflect state of the plan that belongs to the machine inventory.

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.

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

StorageOperationStatus is the durable controller journal projection for a logical operation and its current execution attempt.

StorageLifecyclePhase is the Inventory-wide managed-storage phase.

StorageFilesystemPolicy declares whether an existing filesystem is adopted or an entirely blank logical device may be initialized.

StorageFilesystemType is a supported ordinary single-host filesystem.

StorageMutationState records whether durable host state may have changed.

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status of the condition, one of True, False, Unknown.

type of condition in CamelCase or in foo.example.com/CamelCase.

StorageMutationState records whether durable host state may have changed.

ObservationBootID is the host boot ID captured before a Machine-owned lifecycle operation. Activate uses it to prove that reprovision crossed a boot before accepting a later mounted observation. It is a fact, not an ordering key.

ObservationReportEpoch and ObservationSequence capture the host report seen when the operation was claimed. The controller waits for a strictly newer accepted report before writing a host plan.

StorageOperationPhase is the controller-side state of an operation.

StorageOperationType identifies one logical convergence operation.

StorageFilesystemPolicy declares whether an existing filesystem is adopted or an entirely blank logical device may be initialized.

StorageFilesystemType is a supported ordinary single-host filesystem.

StorageMutationState records whether durable host state may have changed.