5.6.2. 手动定义的 CSV 字段
很多 CSV 字段无法使用生成的、不属于 Operator SDK 的特殊通用清单进行填充。这些字段大多由人工编写,是一些有关 Operator 和各种自定义资源定义 (CRD) 的元数据。
Operator 作者必须直接修改其集群服务版本(CSV)YAML 文件,将个性化数据添加到以下必填字段。当检测到任何必填字段中缺少数据时,Operator SDK 在生成 CSV 时发出警告。
下表详细介绍了需要手动定义的 CSV 字段,哪些是可选的。
字段 | 描述 |
---|---|
|
该 CSV 的唯一名称。Operator 版本应包含在名称中,以保证唯一性,如 |
|
根据 Operator 成熟度模型划分的能力等级。选项包括 |
| 用于标识 Operator 的公共名称。 |
| 有关 Operator 功能的简短描述。 |
| 描述 Operator 的关键词。 |
|
维护 Operator 的个人或组织实体,含 |
|
Operator 的供应商(通常是机构),含 |
| 供 Operator 内部使用的键值对。 |
|
Operator 的语义版本,如 |
|
Operator 使用的任何 CRD。如果
|
字段 | 描述 |
---|---|
| 被该 CSV 替换的 CSV 名称。 |
|
与被管理的 Operator 或应用程序相关的 URL(如网站和文档),各自含 |
| Operator 可用于配对群集中资源的选择器。 |
|
Operator 独有的 base64 编码图标,通过 |
|
软件在这个版本中达到的成熟度。选项包括 |
有关以上每个字段应包含哪些数据的更多详情,请参见 CSV spec。
目前需要用户干预的几个 YAML 字段可能会从 Operator 代码中解析。
其他资源
5.6.2.1. Operator 元数据注解
operator 开发人员可以在集群服务版本(CSV)的元数据中手动定义某些注解,以启用功能或在用户界面(UI)中突出功能,如 OperatorHub。
下表列出了可使用 metadata.annotations
字段手动定义的 Operator 元数据注解。
字段 | 描述 |
---|---|
| 提供自定义资源定义(CRD)模板最小配置集。兼容的 UI 会预先填充此模板,供用户进一步自定义。 |
| 指定安装 Operator 时必须创建的一个所需的自定义资源。必须包含带有完整 YAML 定义的模板。 |
| 设置部署 Operator 的建议命名空间。 |
| Operator 支持的基础架构功能。在 web 控制台中通过 OperatorHub 发现 Operator 时,用户可以查看和过滤这些功能。有效的、区分大小写的值:
重要
只有在
|
|
用于列出使用 Operator 所需的任何特定订阅的空闲数组。例如, |
| 在 UI 中隐藏不用于用户操作的 CRD。 |
使用案例示例
Operator 支持断开连接和代理
operators.openshift.io/infrastructure-features: '["disconnected", "proxy-aware"]'
Operator 需要 OpenShift Container Platform 许可证
operators.openshift.io/valid-subscription: '["OpenShift Container Platform"]'
Operator 需要 3scale 许可证
operators.openshift.io/valid-subscription: '["3Scale Commercial License", "Red Hat Managed Integration"]'
Operator 支持断开连接和代理,且需要一个 OpenShift Container Platform 许可证
operators.openshift.io/infrastructure-features: '["disconnected", "proxy-aware"]' operators.openshift.io/valid-subscription: '["OpenShift Container Platform"]'
其它资源