1.3. AMQ Streams 自定义资源

使用 AMQ Streams 将 Kafka 组件部署到 OpenShift 集群可通过应用自定义资源进行高度配置。自定义资源作为自定义资源定义(CRD)添加的 API 实例创建，以扩展 OpenShift 资源。

CRD 用作描述 OpenShift 集群中自定义资源的配置说明，并为部署中使用的每个 Kafka 组件以及用户和主题提供 AMQ Streams。CRD 和自定义资源定义为 YAML 文件。AMQ Streams 发行版提供了示例 YAML 文件。

CRD 还允许 AMQ Streams 资源受益于原生 OpenShift 功能，如 CLI 访问和配置验证。

其它资源

1.3.1. AMQ Streams 自定义资源示例

CRD 需要在集群中进行一次性安装，以定义用于实例化和管理 AMQ Streams 特定资源的 schema。

通过安装 CRD 在集群中添加新的自定义资源类型后，您可以根据具体规格创建资源实例。

根据集群设置，安装通常需要集群管理员特权。

注意

管理自定义资源的访问权限仅限于 AMQ Streams 管理员。如需更多信息，请参阅 OpenShift 上部署和升级 AMQ 流指南中的指定 AMQ 流 管理员。

CRD 在 OpenShift 集群中定义 一种 新型资源，如 kind:Kafka。

Kubernetes API 服务器允许基于 kind 创建自定义资源，并且从 CRD 中了解如何在添加到 OpenShift 集群时验证和存储自定义资源。

警告

当 CRD 被删除时，该类型的自定义资源也会被删除。另外，自定义资源创建的资源也会被删除，如 pod 和 statefulsets。

每个 AMQ Streams 特定自定义资源都符合 CRD 为资源类型定义的 schema 。AMQ Streams 组件的自定义资源具有常见的配置属性，这些属性在 spec 下定义。

要了解 CRD 和自定义资源之间的关系，让我们看一下 Kafka 主题的 CRD 示例。

Kafka 主题 CRD

apiVersion: kafka.strimzi.io/v1beta2
kind: CustomResourceDefinition
metadata: 1
  name: kafkatopics.kafka.strimzi.io
  labels:
    app: strimzi
spec: 2
  group: kafka.strimzi.io
  versions:
    v1beta2
  scope: Namespaced
  names:
    # ...
    singular: kafkatopic
    plural: kafkatopics
    shortNames:
    - kt 3
  additionalPrinterColumns: 4
      # ...
  subresources:
    status: {} 5
  validation: 6
    openAPIV3Schema:
      properties:
        spec:
          type: object
          properties:
            partitions:
              type: integer
              minimum: 1
            replicas:
              type: integer
              minimum: 1
              maximum: 32767
      # ...

1
主题 CRD 的元数据、名称和标识 CRD 的标签。
2
此 CRD 的规格，包括组（域）名称、复数名称和支持的 schema 版本，用于 URL 以访问该主题的 API。其他名称用于标识 CLI 中的实例资源。例如，oc get kafkatopic my-topic 或 oc get kafkatopics。
3
可以在 CLI 命令中使用短名称。例如，oc get kt 可用作缩写而不是 oc get kafkatopic。
4
在自定义资源上使用 get 命令时显示的信息。
5
CRD 的当前状态，如资源的 schema 引用 中所述。
6
OpenAPIV3Schema 验证提供了用于创建主题自定义资源的验证。例如，一个主题至少需要一个分区和一个副本。
注意

您可以识别 AMQ Streams 安装文件提供的 CRD YAML 文件，因为文件名包含索引号后跟 'Crd'。

以下是 KafkaTopic 自定义资源的对应示例。

Kafka 主题自定义资源

apiVersion: kafka.strimzi.io/v1beta2
kind: KafkaTopic 1
metadata:
  name: my-topic
  labels:
    strimzi.io/cluster: my-cluster 2
spec: 3
  partitions: 1
  replicas: 1
  config:
    retention.ms: 7200000
    segment.bytes: 1073741824
status:
  conditions: 4
    lastTransitionTime: "2019-08-20T11:37:00.706Z"
    status: "True"
    type: Ready
  observedGeneration: 1
  / ...

1
kind 和 apiVersion 标识自定义资源是实例的 CRD。
2
个标签，仅适用于 KafkaTopic 和 KafkaUser 资源，定义 Kafka 集群的名称（与 Kafka 资源的名称相同），该标签定义某个主题或用户所属的名称。
3
spec 显示主题的分区和副本数量，以及主题本身的配置参数。在本例中，消息保留周期保留在主题中，并指定日志的片段文件大小。
4
KafkaTopic 资源的状态条件。在 lastTransitionTime 中，类型 条件更改为 Ready。

自定义资源可以通过平台 CLI 应用到集群。创建自定义资源时，它将使用与 Kubernetes API 内置资源相同的验证。

创建 KafkaTopic 自定义资源后，Tpic Operator 将获得通知，并在 AMQ Streams 中创建对应的 Kafka 主题。