Node
v1
Cluster
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
RBAC Verbs
create
delete
deletecollection
get
list
patch
update
watch
Properties
| Field | Type | Required? | Description |
|---|---|---|---|
| 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 |
| Field | Type | Required? | Description |
|---|---|---|---|
| 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 |
| Field | Type | Required? | Description |
|---|---|---|---|
| metadata | object | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
| metadata.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 | |
| metadata.creationTimestamp | string | 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 | |
| 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. | |
| metadata.deletionTimestamp | string | 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 | |
| metadata.finalizers | array | 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. | |
| metadata.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 | |
| metadata.generation | integer | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. | |
| metadata.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 | |
| metadata.managedFields | array | 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. | |
| metadata.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 | |
| metadata.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 | |
| metadata.ownerReferences | array | 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. | |
| metadata.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 | |
| metadata.selfLink | string | Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. | |
| metadata.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 |
| Field | Type | Required? | Description |
|---|---|---|---|
| spec | object | Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status | |
| spec.configSource | object | Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed. | |
| spec.configSource.configMap | object | ConfigMap is a reference to a Node's ConfigMap | |
| spec.configSource.configMap.kubeletConfigKey | string | Required | KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
| spec.configSource.configMap.name | string | Required | Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
| spec.configSource.configMap.namespace | string | Required | Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
| spec.configSource.configMap.resourceVersion | string | ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | |
| spec.configSource.configMap.uid | string | UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | |
| spec.externalID | string | Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 | |
| spec.podCIDR | string | PodCIDR represents the pod IP range assigned to the node. | |
| spec.podCIDRs | array | podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. | |
| spec.podPreemptionPolicy | object | PodPreemptionPolicy controls the node-level preemption behaviors for pods on this node. This is an alpha field and requires enabling the InPlacePodVerticalScalingSchedulerPreemption feature gate. | |
| spec.podPreemptionPolicy.disableResizePreemption | array | DisableResizePreemption lists the owners (e.g., autoscalers, operators, administrators) that have requested to disable scheduler and Kubelet preemption for in-place pod resize on this node. If this list is non-empty, resize-induced preemption is disabled on this node. This is an alpha field and requires enabling the InPlacePodVerticalScalingSchedulerPreemption feature gate. | |
| spec.providerID | string | ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID> | |
| spec.taints | array | If specified, the node's taints. | |
| spec.unschedulable | boolean | Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration |
| Field | Type | Required? | Description |
|---|---|---|---|
| status | object | Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status | |
| status.addresses | array | List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/reference/node/node-status/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP). | |
| status.allocatable | object | Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. | |
| status.capacity | object | Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/reference/node/node-status/#capacity | |
| status.conditions | array | Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition | |
| status.config | object | Status of the config assigned to the node via the dynamic Kubelet config feature. | |
| status.daemonEndpoints | object | Endpoints of daemons running on the Node. | |
| status.declaredFeatures | array | DeclaredFeatures represents the features related to feature gates that are declared by the node. | |
| status.features | object | Features describes the set of features implemented by the CRI implementation. | |
| status.images | array | List of container images on this node | |
| status.nodeInfo | object | Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/reference/node/node-status/#info | |
| status.phase | string | NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated. | |
| status.runtimeHandlers | array | The available runtime handlers. | |
| status.volumesAttached | array | List of volumes that are attached to the node. | |
| status.volumesInUse | array | List of attachable volumes in use (mounted) by the node. |
| Field | Type | Required? | Description |
|---|---|---|---|
| status.config.active | object | Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error. | |
| status.config.assigned | object | Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned. | |
| status.config.error | string | Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions. | |
| status.config.lastKnownGood | object | LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future. |
| Field | Type | Required? | Description |
|---|---|---|---|
| status.config.active.configMap | object | ConfigMap is a reference to a Node's ConfigMap | |
| status.config.active.configMap.kubeletConfigKey | string | Required | KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
| status.config.active.configMap.name | string | Required | Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
| status.config.active.configMap.namespace | string | Required | Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
| status.config.active.configMap.resourceVersion | string | ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | |
| status.config.active.configMap.uid | string | UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
| Field | Type | Required? | Description |
|---|---|---|---|
| status.config.assigned.configMap | object | ConfigMap is a reference to a Node's ConfigMap | |
| status.config.assigned.configMap.kubeletConfigKey | string | Required | KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
| status.config.assigned.configMap.name | string | Required | Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
| status.config.assigned.configMap.namespace | string | Required | Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
| status.config.assigned.configMap.resourceVersion | string | ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | |
| status.config.assigned.configMap.uid | string | UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
| Field | Type | Required? | Description |
|---|---|---|---|
| status.config.lastKnownGood.configMap | object | ConfigMap is a reference to a Node's ConfigMap | |
| status.config.lastKnownGood.configMap.kubeletConfigKey | string | Required | KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
| status.config.lastKnownGood.configMap.name | string | Required | Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
| status.config.lastKnownGood.configMap.namespace | string | Required | Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
| status.config.lastKnownGood.configMap.resourceVersion | string | ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | |
| status.config.lastKnownGood.configMap.uid | string | UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
| Field | Type | Required? | Description |
|---|---|---|---|
| status.daemonEndpoints.kubeletEndpoint | object | Endpoint on which Kubelet is listening. | |
| status.daemonEndpoints.kubeletEndpoint.Port | integer | Required | Port number of the given endpoint. |
| Field | Type | Required? | Description |
|---|---|---|---|
| status.features.supplementalGroupsPolicy | boolean | SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser. |
| Field | Type | Required? | Description |
|---|---|---|---|
| status.nodeInfo.architecture | string | Required | The Architecture reported by the node |
| status.nodeInfo.bootID | string | Required | Boot ID reported by the node. |
| status.nodeInfo.containerRuntimeVersion | string | Required | ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2). |
| status.nodeInfo.kernelVersion | string | Required | Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). |
| status.nodeInfo.kubeProxyVersion | string | Required | Deprecated: KubeProxy Version reported by the node. |
| status.nodeInfo.kubeletVersion | string | Required | Kubelet Version reported by the node. |
| status.nodeInfo.machineID | string | Required | MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html |
| status.nodeInfo.operatingSystem | string | Required | The Operating System reported by the node |
| status.nodeInfo.osImage | string | Required | OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). |
| status.nodeInfo.runningInUserNamespace | boolean | Whether the node is running in a user namespace. | |
| status.nodeInfo.swap | object | Swap Info reported by the node. | |
| status.nodeInfo.swap.capacity | integer | Total amount of swap memory in bytes. | |
| status.nodeInfo.systemUUID | string | Required | SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid |
Sample Manifest
Minimal example generated from required fields — not hand-verified.
apiVersion: v1
kind: Node
metadata:
name: my-node
Need this managed for you, not just automated?
We're also a hands-on DevOps consultancy — Kubernetes, CI/CD, and cloud infrastructure.