附录 B. 自定义资源 API 参考

使用 replicas 属性来配置副本。

复制的类型取决于资源。

使用 bootstrapServers 属性来配置 bootstrap 服务器列表。

bootstrap 服务器列表可以引用未在同一 OpenShift 集群中部署的 Kafka 集群。它们还可以引用 AMQ Streams 未部署的 Kafka 集群。

如果在同一 OpenShift 集群中，每个列表必须理想包含名为 CLUSTER-NAME -kafka-bootstrap 和端口号的 Kafka 集群 bootstrap 服务。如果由 AMQ Streams 部署，但在不同的 OpenShift 集群上，列表内容取决于用于公开集群（路由、节点端口或负载均衡器）的方法。

当在由 AMQ Streams 管理的 Kafka 集群中使用 Kafka 时，您可以根据给定集群的配置指定 bootstrap 服务器列表。

使用三个允许的 ssl 配置选项，将特定的 密码套件 用于 TLS 版本。密码套件组合了用于安全连接和数据传输的算法。

您还可以配置 ssl.endpoint.identification.algorithm 属性来 启用或禁用主机名验证。

# ...
spec:
  config:
    ssl.cipher.suites: "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" 1
    ssl.enabled.protocols: "TLSv1.2" 2
    ssl.protocol: "TLSv1.2" 3
    ssl.endpoint.identification.algorithm: HTTPS 4
# ...

通过 set tls 配置 TLS 加密，请使用 trustedCertificates 属性提供带有密钥名称的 secret 列表，并在其中以 X.509 格式存储证书。

您可以使用 Cluster Operator 为 Kafka 集群创建的 secret，或者创建自己的 TLS 证书文件，然后从文件创建 Secret ：

oc create secret generic MY-SECRET \
--from-file=MY-TLS-CERTIFICATE-FILE.crt

tls:
  trustedCertificates:
    - secretName: my-cluster-cluster-cert
      certificate: ca.crt
    - secretName: my-cluster-cluster-cert
      certificate: ca2.crt

如果证书存储在同一个 secret 中，则可以多次列出证书。

如果要启用 TLS，但使用 Java 附带的默认公共证书颁发机构集合，您可以将 trustedCertificates 指定为空数组：

tls:
  trustedCertificates: []

有关配置 TLS 客户端身份验证的详情，请参考 KafkaClientAuthenticationTls schema 参考。

您可以为组件请求 CPU 和内存资源。limits 指定给定容器可以消耗的最大资源。

在 Kafka 资源中设置 Topic Operator 和 User Operator 的资源请求和限值。

使用 reources.requests 和 resources.limits 属性来配置资源请求和限值。

对于每个部署的容器，AMQ Streams 允许您请求特定资源并定义这些资源的最大消耗。

AMQ Streams 支持以下资源类型的请求和限值：

AMQ Streams 使用 OpenShift 语法来指定这些资源。

有关在 OpenShift 中管理计算资源的更多信息，请参阅为容器管理计算资源。

资源请求

请求指定要为给定容器保留的资源。保留资源可确保资源始终可用。

可以为一个或多个支持的资源配置请求。

资源限值

limits 指定给定容器可以消耗的最大资源。限制不是保留的，可能并不总是可用。容器只能在资源可用时才使用资源限制。资源限制应始终大于资源请求。

资源可以被配置为一个或多个支持的限制。

支持的 CPU 格式

支持 CPU 请求和限制，其格式如下：

有关 CPU 规格的更多信息，请参阅 CPU 含义。

支持的内存格式

内存请求和限值以兆字节、千兆字节、兆字节和千兆字节为单位指定。

有关内存规格和其他支持单元的详情，请参阅 内存含义。

使用 image 属性配置组件使用的容器镜像。

建议仅在需要使用其他容器 registry 或自定义镜像的特殊情况下覆盖容器镜像。

例如，如果您的网络不允许访问 AMQ Streams 使用的容器存储库，您可以复制 AMQ Streams 镜像或从源构建它们。但是，如果配置的镜像与 AMQ Streams 镜像不兼容，它可能无法正常工作。

也可自定义容器镜像的副本，并用于调试。

您可以使用以下资源中的 image 属性来指定用于组件的容器镜像：

为 Kafka、Kafka Connect 和 Kafka MirrorMaker 配置 镜像 属性

Kafka、Kafka Connect（包括使用 S2I 支持的 Kafka Connect）和 Kafka MirrorMaker 支持多个 Kafka 版本。每个组件都需要自己的映像。在以下环境变量中配置了不同 Kafka 版本的默认镜像：

这些环境变量包含 Kafka 版本及其相应镜像之间的映射。映射与 镜像 和 版本 属性一同使用：

可以在以下属性中配置不同组件 的镜像 和 版本 ：

在其他资源中配置 image 属性

对于其他自定义资源中的 image 属性，在部署期间将使用给定值。如果缺少 image 属性，将使用 Cluster Operator 配置中指定的 镜像。如果 Cluster Operator 配置中没有定义 镜像名称，则会使用默认值。

apiVersion: kafka.strimzi.io/v1beta1
kind: Kafka
metadata:
  name: my-cluster
spec:
  kafka:
    # ...
    image: my-org/my-image:latest
    # ...
  zookeeper:
    # ...

使用 livenessProbe 和 readinessProbe 属性来配置 AMQ Streams 中支持的健康检查探测。

健康检查是定期测试，可验证应用的健康状况。当健康检查探测失败时，OpenShift 假定应用不健康，并尝试修复它。

有关探测的详情，请参阅 配置存活度和就绪度探测。

Live nessProbe 和 readinessProbe 均支持以下选项：

# ...
readinessProbe:
  initialDelaySeconds: 15
  timeoutSeconds: 5
livenessProbe:
  initialDelaySeconds: 15
  timeoutSeconds: 5
# ...

有关 livenessProbe 和 readinessProbe 选项的更多信息，请参阅 探测模式参考。

使用 metrics 属性来启用和配置 Prometheus 指标。

指标 属性也可以包含 Prometheus JMX 导出器的其他配置。AMQ Streams 支持使用 Prometheus JMX 导出器的 Prometheus 指标将 Apache Kafka 和 ZooKeeper 支持的 JMX 指标转换为 Prometheus 指标。

要在不进一步配置的情况下启用 Prometheus 指标导出，您可以将其设置为空对象({})。

启用指标数据后，它们会在端口 9404 上公开。

当资源中没有定义 metrics 属性时，Prometheus 指标会被禁用。

有关设置和部署 Prometheus 和 Grafana 的更多信息，请参阅 OpenShift 指南中的 Deploying 和 升级 AMQ Streams 中的 介绍 Metrics 到 Kafka。

可以使用以下资源中的 jvmOptions 属性配置 JVM 选项：

只支持以下 JVM 选项：

用于 -Xms 和 -Xmx 的默认值取决于是否有为容器配置的 内存请求 限值。

在明确设置 -Xmx 时，建议您这样做：

# ...
jvmOptions:
  "-Xmx": "2g"
  "-Xms": "2g"
# ...

在上例中，JVM 会将 2 GiB（=2,147,483,648 字节）用于其堆。其总内存用量大约为 8GiB。

为初始(-Xms)和最大(-Xmx)堆大小设置相同的值可避免 JVM 启动后分配内存，其代价可能是分配超过真正需要的堆数。对于 Kafka 和 ZooKeeper pod，此类分配可能会导致不必要的延迟。对于 Kafka Connect 避免过度分配，可能是最重要的问题，特别是在分布式模式中，过度分配的效果会乘以消费者的数量。

-server

-server 启用服务器 JVM。这个选项可以设为 true 或 false。

# ...
jvmOptions:
  "-server": true
# ...

-XX

-XX 对象可用于配置 JVM 的高级运行时选项。server 和 -XX 选项用于配置 Apache Kafka 的 KAFKA_JVM_PERFORMANCE_OPTS 选项。

jvmOptions:
  "-XX":
    "UseG1GC": true
    "MaxGCPauseMillis": 20
    "InitiatingHeapOccupancyPercent": 35
    "ExplicitGCInvokesConcurrent": true

以上示例配置将导致以下 JVM 选项：

-XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+ExplicitGCInvokesConcurrent -XX:-UseParNewGC

jvmOptions 属性还允许您启用和禁用垃圾收集器(GC)日志记录。默认禁用 GC 日志。要启用它，请按如下方式设置 gcLoggingEnabled 属性：

# ...
jvmOptions:
  gcLoggingEnabled: true
# ...