Search
SupportConsoleDevelopersStart a trialContact

Chapter 18. Node [config.openshift.io/v1]

download PDF
Description
Node holds cluster-wide information about node specific features. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type
object
Required
  • spec

18.1. Specification

PropertyTypeDescription

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

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

metadata

ObjectMeta

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

spec

object

spec holds user settable values for configuration

status

object

status holds observed values.

18.1.1. .spec

Description
spec holds user settable values for configuration
Type
object
PropertyTypeDescription

cgroupMode

string

CgroupMode determines the cgroups version on the node

workerLatencyProfile

string

WorkerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster

18.1.2. .status

Description
status holds observed values.
Type
object

18.2. API endpoints

The following API endpoints are available:

  • /apis/config.openshift.io/v1/nodes

    • DELETE: delete collection of Node
    • GET: list objects of kind Node
    • POST: create a Node

  • /apis/config.openshift.io/v1/nodes/{name}

    • DELETE: delete a Node
    • GET: read the specified Node
    • PATCH: partially update the specified Node
    • PUT: replace the specified Node

  • /apis/config.openshift.io/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

18.2.1. /apis/config.openshift.io/v1/nodes

HTTP method
DELETE
Description
delete collection of Node
Table 18.1. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind Node
Table 18.2. HTTP responses
HTTP codeReponse body

200 - OK

NodeList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a Node
Table 18.3. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.4. Body parameters
ParameterTypeDescription

body

Node schema

 
Table 18.5. HTTP responses
HTTP codeReponse body

200 - OK

Node schema

201 - Created

Node schema

202 - Accepted

Node schema

401 - Unauthorized

Empty

18.2.2. /apis/config.openshift.io/v1/nodes/{name}

Table 18.6. Global path parameters
ParameterTypeDescription

name

string

name of the Node

HTTP method
DELETE
Description
delete a Node
Table 18.7. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 18.8. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified Node
Table 18.9. HTTP responses
HTTP codeReponse body

200 - OK

Node schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified Node
Table 18.10. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.11. HTTP responses
HTTP codeReponse body

200 - OK

Node schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified Node
Table 18.12. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.13. Body parameters
ParameterTypeDescription

body

Node schema

 
Table 18.14. HTTP responses
HTTP codeReponse body

200 - OK

Node schema

201 - Created

Node schema

401 - Unauthorized

Empty

18.2.3. /apis/config.openshift.io/v1/nodes/{name}/status

Table 18.15. Global path parameters
ParameterTypeDescription

name

string

name of the Node

HTTP method
GET
Description
read status of the specified Node
Table 18.16. HTTP responses
HTTP codeReponse body

200 - OK

Node schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified Node
Table 18.17. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.18. HTTP responses
HTTP codeReponse body

200 - OK

Node schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified Node
Table 18.19. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18.20. Body parameters
ParameterTypeDescription

body

Node schema

 
Table 18.21. HTTP responses
HTTP codeReponse body

200 - OK

Node schema

201 - Created

Node schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.