第 11 章管理 AMQ Streams

11.1.1. 在自定义资源上执行 oc 操作
复制链接

使用 oc 命令，如 get, describe, edit, 或 delete, 对资源类型执行操作。例如，oc get kafkatopics 检索所有 Kafka 主题和 oc get kafkas 列表，检索所有部署的 Kafka 集群。

引用资源类型时，您可以使用单数和复数名称： oc get kafkas 获取与 oc get kafka 相同的结果。

您还可以使用资源 的短名称。学习短名称可在管理 AMQ Streams 时节省时间。Kafka 的短名称为 k，因此也可以运行 oc get k 来列出所有 Kafka 集群。

oc get k

NAME         DESIRED KAFKA REPLICAS   DESIRED ZK REPLICAS
my-cluster   3                        3

oc get k

NAME         DESIRED KAFKA REPLICAS   DESIRED ZK REPLICAS
my-cluster   3                        3

Copy to Clipboard

Toggle word wrap

Expand

表 11.1. 每个 AMQ Streams 资源的长和短名称
AMQ Streams 资源	长名称	短名称
Kafka	kafka	k
Kafka 主题	kafkatopic	kt
Kafka 用户	kafkauser	ku
Kafka Connect	kafkaconnect	kc
Kafka Connector	kafkaconnector	kctr
Kafka Mirror Maker	kafkamirrormaker	kmm
Kafka Mirror Maker 2	kafkamirrormaker2	kmm2
Kafka Bridge	kafkabridge	kb
Kafka Rebalance	kafkarebalance	kr

11.1.1.1. 资源类型( resource category)
复制链接

自定义资源的类别也可以在 oc 命令中使用。

所有 AMQ Streams 自定义资源都属于类别 strimzi，因此您可以使用 strimzi 获取所有 AMQ Streams 资源。

例如，运行 oc get strimzi 列出了给定命名空间中的所有 AMQ Streams 自定义资源。

oc get strimzi

NAME                                   DESIRED KAFKA REPLICAS DESIRED ZK REPLICAS
kafka.kafka.strimzi.io/my-cluster      3                      3

NAME                                   PARTITIONS REPLICATION FACTOR
kafkatopic.kafka.strimzi.io/kafka-apps 3          3

NAME                                   AUTHENTICATION AUTHORIZATION
kafkauser.kafka.strimzi.io/my-user     tls            simple

oc get strimzi

NAME                                   DESIRED KAFKA REPLICAS DESIRED ZK REPLICAS
kafka.kafka.strimzi.io/my-cluster      3                      3

NAME                                   PARTITIONS REPLICATION FACTOR
kafkatopic.kafka.strimzi.io/kafka-apps 3          3

NAME                                   AUTHENTICATION AUTHORIZATION
kafkauser.kafka.strimzi.io/my-user     tls            simple

Copy to Clipboard

Toggle word wrap

oc get strimzi -o name 命令返回所有资源类型和资源名称。-o name 选项以 type/name 格式获取输出

oc get strimzi -o name

kafka.kafka.strimzi.io/my-cluster
kafkatopic.kafka.strimzi.io/kafka-apps
kafkauser.kafka.strimzi.io/my-user

oc get strimzi -o name

kafka.kafka.strimzi.io/my-cluster
kafkatopic.kafka.strimzi.io/kafka-apps
kafkauser.kafka.strimzi.io/my-user

Copy to Clipboard

Toggle word wrap

您可以将这一 strimzi 命令与其他命令组合。例如，您可以将它传递到 oc delete 命令，以删除单个命令中的所有资源。

oc delete $(oc get strimzi -o name)

kafka.kafka.strimzi.io "my-cluster" deleted
kafkatopic.kafka.strimzi.io "kafka-apps" deleted
kafkauser.kafka.strimzi.io "my-user" deleted

oc delete $(oc get strimzi -o name)

kafka.kafka.strimzi.io "my-cluster" deleted
kafkatopic.kafka.strimzi.io "kafka-apps" deleted
kafkauser.kafka.strimzi.io "my-user" deleted

Copy to Clipboard

Toggle word wrap

在单个操作中删除所有资源可能很有用，例如，当您测试了新的 AMQ Streams 功能时。

11.1.1.2. 查询子资源的状态
复制链接

还有其他值，您可以传递给 -o 选项。例如，通过使用 -o yaml 以 YAML 格式获取输出。使用 -o json 将其返回为 JSON。

您可以在 oc get --help 中看到所有选项。

其中一个最有用的选项是 JSONPath 支持，它允许您传递 JSONPath 表达式来查询 Kubernetes API。JSONPath 表达式可以提取或导航任何资源的特定部分。

例如，您可以使用 JSONPath 表达式 {.status.listeners[? (@.name=="tls")].bootstrapServers} 从 Kafka 自定义资源的状态获取 bootstrap 地址，并在 Kafka 客户端中使用它。

在这里，该命令会找到名为 tls 的监听程序的 bootstrapServers 值：

oc get kafka my-cluster -o=jsonpath='{.status.listeners[?(@.name=="tls")].bootstrapServers}{"\n"}'

my-cluster-kafka-bootstrap.myproject.svc:9093

oc get kafka my-cluster -o=jsonpath='{.status.listeners[?(@.name=="tls")].bootstrapServers}{"\n"}'

my-cluster-kafka-bootstrap.myproject.svc:9093

Copy to Clipboard

Toggle word wrap

通过更改名称条件，您也可以获取其他 Kafka 监听器的地址。

您可以使用 jsonpath 从任何自定义资源中提取任何其他属性或属性组。

11.1.2. AMQ Streams 自定义资源状态信息
复制链接

几个资源具有一个 status 属性，如下表中所述。

Expand

表 11.2. 自定义资源状态属性
AMQ Streams 资源	架构参考	发布状态信息 on…
`Kafka`	第 12.2.55 节 “`KafkaStatus` 模式参考”	Kafka 集群。
`KafkaConnect`	第 12.2.85 节 “`KafkaConnectStatus` schema 参考”	Kafka Connect 集群（如果部署）。
`KafkaConnector`	第 12.2.123 节 “`KafkaConnectorStatus` schema 参考”	KafkaConnector 资源（如果部署）。
`KafkaMirrorMaker`	第 12.2.111 节 “`KafkaMirrorMakerStatus` 模式参考”	Kafka MirrorMaker 工具（如果部署）。
`KafkaTopic`	第 12.2.89 节 “`KafkaTopicStatus` 模式参考”	Kafka 集群中的 Kafka 主题。
`KafkaUser`	第 12.2.105 节 “`KafkaUserStatus` schema 参考”	Kafka 集群中的 Kafka 用户。
`KafkaBridge`	第 12.2.120 节 “`KafkaBridgeStatus` schema reference”	AMQ Streams Kafka Bridge （如果部署）。

资源的 status 属性提供资源的信息：

当前状态，在 status.conditions 属性中
最后观察到的生成，在 status.observedGeneration 属性中

status 属性还提供特定于资源的信息。例如：

KafkaStatus 提供有关监听程序地址的信息，以及 Kafka 集群的 id。
KafkaConnectStatus 为 Kafka Connect 连接器提供 REST API 端点。
KafkaUserStatus 提供 Kafka 用户的用户名，以及存储其凭证的 Secret。
KafkaBridgeStatus 提供 HTTP 地址，外部客户端应用程序可以访问 Bridge 服务。

资源的当前状态可用于跟踪与资源相关的进度，达到其所需状态，如 spec 属性所定义。状态条件提供资源更改和事件详细信息以及防止或延迟 Operator 实现资源所需状态的时间和原因。

最后观察到的生成 是 Cluster Operator 最后协调的资源的生成。如果 observedGeneration 的值与 metadata.generation 的值不同，Operator 还没有处理对该资源的最新更新。如果这些值相同，状态信息会显示对资源的最新更改。

AMQ Streams 创建并维护自定义资源的状态，定期评估自定义资源的当前状态并相应地更新其状态。当使用 oc edit 在自定义资源上执行更新时，则 其状态 不可编辑。此外，更改 状态 不会影响 Kafka 集群的配置。

此处我们看到为 Kafka 自定义资源指定的 status 属性。

带有状态的 Kafka 自定义资源

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
spec:
  # ...
status:
  conditions: 
  - lastTransitionTime: 2021-07-23T23:46:57+0000
    status: "True"
    type: Ready 
  observedGeneration: 4 
  listeners: 
  - addresses:
    - host: my-cluster-kafka-bootstrap.myproject.svc
      port: 9092
    type: plain
  - addresses:
    - host: my-cluster-kafka-bootstrap.myproject.svc
      port: 9093
    certificates:
    - |
      -----BEGIN CERTIFICATE-----
      ...
      -----END CERTIFICATE-----
    type: tls
  - addresses:
    - host: 172.29.49.180
      port: 9094
    certificates:
    - |
      -----BEGIN CERTIFICATE-----
      ...
      -----END CERTIFICATE-----
    type: external
  clusterId: CLUSTER-ID 
# ...

apiVersion: kafka.strimzi.io/v1beta2
kind: Kafka
metadata:
spec:
  # ...
status:
  conditions:

1


  - lastTransitionTime: 2021-07-23T23:46:57+0000
    status: "True"
    type: Ready

2


  observedGeneration: 4

3


  listeners:

4


  - addresses:
    - host: my-cluster-kafka-bootstrap.myproject.svc
      port: 9092
    type: plain
  - addresses:
    - host: my-cluster-kafka-bootstrap.myproject.svc
      port: 9093
    certificates:
    - |
      -----BEGIN CERTIFICATE-----
      ...
      -----END CERTIFICATE-----
    type: tls
  - addresses:
    - host: 172.29.49.180
      port: 9094
    certificates:
    - |
      -----BEGIN CERTIFICATE-----
      ...
      -----END CERTIFICATE-----
    type: external
  clusterId: CLUSTER-ID

5


# ...

Copy to Clipboard

Toggle word wrap

1: 状态条件 描述与从现有资源信息中无法推断的状态相关的标准，或者特定于资源实例。
2: Ready 条件指示 Cluster Operator 当前是否认为 Kafka 集群可以处理流量。
3: observedGeneration 表示由 Cluster Operator 最后协调的 Kafka 自定义资源的生成。
4: 侦听器 根据类型描述当前的 Kafka bootstrap 地址。
5: Kafka 集群 ID。
重要
目前还不支持带有 nodeport 的外部监听程序的自定义资源状态中的地址。

注意

状态中列出的 Kafka bootstrap 地址不表示这些端点或 Kafka 集群处于就绪状态。

访问状态信息

您可以从命令行访问资源的状态信息。更多信息请参阅第 11.1.3 节 “查找自定义资源的状态”。

11.1.3. 查找自定义资源的状态
复制链接

这个步骤描述了如何查找自定义资源的状态。

先决条件

OpenShift 集群。
Cluster Operator 正在运行。

流程

指定自定义资源，并使用 -o jsonpath 选项应用标准 JSONPath 表达式来选择 status 属性：
```
oc get kafka <kafka_resource_name> -o jsonpath='{.status}'
```
```
oc get kafka <kafka_resource_name> -o jsonpath='{.status}'
```
Copy to Clipboard Toggle word wrap
此表达式返回指定自定义资源的所有状态信息。您可以使用点表示法（如 status.listeners 或 status.observedGeneration ）来微调您要查看的状态信息。

11.1. 使用自定义资源
复制链接

11.1.1. 在自定义资源上执行 oc 操作
复制链接

11.1.1.1. 资源类型( resource category)
复制链接

11.1.1.2. 查询子资源的状态
复制链接

11.1.2. AMQ Streams 自定义资源状态信息
复制链接

11.1.3. 查找自定义资源的状态
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

第 11 章 管理 AMQ Streams

11.1. 使用自定义资源复制链接链接已复制到粘贴板!

11.1.1. 在自定义资源上执行 oc 操作复制链接链接已复制到粘贴板!

11.1.1.1. 资源类型( resource category)复制链接链接已复制到粘贴板!

11.1.1.2. 查询子资源的状态复制链接链接已复制到粘贴板!

11.1.2. AMQ Streams 自定义资源状态信息复制链接链接已复制到粘贴板!

11.1.3. 查找自定义资源的状态复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

第 11 章管理 AMQ Streams

11.1. 使用自定义资源
复制链接

11.1.1. 在自定义资源上执行 oc 操作
复制链接

11.1.1.1. 资源类型( resource category)
复制链接

11.1.1.2. 查询子资源的状态
复制链接

11.1.2. AMQ Streams 自定义资源状态信息
复制链接

11.1.3. 查找自定义资源的状态
复制链接