安装计划 [operators.coreos.com/v1alpha1] - OperatorHub APIs | API 参考 | OpenShift Container Platform 4.17

规范
API 端点

描述

InstallPlan 定义了一组操作符的安装。

类型

对象

必需

元数据
规范

规范

属性类型描述

属性	类型	描述
`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
`元数据`	`ObjectMeta`	标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`规范`	`对象`	InstallPlanSpec 定义了一组要安装的 Application 资源。
`状态`	`对象`	InstallPlanStatus 表示有关完成安装所需步骤的状态的信息。状态可能滞后于系统的实际状态。

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

元数据

ObjectMeta

标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

规范

对象

InstallPlanSpec 定义了一组要安装的 Application 资源。

状态

对象

InstallPlanStatus 表示有关完成安装所需步骤的状态的信息。

状态可能滞后于系统的实际状态。

.spec

描述

InstallPlanSpec 定义了一组要安装的 Application 资源。

类型

对象

必需

批准
已批准
clusterServiceVersionNames

属性类型描述

属性	类型	描述
`批准`	`字符串`	Approval 是 InstallPlan 的用户批准策略。它必须是“自动”或“手动”之一。
`已批准`	`布尔值`
`clusterServiceVersionNames`	`数组（字符串）`
`代`	`整数`
`来源`	`字符串`
`sourceNamespace`	`字符串`

批准

字符串

Approval 是 InstallPlan 的用户批准策略。它必须是“自动”或“手动”之一。

已批准

布尔值

clusterServiceVersionNames

数组（字符串）

代

整数

来源

字符串

sourceNamespace

字符串

.status

描述

InstallPlanStatus 表示有关完成安装所需步骤的状态的信息。

状态可能滞后于系统的实际状态。

类型

对象

必需

catalogSources
阶段

属性类型描述

属性	类型	描述
`attenuatedServiceAccountRef`	`对象`	AttenuatedServiceAccountRef 引用用于执行范围操作符安装的服务帐户。
`bundleLookups`	`数组`	BundleLookups 是将捆绑包内容拉取并解包到集群的正在进行的请求集。
`bundleLookups[]`	`对象`	BundleLookup 是将捆绑包的内容拉取并解包到集群的请求。
`catalogSources`	`数组（字符串）`
`条件`	`数组`
`conditions[]`	`对象`	InstallPlanCondition 表示 InstallPlan 执行的总体状态。
`消息`	`字符串`	Message 是包含可能对于理解计划为何具有当前状态很重要的详细信息的可读消息。
`阶段`	`字符串`	InstallPlanPhase 是 InstallPlan 的整体当前状态。
`计划`	`数组`
`plan[]`	`对象`	Step 表示 InstallPlan 中单个步骤的状态。
`startTime`	`字符串`	StartTime 是控制器开始将计划中列出的资源应用于集群的时间。

attenuatedServiceAccountRef

对象

AttenuatedServiceAccountRef 引用用于执行范围操作符安装的服务帐户。

bundleLookups

数组

BundleLookups 是将捆绑包内容拉取并解包到集群的正在进行的请求集。

bundleLookups[]

对象

BundleLookup 是将捆绑包的内容拉取并解包到集群的请求。

catalogSources

数组（字符串）

条件

数组

conditions[]

对象

InstallPlanCondition 表示 InstallPlan 执行的总体状态。

消息

字符串

Message 是包含可能对于理解计划为何具有当前状态很重要的详细信息的可读消息。

阶段

字符串

InstallPlanPhase 是 InstallPlan 的整体当前状态。

计划

数组

plan[]

对象

Step 表示 InstallPlan 中单个步骤的状态。

startTime

字符串

StartTime 是控制器开始将计划中列出的资源应用于集群的时间。

.status.attenuatedServiceAccountRef

描述: AttenuatedServiceAccountRef 引用用于执行范围操作符安装的服务帐户。
类型: 对象

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	引用的 API 版本。
`fieldPath`	`字符串`	如果引用的是对象的一部分而不是整个对象，则此字符串应包含有效的 JSON/Go 字段访问语句，例如 desiredState.manifest.containers[2]。例如，如果对象引用指向 pod 内的容器，则其值将类似于：“spec.containers{name}”（其中“name”指的是触发事件的容器的名称）或者如果没有指定容器名称则为“spec.containers[2]”（此 pod 中索引为 2 的容器）。选择此语法只是为了拥有一种明确定义的方法来引用对象的一部分。待办事项：此设计尚未最终确定，此字段将来可能会更改。
`kind`	`字符串`	引用的 Kind。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`名称`	`字符串`	引用的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names
`命名空间`	`字符串`	引用的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`字符串`	此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`字符串`	引用的 UID。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#uids

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

如果引用的是对象的一部分而不是整个对象，则此字符串应包含有效的 JSON/Go 字段访问语句，例如 desiredState.manifest.containers[2]。例如，如果对象引用指向 pod 内的容器，则其值将类似于：“spec.containers{name}”（其中“name”指的是触发事件的容器的名称）或者如果没有指定容器名称则为“spec.containers[2]”（此 pod 中索引为 2 的容器）。选择此语法只是为了拥有一种明确定义的方法来引用对象的一部分。待办事项：此设计尚未最终确定，此字段将来可能会更改。

kind

字符串

名称

字符串

命名空间

字符串

引用的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

.status.bundleLookups

描述: BundleLookups 是将捆绑包内容拉取并解包到集群的正在进行的请求集。
类型: 数组

.status.bundleLookups[]

描述

BundleLookup 是将捆绑包的内容拉取并解包到集群的请求。

类型

对象

必需

catalogSourceRef
标识符
路径
替换

属性类型描述

属性	类型	描述
`catalogSourceRef`	`对象`	CatalogSourceRef 是对从中解析捆绑包路径的 CatalogSource 的引用。
`条件`	`数组`	条件表示 BundleLookup 的整体状态。
`conditions[]`	`对象`
`标识符`	`字符串`	标识符是操作符在目录中唯一的名称（对于包含 CSV 的 bundle，指的是 CSV 的名称）。
`路径`	`字符串`	路径指的是要拉取的 bundle 的位置。通常是一个镜像引用。
`属性`	`字符串`	解压后的 bundle 的有效属性。
`替换`	`字符串`	替换的是用 Path 位置找到的 bundle 替换的 bundle 的名称。

catalogSourceRef

对象

CatalogSourceRef 是对从中解析捆绑包路径的 CatalogSource 的引用。

条件

数组

条件表示 BundleLookup 的整体状态。

conditions[]

对象

标识符

字符串

标识符是操作符在目录中唯一的名称（对于包含 CSV 的 bundle，指的是 CSV 的名称）。

路径

字符串

路径指的是要拉取的 bundle 的位置。通常是一个镜像引用。

属性

字符串

解压后的 bundle 的有效属性。

替换

字符串

替换的是用 Path 位置找到的 bundle 替换的 bundle 的名称。

.status.bundleLookups[].catalogSourceRef

描述: CatalogSourceRef 是对从中解析捆绑包路径的 CatalogSource 的引用。
类型: 对象

属性类型描述

属性	类型	描述
`apiVersion`	`字符串`	引用的 API 版本。
`fieldPath`	`字符串`	如果引用的是对象的一部分而不是整个对象，则此字符串应包含有效的 JSON/Go 字段访问语句，例如 desiredState.manifest.containers[2]。例如，如果对象引用指向 pod 内的容器，则其值将类似于：“spec.containers{name}”（其中“name”指的是触发事件的容器的名称）或者如果没有指定容器名称则为“spec.containers[2]”（此 pod 中索引为 2 的容器）。选择此语法只是为了拥有一种明确定义的方法来引用对象的一部分。待办事项：此设计尚未最终确定，此字段将来可能会更改。
`kind`	`字符串`	引用的 Kind。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`名称`	`字符串`	引用的名称。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names
`命名空间`	`字符串`	引用的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`字符串`	此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`字符串`	引用的 UID。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#uids

apiVersion

字符串

引用的 API 版本。

fieldPath

字符串

kind

字符串

名称

字符串

命名空间

字符串

引用的命名空间。更多信息：https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

字符串

此引用的特定 resourceVersion（如果存在）。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

字符串

.status.bundleLookups[].conditions

描述: 条件表示 BundleLookup 的整体状态。
类型: 数组

.status.bundleLookups[].conditions[]

描述

类型

对象

必需

状态
类型

属性类型描述

属性	类型	描述
`最后转换时间`	`字符串`	条件从一种状态转换到另一种状态的最后时间。
`最后更新时间`	`字符串`	最后一次探测条件的时间。
`消息`	`字符串`	指示转换详细信息的人类可读消息。
`原因`	`字符串`	条件最后一次转换的原因。
`状态`	`字符串`	条件的状态，取值为 True、False、Unknown 之一。
`类型`	`字符串`	条件的类型。

最后转换时间

字符串

条件从一种状态转换到另一种状态的最后时间。

最后更新时间

字符串

最后一次探测条件的时间。

消息

字符串

指示转换详细信息的人类可读消息。

原因

字符串

条件最后一次转换的原因。

状态

字符串

条件的状态，取值为 True、False、Unknown 之一。

类型

字符串

条件的类型。

.status.conditions

描述
类型: 数组

.status.conditions[]

描述: InstallPlanCondition 表示 InstallPlan 执行的总体状态。
类型: 对象

属性类型描述

属性	类型	描述
`最后转换时间`	`字符串`
`最后更新时间`	`字符串`
`消息`	`字符串`
`原因`	`字符串`	ConditionReason 是状态转换的驼峰命名原因。
`状态`	`字符串`
`类型`	`字符串`	InstallPlanConditionType 描述了 InstallPlan 在某一时刻的整体状态。

最后转换时间

字符串

最后更新时间

字符串

消息

字符串

原因

字符串

ConditionReason 是状态转换的驼峰命名原因。

状态

字符串

类型

字符串

InstallPlanConditionType 描述了 InstallPlan 在某一时刻的整体状态。

.status.plan

描述
类型: 数组

.status.plan[]

描述

Step 表示 InstallPlan 中单个步骤的状态。

类型

对象

必需

解析中
资源
状态

属性类型描述

属性	类型	描述
`可选`	`布尔值`
`解析中`	`字符串`
`资源`	`对象`	StepResource 表示 InstallPlan 要跟踪的资源的状态。
`状态`	`字符串`	StepStatus 是 InstallPlan 中特定资源的当前状态。

可选

布尔值

解析中

字符串

资源

对象

StepResource 表示 InstallPlan 要跟踪的资源的状态。

状态

字符串

StepStatus 是 InstallPlan 中特定资源的当前状态。

.status.plan[].resource

描述

StepResource 表示 InstallPlan 要跟踪的资源的状态。

类型

对象

必需

组
kind
名称
源名称
sourceNamespace
版本

属性类型描述

属性	类型	描述
`组`	`字符串`
`kind`	`字符串`
`清单`	`字符串`
`名称`	`字符串`
`源名称`	`字符串`
`sourceNamespace`	`字符串`
`版本`	`字符串`

组

字符串

kind

字符串

清单

字符串

名称

字符串

源名称

字符串

sourceNamespace

字符串

版本

字符串

API 端点

以下 API 端点可用

/apis/operators.coreos.com/v1alpha1/installplans
- GET：列出 InstallPlan 类型的对象
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans
- DELETE：删除 InstallPlan 集合
- GET：列出 InstallPlan 类型的对象
- POST：创建一个 InstallPlan
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}
- DELETE：删除一个 InstallPlan
- GET：读取指定的 InstallPlan
- PATCH：部分更新指定的 InstallPlan
- PUT：替换指定的 InstallPlan
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status
- GET：读取指定的 InstallPlan 的状态
- PATCH：部分更新指定的 InstallPlan 的状态
- PUT：替换指定的 InstallPlan 的状态

/apis/operators.coreos.com/v1alpha1/installplans

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

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlanList` 模式
401 - 未授权	空

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans

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

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
401 - 未授权	空

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

表 3. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlanList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 InstallPlan

表 4. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为从对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 5. 请求体参数
参数	类型	描述
`请求体`	`InstallPlan` 模式

表 6. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlan` 模式
201 - 已创建	`InstallPlan` 模式
202 - 已接受	`InstallPlan` 模式
401 - 未授权	空

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}

表 7. 全局路径参数
参数	类型	描述
`名称`	`字符串`	InstallPlan 的名称

HTTP 方法: DELETE
描述: 删除一个 InstallPlan

表 8. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
202 - 已接受	`Status` 模式
401 - 未授权	空

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

表 10. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlan` 模式
401 - 未授权	空

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

表 11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为从对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 12. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlan` 模式
401 - 未授权	空

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

表 13. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为从对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 14. 请求体参数
参数	类型	描述
`请求体`	`InstallPlan` 模式

表 15. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlan` 模式
201 - 已创建	`InstallPlan` 模式
401 - 未授权	空

/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status

表 16. 全局路径参数
参数	类型	描述
`名称`	`字符串`	InstallPlan 的名称

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

表 17. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlan` 模式
401 - 未授权	空

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

表 18. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为从对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 19. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlan` 模式
401 - 未授权	空

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

表 20. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为从对象中删除的每个未知字段以及遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会持久化任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict：如果从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 21. 请求体参数
参数	类型	描述
`请求体`	`InstallPlan` 模式

表 22. HTTP 响应
HTTP 代码	响应体
200 - OK	`InstallPlan` 模式
201 - 已创建	`InstallPlan` 模式
401 - 未授权	空