Skip to main content

core/Node@v1

Properties

PropertyTypeAttributesDescription
metadataIoK8SApimachineryPkgApisMetaV1ObjectMetaRequired, IdentifierObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
apiVersion'v1'Read-only, Deploy-time constantAPIVersion 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'Node'Read-only, Deploy-time constantKind 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
specIoK8SApiCoreV1NodeSpecNodeSpec describes the attributes that a node is created with.
statusIoK8SApiCoreV1NodeStatusNodeStatus is information about the current status of a node.

IoK8SApimachineryPkgApisMetaV1ObjectMeta

PropertyTypeAttributesDescription
namestringRequired, Deploy-time constant, IdentifierName 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
annotationsIoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotationsAnnotations 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
creationTimestampstringRead-onlyTime 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.
deletionGracePeriodSecondsintRead-onlyNumber 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.
deletionTimestampstringRead-onlyTime 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.
finalizersstring[]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.
generationintRead-onlyA sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labelsIoK8SApimachineryPkgApisMetaV1ObjectMetaLabelsMap 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
managedFieldsIoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry[]Read-onlyManagedFields 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.
namespacestringDeploy-time constant, IdentifierNamespace 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
ownerReferencesIoK8SApimachineryPkgApisMetaV1OwnerReference[]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.
resourceVersionstringRead-onlyAn 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
selfLinkstringRead-onlyDeprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uidstringRead-onlyUID 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

IoK8SApiCoreV1NodeSpec

PropertyTypeAttributesDescription
configSourceIoK8SApiCoreV1NodeConfigSourceNodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
externalIDstringDeprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
podCIDRstringPodCIDR represents the pod IP range assigned to the node.
podCIDRsstring[]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.
providerIDstringID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
taintsIoK8SApiCoreV1Taint[]If specified, the node's taints.
unschedulableboolUnschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

IoK8SApiCoreV1NodeStatus

PropertyTypeAttributesDescription
addressesIoK8SApiCoreV1NodeAddress[]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).
allocatableIoK8SApiCoreV1NodeStatusAllocatableAllocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacityIoK8SApiCoreV1NodeStatusCapacityCapacity represents the total resources of a node. More info: https://kubernetes.io/docs/reference/node/node-status/#capacity
conditionsIoK8SApiCoreV1NodeCondition[]Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition
configIoK8SApiCoreV1NodeConfigStatusNodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
daemonEndpointsIoK8SApiCoreV1NodeDaemonEndpointsNodeDaemonEndpoints lists ports opened by daemons running on the Node.
featuresIoK8SApiCoreV1NodeFeaturesNodeFeatures 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.
imagesIoK8SApiCoreV1ContainerImage[]List of container images on this node
nodeInfoIoK8SApiCoreV1NodeSystemInfoNodeSystemInfo is a set of ids/uuids to uniquely identify the node.
phasestringNodePhase 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.
runtimeHandlersIoK8SApiCoreV1NodeRuntimeHandler[]The available runtime handlers.
volumesAttachedIoK8SApiCoreV1AttachedVolume[]List of volumes that are attached to the node.
volumesInUsestring[]List of attachable volumes in use (mounted) by the node.

IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry

PropertyTypeAttributesDescription
apiVersionstringAPIVersion 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.
fieldsTypestringFieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1anyAny object
managerstringManager is an identifier of the workflow managing these fields.
operationstringOperation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresourcestringSubresource 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.
timestringTime 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.

IoK8SApimachineryPkgApisMetaV1OwnerReference

PropertyTypeAttributesDescription
apiVersionstringRequiredAPI version of the referent.
kindstringRequiredKind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
namestringRequiredName of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uidstringRequiredUID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
blockOwnerDeletionboolIf 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.
controllerboolIf true, this reference points to the managing controller.

IoK8SApiCoreV1NodeConfigSource

PropertyTypeAttributesDescription
configMapIoK8SApiCoreV1ConfigMapNodeConfigSourceConfigMapNodeConfigSource 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-configuration

IoK8SApiCoreV1Taint

PropertyTypeAttributesDescription
effectstringRequiredRequired. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
keystringRequiredRequired. The taint key to be applied to a node.
timeAddedstringTime 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.
valuestringThe taint value corresponding to the taint key.

IoK8SApiCoreV1NodeAddress

PropertyTypeAttributesDescription
addressstringRequiredThe node address.
typestringRequiredNode address type, one of Hostname, ExternalIP or InternalIP.

IoK8SApiCoreV1NodeStatusAllocatable

Additional properties of type string are allowed.

IoK8SApiCoreV1NodeStatusCapacity

Additional properties of type string are allowed.

IoK8SApiCoreV1NodeCondition

PropertyTypeAttributesDescription
statusstringRequiredStatus of the condition, one of True, False, Unknown.
typestringRequiredType of node condition.
lastHeartbeatTimestringTime 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.
lastTransitionTimestringTime 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.
messagestringHuman readable message indicating details about last transition.
reasonstring(brief) reason for the condition's last transition.

IoK8SApiCoreV1NodeConfigStatus

PropertyTypeAttributesDescription
activeIoK8SApiCoreV1NodeConfigSourceNodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
assignedIoK8SApiCoreV1NodeConfigSourceNodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
errorstringError 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.
lastKnownGoodIoK8SApiCoreV1NodeConfigSourceNodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

IoK8SApiCoreV1NodeDaemonEndpoints

PropertyTypeAttributesDescription
kubeletEndpointIoK8SApiCoreV1DaemonEndpointDaemonEndpoint contains information about a single Daemon endpoint.

IoK8SApiCoreV1NodeFeatures

PropertyTypeAttributesDescription
supplementalGroupsPolicyboolSupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser.

IoK8SApiCoreV1ContainerImage

PropertyTypeAttributesDescription
namesstring[]Names by which this image is known. e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]
sizeBytesintThe size of the image in bytes.

IoK8SApiCoreV1NodeSystemInfo

PropertyTypeAttributesDescription
architecturestringRequiredThe Architecture reported by the node
bootIDstringRequiredBoot ID reported by the node.
containerRuntimeVersionstringRequiredContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).
kernelVersionstringRequiredKernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
kubeletVersionstringRequiredKubelet Version reported by the node.
kubeProxyVersionstringRequiredDeprecated: KubeProxy Version reported by the node.
machineIDstringRequiredMachineID 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
operatingSystemstringRequiredThe Operating System reported by the node
osImagestringRequiredOS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
systemUUIDstringRequiredSystemUUID 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
swapIoK8SApiCoreV1NodeSwapStatusNodeSwapStatus represents swap memory information.

IoK8SApiCoreV1NodeRuntimeHandler

PropertyTypeAttributesDescription
featuresIoK8SApiCoreV1NodeRuntimeHandlerFeaturesNodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.
namestringRuntime handler name. Empty for the default runtime handler.

IoK8SApiCoreV1AttachedVolume

PropertyTypeAttributesDescription
devicePathstringRequiredDevicePath represents the device path where the volume should be available
namestringRequiredName of the attached volume

IoK8SApiCoreV1ConfigMapNodeConfigSource

PropertyTypeAttributesDescription
kubeletConfigKeystringRequiredKubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
namestringRequiredName is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespacestringRequiredNamespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersionstringResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uidstringUID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

IoK8SApiCoreV1DaemonEndpoint

PropertyTypeAttributesDescription
PortintRequiredPort number of the given endpoint.

IoK8SApiCoreV1NodeSwapStatus

PropertyTypeAttributesDescription
capacityintTotal amount of swap memory in bytes.

IoK8SApiCoreV1NodeRuntimeHandlerFeatures

PropertyTypeAttributesDescription
recursiveReadOnlyMountsboolRecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts.
userNamespacesboolUserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes.