// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="performanceprofile-performance-openshift-io-v2"]
= PerformanceProfile [performance.openshift.io/v2]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
PerformanceProfile is the Schema for the performanceprofiles API
--

Type::
  `object`



== Specification

[cols="1,1,1",options="header"]
|===
| 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`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| PerformanceProfileSpec defines the desired state of PerformanceProfile.

| `status`
| `object`
| PerformanceProfileStatus defines the observed state of PerformanceProfile.

|===
=== .spec
Description::
+
--
PerformanceProfileSpec defines the desired state of PerformanceProfile.
--

Type::
  `object`

Required::
  - `cpu`
  - `nodeSelector`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `additionalKernelArgs`
| `array (string)`
| Additional kernel arguments.

| `cpu`
| `object`
| CPU defines a set of CPU related parameters.

| `globallyDisableIrqLoadBalancing`
| `boolean`
| GloballyDisableIrqLoadBalancing toggles whether IRQ load balancing will be disabled for the Isolated CPU set.
When the option is set to "true" it disables IRQs load balancing for the Isolated CPU set.
Setting the option to "false" allows the IRQs to be balanced across all CPUs, however the IRQs load balancing
can be disabled per pod CPUs when using irq-load-balancing.crio.io/cpu-quota.crio.io annotations.
Defaults to "false"

| `hardwareTuning`
| `object`
| HardwareTuning defines a set of CPU frequencies for isolated and reserved cpus.

| `hugepages`
| `object`
| HugePages defines a set of huge pages related parameters.
It is possible to set huge pages with multiple size values at the same time.
For example, hugepages can be set with 1G and 2M, both values will be set on the node by the Performance Profile Controller.
It is important to notice that setting hugepages default size to 1G will remove all 2M related
folders from the node and it will be impossible to configure 2M hugepages under the node.

| `kernelPageSize`
| `string`
| KernelPageSize defines the kernel page size. 4k is the default, 64k is only supported on aarch64

| `machineConfigLabel`
| `object (string)`
| MachineConfigLabel defines the label to add to the MachineConfigs the operator creates. It has to be
used in the MachineConfigSelector of the MachineConfigPool which targets this performance profile.
Defaults to "machineconfiguration.openshift.io/role=<same role as in NodeSelector label key>"

| `machineConfigPoolSelector`
| `object (string)`
| MachineConfigPoolSelector defines the MachineConfigPool label to use in the MachineConfigPoolSelector
of resources like KubeletConfigs created by the operator.
Defaults to "machineconfiguration.openshift.io/role=<same role as in NodeSelector label key>"

| `net`
| `object`
| Net defines a set of network related features

| `nodeSelector`
| `object (string)`
| NodeSelector defines the Node label to use in the NodeSelectors of resources like Tuned created by the operator.
It most likely should, but does not have to match the node label in the NodeSelector of the MachineConfigPool
which targets this performance profile.
In the case when machineConfigLabels or machineConfigPoolSelector are not set, we are expecting a certain NodeSelector format
<domain>/<role>: "" in order to be able to calculate the default values for the former mentioned fields.

| `numa`
| `object`
| NUMA defines options related to topology aware affinities

| `realTimeKernel`
| `object`
| RealTimeKernel defines a set of real time kernel related parameters. RT kernel won't be installed when not set.

| `workloadHints`
| `object`
| WorkloadHints defines hints for different types of workloads. It will allow defining exact set of tuned and
kernel arguments that should be applied on top of the node.

|===
=== .spec.cpu
Description::
+
--
CPU defines a set of CPU related parameters.
--

Type::
  `object`

Required::
  - `isolated`
  - `reserved`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `balanceIsolated`
| `boolean`
| BalanceIsolated toggles whether or not the Isolated CPU set is eligible for load balancing work loads.
When this option is set to "false", the Isolated CPU set will be static, meaning workloads have to
explicitly assign each thread to a specific cpu in order to work across multiple CPUs.
Setting this to "true" allows workloads to be balanced across CPUs.
Setting this to "false" offers the most predictable performance for guaranteed workloads, but it
offloads the complexity of cpu load balancing to the application.
Defaults to "true"

| `isolated`
| `string`
| Isolated defines a set of CPUs that will be used to give to application threads the most execution time possible,
which means removing as many extraneous tasks off a CPU as possible.
It is important to notice the CPU manager can choose any CPU to run the workload
except the reserved CPUs. In order to guarantee that your workload will run on the isolated CPU:
  1. The union of reserved CPUs and isolated CPUs should include all online CPUs
  2. The isolated CPUs field should be the complementary to reserved CPUs field

| `offlined`
| `string`
| Offline defines a set of CPUs that will be unused and set offline

| `reserved`
| `string`
| Reserved defines a set of CPUs that will not be used for any container workloads initiated by kubelet.

| `shared`
| `string`
| Shared defines a set of CPUs that will be shared among guaranteed workloads
that needs additional cpus which are not exclusive,
alongside the isolated, exclusive resources that are being used already by those workloads.

|===
=== .spec.hardwareTuning
Description::
+
--
HardwareTuning defines a set of CPU frequencies for isolated and reserved cpus.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `isolatedCpuFreq`
| `integer`
| IsolatedCpuFreq defines a minimum frequency to be set across isolated cpus

| `reservedCpuFreq`
| `integer`
| ReservedCpuFreq defines a maximum frequency to be set across reserved cpus

|===
=== .spec.hugepages
Description::
+
--
HugePages defines a set of huge pages related parameters.
It is possible to set huge pages with multiple size values at the same time.
For example, hugepages can be set with 1G and 2M, both values will be set on the node by the Performance Profile Controller.
It is important to notice that setting hugepages default size to 1G will remove all 2M related
folders from the node and it will be impossible to configure 2M hugepages under the node.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `defaultHugepagesSize`
| `string`
| DefaultHugePagesSize defines huge pages default size under kernel boot parameters.

| `pages`
| `array`
| Pages defines huge pages that we want to allocate at boot time.

| `pages[]`
| `object`
| HugePage defines the number of allocated huge pages of the specific size.

|===
=== .spec.hugepages.pages
Description::
+
--
Pages defines huge pages that we want to allocate at boot time.
--

Type::
  `array`




=== .spec.hugepages.pages[]
Description::
+
--
HugePage defines the number of allocated huge pages of the specific size.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `count`
| `integer`
| Count defines amount of huge pages, maps to the 'hugepages' kernel boot parameter.

| `node`
| `integer`
| Node defines the NUMA node where hugepages will be allocated,
if not specified, pages will be allocated equally between NUMA nodes

| `size`
| `string`
| Size defines huge page size, maps to the 'hugepagesz' kernel boot parameter.

|===
=== .spec.net
Description::
+
--
Net defines a set of network related features
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `devices`
| `array`
| Devices contains a list of network device representations that will be
set with a netqueue count equal to CPU.Reserved .
If no devices are specified then the default is all devices.

| `devices[]`
| `object`
| Device defines a way to represent a network device in several options:
device name, vendor ID, model ID, PCI path and MAC address

| `userLevelNetworking`
| `boolean`
| UserLevelNetworking when enabled - sets either all or specified network devices queue size to the amount of reserved CPUs. Defaults to "false".

|===
=== .spec.net.devices
Description::
+
--
Devices contains a list of network device representations that will be
set with a netqueue count equal to CPU.Reserved .
If no devices are specified then the default is all devices.
--

Type::
  `array`




=== .spec.net.devices[]
Description::
+
--
Device defines a way to represent a network device in several options:
device name, vendor ID, model ID, PCI path and MAC address
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `deviceID`
| `string`
| Network device ID (model) represnted as a 16 bit hexmadecimal number.

| `interfaceName`
| `string`
| Network device name to be matched. It uses a syntax of shell-style wildcards which are either positive or negative.

| `vendorID`
| `string`
| Network device vendor ID represnted as a 16 bit Hexmadecimal number.

|===
=== .spec.numa
Description::
+
--
NUMA defines options related to topology aware affinities
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `topologyPolicy`
| `string`
| Name of the policy applied when TopologyManager is enabled
Operator defaults to "best-effort"

|===
=== .spec.realTimeKernel
Description::
+
--
RealTimeKernel defines a set of real time kernel related parameters. RT kernel won't be installed when not set.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `enabled`
| `boolean`
| Enabled defines if the real time kernel packages should be installed. Defaults to "false"

|===
=== .spec.workloadHints
Description::
+
--
WorkloadHints defines hints for different types of workloads. It will allow defining exact set of tuned and
kernel arguments that should be applied on top of the node.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `highPowerConsumption`
| `boolean`
| HighPowerConsumption defines if the node should be configured in high power consumption mode.
The flag will affect the power consumption but will improve the CPUs latency. Defaults to false.

| `mixedCpus`
| `boolean`
| MixedCpus enables the mixed-cpu-node-plugin on the node.
Defaults to false.

| `perPodPowerManagement`
| `boolean`
| PerPodPowerManagement defines if the node should be configured in per pod power management.
PerPodPowerManagement and HighPowerConsumption hints can not be enabled together. Defaults to false.

| `realTime`
| `boolean`
| RealTime defines if the node should be configured for the real time workload. Defaults to true.

|===
=== .status
Description::
+
--
PerformanceProfileStatus defines the observed state of PerformanceProfile.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `conditions`
| `array`
| Conditions represents the latest available observations of current state.

| `conditions[]`
| `object`
| Condition represents the state of the operator's
reconciliation functionality.

| `runtimeClass`
| `string`
| RuntimeClass contains the name of the RuntimeClass resource created by the operator.

| `tuned`
| `string`
| Tuned points to the Tuned custom resource object that contains the tuning values generated by this operator.

|===
=== .status.conditions
Description::
+
--
Conditions represents the latest available observations of current state.
--

Type::
  `array`




=== .status.conditions[]
Description::
+
--
Condition represents the state of the operator's
reconciliation functionality.
--

Type::
  `object`

Required::
  - `status`
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `lastHeartbeatTime`
| `string`
| 

| `lastTransitionTime`
| `string`
| 

| `message`
| `string`
| 

| `reason`
| `string`
| 

| `status`
| `string`
| 

| `type`
| `string`
| ConditionType is the state of the operator's reconciliation functionality.

|===

== API endpoints

The following API endpoints are available:

* `/apis/performance.openshift.io/v2/performanceprofiles`
- `DELETE`: delete collection of PerformanceProfile
- `GET`: list objects of kind PerformanceProfile
- `POST`: create a PerformanceProfile
* `/apis/performance.openshift.io/v2/performanceprofiles/{name}`
- `DELETE`: delete a PerformanceProfile
- `GET`: read the specified PerformanceProfile
- `PATCH`: partially update the specified PerformanceProfile
- `PUT`: replace the specified PerformanceProfile
* `/apis/performance.openshift.io/v2/performanceprofiles/{name}/status`
- `GET`: read status of the specified PerformanceProfile
- `PATCH`: partially update status of the specified PerformanceProfile
- `PUT`: replace status of the specified PerformanceProfile


=== /apis/performance.openshift.io/v2/performanceprofiles



HTTP method::
  `DELETE`

Description::
  delete collection of PerformanceProfile




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  list objects of kind PerformanceProfile




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-performance-v2-PerformanceProfileList[`PerformanceProfileList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a PerformanceProfile


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 201 - Created
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 202 - Accepted
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/performance.openshift.io/v2/performanceprofiles/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the PerformanceProfile
|===


HTTP method::
  `DELETE`

Description::
  delete a PerformanceProfile


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified PerformanceProfile




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified PerformanceProfile


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified PerformanceProfile


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 201 - Created
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/performance.openshift.io/v2/performanceprofiles/{name}/status

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the PerformanceProfile
|===


HTTP method::
  `GET`

Description::
  read status of the specified PerformanceProfile




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified PerformanceProfile


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified PerformanceProfile


.Query parameters
[cols="1,1,2",options="header"]
|===
| 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
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 201 - Created
| xref:../node_apis/performanceprofile-performance-openshift-io-v2.adoc#performanceprofile-performance-openshift-io-v2[`PerformanceProfile`] schema
| 401 - Unauthorized
| Empty
|===


