This is a cache of https://docs.openshift.com/dedicated/3/rest_api/core/node-core-v1.html. It is a snapshot of the page at 2024-11-22T05:06:33.836+0000.
Node [core/v1] - core | API reference | OpenShift Dedicated 3
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
×

Node [core/v1]

Description

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

Type

object

Specification

Property Type 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/api-conventions.md#resources

.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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

.spec

object

NodeSpec describes the attributes that a node is created with.

.status

object

NodeStatus is information about the current status of a node.
.spec
Description

NodeSpec describes the attributes that a node is created with.

Type

object

Property Type Description

configSource

NodeConfigSource core/v1

If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field

externalID

string

Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966

podCIDR

string

PodCIDR represents the pod IP range assigned to the node.

providerID

string

ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>

taints

array (Taint core/v1)

If specified, the node’s taints.

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
.status
Description

NodeStatus is information about the current status of a node.

Type

object

Property Type Description

addresses

array (NodeAddress core/v1)

List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses

allocatable

object (Quantity api/resource)

Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

capacity

object (Quantity api/resource)

Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

conditions

array (NodeCondition core/v1)

Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition

config

object

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

daemonEndpoints

NodeDaemonEndpoints core/v1

Endpoints of daemons running on the Node.

images

array (ContainerImage core/v1)

List of container images on this node

nodeInfo

NodeSystemInfo core/v1

Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info

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.

volumesAttached

array (AttachedVolume core/v1)

List of volumes that are attached to the node.

volumesInUse

array (string)

List of attachable volumes in use (mounted) by the node.
.status.config
Description

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

Type

object

Property Type Description

active

NodeConfigSource core/v1

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.

assigned

NodeConfigSource core/v1

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.

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.

lastKnownGood

NodeConfigSource core/v1

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.

API endpoints

The following API endpoints are available:

  • /api/v1/nodes

    • DELETE: delete collection of Node

    • GET: list or watch objects of kind Node

    • POST: create a Node

  • /api/v1/nodes/{name}

    • DELETE: delete a Node

    • GET: read the specified Node

    • PATCH: partially update the specified Node

    • PUT: replace the specified Node

  • /api/v1/nodes/{name}/proxy

    • DELETE: connect DELETE requests to proxy of Node

    • GET: connect GET requests to proxy of Node

    • HEAD: connect HEAD requests to proxy of Node

    • OPTIONS: connect OPTIONS requests to proxy of Node

    • PATCH: connect PATCH requests to proxy of Node

    • POST: connect POST requests to proxy of Node

    • PUT: connect PUT requests to proxy of Node

  • /api/v1/nodes/{name}/status

    • GET: read status of the specified Node

    • PATCH: partially update status of the specified Node

    • PUT: replace status of the specified Node

  • /api/v1/nodes/{name}/proxy/{path}

    • DELETE: connect DELETE requests to proxy of Node

    • GET: connect GET requests to proxy of Node

    • HEAD: connect HEAD requests to proxy of Node

    • OPTIONS: connect OPTIONS requests to proxy of Node

    • PATCH: connect PATCH requests to proxy of Node

    • POST: connect POST requests to proxy of Node

    • PUT: connect PUT requests to proxy of Node

/api/v1/nodes

Table 1. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete collection of Node

Table 2. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 3. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty
HTTP method

GET

Description

list or watch objects of kind Node

Table 4. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
Table 5. HTTP responses
HTTP code Reponse body

200 - OK

NodeList core/v1

401 - Unauthorized

Empty
HTTP method

POST

Description

create a Node

Table 6. Body parameters
Parameter Type Description

body

Node core/v1
Table 7. HTTP responses
HTTP code Reponse body

200 - OK

Node core/v1

201 - Created

Node core/v1

202 - Accepted

Node core/v1

401 - Unauthorized

Empty

/api/v1/nodes/{name}

Table 8. Global path parameters
Parameter Type Description

name

string

name of the Node
Table 9. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

DELETE

Description

delete a Node

Table 10. Query parameters
Parameter Type Description

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
Table 11. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1
Table 12. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified Node

Table 13. Query parameters
Parameter Type Description

exact

boolean

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

boolean

Should this value be exported. Export strips fields that a user can not specify.
Table 14. HTTP responses
HTTP code Reponse body

200 - OK

Node core/v1

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified Node

Table 15. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 16. HTTP responses
HTTP code Reponse body

200 - OK

Node core/v1

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified Node

Table 17. Body parameters
Parameter Type Description

body

Node core/v1
Table 18. HTTP responses
HTTP code Reponse body

200 - OK

Node core/v1

201 - Created

Node core/v1

401 - Unauthorized

Empty

/api/v1/nodes/{name}/proxy

Table 19. Global path parameters
Parameter Type Description

name

string

name of the Node
Table 20. Global guery parameters
Parameter Type Description

path

string

Path is the URL path to use for the current proxy request to node.
HTTP method

DELETE

Description

connect DELETE requests to proxy of Node

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

GET

Description

connect GET requests to proxy of Node

Table 22. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

HEAD

Description

connect HEAD requests to proxy of Node

Table 23. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

OPTIONS

Description

connect OPTIONS requests to proxy of Node

Table 24. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

PATCH

Description

connect PATCH requests to proxy of Node

Table 25. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

POST

Description

connect POST requests to proxy of Node

Table 26. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

PUT

Description

connect PUT requests to proxy of Node

Table 27. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty

/api/v1/nodes/{name}/status

Table 28. Global path parameters
Parameter Type Description

name

string

name of the Node
Table 29. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.
HTTP method

GET

Description

read status of the specified Node

Table 30. HTTP responses
HTTP code Reponse body

200 - OK

Node core/v1

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update status of the specified Node

Table 31. Body parameters
Parameter Type Description

body

Patch meta/v1
Table 32. HTTP responses
HTTP code Reponse body

200 - OK

Node core/v1

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace status of the specified Node

Table 33. Body parameters
Parameter Type Description

body

Node core/v1
Table 34. HTTP responses
HTTP code Reponse body

200 - OK

Node core/v1

201 - Created

Node core/v1

401 - Unauthorized

Empty

/api/v1/nodes/{name}/proxy/{path}

Table 35. Global path parameters
Parameter Type Description

name

string

name of the Node

path

string

path to the resource
Table 36. Global guery parameters
Parameter Type Description

path

string

Path is the URL path to use for the current proxy request to node.
HTTP method

DELETE

Description

connect DELETE requests to proxy of Node

Table 37. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

GET

Description

connect GET requests to proxy of Node

Table 38. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

HEAD

Description

connect HEAD requests to proxy of Node

Table 39. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

OPTIONS

Description

connect OPTIONS requests to proxy of Node

Table 40. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

PATCH

Description

connect PATCH requests to proxy of Node

Table 41. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

POST

Description

connect POST requests to proxy of Node

Table 42. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty
HTTP method

PUT

Description

connect PUT requests to proxy of Node

Table 43. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty