×

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_v2

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

Property Type Description

additionalKernelArgs

array (string)

Addional 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"

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 addon 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.

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

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.

.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 addon 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

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

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

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

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

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

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

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.

realTime

boolean

RealTime defines if the node should be configured for the real time workload.

.status

Description

PerformanceProfileStatus defines the observed state of PerformanceProfile.

Type

object

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

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

Table 1. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete collection of PerformanceProfile

Table 2. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initi