主页
产品
OpenShift Container Platform
4.6
Operator
5.6.9. 了解您的自定义资源定义（CRD）

5.6.9. 了解您的自定义资源定义（CRD）

您的 Operator 可能会使用两类自定义资源定义 (CRD)：一类归 Operator 拥有，另一类为 Operator 依赖的必要 CRD。

5.6.9.1. 拥有的 CRD
复制链接

Operator 拥有的自定义资源定义（CRD）是 CSV 最重要的部分。这类 CRD 会在您的 Operator 与所需 RBAC 规则、依赖项管理和其他 Kubernetes 概念之间建立联系。

Operator 通常会使用多个 CRD 将各个概念链接在一起，例如一个对象中的顶级数据库配置和另一对象中的副本集表示代表。这在 CSV 文件中应逐一列出。

Expand

表 5.10. 拥有的 CRD 字段
字段	描述	必需/可选
`名称`	CRD 的全名。	必填
`Version`	该对象 API 的版本。	必填
`Kind`	CRD 的机器可读名称。	必填
`DisplayName`	CRD 名称的人类可读版本，如 `MongoDB Standalone`。	必填
`描述`	有关 Operator 如何使用该 CRD 的简短描述，或有关 CRD 所提供功能的描述。	必填
`Group`	该 CRD 所属的 API 组，如 `database.example.com`。	选填
`Resources`	您的 CRD 可能拥有一类或多类 Kubernetes 对象。它们将在 `resources` 部分列出，用于告知用户他们可能需要排除故障的对象或如何连接至应用程序，如公开数据库的服务或 Ingress 规则。建议仅列出对人重要的对象，而不必列出您编排的所有对象。例如，不要列出存储用户不会修改的内部状态的配置映射。	选填
`SpecDescriptors`、`StatusDescriptors` 和 `ActionDescriptors`	这些描述符是通过对终端用户来说最重要的 Operator 的某些输入或输出提示 UI 的一种方式。如果您的 CRD 包含用户必须提供的 Secret 或 ConfigMap 的名称，您可在此处指定。这些项目在兼容的 UI 中链接并突出显示。共有以下三类描述符： `SpecDescriptors`：引用对象 `spec` 块中的字段。 `StatusDescriptors`：引用对象 `status` 块中的字段。 `ActionDescriptors`：引用对象上可执行的操作。所有描述符都接受以下字段： `DisplayName`: `Spec`、`Status` 或 `Action` 的人类可读名称。 `Description`:有关 `Spec`、`Status` 或 `Action` 以及 Operator 如何使用它的简短描述。 `Path`：描述符描述的对象上字段的点分隔路径。 `X-Descriptors`：用于决定该描述符拥有哪些“功能”以及要使用哪个 UI 组件。有关 OpenShift Container Platform 的标准 React UI X-Descriptors 列表的信息，请参见 openshift/console 项目。有关描述符的更多一般信息，请参见 openshift/console 项目。	选填

以下示例描述了一个 MongoDB Standalone CRD，要求某些用户以 Secret 和配置映射的形式输入，并编排服务、有状态集、pod 和配置映射：

拥有的 CRD 示例

      - displayName: MongoDB Standalone
        group: mongodb.com
        kind: MongoDbStandalone
        name: mongodbstandalones.mongodb.com
        resources:
          - kind: Service
            name: ''
            version: v1
          - kind: StatefulSet
            name: ''
            version: v1beta2
          - kind: Pod
            name: ''
            version: v1
          - kind: ConfigMap
            name: ''
            version: v1
        specDescriptors:
          - description: Credentials for Ops Manager or Cloud Manager.
            displayName: Credentials
            path: credentials
            x-descriptors:
              - 'urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Secret'
          - description: Project this deployment belongs to.
            displayName: Project
            path: project
            x-descriptors:
              - 'urn:alm:descriptor:com.tectonic.ui:selector:core:v1:ConfigMap'
          - description: MongoDB version to be installed.
            displayName: Version
            path: version
            x-descriptors:
              - 'urn:alm:descriptor:com.tectonic.ui:label'
        statusDescriptors:
          - description: The status of each of the pods for the MongoDB cluster.
            displayName: Pod Status
            path: pods
            x-descriptors:
              - 'urn:alm:descriptor:com.tectonic.ui:podStatuses'
        version: v1
        description: >-
          MongoDB Deployment consisting of only one host. No replication of
          data.

      - displayName: MongoDB Standalone
        group: mongodb.com
        kind: MongoDbStandalone
        name: mongodbstandalones.mongodb.com
        resources:
          - kind: Service
            name: ''
            version: v1
          - kind: StatefulSet
            name: ''
            version: v1beta2
          - kind: Pod
            name: ''
            version: v1
          - kind: ConfigMap
            name: ''
            version: v1
        specDescriptors:
          - description: Credentials for Ops Manager or Cloud Manager.
            displayName: Credentials
            path: credentials
            x-descriptors:
              - 'urn:alm:descriptor:com.tectonic.ui:selector:core:v1:Secret'
          - description: Project this deployment belongs to.
            displayName: Project
            path: project
            x-descriptors:
              - 'urn:alm:descriptor:com.tectonic.ui:selector:core:v1:ConfigMap'
          - description: MongoDB version to be installed.
            displayName: Version
            path: version
            x-descriptors:
              - 'urn:alm:descriptor:com.tectonic.ui:label'
        statusDescriptors:
          - description: The status of each of the pods for the MongoDB cluster.
            displayName: Pod Status
            path: pods
            x-descriptors:
              - 'urn:alm:descriptor:com.tectonic.ui:podStatuses'
        version: v1
        description: >-
          MongoDB Deployment consisting of only one host. No replication of
          data.

Copy to Clipboard

Toggle word wrap

返回顶部

5.6.9. 了解您的自定义资源定义（CRD）

5.6.9.1. 拥有的 CRD
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

5.6.9. 了解您的自定义资源定义（CRD）

5.6.9.1. 拥有的 CRD复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

5.6.9.1. 拥有的 CRD
复制链接