# Node

NodeNode is a worker node in Kubernetes.apiVersion: v1import "k8s.io/api/core/v1"NodeNode is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).apiVersion: v1kind: Nodemetadata (ObjectMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (NodeSpec)Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-statusstatus (NodeStatus)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-statusNodeSpecNodeSpec describes the attributes that a node is created with.configSource (NodeConfigSource)Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed.NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22configSource.configMap (ConfigMapNodeConfigSource)ConfigMap is a reference to a Node's ConfigMapConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configurationconfigSource.configMap.kubeletConfigKey (string), requiredKubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.configSource.configMap.name (string), requiredName is the metadata.name of the referenced ConfigMap. This field is required in all cases.configSource.configMap.namespace (string), requiredNamespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.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.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.externalID (string)Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966podCIDR (string)PodCIDR represents the pod IP range assigned to the node.podCIDRs ([]string)Set: unique values will be kept during a mergepodCIDRs 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.providerID (string)ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>taints ([]Taint)Atomic: will be replaced during a mergeIf specified, the node's taints.The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.taints.effect (string), requiredRequired. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.taints.key (string), requiredRequired. The taint key to be applied to a node.taints.timeAdded (Time)TimeAdded represents the time at which the taint was added.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.taints.value (string)The taint value corresponding to the taint key.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-administrationNodeStatusNodeStatus is information about the current status of a node.addresses ([]NodeAddress)Patch strategy: merge on key typeMap: unique values on key type will be kept during a mergeList 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).NodeAddress contains information for the node's address.addresses.address (string), requiredThe node address.addresses.type (string), requiredNode address type, one of Hostname, ExternalIP or InternalIP.allocatable (map[string]Quantity)Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.capacity (map[string]Quantity)Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/reference/node/node-status/#capacityconditions ([]NodeCondition)Patch strategy: merge on key typeMap: unique values on key type will be kept during a mergeConditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#conditionNodeCondition contains condition information for a node.conditions.status (string), requiredStatus of the condition, one of True, False, Unknown.conditions.type (string), requiredType of node condition.conditions.lastHeartbeatTime (Time)Last time we got an update on a given condition.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.conditions.lastTransitionTime (Time)Last time the condition transit from one status to another.Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.conditions.message (string)Human readable message indicating details about last transition.conditions.reason (string)(brief) reason for the condition's last transition.config (NodeConfigStatus)Status of the config assigned to the node via the dynamic Kubelet config feature.NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.config.active (NodeConfigSource)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.NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22config.active.configMap (ConfigMapNodeConfigSource)ConfigMap is a reference to a Node's ConfigMapConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configurationconfig.active.configMap.kubeletConfigKey (string), requiredKubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.config.active.configMap.name (string), requiredName is the metadata.name of the referenced ConfigMap. This field is required in all cases.config.active.configMap.namespace (string), requiredNamespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.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.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.config.assigned (NodeConfigSource)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.NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22config.assigned.configMap (ConfigMapNodeConfigSource)ConfigMap is a reference to a Node's ConfigMapConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configurationconfig.assigned.configMap.kubeletConfigKey (string), requiredKubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.config.assigned.configMap.name (string), requiredName is the metadata.name of the referenced ConfigMap. This field is required in all cases.config.assigned.configMap.namespace (string), requiredNamespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.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.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.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.config.lastKnownGood (NodeConfigSource)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.NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22config.lastKnownGood.configMap (ConfigMapNodeConfigSource)ConfigMap is a reference to a Node's ConfigMapConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configurationconfig.lastKnownGood.configMap.kubeletConfigKey (string), requiredKubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.config.lastKnownGood.configMap.name (string), requiredName is the metadata.name of the referenced ConfigMap. This field is required in all cases.config.lastKnownGood.configMap.namespace (string), requiredNamespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.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.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.daemonEndpoints (NodeDaemonEndpoints)Endpoints of daemons running on the Node.NodeDaemonEndpoints lists ports opened by daemons running on the Node.daemonEndpoints.kubeletEndpoint (DaemonEndpoint)Endpoint on which Kubelet is listening.DaemonEndpoint contains information about a single Daemon endpoint.daemonEndpoints.kubeletEndpoint.Port (int32), requiredPort number of the given endpoint.features (NodeFeatures)Features describes the set of features implemented by the CRI implementation.NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.features.supplementalGroupsPolicy (boolean)SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser.images ([]ContainerImage)Atomic: will be replaced during a mergeList of container images on this nodeDescribe a container imageimages.names ([]string)Atomic: will be replaced during a mergeNames by which this image is known. e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]images.sizeBytes (int64)The size of the image in bytes.nodeInfo (NodeSystemInfo)Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/reference/node/node-status/#infoNodeSystemInfo is a set of ids/uuids to uniquely identify the node.nodeInfo.architecture (string), requiredThe Architecture reported by the nodenodeInfo.bootID (string), requiredBoot ID reported by the node.nodeInfo.containerRuntimeVersion (string), requiredContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).nodeInfo.kernelVersion (string), requiredKernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).nodeInfo.kubeProxyVersion (string), requiredDeprecated: KubeProxy Version reported by the node.nodeInfo.kubeletVersion (string), requiredKubelet Version reported by the node.nodeInfo.machineID (string), requiredMachineID 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.htmlnodeInfo.operatingSystem (string), requiredThe Operating System reported by the nodenodeInfo.osImage (string), requiredOS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).nodeInfo.systemUUID (string), requiredSystemUUID 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/uuidnodeInfo.swap (NodeSwapStatus)Swap Info reported by the node.NodeSwapStatus represents swap memory information.nodeInfo.swap.capacity (int64)Total amount of swap memory in bytes.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.runtimeHandlers ([]NodeRuntimeHandler)Atomic: will be replaced during a mergeThe available runtime handlers.NodeRuntimeHandler is a set of runtime handler information.runtimeHandlers.features (NodeRuntimeHandlerFeatures)Supported features.NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.runtimeHandlers.features.recursiveReadOnlyMounts (boolean)RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts.runtimeHandlers.features.userNamespaces (boolean)UserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes.runtimeHandlers.name (string)Runtime handler name. Empty for the default runtime handler.volumesAttached ([]AttachedVolume)Atomic: will be replaced during a mergeList of volumes that are attached to the node.AttachedVolume describes a volume attached to a nodevolumesAttached.devicePath (string), requiredDevicePath represents the device path where the volume should be availablevolumesAttached.name (string), requiredName of the attached volumevolumesInUse ([]string)Atomic: will be replaced during a mergeList of attachable volumes in use (mounted) by the node.NodeListNodeList is the whole list of all Nodes which have been registered with master.apiVersion: v1kind: NodeListmetadata (ListMeta)Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kindsitems ([]Node), requiredList of nodesOperationsget read the specified NodeHTTP RequestGET /api/v1/nodes/{name}Parametersname (in path): string, requiredname of the Nodepretty (in query): stringprettyResponse200 (Node): OK401: Unauthorizedget read status of the specified NodeHTTP RequestGET /api/v1/nodes/{name}/statusParametersname (in path): string, requiredname of the Nodepretty (in query): stringprettyResponse200 (Node): OK401: Unauthorizedlist list or watch objects of kind NodeHTTP RequestGET /api/v1/nodesParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (NodeList): OK401: Unauthorizedcreate create a NodeHTTP RequestPOST /api/v1/nodesParametersbody: Node, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (Node): OK201 (Node): Created202 (Node): Accepted401: Unauthorizedupdate replace the specified NodeHTTP RequestPUT /api/v1/nodes/{name}Parametersname (in path): string, requiredname of the Nodebody: Node, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (Node): OK201 (Node): Created401: Unauthorizedupdate replace status of the specified NodeHTTP RequestPUT /api/v1/nodes/{name}/statusParametersname (in path): string, requiredname of the Nodebody: Node, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (Node): OK201 (Node): Created401: Unauthorizedpatch partially update the specified NodeHTTP RequestPATCH /api/v1/nodes/{name}Parametersname (in path): string, requiredname of the Nodebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (Node): OK201 (Node): Created401: Unauthorizedpatch partially update status of the specified NodeHTTP RequestPATCH /api/v1/nodes/{name}/statusParametersname (in path): string, requiredname of the Nodebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (Node): OK201 (Node): Created401: Unauthorizeddelete delete a NodeHTTP RequestDELETE /api/v1/nodes/{name}Parametersname (in path): string, requiredname of the Nodebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of NodeHTTP RequestDELETE /api/v1/nodesParametersbody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.