Node [config.openshift.io/v1]
Esc
Start typing to search...
On this page

Node [config.openshift.io/v1]

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

Specification

PropertyTypeDescription
apiVersionstringAPIVersion 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
kindstringKind 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
metadataObjectMetaStandard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specobjectspec holds user settable values for configuration
statusobjectstatus holds observed values.

.spec

Description

spec holds user settable values for configuration

Type
`object`
PropertyTypeDescription
cgroupModestringcgroupMode determines the cgroups version on the node
workerLatencyProfilestringworkerLatencyProfile determins the how fast the kubelet is updating the status and corresponding reaction of the cluster

.status

Description

status holds observed values.

Type
`object`
PropertyTypeDescription
conditionsarrayconditions contain the details and the current state of the nodes.config object
conditions[]objectCondition contains details for one aspect of the current state of this API Resource.

.status.conditions

Description

conditions contain the details and the current state of the nodes.config object

Type
`array`

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource.

Type
`object`
Required
  • lastTransitionTime
  • message
  • reason
  • status
  • type
PropertyTypeDescription
lastTransitionTimestringlastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
messagestringmessage is a human readable message indicating details about the transition. This may be an empty string.
observedGenerationintegerobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reasonstringreason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
statusstringstatus of the condition, one of True, False, Unknown.
typestringtype of condition in CamelCase or in foo.example.com/CamelCase.

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

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

HTTP method
`DELETE`
Description
delete collection of Node

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
list objects of kind Node

HTTP responses

HTTP codeReponse body
200 - OKNodeList schema
401 - UnauthorizedEmpty
HTTP method
`POST`
Description
create a Node

Query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.

Body parameters

ParameterTypeDescription
bodyNode schema

HTTP responses

HTTP codeReponse body
200 - OKNode schema
201 - CreatedNode schema
202 - AcceptedNode schema
401 - UnauthorizedEmpty

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

Global path parameters

ParameterTypeDescription
namestringname of the Node
HTTP method
`DELETE`
Description
delete a Node

Query parameters

ParameterTypeDescription
dryRunstringWhen 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

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
read the specified Node

HTTP responses

HTTP codeReponse body
200 - OKNode schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update the specified Node

Query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.

HTTP responses

HTTP codeReponse body
200 - OKNode schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace the specified Node

Query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.

Body parameters

ParameterTypeDescription
bodyNode schema

HTTP responses

HTTP codeReponse body
200 - OKNode schema
201 - CreatedNode schema
401 - UnauthorizedEmpty

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

Global path parameters

ParameterTypeDescription
namestringname of the Node
HTTP method
`GET`
Description
read status of the specified Node

HTTP responses

HTTP codeReponse body
200 - OKNode schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update status of the specified Node

Query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.

HTTP responses

HTTP codeReponse body
200 - OKNode schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace status of the specified Node

Query parameters

ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.

Body parameters

ParameterTypeDescription
bodyNode schema

HTTP responses

HTTP codeReponse body
200 - OKNode schema
201 - CreatedNode schema
401 - UnauthorizedEmpty