×
描述

ClusterCSIDriver 对象允许管理和配置在 OpenShift 中默认安装的 CSI 驱动程序操作符。对象的名称必须是其操作的 CSI 驱动程序的名称。有关允许值的列表,请参阅 CSIDriverName 类型。兼容性级别 1:在主要版本中至少稳定 12 个月或 3 个次要版本(以较长者为准)。

类型

对象

必需
  • spec

规格

属性 类型 描述

apiVersion

字符串

APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值,并可能拒绝无法识别的值。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值,表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。无法更新。使用驼峰式命名法。更多信息: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 包含用户可设置的配置值

status

对象

status 包含来自集群的观察值。这些值不能被覆盖。

.spec

描述

spec 包含用户可设置的配置值

类型

对象

属性 类型 描述

driverConfig

对象

driverConfig 可用于指定特定于平台的驱动程序配置。省略此项表示没有意见,平台将选择合理的默认值。这些默认值可能会随着时间的推移而改变。

logLevel

字符串

logLevel 是基于意图的整体组件日志记录。它不提供细粒度的控制,但它是一种简单的方法来管理操作员必须为其操作数解释的粗粒度日志记录选择。有效值为:“Normal”、“Debug”、“Trace”、“TraceAll”。默认为“Normal”。

managementState

字符串

managementState 指示操作员是否以及如何管理组件

observedConfig

``

observedConfig 包含控制器从集群状态观察到的稀疏配置。它存在于 spec 中,因为它是对操作员级别的输入。

operatorLogLevel

字符串

operatorLogLevel 是基于意图的操作员本身的日志记录。它不提供细粒度的控制,但它是一种简单的方法来管理操作员必须为自己解释的粗粒度日志记录选择。有效值为:“Normal”、“Debug”、“Trace”、“TraceAll”。默认为“Normal”。

storageClassState

字符串

StorageClassState 确定 CSI 操作员是否应该创建和管理存储类。如果此字段值为空或为 Managed - CSI 操作员将持续协调存储类并在必要时创建。如果此字段值为 Unmanaged - CSI 操作员将不会协调任何先前创建的存储类。如果此字段值为 Removed - CSI 操作员将删除它先前创建的存储类。省略此项表示用户没有意见,平台将选择合理的默认值,该默认值可能会随着时间的推移而改变。当前默认行为为 Managed。

unsupportedConfigOverrides

``

unsupportedConfigOverrides 覆盖由操作员计算的最终配置。Red Hat 不支持使用此字段。误用此字段可能导致意外行为或与其他配置选项冲突。在使用此字段之前,请寻求 Red Hat 支持的指导。使用此属性会阻止集群升级,必须在升级集群之前将其删除。

.spec.driverConfig

描述

driverConfig 可用于指定特定于平台的驱动程序配置。省略此项表示没有意见,平台将选择合理的默认值。这些默认值可能会随着时间的推移而改变。

类型

对象

必需
  • driverType

属性 类型 描述

aws

对象

aws 用于配置 AWS CSI 驱动程序。

azure

对象

azure 用于配置 Azure CSI 驱动程序。

driverType

字符串

driverType 指示要为其应用 driverConfig 的 CSI 驱动程序的类型。有效值为:AWS、Azure、GCP、IBMCloud、vSphere 和省略。使用者应将未知值视为 NO-OP。

gcp

对象

gcp 用于配置 GCP CSI 驱动程序。

ibmcloud

对象

ibmcloud 用于配置 IBM Cloud CSI 驱动程序。

vSphere

对象

vsphere 用于配置 vsphere CSI 驱动程序。

.spec.driverConfig.aws

描述

aws 用于配置 AWS CSI 驱动程序。

类型

对象

属性 类型 描述

efsVolumeMetrics

对象

efsVolumeMetrics 设置用于收集 EFS CSI 驱动程序使用的 EFS 卷的指标的配置。

kmsKeyARN

字符串

kmsKeyARN 将集群默认存储类设置为使用用户定义的 KMS 密钥加密卷,而不是 AWS 使用的默认 KMS 密钥。该值可以是 KMS 密钥的 ARN 或别名 ARN。

.spec.driverConfig.aws.efsVolumeMetrics

描述

efsVolumeMetrics 设置用于收集 EFS CSI 驱动程序使用的 EFS 卷的指标的配置。

类型

对象

必需
  • state

属性 类型 描述

recursiveWalk

对象

recursiveWalk 为在状态设置为 RecursiveWalk 时收集 AWS EFS CSI 驱动程序中的卷指标提供其他配置。

state

字符串

state 定义 AWS EFS CSI 驱动程序中指标收集的状态。此字段是必需的,必须设置为以下值之一:Disabled 或 RecursiveWalk。Disabled 表示不会执行指标收集。这是默认值。RecursiveWalk 表示 AWS EFS CSI 驱动程序将递归扫描卷以收集指标。此过程可能会导致高 CPU 和内存使用率,具体取决于卷的大小。

.spec.driverConfig.aws.efsVolumeMetrics.recursiveWalk

描述

recursiveWalk 为在状态设置为 RecursiveWalk 时收集 AWS EFS CSI 驱动程序中的卷指标提供其他配置。

类型

对象

属性 类型 描述

fsRateLimit

整数

fsRateLimit 定义每个文件系统的 goroutines 速率限制,用于处理卷指标。省略此项表示没有意见,平台将选择合理的默认值,该默认值可能会随着时间的推移而改变。当前默认为 5。有效范围为 1 到 100 个 goroutines。

refreshPeriodMinutes

整数

refreshPeriodMinutes 指定以分钟为单位刷新卷指标的频率。省略此项表示没有意见,平台将选择合理的默认值,该默认值可能会随着时间的推移而改变。当前默认为 240。有效范围为 1 到 43200 分钟(30 天)。

.spec.driverConfig.azure

描述

azure 用于配置 Azure CSI 驱动程序。

类型

对象

属性 类型 描述

diskEncryptionSet

对象

diskEncryptionSet 将集群默认存储类设置为使用客户管理的加密集加密卷,而不是默认的平台管理密钥。

.spec.driverConfig.azure.diskEncryptionSet

描述

diskEncryptionSet 将集群默认存储类设置为使用客户管理的加密集加密卷,而不是默认的平台管理密钥。

类型

对象

必需
  • name

  • resourceGroup

  • subscriptionID

属性 类型 描述

name

字符串

name 是将在默认存储类上设置的磁盘加密集的名称。该值应仅包含字母数字字符、下划线 (_) 和连字符,长度最多为 80 个字符。

resourceGroup

字符串

resourceGroup 定义包含磁盘加密集的 Azure 资源组。该值应仅包含字母数字字符、下划线 (_) 、括号、连字符和句点。该值不应以句点结尾,长度最多为 90 个字符。

subscriptionID

字符串

subscriptionID 定义包含磁盘加密集的 Azure 订阅。该值应符合以下条件:1. 它应为 128 位数字。2. 它应为 36 个字符(32 个十六进制字符和 4 个连字符)长。3. 它应以连字符 (-) 分隔的五个组显示。4. 第一组应为 8 个字符长。5. 第二、第三和第四组应为 4 个字符长。6. 第五组应为 12 个字符长。订阅 ID 示例:f2007bbf-f802-4a47-9336-cf7c6b89b378

.spec.driverConfig.gcp

描述

gcp 用于配置 GCP CSI 驱动程序。

类型

对象

属性 类型 描述

kmsKey

对象

kmsKey 将集群默认存储类设置为使用客户提供的加密密钥加密卷,而不是 GCP 管理的默认密钥。

.spec.driverConfig.gcp.kmsKey

描述

kmsKey 将集群默认存储类设置为使用客户提供的加密密钥加密卷,而不是 GCP 管理的默认密钥。

类型

对象

必需
  • keyRing

  • name

  • projectID

属性 类型 描述

keyRing

字符串

keyRing 是 KMS 密钥所属的 KMS 密钥环的名称。该值应对应于现有的 KMS 密钥环,并且应仅包含字母数字字符、连字符 (-) 和下划线 (_) ,长度最多为 63 个字符。

location

字符串

location 是密钥环所在的 GCP 位置。“global”。如果未设置,则默认为 global。

name

字符串

name 是客户管理的加密密钥的名称,用于磁盘加密。该值应对应于现有的 KMS 密钥,并且应仅包含字母数字字符、连字符 (-) 和下划线 (_) ,长度最多为 63 个字符。

projectID

字符串

projectID 是 KMS 密钥环所在的项目的 ID。它必须是 6 到 30 个小写字母、数字或连字符。它必须以字母开头。不允许尾随连字符。

.spec.driverConfig.ibmcloud

描述

ibmcloud 用于配置 IBM Cloud CSI 驱动程序。

类型

对象

必需
  • encryptionKeyCRN

属性 类型 描述

encryptionKeyCRN

字符串

encryptionKeyCRN 是用于默认存储类卷磁盘加密的客户管理根密钥的 IBM Cloud CRN。

.spec.driverConfig.vSphere

描述

vsphere 用于配置 vsphere CSI 驱动程序。

类型

对象

属性 类型 描述

globalMaxSnapshotsPerBlockVolume

整数

globalMaxSnapshotsPerBlockVolume 是一个全局配置参数,适用于所有类型数据存储上的卷。如果省略,平台将选择默认值,该默认值会随着时间推移而更改,当前默认值为 3。无法使用此参数禁用快照。将快照数量增加到 3 以上可能会对性能产生负面影响,详情请参阅:https://kb.vmware.com/s/article/1025279 卷快照文档:https://docs.vmware.com/en/VMware-vSphere-Container-Storage-Plug-in/3.0/vmware-vsphere-csp-getting-started/GUID-E0B41C69-7EEB-450F-A73D-5FD2FF39E891.html

granularMaxSnapshotsPerBlockVolumeInVSAN

整数

granularMaxSnapshotsPerBlockVolumeInVSAN 仅是 vSAN 数据存储上的粒度配置参数。如果设置,它将覆盖 GlobalMaxSnapshotsPerBlockVolume,如果未设置,则回退到全局约束。无法使用此参数禁用 VSAN 的快照。

granularMaxSnapshotsPerBlockVolumeInVVOL

整数

granularMaxSnapshotsPerBlockVolumeInVVOL 仅是虚拟卷数据存储上的粒度配置参数。如果设置,它将覆盖 GlobalMaxSnapshotsPerBlockVolume,如果未设置,则回退到全局约束。无法使用此参数禁用 VVOL 的快照。

topologyCategories

数组 (字符串)

topologyCategories 指示 vCenter 资源(例如主机集群或数据中心)已标记的标签类别。如果集群基础设施对象具有拓扑结构,则将使用基础设施对象中指定的值,并将拒绝对 topologyCategories 的修改。

.status

描述

status 包含来自集群的观察值。这些值不能被覆盖。

类型

对象

属性 类型 描述

conditions

数组

conditions 是条件及其状态的列表。

conditions[]

对象

OperatorCondition 只是标准的条件字段。

generations

数组

generations 用于确定何时需要协调项目或项目以需要做出反应的方式发生了更改。

generations[]

对象

GenerationStatus 跟踪给定资源的代数,以便可以做出有关强制更新的决定。

observedGeneration

整数

observedGeneration 是您已处理的最后一代变更。

readyReplicas

整数

readyReplicas 指示有多少个副本已准备就绪并处于所需状态。

version

字符串

version 是此可用性适用的级别。

.status.conditions

描述

conditions 是条件及其状态的列表。

类型

数组

.status.conditions[]

描述

OperatorCondition 只是标准的条件字段。

类型

对象

必需
  • 类型

属性 类型 描述

lastTransitionTime

字符串

消息

字符串

原因

字符串

status

字符串

类型

字符串

.status.generations

描述

generations 用于确定何时需要协调项目或项目以需要做出反应的方式发生了更改。

类型

数组

.status.generations[]

描述

GenerationStatus 跟踪给定资源的代数,以便可以做出有关强制更新的决定。

类型

对象

属性 类型 描述

字符串

组是您正在跟踪的事物的组。

哈希值

字符串

hash 是为没有代数但对内容敏感的资源(如密钥和 ConfigMap)设置的可选字段。

lastGeneration

整数

lastGeneration 是所涉及的工作负载控制器的最后一代。

name

字符串

名称是您正在跟踪的事物的名称。

命名空间

字符串

命名空间是您正在跟踪的事物所在的位置。

资源

字符串

资源是您正在跟踪的事物的资源类型。

API 端点

提供以下 API 端点:

  • /apis/operator.openshift.io/v1/clustercsidrivers

    • DELETE:删除 ClusterCSIDriver 集合

    • GET:列出 ClusterCSIDriver 类型的对象

    • POST:创建 ClusterCSIDriver

  • /apis/operator.openshift.io/v1/clustercsidrivers/{name}

    • DELETE:删除 ClusterCSIDriver

    • GET:读取指定的 ClusterCSIDriver

    • PATCH:部分更新指定的 ClusterCSIDriver

    • PUT:替换指定的 ClusterCSIDriver

  • /apis/operator.openshift.io/v1/clustercsidrivers/{name}/status

    • GET:读取指定的 ClusterCSIDriver 的状态

    • PATCH:部分更新指定的 ClusterCSIDriver 的状态

    • PUT:替换指定的 ClusterCSIDriver 的状态

/apis/operator.openshift.io/v1/clustercsidrivers

HTTP 方法

DELETE

描述

删除 ClusterCSIDriver 集合

表 1. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出 ClusterCSIDriver 类型的对象

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

ClusterCSIDriverList 模式

401 - 未授权

HTTP 方法

POST

描述

创建 ClusterCSIDriver

表 3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 4. 主体参数
参数 类型 描述

主体

ClusterCSIDriver 模式

表 5. HTTP 响应
HTTP 代码 响应正文

200 - OK

ClusterCSIDriver 模式

201 - 已创建

ClusterCSIDriver 模式

202 - 已接受

ClusterCSIDriver 模式

401 - 未授权

/apis/operator.openshift.io/v1/clustercsidrivers/{name}

表 6. 全局路径参数
参数 类型 描述

name

字符串

ClusterCSIDriver 的名称

HTTP 方法

DELETE

描述

删除 ClusterCSIDriver

表 7. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

表 8. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 ClusterCSIDriver

表 9. HTTP 响应
HTTP 代码 响应正文

200 - OK

ClusterCSIDriver 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 ClusterCSIDriver

表 10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 11. HTTP 响应
HTTP 代码 响应正文

200 - OK

ClusterCSIDriver 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 ClusterCSIDriver

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. 主体参数
参数 类型 描述

主体

ClusterCSIDriver 模式

表 14. HTTP 响应
HTTP 代码 响应正文

200 - OK

ClusterCSIDriver 模式

201 - 已创建

ClusterCSIDriver 模式

401 - 未授权

/apis/operator.openshift.io/v1/clustercsidrivers/{name}/status

表 15. 全局路径参数
参数 类型 描述

name

字符串

ClusterCSIDriver 的名称

HTTP 方法

GET

描述

读取指定的 ClusterCSIDriver 的状态

表 16. HTTP 响应
HTTP 代码 响应正文

200 - OK

ClusterCSIDriver 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 ClusterCSIDriver 的状态

表 17. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 18. HTTP 响应
HTTP 代码 响应正文

200 - OK

ClusterCSIDriver 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 ClusterCSIDriver 的状态

表 19. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 20. 主体参数
参数 类型 描述

主体

ClusterCSIDriver 模式

表 21. HTTP 响应
HTTP 代码 响应正文

200 - OK

ClusterCSIDriver 模式

201 - 已创建

ClusterCSIDriver 模式

401 - 未授权