{ "description": "Machine is the Schema for the machines API.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "spec is the desired state of Machine.", "properties": { "bootstrap": { "description": "bootstrap is a reference to a local struct which encapsulates\nfields to configure the Machine\u2019s bootstrapping mechanism.", "properties": { "configRef": { "description": "configRef is a reference to a bootstrap provider-specific resource\nthat holds configuration details. The reference is optional to\nallow users/operators to specify Bootstrap.DataSecretName without\nthe need of a controller.", "properties": { "apiGroup": { "description": "apiGroup is the group of the resource being referenced.\napiGroup must be fully qualified domain name.\nThe corresponding version for this reference will be looked up from the contract\nlabels of the corresponding CRD of the resource being referenced.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "kind": { "description": "kind of the resource being referenced.\nkind must consist of alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": "string" }, "name": { "description": "name of the resource being referenced.\nname must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "required": [ "apiGroup", "kind", "name" ], "type": "object", "additionalProperties": false }, "dataSecretName": { "description": "dataSecretName is the name of the secret that stores the bootstrap data script.\nIf nil, the Machine should remain in the Pending state.", "maxLength": 253, "minLength": 0, "type": "string" } }, "type": "object", "additionalProperties": false }, "clusterName": { "description": "clusterName is the name of the Cluster this object belongs to.", "maxLength": 63, "minLength": 1, "type": "string" }, "deletion": { "description": "deletion contains configuration options for Machine deletion.", "minProperties": 1, "properties": { "nodeDeletionTimeoutSeconds": { "description": "nodeDeletionTimeoutSeconds defines how long the controller will attempt to delete the Node that the Machine\nhosts after the Machine is marked for deletion. A duration of 0 will retry deletion indefinitely.\nDefaults to 10 seconds.", "format": "int32", "minimum": 0, "type": "integer" }, "nodeDrainTimeoutSeconds": { "description": "nodeDrainTimeoutSeconds is the total amount of time that the controller will spend on draining a node.\nThe default value is 0, meaning that the node can be drained without any time limitations.\nNOTE: nodeDrainTimeoutSeconds is different from `kubectl drain --timeout`", "format": "int32", "minimum": 0, "type": "integer" }, "nodeVolumeDetachTimeoutSeconds": { "description": "nodeVolumeDetachTimeoutSeconds is the total amount of time that the controller will spend on waiting for all volumes\nto be detached. The default value is 0, meaning that the volumes can be detached without any time limitations.", "format": "int32", "minimum": 0, "type": "integer" } }, "type": "object", "additionalProperties": false }, "failureDomain": { "description": "failureDomain is the failure domain the machine will be created in.\nMust match the name of a FailureDomain from the Cluster status.", "maxLength": 256, "minLength": 1, "type": "string" }, "infrastructureRef": { "description": "infrastructureRef is a required reference to a custom resource\noffered by an infrastructure provider.", "properties": { "apiGroup": { "description": "apiGroup is the group of the resource being referenced.\napiGroup must be fully qualified domain name.\nThe corresponding version for this reference will be looked up from the contract\nlabels of the corresponding CRD of the resource being referenced.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "kind": { "description": "kind of the resource being referenced.\nkind must consist of alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", "type": "string" }, "name": { "description": "name of the resource being referenced.\nname must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "required": [ "apiGroup", "kind", "name" ], "type": "object", "additionalProperties": false }, "minReadySeconds": { "description": "minReadySeconds is the minimum number of seconds for which a Machine should be ready before considering it available.\nDefaults to 0 (Machine will be considered available as soon as the Machine is ready)", "format": "int32", "minimum": 0, "type": "integer" }, "providerID": { "description": "providerID is the identification ID of the machine provided by the provider.\nThis field must match the provider ID as seen on the node object corresponding to this machine.\nThis field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler\nwith cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out\nmachines at provider which could not get registered as Kubernetes nodes. With cluster-api as a\ngeneric out-of-tree provider for autoscaler, this field is required by autoscaler to be\nable to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver\nand then a comparison is done to find out unregistered machines and are marked for delete.\nThis field will be set by the actuators and consumed by higher level entities like autoscaler that will\nbe interfacing with cluster-api as generic provider.", "maxLength": 512, "minLength": 1, "type": "string" }, "readinessGates": { "description": "readinessGates specifies additional conditions to include when evaluating Machine Ready condition.\n\nThis field can be used e.g. by Cluster API control plane providers to extend the semantic of the\nReady condition for the Machine they control, like the kubeadm control provider adding ReadinessGates\nfor the APIServerPodHealthy, SchedulerPodHealthy conditions, etc.\n\nAnother example are external controllers, e.g. responsible to install special software/hardware on the Machines;\nthey can include the status of those components with a new condition and add this condition to ReadinessGates.\n\nNOTE: In case readinessGates conditions start with the APIServer, ControllerManager, Scheduler prefix, and all those\nreadiness gates condition are reporting the same message, when computing the Machine's Ready condition those\nreadinessGates will be replaced by a single entry reporting \"Control plane components: \" + message.\nThis helps to improve readability of conditions bubbling up to the Machine's owner resource / to the Cluster).", "items": { "description": "MachineReadinessGate contains the type of a Machine condition to be used as a readiness gate.", "properties": { "conditionType": { "description": "conditionType refers to a condition with matching type in the Machine's condition list.\nIf the conditions doesn't exist, it will be treated as unknown.\nNote: Both Cluster API conditions or conditions added by 3rd party controllers can be used as readiness gates.", "maxLength": 316, "minLength": 1, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" }, "polarity": { "description": "polarity of the conditionType specified in this readinessGate.\nValid values are Positive, Negative and omitted.\nWhen omitted, the default behaviour will be Positive.\nA positive polarity means that the condition should report a true status under normal conditions.\nA negative polarity means that the condition should report a false status under normal conditions.", "enum": [ "Positive", "Negative" ], "type": "string" } }, "required": [ "conditionType" ], "type": "object", "additionalProperties": false }, "maxItems": 32, "minItems": 1, "type": "array", "x-kubernetes-list-map-keys": [ "conditionType" ], "x-kubernetes-list-type": "map" }, "version": { "description": "version defines the desired Kubernetes version.\nThis field is meant to be optionally used by bootstrap providers.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "bootstrap", "clusterName", "infrastructureRef" ], "type": "object", "additionalProperties": false }, "status": { "description": "status is the observed state of Machine.", "minProperties": 1, "properties": { "addresses": { "description": "addresses is a list of addresses assigned to the machine.\nThis field is copied from the infrastructure provider reference.", "items": { "description": "MachineAddress contains information for the node's address.", "properties": { "address": { "description": "address is the machine address.", "maxLength": 256, "minLength": 1, "type": "string" }, "type": { "description": "type is the machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.", "enum": [ "Hostname", "ExternalIP", "InternalIP", "ExternalDNS", "InternalDNS" ], "type": "string" } }, "required": [ "address", "type" ], "type": "object", "additionalProperties": false }, "maxItems": 32, "type": "array", "x-kubernetes-list-type": "atomic" }, "certificatesExpiryDate": { "description": "certificatesExpiryDate is the expiry date of the machine certificates.\nThis value is only set for control plane machines.", "format": "date-time", "type": "string" }, "conditions": { "description": "conditions represents the observations of a Machine's current state.\nKnown condition types are Available, Ready, UpToDate, BootstrapConfigReady, InfrastructureReady, NodeReady,\nNodeHealthy, Deleting, Paused.\nIf a MachineHealthCheck is targeting this machine, also HealthCheckSucceeded, OwnerRemediated conditions are added.\nAdditionally control plane Machines controlled by KubeadmControlPlane will have following additional conditions:\nAPIServerPodHealthy, ControllerManagerPodHealthy, SchedulerPodHealthy, EtcdPodHealthy, EtcdMemberHealthy.", "items": { "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", "maxLength": 32768, "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "minimum": 0, "type": "integer" }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "enum": [ "True", "False", "Unknown" ], "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "maxLength": 316, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "maxItems": 32, "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "deletion": { "description": "deletion contains information relating to removal of the Machine.\nOnly present when the Machine has a deletionTimestamp and drain or wait for volume detach started.", "properties": { "nodeDrainStartTime": { "description": "nodeDrainStartTime is the time when the drain of the node started and is used to determine\nif the nodeDrainTimeoutSeconds is exceeded.\nOnly present when the Machine has a deletionTimestamp and draining the node had been started.", "format": "date-time", "type": "string" }, "waitForNodeVolumeDetachStartTime": { "description": "waitForNodeVolumeDetachStartTime is the time when waiting for volume detachment started\nand is used to determine if the nodeVolumeDetachTimeoutSeconds is exceeded.\nDetaching volumes from nodes is usually done by CSI implementations and the current state\nis observed from the node's `.Status.VolumesAttached` field.\nOnly present when the Machine has a deletionTimestamp and waiting for volume detachments had been started.", "format": "date-time", "type": "string" } }, "type": "object", "additionalProperties": false }, "deprecated": { "description": "deprecated groups all the status fields that are deprecated and will be removed when all the nested field are removed.", "properties": { "v1beta1": { "description": "v1beta1 groups all the status fields that are deprecated and will be removed when support for v1beta1 will be dropped.\n\nDeprecated: This field is deprecated and is going to be removed when support for v1beta1 will be dropped. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", "properties": { "conditions": { "description": "conditions defines current service state of the Machine.\n\nDeprecated: This field is deprecated and is going to be removed when support for v1beta1 will be dropped. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", "items": { "description": "Condition defines an observation of a Cluster API resource operational state.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when\nthe API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis field may be empty.", "maxLength": 10240, "minLength": 1, "type": "string" }, "reason": { "description": "reason is the reason for the condition's last transition in CamelCase.\nThe specific API may choose whether or not this field is considered a guaranteed API.\nThis field may be empty.", "maxLength": 256, "minLength": 1, "type": "string" }, "severity": { "description": "severity provides an explicit classification of Reason code, so the users or machines can immediately\nunderstand the current situation and act accordingly.\nThe Severity field MUST be set only when Status=False.", "maxLength": 32, "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions\ncan be useful (see .node.status.conditions), the ability to deconflict is important.", "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "lastTransitionTime", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array" }, "failureMessage": { "description": "failureMessage will be set in the event that there is a terminal problem\nreconciling the Machine and will contain a more verbose string suitable\nfor logging and human consumption.\n\nThis field should not be set for transitive errors that a controller\nfaces that are expected to be fixed automatically over\ntime (like service outages), but instead indicate that something is\nfundamentally wrong with the Machine's spec or the configuration of\nthe controller, and that manual intervention is required. Examples\nof terminal errors would be invalid combinations of settings in the\nspec, values that are unsupported by the controller, or the\nresponsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines\ncan be added as events to the Machine object and/or logged in the\ncontroller's output.\n\nDeprecated: This field is deprecated and is going to be removed when support for v1beta1 will be dropped. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", "maxLength": 10240, "minLength": 1, "type": "string" }, "failureReason": { "description": "failureReason will be set in the event that there is a terminal problem\nreconciling the Machine and will contain a succinct value suitable\nfor machine interpretation.\n\nThis field should not be set for transitive errors that a controller\nfaces that are expected to be fixed automatically over\ntime (like service outages), but instead indicate that something is\nfundamentally wrong with the Machine's spec or the configuration of\nthe controller, and that manual intervention is required. Examples\nof terminal errors would be invalid combinations of settings in the\nspec, values that are unsupported by the controller, or the\nresponsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines\ncan be added as events to the Machine object and/or logged in the\ncontroller's output.\n\nDeprecated: This field is deprecated and is going to be removed when support for v1beta1 will be dropped. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.", "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "initialization": { "description": "initialization provides observations of the Machine initialization process.\nNOTE: Fields in this struct are part of the Cluster API contract and are used to orchestrate initial Machine provisioning.", "minProperties": 1, "properties": { "bootstrapDataSecretCreated": { "description": "bootstrapDataSecretCreated is true when the bootstrap provider reports that the Machine's boostrap secret is created.\nNOTE: this field is part of the Cluster API contract, and it is used to orchestrate provisioning.\nThe value of this field is never updated after provisioning is completed.", "type": "boolean" }, "infrastructureProvisioned": { "description": "infrastructureProvisioned is true when the infrastructure provider reports that Machine's infrastructure is fully provisioned.\nNOTE: this field is part of the Cluster API contract, and it is used to orchestrate provisioning.\nThe value of this field is never updated after provisioning is completed.", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "lastUpdated": { "description": "lastUpdated identifies when the phase of the Machine last transitioned.", "format": "date-time", "type": "string" }, "nodeInfo": { "description": "nodeInfo is a set of ids/uuids to uniquely identify the node.\nMore info: https://kubernetes.io/docs/concepts/nodes/node/#info", "properties": { "architecture": { "description": "The Architecture reported by the node", "type": "string" }, "bootID": { "description": "Boot ID reported by the node.", "type": "string" }, "containerRuntimeVersion": { "description": "ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).", "type": "string" }, "kernelVersion": { "description": "Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).", "type": "string" }, "kubeProxyVersion": { "description": "Deprecated: KubeProxy Version reported by the node.", "type": "string" }, "kubeletVersion": { "description": "Kubelet Version reported by the node.", "type": "string" }, "machineID": { "description": "MachineID reported by the node. For unique machine identification\nin the cluster this field is preferred. Learn more from man(5)\nmachine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html", "type": "string" }, "operatingSystem": { "description": "The Operating System reported by the node", "type": "string" }, "osImage": { "description": "OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).", "type": "string" }, "swap": { "description": "Swap Info reported by the node.", "properties": { "capacity": { "description": "Total amount of swap memory in bytes.", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false }, "systemUUID": { "description": "SystemUUID reported by the node. For unique machine identification\nMachineID is preferred. This field is specific to Red Hat hosts\nhttps://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid", "type": "string" } }, "required": [ "architecture", "bootID", "containerRuntimeVersion", "kernelVersion", "kubeProxyVersion", "kubeletVersion", "machineID", "operatingSystem", "osImage", "systemUUID" ], "type": "object", "additionalProperties": false }, "nodeRef": { "description": "nodeRef will point to the corresponding Node if it exists.", "properties": { "name": { "description": "name of the node.\nname must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "observedGeneration": { "description": "observedGeneration is the latest generation observed by the controller.", "format": "int64", "minimum": 1, "type": "integer" }, "phase": { "description": "phase represents the current phase of machine actuation.", "enum": [ "Pending", "Provisioning", "Provisioned", "Running", "Deleting", "Deleted", "Failed", "Unknown" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "spec" ], "type": "object" }