节点 API

OpenShift Container Platform 4.17

节点 API 的参考指南

Red Hat OpenShift Documentation Team

法律通告

摘要

本文档描述了 OpenShift Container Platform 节点 API 对象及其详细规格。

第 1 章节点 API

1.1. Node [v1]

描述: 节点是 Kubernetes 中的 worker 节点。每个节点在缓存中都有一个唯一标识符（例如在 etcd 中）。
类型: object

1.2. PerformanceProfile [performance.openshift.io/v2]

描述: PerformanceProfile 是 performanceprofiles API 的 Schema
类型: 对象

1.3. Profile [tuned.openshift.io/v1]

描述: profile 是 Profile 资源的规格。
类型: 对象

1.4. RuntimeClass [node.k8s.io/v1]

描述: RuntimeClass 定义集群中支持的容器运行时类。RuntimeClass 用于决定使用哪个容器运行时来运行 pod 中的所有容器。runtimeclasses 由用户或集群置备程序手动定义，并在 PodSpec 中引用。Kubelet 负责在运行 pod 前解析 RuntimeClassName 引用。如需了解更多详细信息，请参阅 https://kubernetes.io/docs/concepts/containers/runtime-class/
类型: 对象

1.5. Tuned [tuned.openshift.io/v1]

描述: TuneD 是一组规则，允许集群范围的节点级 sysctl 部署，并更灵活添加用户需求指定的自定义性能优化。这些规则会被转换并传递给集群中运行的所有容器化 Tuned 守护进程，格式为守护进程了解的格式。然后，应用节点级别的调优的职责在于容器化的 Tuned 守护进程。更多信息： https://github.com/openshift/cluster-node-tuning-operator
类型: 对象

第 2 章 Node [v1]

描述: 节点是 Kubernetes 中的 worker 节点。每个节点在缓存中都有一个唯一标识符（例如在 etcd 中）。
类型: 对象

2.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	nodeSpec 描述了创建节点的属性。
`status`	`对象`	NodeStatus 显示有关节点当前状态的信息。

2.1.1. .spec

描述: nodeSpec 描述了创建节点的属性。
类型: object

属性	类型	描述
`configSource`	`对象`	NodeConfigSource 指定节点配置的来源。只有一个子字段（不包括元数据）必须是非il。此 API 从 1.22 开始已弃用
`externalID`	`字符串`	已弃用。并非所有 kubelet 将设置此字段。在 1.13 后删除字段，请参阅：https://issues.k8s.io/61966
`podCIDR`	`字符串`	PodCIDR 代表分配给节点的 pod IP 范围。
`podCIDRs`	`数组（字符串）`	podCIDRs 代表分配给节点的 IP 范围，供该节点上的 Pod 使用。如果指定了此字段，则 0th 条目必须与 podCIDR 字段匹配。它最多可包含每个 IPv4 和 IPv6 的 1 值。
`providerID`	`字符串`	由云供应商分配的节点的 ID，格式为： <ProviderName>://<ProviderSpecificNodeID>
`污点`	`array`	如果指定，节点的污点。
`taints[]`	`对象`	此 Taint 附加到任何不容许 Taint 的 pod 上的"effect"的节点。
`不可调度`	`布尔值`	不可调度控制新 pod 的节点调度性。默认情况下，节点可以调度。更多信息： https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

2.1.2. .spec.configSource

描述: NodeConfigSource 指定节点配置的来源。只有一个子字段（不包括元数据）必须是非il。此 API 从 1.22 开始已弃用
类型: object

属性	类型	描述
`configMap`	`对象`	ConfigMapNodeConfigSource 包含将 ConfigMap 引用为节点配置源的信息。此 API 从 1.22 开始已弃用： https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

2.1.3. .spec.configSource.configMap

描述

ConfigMapNodeConfigSource 包含将 ConfigMap 引用为节点配置源的信息。此 API 从 1.22 开始已弃用： https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

类型

object

必填

namespace
name
kubeletConfigKey

属性	类型	描述
`kubeletConfigKey`	`字符串`	KubeletConfigKey 声明引用 ConfigMap 的键对应于 KubeletConfiguration 结构此字段。
`name`	`字符串`	name 是引用的 ConfigMap 的 metadata.name。所有情况下都需要此字段。
`namespace`	`字符串`	namespace 是引用的 ConfigMap 的 metadata.namespace。所有情况下都需要此字段。
`resourceVersion`	`字符串`	resourceVersion 是引用的 ConfigMap 的 metadata.ResourceVersion。此字段在 Node.Spec 中禁止，在 Node.Status 中需要。
`uid`	`字符串`	UID 是引用的 ConfigMap 的 metadata.UID。此字段在 Node.Spec 中禁止，在 Node.Status 中需要。

2.1.4. .spec.taints

描述: 如果指定，节点的污点。
类型: array

2.1.5. .spec.taints[]

描述

此 Taint 附加到任何不容许 Taint 的 pod 上的"effect"的节点。

类型

object

必填

key
effect

属性	类型	描述
`effect`	`字符串`	必需。污点对不容许该污点的 pod 的影响。有效效果为 NoSchedule、PreferNoSchedule 和 NoExecute。可能枚举值： - `"NoExecute"` Evict any already-running pod 不容许该污点。目前，由 NodeController 强制执行 - `"NoSchedule"` 不允许新 pod 调度到该节点上，除非容许污点，但允许所有提交至 Kubelet 的 pod 而无需通过调度程序启动，并允许所有已在运行的 pod 继续运行。由调度程序强制执行。- `"PreferNoSchedule"` Like TaintEffectNoSchedule，但调度程序不会将新 pod 调度到该节点上，而不是阻止新 pod 完全调度到该节点上。由调度程序实施。
`key`	`字符串`	必需。要应用到节点的污点键。
`timeAdded`	`时间`	TimeAdded 代表添加污点的时间。它仅针对 NoExecute 污点编写。
`value`	`字符串`	与污点键对应的污点值。

2.1.6. .status

描述: NodeStatus 显示有关节点当前状态的信息。
类型: object

属性	类型	描述
`addresses`	`array`	节点可访问的地址列表。从云供应商查询（如果可用）。更多信息： https://kubernetes.io/docs/concepts/nodes/node/#addresses 注意：此字段声明为可合并的，但合并密钥不够唯一，这可能会在合并时造成数据崩溃。调用者应该使用 full-replacement 补丁。如需示例，请参阅 https://pr.k8s.io/79391。消费者应假定地址可在节点生命周期内发生更改。但是，有些例外情况可能无法正常工作，例如，在 Downward API (status.hostIP)中继承节点地址的 Pod。
`addresses[]`	`对象`	NodeAddress 包含节点地址的信息。
`allocatable`	`对象（数量）`	allocatable 代表可用于调度的节点的资源。默认为 Capacity。
`capacity`	`对象（数量）`	Capacity 代表节点的总资源。更多信息： https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
`conditions`	`array`	条件是当前观察到的节点条件的数组。更多信息： https://kubernetes.io/docs/concepts/nodes/node/#condition
`conditions[]`	`对象`	NodeCondition 包含节点的条件信息。
`config`	`对象`	NodeConfigStatus 描述了 Node.Spec.ConfigSource 分配的配置状态。
`daemonEndpoints`	`对象`	NodeDaemonEndpoints 列出了由节点上运行的守护进程打开的端口。
`images`	`array`	此节点上的容器镜像列表
`images[]`	`对象`	描述容器镜像
`nodeInfo`	`对象`	NodeSystemInfo 是一组 ids/uuids，用于唯一标识节点。
`phase`	`字符串`	NodePhase 是节点最近观察到的生命周期阶段。更多信息： https://kubernetes.io/docs/concepts/nodes/node/#phase 字段永不填充，现在已弃用。可能枚举值： - `"Pending"` 表示节点已被系统创建/添加，但没有配置。- `"Running"` 表示节点已经配置并正在运行 Kubernetes 组件。- `"Terminated"` 表示节点已经从集群中移除。
`runtimeHandlers`	`数组`	可用的运行时处理程序。
`runtimeHandlers[]`	`object`	NodeRuntimeHandler 是一组运行时处理程序信息。
`volumesAttached`	`array`	附加到节点的卷列表。
`volumesAttached[]`	`对象`	AttachedVolume 描述了附加到节点的卷
`volumesInUse`	`数组（字符串）`	节点使用的可附加卷列表（挂载）。

2.1.7. .status.addresses

描述: 节点可访问的地址列表。从云供应商查询（如果可用）。更多信息： https://kubernetes.io/docs/concepts/nodes/node/#addresses 注意：此字段声明为可合并的，但合并密钥不够唯一，这可能会在合并时造成数据崩溃。调用者应该使用 full-replacement 补丁。如需示例，请参阅 https://pr.k8s.io/79391。消费者应假定地址可在节点生命周期内发生更改。但是，有些例外情况可能无法正常工作，例如，在 Downward API (status.hostIP)中继承节点地址的 Pod。
类型: array

2.1.8. .status.addresses[]

描述

NodeAddress 包含节点地址的信息。

类型

object

必填

type
address

属性	类型	描述
`address`	`字符串`	节点地址。
`type`	`字符串`	节点地址类型，一个用于 Hostname、ExternalIP 或 InternalIP 之一。

2.1.9. .status.conditions

描述: 条件是当前观察到的节点条件的数组。更多信息： https://kubernetes.io/docs/concepts/nodes/node/#condition
类型: array

2.1.10. .status.conditions[]

描述

NodeCondition 包含节点的条件信息。

类型

object

必填

type
status

属性	类型	描述
`lastHeartbeatTime`	`时间`	在给定条件上有更新的时间。
`lastTransitionTime`	`时间`	条件从一个状态传输到另一个状态最后一次的时间。
`message`	`字符串`	人类可读的消息，指示最后一次转换的详细信息。
`reason`	`字符串`	(brief)条件最后一次转换的原因。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	节点状况的类型。

2.1.11. .status.config

描述: NodeConfigStatus 描述了 Node.Spec.ConfigSource 分配的配置状态。
类型: object

属性	类型	描述
`active`	`对象`	NodeConfigSource 指定节点配置的来源。只有一个子字段（不包括元数据）必须是非il。此 API 从 1.22 开始已弃用
`assigned`	`对象`	NodeConfigSource 指定节点配置的来源。只有一个子字段（不包括元数据）必须是非il。此 API 从 1.22 开始已弃用
`错误`	`字符串`	错误描述了将 Spec.ConfigSource 协调到 Active 配置中的任何问题。可能会出现错误，例如尝试检查点 Spec.ConfigSource 到本地分配记录，尝试检查点与 Spec.ConfigSource 关联的有效负载，尝试加载或验证分配的配置等。同步配置时在不同点上可能会出现错误。以前的错误（如下载或检查点错误）不会导致回滚到 LastKnownGood，并可能会在 Kubelet 重试过程中解决。之后的错误（如加载或验证检查点的配置）将导致回滚到 LastKnownGood。在后者的情况下，通常可以通过修复 Spec.ConfigSource 中分配的配置来解决这个问题。您可以通过在 Kubelet 日志中搜索错误消息来查找用于调试的额外信息。错误是错误状态人类可读的描述；机器可以检查 Error 是否为空，但应该不依赖于 Kubelet 版本中的 Error 文本的稳定性。
`lastKnownGood`	`对象`	NodeConfigSource 指定节点配置的来源。只有一个子字段（不包括元数据）必须是非il。此 API 从 1.22 开始已弃用

2.1.12. .status.config.active

描述: NodeConfigSource 指定节点配置的来源。只有一个子字段（不包括元数据）必须是非il。此 API 从 1.22 开始已弃用
类型: object

属性	类型	描述
`configMap`	`对象`	ConfigMapNodeConfigSource 包含将 ConfigMap 引用为节点配置源的信息。此 API 从 1.22 开始已弃用： https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

2.1.13. .status.config.active.configMap

描述

ConfigMapNodeConfigSource 包含将 ConfigMap 引用为节点配置源的信息。此 API 从 1.22 开始已弃用： https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

类型

object

必填

namespace
name
kubeletConfigKey

属性	类型	描述
`kubeletConfigKey`	`字符串`	KubeletConfigKey 声明引用 ConfigMap 的键对应于 KubeletConfiguration 结构此字段。
`name`	`字符串`	name 是引用的 ConfigMap 的 metadata.name。所有情况下都需要此字段。
`namespace`	`字符串`	namespace 是引用的 ConfigMap 的 metadata.namespace。所有情况下都需要此字段。
`resourceVersion`	`字符串`	resourceVersion 是引用的 ConfigMap 的 metadata.ResourceVersion。此字段在 Node.Spec 中禁止，在 Node.Status 中需要。
`uid`	`字符串`	UID 是引用的 ConfigMap 的 metadata.UID。此字段在 Node.Spec 中禁止，在 Node.Status 中需要。

2.1.14. .status.config.assigned

描述: NodeConfigSource 指定节点配置的来源。只有一个子字段（不包括元数据）必须是非il。此 API 从 1.22 开始已弃用
类型: object

属性	类型	描述
`configMap`	`对象`	ConfigMapNodeConfigSource 包含将 ConfigMap 引用为节点配置源的信息。此 API 从 1.22 开始已弃用： https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

2.1.15. .status.config.assigned.configMap

描述

ConfigMapNodeConfigSource 包含将 ConfigMap 引用为节点配置源的信息。此 API 从 1.22 开始已弃用： https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

类型

object

必填

namespace
name
kubeletConfigKey

属性	类型	描述
`kubeletConfigKey`	`字符串`	KubeletConfigKey 声明引用 ConfigMap 的键对应于 KubeletConfiguration 结构此字段。
`name`	`字符串`	name 是引用的 ConfigMap 的 metadata.name。所有情况下都需要此字段。
`namespace`	`字符串`	namespace 是引用的 ConfigMap 的 metadata.namespace。所有情况下都需要此字段。
`resourceVersion`	`字符串`	resourceVersion 是引用的 ConfigMap 的 metadata.ResourceVersion。此字段在 Node.Spec 中禁止，在 Node.Status 中需要。
`uid`	`字符串`	UID 是引用的 ConfigMap 的 metadata.UID。此字段在 Node.Spec 中禁止，在 Node.Status 中需要。

2.1.16. .status.config.lastKnownGood

描述: NodeConfigSource 指定节点配置的来源。只有一个子字段（不包括元数据）必须是非il。此 API 从 1.22 开始已弃用
类型: object

属性	类型	描述
`configMap`	`对象`	ConfigMapNodeConfigSource 包含将 ConfigMap 引用为节点配置源的信息。此 API 从 1.22 开始已弃用： https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

2.1.17. .status.config.lastKnownGood.configMap

描述

ConfigMapNodeConfigSource 包含将 ConfigMap 引用为节点配置源的信息。此 API 从 1.22 开始已弃用： https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

类型

object

必填

namespace
name
kubeletConfigKey

属性	类型	描述
`kubeletConfigKey`	`字符串`	KubeletConfigKey 声明引用 ConfigMap 的键对应于 KubeletConfiguration 结构此字段。
`name`	`字符串`	name 是引用的 ConfigMap 的 metadata.name。所有情况下都需要此字段。
`namespace`	`字符串`	namespace 是引用的 ConfigMap 的 metadata.namespace。所有情况下都需要此字段。
`resourceVersion`	`字符串`	resourceVersion 是引用的 ConfigMap 的 metadata.ResourceVersion。此字段在 Node.Spec 中禁止，在 Node.Status 中需要。
`uid`	`字符串`	UID 是引用的 ConfigMap 的 metadata.UID。此字段在 Node.Spec 中禁止，在 Node.Status 中需要。

2.1.18. .status.daemonEndpoints

描述: NodeDaemonEndpoints 列出了由节点上运行的守护进程打开的端口。
类型: object

属性	类型	描述
`kubeletEndpoint`	`对象`	DaemonEndpoint 包含有关单个守护进程端点的信息。

2.1.19. .status.daemonEndpoints.kubeletEndpoint

描述

DaemonEndpoint 包含有关单个守护进程端点的信息。

类型

object

必填

端口

属性	类型	描述
`端口`	`整数`	给定端点的端口号。

2.1.20. .status.images

描述: 此节点上的容器镜像列表
类型: array

2.1.21. .status.images[]

描述: 描述容器镜像
类型: object

属性	类型	描述
`names`	`数组（字符串）`	此镜像已知的名称。例如 ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]
`sizeBytes`	`整数`	以字节为单位镜像的大小。

2.1.22. .status.nodeInfo

描述

NodeSystemInfo 是一组 ids/uuids，用于唯一标识节点。

类型

object

必填

machineID
systemUUID
bootID
kernelVersion
osImage
containerRuntimeVersion
kubeletVersion
kubeProxyVersion
operatingSystem
架构

属性	类型	描述
`架构`	`字符串`	节点报告的构架
`bootID`	`字符串`	节点报告的引导 ID。
`containerRuntimeVersion`	`string`	通过运行时远程 API （如 containerd://1.4.2）报告的 containerruntime Version。
`kernelVersion`	`字符串`	节点从 'uname -r' 报告的内核版本（如 3.16.0-0.bpo.4-amd64）。
`kubeProxyVersion`	`字符串`	节点报告的 kubeProxy 版本。
`kubeletVersion`	`字符串`	节点报告的 kubelet 版本。
`machineID`	`字符串`	节点报告的 MachineID。对于集群中唯一机器识别，首选此字段。从 man (5) machine-id 了解更多：http://man7.org/linux/man-pages/man5/machine-id.5.html
`operatingSystem`	`字符串`	节点报告的操作系统
`osImage`	`字符串`	节点从 /etc/os-release （如 Debian GNU/Linux 7 (wheezy)）报告的操作系统镜像。
`systemUUID`	`字符串`	节点报告的 SystemUUID。对于唯一机器识别 MachineID，首选使用。该字段特定于红帽主机 https://access.redhat.com/documentation/zh-cn/red_hat_subscription_management/1/html/rhsm/uuid

2.1.23. .status.runtimeHandlers

描述: 可用的运行时处理程序。
类型: 数组

2.1.24. .status.runtimeHandlers[]

描述: NodeRuntimeHandler 是一组运行时处理程序信息。
类型: object

属性	类型	描述
`功能`	`object`	NodeRuntimeHandlerFeatures 是一组运行时功能。
`名称`	`string`	运行时处理程序名称。默认运行时处理程序为空。

2.1.25. .status.runtimeHandlers[].features

描述: NodeRuntimeHandlerFeatures 是一组运行时功能。
类型: object

属性	类型	描述
`recursiveReadOnlyMounts`	`布尔值`	如果运行时处理程序支持 RecursiveReadOnlyMounts，则 RecursiveReadOnlyMounts 被设置为 true。

2.1.26. .status.volumesAttached

描述: 附加到节点的卷列表。
类型: array

2.1.27. .status.volumesAttached[]

描述

AttachedVolume 描述了附加到节点的卷

类型

object

必填

name
devicePath

属性	类型	描述
`devicePath`	`字符串`	DevicePath 代表卷应该可用的设备路径
`name`	`字符串`	附加卷的名称

2.2. API 端点

可用的 API 端点如下：

/api/v1/nodes
- DELETE ：删除节点集合
- GET ：列出或监视类型为 Node 的对象
- POST ：创建节点
/api/v1/watch/nodes
- GET: 观察单个对 Node 列表的更改。已弃用：改为使用 'watch' 参数及列表操作。
/api/v1/nodes/{name}
- DELETE ：删除节点
- GET ：读取指定的节点
- PATCH: 部分更新指定节点
- PUT ：替换指定的节点
/api/v1/watch/nodes/{name}
- GET: 观察对类型为 Node 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。
/api/v1/nodes/{name}/status
- GET ：指定节点的读取状态
- PATCH: 部分更新指定节点的状态
- PUT ：替换指定节点的状态

2.2.1. /api/v1/nodes

HTTP 方法: DELETE
描述: 删除节点集合

表 2.1. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 2.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出或监视类型为 Node 的对象

表 2.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`NodeList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建节点

表 2.4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.5. 主体参数
参数	类型	描述
`正文（body）`	`Node` 模式

表 2.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
201 - Created	`Node` 模式
202 - Accepted	`Node` 模式
401 - Unauthorized	空

2.2.2. /api/v1/watch/nodes

HTTP 方法: GET
描述: 观察单个对节点列表的更改。已弃用：改为使用 'watch' 参数及列表操作。

表 2.7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

2.2.3. /api/v1/nodes/{name}

表 2.8. 全局路径参数
参数	类型	描述
`name`	`字符串`	节点的名称

HTTP 方法: DELETE
描述: 删除节点

表 2.9. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 2.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的节点

表 2.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定节点

表 2.12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
201 - Created	`Node` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的节点

表 2.14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.15. 主体参数
参数	类型	描述
`正文（body）`	`Node` 模式

表 2.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
201 - Created	`Node` 模式
401 - Unauthorized	空

2.2.4. /api/v1/watch/nodes/{name}

表 2.17. 全局路径参数
参数	类型	描述
`name`	`字符串`	节点的名称

HTTP 方法: GET
描述: 观察对类型为 Node 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。

表 2.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

2.2.5. /api/v1/nodes/{name}/status

表 2.19. 全局路径参数
参数	类型	描述
`name`	`字符串`	节点的名称

HTTP 方法: GET
描述: 指定节点的读取状态

表 2.20. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定节点的状态

表 2.21. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
201 - Created	`Node` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定节点的状态

表 2.23. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 2.24. 主体参数
参数	类型	描述
`正文（body）`	`Node` 模式

表 2.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
201 - Created	`Node` 模式
401 - Unauthorized	空

第 3 章 PerformanceProfile [performance.openshift.io/v2]

描述: PerformanceProfile 是 performanceprofiles API 的 Schema
类型: 对象

3.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	PerformanceProfileSpec 定义 PerformanceProfile 的所需状态。
`status`	`object`	PerformanceProfileStatus 定义 PerformanceProfile 的观察状态。

3.1.1. .spec

描述

PerformanceProfileSpec 定义 PerformanceProfile 的所需状态。

类型

object

必填

cpu
nodeSelector

属性	类型	描述
`additionalKernelArgs`	`数组（字符串）`	其他内核参数。
`cpu`	`object`	CPU 定义一组与 CPU 相关的参数。
`globallyDisableIrqLoadBalancing`	`布尔值`	globallyDisableIrqLoadBalancing 切换在 Isolated CPU 集合中是否禁用 IRQ 负载均衡。当选项设置为 "true" 时，它会禁用 Isolated CPU 集的 IRQs 负载均衡。将选项设置为 "false" 允许在所有 CPU 之间平衡 IRQ，但使用 irq-load-balancing.crio.io/cpu-quota.crio.io 注解时，可以禁用 IRQs 负载均衡。默认为 "false"
`hardwareTuning`	`object`	HardwareTuning 为 isolated 和 reserved cpus 定义一组 CPU 频率。
`hugepages`	`object`	hugepages 定义一组与巨页相关的参数。可以同时使用多个大小值同时设置巨页。例如，巨页可以使用 1G 和 2M 设置，两个值都由 Performance Profile Controller 在节点上设置。务必要注意，将 hugepages 默认大小设置为 1G 将从节点中删除所有 2M 相关文件夹，因此无法在节点下配置 2M 巨页。
`machineConfigLabel`	`对象（字符串）`	MachineConfigLabel 定义添加到 Operator 创建的 MachineConfig 的标签。它必须在以这个性能配置集为目标的 MachineConfigPool 的 MachineConfigSelector 中使用。默认为 "machineconfiguration.openshift.io/role=<same 角色，如 NodeSelector label key>"
`machineConfigPoolSelector`	`对象（字符串）`	MachineConfigPoolSelector 定义在 Operator 创建的 KubeletConfigs 等资源的 MachineConfigPoolSelector 中使用的 MachineConfigPool 标签。默认为 "machineconfiguration.openshift.io/role=<same 角色，如 NodeSelector label key>"
`net`	`object`	net 定义一组与网络相关的功能
`nodeSelector`	`对象（字符串）`	nodeSelector 定义在 Operator 创建的 Tuned 等资源的 NodeSelectors 中使用的 Node 标签。最有可能，但不一定与 MachineConfigPool 的 NodeSelector 中的节点标签匹配，后者以这个性能配置集为目标。如果没有设置 machineConfigLabels 或 machineConfigPoolSelector，我们会期望特定的 NodeSelector 格式 <domain>/<role>: "" 来计算前提到的字段的默认值。
`numa`	`object`	NUMA 定义与拓扑感知相关的选项
`realTimeKernel`	`object`	realTimeKernel 定义一组实时内核相关参数。未设置时不会安装 RT 内核。
`workloadHints`	`object`	workloadHints 为不同类型的工作负载定义提示。它允许定义应在节点之上应用的 tuned 和内核参数集。

3.1.2. .spec.cpu

描述

CPU 定义一组与 CPU 相关的参数。

类型

object

必填

已隔离
reserved

属性	类型	描述
`balanceIsolated`	`布尔值`	BalanceIsolated 切换切换 Isolated CPU 集是否有资格进行负载均衡工作负载。当此选项设置为 "false" 时，Isolated CPU 集为静态，这意味着工作负载必须明确将每个线程分配给特定的 cpu，才能在多个 CPU 之间工作。把它设置为 "true" 允许在 CPU 之间平衡工作负载。把它设置为 "false" 为保证的工作负载提供最可预测的性能，但它会将 cpu 负载均衡的复杂性卸载到应用程序。默认值为 "true"
`已隔离`	`string`	isolated 定义一组 CPU，它们将用来为应用程序线程提供最可能执行时间，这意味着尽可能删除 CPU 的许多额外任务。务必要注意，CPU 管理器可以选择任何 CPU 来运行工作负载，但保留 CPU 除外。为确保工作负载在隔离的 CPU 上运行：1.保留 CPU 和隔离的 CPU 的 union 应该包括所有在线 CPU 2。隔离的 CPU 字段应当是保留的 CPU 字段的补充
`offlined`	`string`	offline 定义一组未使用的 CPU 并离线设置
`reserved`	`string`	reserved 定义一组不会用于 kubelet 启动的任何容器工作负载的 CPU。
`shared`	`string`	共享定义一组在保证工作负载之间共享的 CPU，这些 CPU 需要额外的不是专用的 cpu，以及被这些工作负载已使用的专用资源。

3.1.3. .spec.hardwareTuning

描述: HardwareTuning 为 isolated 和 reserved cpus 定义一组 CPU 频率。
类型: object

属性	类型	描述
`isolatedCpuFreq`	`整数`	IsolatedCpuFreq 定义在隔离的 cpu 中设置的最小频率
`reservedCpuFreq`	`整数`	ReservedCpuFreq 定义在保留 cpus 中设置的最大频率

3.1.4. .spec.hugepages

描述: hugepages 定义一组与巨页相关的参数。可以同时使用多个大小值同时设置巨页。例如，巨页可以使用 1G 和 2M 设置，两个值都由 Performance Profile Controller 在节点上设置。务必要注意，将 hugepages 默认大小设置为 1G 将从节点中删除所有 2M 相关文件夹，因此无法在节点下配置 2M 巨页。
类型: object

属性	类型	描述
`defaultHugepagesSize`	`string`	DefaultHugePagesSize 在内核引导参数下定义巨页默认大小。
`pages`	`数组`	页面定义我们要在引导时分配的巨页。
`pages[]`	`object`	巨页定义了分配特定大小的巨页数量。

3.1.5. .spec.hugepages.pages

描述: 页面定义我们要在引导时分配的巨页。
类型: 数组

3.1.6. .spec.hugepages.pages[]

描述: 巨页定义了分配特定大小的巨页数量。
类型: object

属性	类型	描述
`数量`	`整数`	count 定义巨页量，映射到"hugepages"内核引导参数。
`node`	`整数`	节点定义在 NUMA 节点之间分配巨页的 NUMA 节点（如果未指定），则会在 NUMA 节点之间平均分配页面
`size`	`string`	大小定义巨页大小，映射到 'hugepagesz' 内核引导参数。

3.1.7. .spec.net

描述: net 定义一组与网络相关的功能
类型: object

属性	类型	描述
`devices`	`数组`	devices 包含网络设备表示列表，其网络队列数等于 CPU.Reserved。如果没有指定设备，则默认为所有设备。
`devices[]`	`object`	device 定义在多个选项中代表网络设备的方法：设备名称、厂商 ID、型号 ID、PCI 路径和 MAC 地址
`userLevelNetworking`	`布尔值`	启用 userLevelNetworking - 将 all 或指定的网络设备队列大小设置为保留 CPU 的数量。默认为 "false"。

3.1.8. .spec.net.devices

描述: devices 包含网络设备表示列表，其网络队列数等于 CPU.Reserved。如果没有指定设备，则默认为所有设备。
类型: 数组

3.1.9. .spec.net.devices[]

描述: device 定义在多个选项中代表网络设备的方法：设备名称、厂商 ID、型号 ID、PCI 路径和 MAC 地址
类型: object

属性	类型	描述
`deviceID`	`string`	网络设备 ID (model)被重新命名为 16 位十六进制数。
`interfaceName`	`string`	要匹配的网络设备名称。它使用 shell 风格的通配符语法，可以是正数或负数。
`vendorID`	`string`	网络设备厂商 ID 被称为 16 位 Hexmadecimal 号码。

3.1.10. .spec.numa

描述: NUMA 定义与拓扑感知相关的选项
类型: object

属性	类型	描述
`topologyPolicy`	`string`	当 TopologyManager 启用 Operator 时应用策略的名称，默认为 "best-effort"

3.1.11. .spec.realTimeKernel

描述: realTimeKernel 定义一组实时内核相关参数。未设置时不会安装 RT 内核。
类型: object

属性	类型	描述
`enabled`	`布尔值`	enabled 定义是否应安装实时内核软件包。默认为 "false"

3.1.12. .spec.workloadHints

描述: workloadHints 为不同类型的工作负载定义提示。它允许定义应在节点之上应用的 tuned 和内核参数集。
类型: object

属性	类型	描述
`highPowerConsumption`	`布尔值`	highPowerConsumption 定义节点是否应该以高功耗模式配置。标志将影响功耗，但会提高 CPU 延迟。默认为false。
`mixedCpus`	`布尔值`	MixedCpus 在节点上启用 mixed-cpu-node-plugin。默认为false。
`perPodPowerManagement`	`布尔值`	perPodPowerManagement 定义是否应在每个 pod 电源管理中配置节点。perPodPowerManagement 和 HighPowerConsumption hints 无法同时启用。默认为false。
`realTime`	`布尔值`	realtime 定义是否应为实时工作负载配置节点。默认值为 true。

3.1.13. .status

描述: PerformanceProfileStatus 定义 PerformanceProfile 的观察状态。
类型: object

属性	类型	描述
`conditions`	`数组`	条件代表当前状态的最新可用影响。
`conditions[]`	`object`	condition 代表 Operator 的协调功能的状态。
`runtimeClass`	`string`	RuntimeClass 包含 Operator 创建的 RuntimeClass 资源的名称。
`tuned`	`string`	TuneD 指向 Tuned 自定义资源对象，其中包含此 Operator 生成的调优值。

3.1.14. .status.conditions

描述: 条件代表当前状态的最新可用影响。
类型: array

3.1.15. .status.conditions[]

描述

condition 代表 Operator 的协调功能的状态。

类型

object

必填

status
type

属性	类型	描述
`lastHeartbeatTime`	`string`
`lastTransitionTime`	`字符串`
`message`	`字符串`
`reason`	`字符串`
`status`	`字符串`
`type`	`string`	conditionType 是 Operator 的协调功能的状态。

3.2. API 端点

可用的 API 端点如下：

/apis/performance.openshift.io/v2/performanceprofiles
- DELETE: 删除 PerformanceProfile 集合
- GET: 列出类型为 PerformanceProfile 的对象
- POST ：创建 PerformanceProfile
/apis/performance.openshift.io/v2/performanceprofiles/{name}
- DELETE ：删除 PerformanceProfile
- GET ：读取指定的 PerformanceProfile
- PATCH: 部分更新指定的 PerformanceProfile
- PUT ：替换指定的 PerformanceProfile
/apis/performance.openshift.io/v2/performanceprofiles/{name}/status
- GET ：指定 PerformanceProfile 的读取状态
- PATCH: 部分更新指定 PerformanceProfile 的状态
- PUT ：替换指定 PerformanceProfile 的状态

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

HTTP 方法: DELETE
描述: 删除 PerformanceProfile 集合

表 3.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出类型为 PerformanceProfile 的对象

表 3.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PerformanceProfileList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 PerformanceProfile

表 3.3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.4. 主体参数
参数	类型	描述
`正文（body）`	`PerformanceProfile` 模式

表 3.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PerformanceProfile` 模式
201 - Created	`PerformanceProfile` 模式
202 - Accepted	`PerformanceProfile` 模式
401 - Unauthorized	空

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

表 3.6. 全局路径参数
参数	类型	描述
`name`	`string`	PerformanceProfile 的名称

HTTP 方法: DELETE
描述: 删除 PerformanceProfile

表 3.7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 3.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的 PerformanceProfile

表 3.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PerformanceProfile` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 PerformanceProfile

表 3.10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PerformanceProfile` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 PerformanceProfile

表 3.12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.13. 主体参数
参数	类型	描述
`正文（body）`	`PerformanceProfile` 模式

表 3.14. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PerformanceProfile` 模式
201 - Created	`PerformanceProfile` 模式
401 - Unauthorized	空

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

表 3.15. 全局路径参数
参数	类型	描述
`name`	`string`	PerformanceProfile 的名称

HTTP 方法: GET
描述: 指定 PerformanceProfile 的读取状态

表 3.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PerformanceProfile` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 PerformanceProfile 的状态

表 3.17. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PerformanceProfile` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 PerformanceProfile 的状态

表 3.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 3.20. 主体参数
参数	类型	描述
`正文（body）`	`PerformanceProfile` 模式

表 3.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`PerformanceProfile` 模式
201 - Created	`PerformanceProfile` 模式
401 - Unauthorized	空

第 4 章 Profile [tuned.openshift.io/v1]

描述: profile 是 Profile 资源的规格。
类型: 对象

4.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`
`status`	`对象`	ProfileStatus 是 Profile 资源的状态，状态仅用于内部使用，其字段可能会在以后更改/删除。

4.1.1. .spec

描述

类型

object

必填

config

属性	类型	描述
`config`	`object`
`配置集`	`array`	调优配置集。
`profile[]`	`对象`	Tuned 配置集。

4.1.2. .spec.config

描述

类型

object

必填

tunedProfile

属性	类型	描述
`debug`	`布尔值`	调试 TuneD 守护进程执行的选项
`providerName`	`string`	从 Node providerID 获取的云供应商名称： <ProviderName>://<ProviderSpecificNodeID>
`tunedConfig`	`object`	TuneD 守护进程的全局配置，如 tuned-main.conf 中定义的
`tunedProfile`	`string`	要应用的 tuned 配置集

4.1.3. .spec.config.tunedConfig

描述: TuneD 守护进程的全局配置，如 tuned-main.conf 中定义的
类型: object

属性	类型	描述
`reapply_sysctl`	`布尔值`	为 TuneD 守护进程打开/off 重新应用_sysctl 功能： true/false

4.1.4. .spec.profile

描述: 调优配置集。
类型: array

4.1.5. .spec.profile[]

描述

Tuned 配置集。

类型

object

必填

data
name

属性	类型	描述
`data`	`字符串`	Tuned 守护进程消耗的 Tuned 配置集规格。
`name`	`字符串`	在 recommend 部分使用的 Tuned 配置集的名称。

4.1.6. .status

描述

ProfileStatus 是 Profile 资源的状态，状态仅用于内部使用，其字段可能会在以后更改/删除。

类型

object

必填

tunedProfile

属性	类型	描述
`conditions`	`array`	conditions 代表每个节点的配置集应用程序的状态
`conditions[]`	`对象`	ProfileStatusCondition 代表每个节点的 Profile 应用程序的部分状态。
`tunedProfile`	`字符串`	Tuned 守护进程使用的当前配置集

4.1.7. .status.conditions

描述: conditions 代表每个节点的配置集应用程序的状态
类型: array

4.1.8. .status.conditions[]

描述

ProfileStatusCondition 代表每个节点的 Profile 应用程序的部分状态。

类型

object

必填

lastTransitionTime
status
type

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是当前 status 属性最后一次更新的时间。
`message`	`字符串`	Message 提供有关当前条件的附加信息。这只能被人类使用。
`reason`	`字符串`	reason 是条件当前状态的 CamelCase 原因。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	Type 指定此条件报告的方面。

4.2. API 端点

可用的 API 端点如下：

/apis/tuned.openshift.io/v1/profiles
- GET: 列出类型为 Profile 的对象
/apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles
- DELETE ：删除配置集集合
- GET: 列出类型为 Profile 的对象
- POST ：创建配置集
/apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles/{name}
- DELETE ：删除配置文件
- GET ：读取指定的配置集
- PATCH: 部分更新指定的配置集
- PUT ：替换指定的配置集
/apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles/{name}/status
- GET ：指定配置集的读取状态
- PATCH: 部分更新指定配置集的状态
- PUT ：替换指定配置集的状态

4.2.1. /apis/tuned.openshift.io/v1/profiles

HTTP 方法: GET
描述: 列出类型为 Profile 的对象

表 4.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProfileList` 模式
401 - Unauthorized	空

4.2.2. /apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles

HTTP 方法: DELETE
描述: 删除配置集集合

表 4.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出类型为 Profile 的对象

表 4.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProfileList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建配置文件

表 4.4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.5. 主体参数
参数	类型	描述
`正文（body）`	`Profile` 模式

表 4.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Profile` 模式
201 - Created	`Profile` 模式
202 - Accepted	`Profile` 模式
401 - Unauthorized	空

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

表 4.7. 全局路径参数
参数	类型	描述
`name`	`字符串`	Profile 的名称

HTTP 方法: DELETE
描述: 删除配置集

表 4.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 4.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的配置集

表 4.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Profile` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的配置集

表 4.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Profile` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的配置集

表 4.13. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.14. 主体参数
参数	类型	描述
`正文（body）`	`Profile` 模式

表 4.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Profile` 模式
201 - Created	`Profile` 模式
401 - Unauthorized	空

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

表 4.16. 全局路径参数
参数	类型	描述
`name`	`字符串`	Profile 的名称

HTTP 方法: GET
描述: 指定配置集的读取状态

表 4.17. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Profile` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定配置集的状态

表 4.18. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.19. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Profile` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定配置集的状态

表 4.20. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 4.21. 主体参数
参数	类型	描述
`正文（body）`	`Profile` 模式

表 4.22. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Profile` 模式
201 - Created	`Profile` 模式
401 - Unauthorized	空

第 5 章 RuntimeClass [node.k8s.io/v1]

描述

RuntimeClass 定义集群中支持的容器运行时类。RuntimeClass 用于决定使用哪个容器运行时来运行 pod 中的所有容器。runtimeclasses 由用户或集群置备程序手动定义，并在 PodSpec 中引用。Kubelet 负责在运行 pod 前解析 RuntimeClassName 引用。如需了解更多详细信息，请参阅 https://kubernetes.io/docs/concepts/containers/runtime-class/

类型

object

必填

handler

5.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`handler`	`string`	处理程序指定 CRI 实施将用于处理此类 pod 的底层运行时和配置。可能的值特定于节点和 CRI 配置。假设所有处理程序在每个节点上都可用，并且相同名称的处理程序在每个节点上都等效。例如，名为 "runc" 的处理程序可能会指定 runc OCI 运行时（使用原生 Linux 容器）将用于在 pod 中运行容器。处理程序必须是小写，符合 DNS 标签(RFC 1123)要求，并且不可变。
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`开销`	`对象`	开销结构代表了与运行 pod 相关的资源开销。
`scheduling`	`对象`	调度指定支持 RuntimeClass 的节点的调度限制。

5.1.1. .overhead

描述: 开销结构代表了与运行 pod 相关的资源开销。
类型: object

属性	类型	描述
`podFixed`	`对象（数量）`	podFixed 代表与运行 pod 关联的固定资源开销。

5.1.2. .scheduling

描述: 调度指定支持 RuntimeClass 的节点的调度限制。
类型: object

属性	类型	描述
`nodeSelector`	`对象（字符串）`	nodeSelector 列出支持此 RuntimeClass 的节点上必须存在的标签。使用此 RuntimeClass 的 Pod 只能调度到与此选择器匹配的节点。RuntimeClass nodeSelector 与 pod 的现有 nodeSelector 合并。任何冲突都会导致 pod 在准入中被拒绝。
`容限（tolerations）`	`数组（容限）`	容限会附加（不包括重复）到在准入过程中使用这个 RuntimeClass 运行的 pod，从而有效地取消 pod 和 RuntimeClass 容许的一组节点。

5.2. API 端点

可用的 API 端点如下：

/apis/node.k8s.io/v1/runtimeclasses
- DELETE: 删除 RuntimeClass 集合
- GET: 列出或监视类型为 RuntimeClass 的对象
- POST ：创建 RuntimeClass
/apis/node.k8s.io/v1/watch/runtimeclasses
- GET: 观察单个对 RuntimeClass 列表的更改。已弃用：使用带有 list 操作的 'watch' 参数。
/apis/node.k8s.io/v1/runtimeclasses/{name}
- DELETE ：删除 RuntimeClass
- GET ：读取指定的 RuntimeClass
- PATCH: 部分更新指定的 RuntimeClass
- PUT ：替换指定的 RuntimeClass
/apis/node.k8s.io/v1/watch/runtimeclasses/{name}
- GET: 观察对类型为 RuntimeClass 的对象的更改。已弃用：使用带有 list 操作的 'watch' 参数，而是过滤到带有 'fieldSelector' 参数的单个项目。

5.2.1. /apis/node.k8s.io/v1/runtimeclasses

HTTP 方法: DELETE
描述: 删除 RuntimeClass 集合

表 5.1. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 5.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出或监视类型为 RuntimeClass 的对象

表 5.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`RuntimeClassList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 RuntimeClass

表 5.4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.5. 主体参数
参数	类型	描述
`正文（body）`	`RuntimeClass` 模式

表 5.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`RuntimeClass` 模式
201 - Created	`RuntimeClass` 模式
202 - Accepted	`RuntimeClass` 模式
401 - Unauthorized	空

5.2.2. /apis/node.k8s.io/v1/watch/runtimeclasses

HTTP 方法: GET
描述: 观察单个对 RuntimeClass 列表的更改。已弃用：使用带有列表操作的 'watch' 参数。

表 5.7. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

5.2.3. /apis/node.k8s.io/v1/runtimeclasses/{name}

表 5.8. 全局路径参数
参数	类型	描述
`name`	`字符串`	RuntimeClass 的名称

HTTP 方法: DELETE
描述: 删除 RuntimeClass

表 5.9. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 5.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 RuntimeClass

表 5.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`RuntimeClass` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 RuntimeClass

表 5.12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`RuntimeClass` 模式
201 - Created	`RuntimeClass` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 RuntimeClass

表 5.14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 5.15. 主体参数
参数	类型	描述
`正文（body）`	`RuntimeClass` 模式

表 5.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`RuntimeClass` 模式
201 - Created	`RuntimeClass` 模式
401 - Unauthorized	空

5.2.4. /apis/node.k8s.io/v1/watch/runtimeclasses/{name}

表 5.17. 全局路径参数
参数	类型	描述
`name`	`字符串`	RuntimeClass 的名称

HTTP 方法: GET
描述: 观察对类型为 RuntimeClass 的对象的更改。已弃用：使用带有列表操作的 'watch' 参数，而是过滤成带有 'fieldSelector' 参数的单个项目。

表 5.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`WatchEvent` 模式
401 - Unauthorized	空

第 6 章 Tuned [tuned.openshift.io/v1]

描述: TuneD 是一组规则，允许集群范围的节点级 sysctl 部署，并更灵活添加用户需求指定的自定义性能优化。这些规则会被转换并传递给集群中运行的所有容器化 Tuned 守护进程，格式为守护进程了解的格式。然后，应用节点级别的调优的职责在于容器化的 Tuned 守护进程。更多信息： https://github.com/openshift/cluster-node-tuning-operator
类型: 对象

6.1. 规格

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 是 Tuned 所需的行为的规格。更多信息： https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
`status`	`对象`	TunedStatus 是 Tuned 资源的状态。

6.1.1. .spec

描述: spec 是 Tuned 所需的行为的规格。更多信息： https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
类型: object

属性	类型	描述
`managementState`	`字符串`	managementState 表示此 config 实例代表的 registry 实例是否在 Operator 管理下。有效值为 Force、Managed、Unmanaged 和 Removed。
`配置集`	`array`	调优配置集。
`profile[]`	`对象`	Tuned 配置集。
`建议`	`array`	所有 Tuned 配置集的选择逻辑。
`recommend[]`	`对象`	单个 Tuned 配置集的选择逻辑。

6.1.2. .spec.profile

描述: 调优配置集。
类型: array

6.1.3. .spec.profile[]

描述

Tuned 配置集。

类型

object

必填

data
name

属性	类型	描述
`data`	`字符串`	Tuned 守护进程消耗的 Tuned 配置集规格。
`name`	`字符串`	在 recommend 部分使用的 Tuned 配置集的名称。

6.1.5. .spec.recommend[]

描述

单个 Tuned 配置集的选择逻辑。

类型

object

必填

priority
配置集

属性	类型	描述
`machineConfigLabels`	`对象（字符串）`	machineConfigLabels 指定 MachineConfig 的标签。MachineConfig 会自动创建，以应用额外的主机设置（如内核引导参数）配置集 'Profile' 需要，只能通过创建 MachineConfig 来应用。这包括使用与 MachineConfigLabels 匹配的 machineConfigSelector 查找所有 MachineConfigPools，并在与 MachineConfigPools' nodeSelectors 匹配的所有节点上设置配置集 'Profile'。
`match`	`array`	管理由逻辑 OR 运算符连接的 Tuned 配置集的应用程序的规则。
`match[]`	`对象`	管理 Tuned 配置集应用程序的规则。
`operand`	`对象`	可选操作对象配置。
`priority`	`整数`	调优配置集优先级。最高优先级是 0。
`配置集`	`字符串`	要推荐的 Tuned 配置集的名称。

6.1.7. .spec.recommend[].match[]

描述

管理 Tuned 配置集应用程序的规则。

类型

object

必填

label

属性	类型	描述
`label`	`字符串`	节点或 Pod 标签名称。
`match`	`数组（未定义）`	管理由逻辑 AND 运算符连接的调优配置集应用程序的其他规则。
`type`	`字符串`	匹配类型： [node/pod]。如果省略，会使用 "node"。
`value`	`字符串`	节点或 Pod 标签值。如果省略，则存在标签名称就足以匹配。

6.1.8. .spec.recommend[].operand

描述: 可选操作对象配置。
类型: object

属性	类型	描述
`debug`	`布尔值`	为 TuneD 守护进程打开/关闭调试：true/false （默认为 false）
`tunedConfig`	`object`	TuneD 守护进程的全局配置，如 tuned-main.conf 中定义的

6.1.9. .spec.recommend[].operand.tunedConfig

描述: TuneD 守护进程的全局配置，如 tuned-main.conf 中定义的
类型: object

属性	类型	描述
`reapply_sysctl`	`布尔值`	为 TuneD 守护进程打开/off 重新应用_sysctl 功能： true/false

6.1.10. .status

描述: TunedStatus 是 Tuned 资源的状态。
类型: object

6.2. API 端点

可用的 API 端点如下：

/apis/tuned.openshift.io/v1/tuneds
- GET: 列出 Tuned 类型的对象
/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds
- DELETE: 删除 Tuned 集合
- GET: 列出 Tuned 类型的对象
- POST ：创建 Tuned
/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}
- DELETE ：删除 Tuned
- GET ：读取指定的 Tuned
- PATCH: 部分更新指定的 Tuned
- PUT ：替换指定的 Tuned

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

HTTP 方法: GET
描述: 列出 Tuned 类型的对象

表 6.1. HTTP 响应
HTTP 代码	响应正文
200 - OK	`TunedList` 模式
401 - Unauthorized	空

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

HTTP 方法: DELETE
描述: 删除 Tuned 集合

表 6.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 Tuned 类型的对象

表 6.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`TunedList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 Tuned

表 6.4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.5. 主体参数
参数	类型	描述
`正文（body）`	`TuneD` 模式

表 6.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`TuneD` 模式
201 - Created	`TuneD` 模式
202 - Accepted	`TuneD` 模式
401 - Unauthorized	空

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

表 6.7. 全局路径参数
参数	类型	描述
`name`	`字符串`	Tuned 的名称

HTTP 方法: DELETE
描述: 删除 Tuned

表 6.8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

表 6.9. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 Tuned

表 6.10. HTTP 响应
HTTP 代码	响应正文
200 - OK	`TuneD` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 Tuned

表 6.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.12. HTTP 响应
HTTP 代码	响应正文
200 - OK	`TuneD` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 Tuned

表 6.13. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段，发送警告。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段，或者存在任何重复字段，请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的，以及重复的字段。

表 6.14. 主体参数
参数	类型	描述
`正文（body）`	`TuneD` 模式

表 6.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`TuneD` 模式
201 - Created	`TuneD` 模式
401 - Unauthorized	空

Legal Notice

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

节点 API

节点 API 的参考指南

第 1 章 节点 API

1.1. Node [v1]

1.2. PerformanceProfile [performance.openshift.io/v2]

1.3. Profile [tuned.openshift.io/v1]

1.4. RuntimeClass [node.k8s.io/v1]

1.5. Tuned [tuned.openshift.io/v1]

第 2 章 Node [v1]

2.1. 规格

2.1.1. .spec

2.1.2. .spec.configSource

2.1.3. .spec.configSource.configMap

2.1.4. .spec.taints

2.1.5. .spec.taints[]

2.1.6. .status

2.1.7. .status.addresses

2.1.8. .status.addresses[]

2.1.9. .status.conditions

2.1.10. .status.conditions[]

2.1.11. .status.config

2.1.12. .status.config.active

2.1.13. .status.config.active.configMap

2.1.14. .status.config.assigned

2.1.15. .status.config.assigned.configMap

2.1.16. .status.config.lastKnownGood

2.1.17. .status.config.lastKnownGood.configMap

2.1.18. .status.daemonEndpoints

2.1.19. .status.daemonEndpoints.kubeletEndpoint

2.1.20. .status.images

2.1.21. .status.images[]

2.1.22. .status.nodeInfo

2.1.23. .status.runtimeHandlers

2.1.24. .status.runtimeHandlers[]

2.1.25. .status.runtimeHandlers[].features

2.1.26. .status.volumesAttached

2.1.27. .status.volumesAttached[]

2.2. API 端点

2.2.1. /api/v1/nodes

2.2.2. /api/v1/watch/nodes

2.2.3. /api/v1/nodes/{name}

2.2.4. /api/v1/watch/nodes/{name}

2.2.5. /api/v1/nodes/{name}/status

第 3 章 PerformanceProfile [performance.openshift.io/v2]

3.1. 规格

3.1.1. .spec

3.1.2. .spec.cpu

3.1.3. .spec.hardwareTuning

3.1.4. .spec.hugepages

3.1.5. .spec.hugepages.pages

3.1.6. .spec.hugepages.pages[]

3.1.7. .spec.net

3.1.8. .spec.net.devices

3.1.9. .spec.net.devices[]

3.1.10. .spec.numa

3.1.11. .spec.realTimeKernel

3.1.12. .spec.workloadHints

3.1.13. .status

3.1.14. .status.conditions

3.1.15. .status.conditions[]

3.2. API 端点

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

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

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

第 4 章 Profile [tuned.openshift.io/v1]

4.1. 规格

4.1.1. .spec

4.1.2. .spec.config

4.1.3. .spec.config.tunedConfig

4.1.4. .spec.profile

4.1.5. .spec.profile[]

4.1.6. .status

4.1.7. .status.conditions

4.1.8. .status.conditions[]

4.2. API 端点

4.2.1. /apis/tuned.openshift.io/v1/profiles

4.2.2. /apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles

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

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

第 5 章 RuntimeClass [node.k8s.io/v1]

第 1 章节点 API