Tuned [tuned.openshift.io/v1]

Description

Tuned is a collection of rules that allows cluster-wide deployment of node-level sysctls and more flexibility to add custom tuning specified by user needs. These rules are translated and passed to all containerized Tuned daemons running in the cluster in the format that the daemons understand. The responsibility for applying the node-level tuning then lies with the containerized Tuned daemons. More info: https://github.com/openshift/cluster-node-tuning-operator

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/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 is the specification of the desired behavior of Tuned. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status	object	TunedStatus is the status for a Tuned resource.

.spec

Description

spec is the specification of the desired behavior of Tuned. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

Type

`object`

Property	Type	Description
managementState	string	managementState indicates whether the registry instance represented by this config instance is under operator management or not. Valid values are Force, Managed, Unmanaged, and Removed.
profile	array	Tuned profiles.
profile[]	object	A Tuned profile.
recommend	array	Selection logic for all Tuned profiles.
recommend[]	object	Selection logic for a single Tuned profile.

.spec.profile

Description

Tuned profiles.

Type

`array`

.spec.profile[]

Description

A Tuned profile.

Type

`object`

Required

• data
• name

Property	Type	Description
data	string	Specification of the Tuned profile to be consumed by the Tuned daemon.
name	string	Name of the Tuned profile to be used in the recommend section.

.spec.recommend

Description

Selection logic for all Tuned profiles.

Type

`array`

.spec.recommend[]

Description

Selection logic for a single Tuned profile.

Type

`object`

Required

• priority
• profile

Property	Type	Description
machineConfigLabels	object (string)	MachineConfigLabels specifies the labels for a MachineConfig. The MachineConfig is created automatically to apply additional host settings (e.g. kernel boot parameters) profile 'Profile' needs and can only be applied by creating a MachineConfig. This involves finding all MachineConfigPools with machineConfigSelector matching the MachineConfigLabels and setting the profile 'Profile' on all nodes that match the MachineConfigPools' nodeSelectors.
match	array	Rules governing application of a Tuned profile connected by logical OR operator.
match[]	object	Rules governing application of a Tuned profile.
operand	object	Optional operand configuration.
priority	integer	Tuned profile priority. Highest priority is 0.
profile	string	Name of the Tuned profile to recommend.

.spec.recommend[].match

Description

Rules governing application of a Tuned profile connected by logical OR operator.

Type

`array`

.spec.recommend[].match[]

Description

Rules governing application of a Tuned profile.

Type

`object`

Required

• label

Property	Type	Description
label	string	Node or Pod label name.
match	array (undefined)	Additional rules governing application of the tuned profile connected by logical AND operator.
type	string	Match type: [node/pod]. If omitted, "node" is assumed.
value	string	Node or Pod label value. If omitted, the presence of label name is enough to match.

.spec.recommend[].operand

Description

Optional operand configuration.

Type

`object`

Property	Type	Description
debug	boolean	turn debugging on/off for the TuneD daemon: true/false (default is false)
tunedConfig	object	Global configuration for the TuneD daemon as defined in tuned-main.conf
verbosity	integer	klog logging verbosity

.spec.recommend[].operand.tunedConfig

Description

Global configuration for the TuneD daemon as defined in tuned-main.conf

Type

`object`

Property	Type	Description
reapply_sysctl	boolean	turn reapply_sysctl functionality on/off for the TuneD daemon: true/false

.status

Description

TunedStatus is the status for a Tuned resource.

Type

`object`

Property	Type	Description
conditions	array	conditions represents the state of the Tuned profile
conditions[]	object	StatusCondition represents a partial state of the per-node Profile application.

.status.conditions

Description

conditions represents the state of the Tuned profile

Type

`array`

.status.conditions[]

Description

StatusCondition represents a partial state of the per-node Profile application.

Type

`object`

Required

• lastTransitionTime
• status
• type

Property	Type	Description
lastTransitionTime	string	lastTransitionTime is the time of the last update to the current status property.
message	string	message provides additional information about the current condition. This is only to be consumed by humans.
reason	string	reason is the CamelCase reason for the condition’s current status.
status	string	status of the condition, one of True, False, Unknown.
type	string	type specifies the aspect reported by this condition.

API endpoints

The following API endpoints are available:

• /apis/tuned.openshift.io/v1/tuneds
  • GET: list objects of kind Tuned
• /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds
  • DELETE: delete collection of Tuned
  • GET: list objects of kind Tuned
  • POST: create a Tuned
• /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}
  • DELETE: delete a Tuned
  • GET: read the specified Tuned
  • PATCH: partially update the specified Tuned
  • PUT: replace the specified Tuned
• /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}/status
  • GET: read status of the specified Tuned
  • PATCH: partially update status of the specified Tuned
  • PUT: replace status of the specified Tuned

/apis/tuned.openshift.io/v1/tuneds

HTTP method

`GET`

Description

list objects of kind Tuned

HTTP responses

HTTP code	Reponse body
200 - OK	TunedList schema
401 - Unauthorized	Empty

/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds

HTTP method

`DELETE`

Description

delete collection of Tuned

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind Tuned

HTTP responses

HTTP code	Reponse body
200 - OK	TunedList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a Tuned

Query parameters

Parameter	Type	Description
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.

Body parameters

Parameter	Type	Description
body	Tuned schema

HTTP responses

HTTP code	Reponse body
200 - OK	Tuned schema
201 - Created	Tuned schema
202 - Accepted	Tuned schema
401 - Unauthorized	Empty

/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the Tuned

HTTP method

`DELETE`

Description

delete a Tuned

Query parameters

Parameter	Type	Description
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

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified Tuned

HTTP responses

HTTP code	Reponse body
200 - OK	Tuned schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified Tuned

Query parameters

Parameter	Type	Description
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.

HTTP responses

HTTP code	Reponse body
200 - OK	Tuned schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified Tuned

Query parameters

Parameter	Type	Description
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.

Body parameters

Parameter	Type	Description
body	Tuned schema

HTTP responses

HTTP code	Reponse body
200 - OK	Tuned schema
201 - Created	Tuned schema
401 - Unauthorized	Empty

/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the Tuned

HTTP method

`GET`

Description

read status of the specified Tuned

HTTP responses

HTTP code	Reponse body
200 - OK	Tuned schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified Tuned

Query parameters

Parameter	Type	Description
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.

HTTP responses

HTTP code	Reponse body
200 - OK	Tuned schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified Tuned

Query parameters

Parameter	Type	Description
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.

Body parameters

Parameter	Type	Description
body	Tuned schema

HTTP responses

HTTP code	Reponse body
200 - OK	Tuned schema
201 - Created	Tuned schema
401 - Unauthorized	Empty