Chapter 6. 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
6.1. Specification
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| 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 |
|
|
| TunedStatus is the status for a Tuned resource. |
6.1.1. .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 indicates whether the registry instance represented by this config instance is under operator management or not. Valid values are Force, Managed, Unmanaged, and Removed. |
|
|
| Tuned profiles. |
|
|
| A Tuned profile. |
|
|
| Selection logic for all Tuned profiles. |
|
|
| Selection logic for a single Tuned profile. |
6.1.2. .spec.profile
- Description
- Tuned profiles.
- Type
-
array
6.1.3. .spec.profile[]
- Description
- A Tuned profile.
- Type
-
object - Required
-
data -
name
-
| Property | Type | Description |
|---|---|---|
|
|
| Specification of the Tuned profile to be consumed by the Tuned daemon. |
|
|
| Name of the Tuned profile to be used in the recommend section. |
6.1.4. .spec.recommend
- Description
- Selection logic for all Tuned profiles.
- Type
-
array
6.1.5. .spec.recommend[]
- Description
- Selection logic for a single Tuned profile.
- Type
-
object - Required
-
priority -
profile
-
| Property | Type | Description |
|---|---|---|
|
|
| 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. |
|
|
| Rules governing application of a Tuned profile connected by logical OR operator. |
|
|
| Rules governing application of a Tuned profile. |
|
|
| Optional operand configuration. |
|
|
| Tuned profile priority. Highest priority is 0. |
|
|
| Name of the Tuned profile to recommend. |
6.1.6. .spec.recommend[].match
- Description
- Rules governing application of a Tuned profile connected by logical OR operator.
- Type
-
array
6.1.7. .spec.recommend[].match[]
- Description
- Rules governing application of a Tuned profile.
- Type
-
object - Required
-
label
-
| Property | Type | Description |
|---|---|---|
|
|
| Node or Pod label name. |
|
|
| Additional rules governing application of the tuned profile connected by logical AND operator. |
|
|
| Match type: [node/pod]. If omitted, "node" is assumed. |
|
|
| Node or Pod label value. If omitted, the presence of label name is enough to match. |
6.1.8. .spec.recommend[].operand
- Description
- Optional operand configuration.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| turn debugging on/off for the TuneD daemon: true/false (default is false) |
|
|
| Global configuration for the TuneD daemon as defined in tuned-main.conf |
6.1.9. .spec.recommend[].operand.tunedConfig
- Description
- Global configuration for the TuneD daemon as defined in tuned-main.conf
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| turn reapply_sysctl functionality on/off for the TuneD daemon: true/false |
6.1.10. .status
- Description
- TunedStatus is the status for a Tuned resource.
- Type
-
object
6.2. 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
-
6.2.1. /apis/tuned.openshift.io/v1/tuneds
- HTTP method
-
GET - Description
- list objects of kind Tuned
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
6.2.2. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds
- HTTP method
-
DELETE - Description
- delete collection of Tuned
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind Tuned
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create a Tuned
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
6.2.3. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the Tuned |
- HTTP method
-
DELETE - Description
- delete a Tuned
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified Tuned
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified Tuned
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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 code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified Tuned
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | Empty |
