在 OpenShift 上部署 AMQ Broker

流程

1. 在 Web 浏览器中，导航到 AMQ Broker 7.10.7 发行版本的 Software Downloads 页面。
2. 确保 Version 下拉列表的值设为 7.10.7，并且选择了 Releases 选项卡。

3. 在 AMQ Broker 7.10.7 Operator Installation and Example Files 旁边，点 Download。

   下载 amq-broker-operator-7.10.7-ocp-install-examples.zip 压缩存档会自动开始。

4. 将存档移到您选择的目录。以下示例将存档 移到名为 ~/broker/operator 的目录。

   $ mkdir ~/broker/operator
   $ mv amq-broker-operator-7.10.7-ocp-install-examples.zip ~/broker/operator

5. 在您选择的目录中，提取存档的内容。例如：

   $ cd ~/broker/operator
   $ unzip amq-broker-operator-7.10.7-ocp-install-examples.zip

6. 切换到提取存档时创建的目录。例如：

   $ cd amq-broker-operator-7.10.7-ocp-install-examples

7. 以集群管理员身份登录 OpenShift Container Platform。例如：

   $ oc login -u system:admin

8. 指定要安装 Operator 的项目。您可以创建新项目或切换到现有项目。

   1. 创建一个新项目

      $ oc new-project <project_name>

   2. 或者，切换到现有项目：

      $ oc project <project_name>

9. 指定要与 Operator 搭配使用的服务帐户。

   1. 在您提取的 Operator 归档的 deploy 目录中，打开 service_account.yaml 文件。
   2. 确保 kind 元素设置为 ServiceAccount。
   3. 如果要更改默认服务帐户名称，在 metadata 部分中，将 amq-broker-operator 替换为自定义名称。

   4. 在项目中创建服务帐户。

      $ oc create -f deploy/service_account.yaml

10. 为 Operator 指定角色名称。

    1. 打开 role.yaml 文件。此文件指定 Operator 可以使用和修改资源。
    2. 确保 kind 元素设为 Role。
    3. 如果要更改默认角色名称，在 metadata 部分中，将 amq-broker-operator 替换为自定义名称。

    4. 在项目中创建角色。

       $ oc create -f deploy/role.yaml

11. 为 Operator 指定角色绑定。角色绑定根据您指定的名称将之前创建的服务帐户绑定到 Operator 角色。

    1. 打开 role_binding.yaml 文件。

    2. 确保 ServiceAccount 和 Role 的 name 值与 service_account.yaml 和 role.yaml 文件中指定的匹配。例如：

       metadata:
           name: amq-broker-operator
       subjects:
           kind: ServiceAccount
           name: amq-broker-operator
       roleRef:
           kind: Role
           name: amq-broker-operator

    3. 在项目中创建角色绑定。

       $ oc create -f deploy/role_binding.yaml

12. 为 Operator 指定领导选举角色绑定。角色绑定根据您指定的名称将之前创建的服务帐户绑定到领导选举角色。

    1. 为 Operator 创建领导选举角色。

       $ oc create -f deploy/election_role.yaml

    2. 在项目中创建领导选举角色绑定。

       $ oc create -f deploy/election_role_binding.yaml

13. （可选）如果希望 Operator 监视多个命名空间，请完成以下步骤：

    注意

    如果 OpenShift Container Platform 集群已经包含 AMQ Broker 安装的 Operator，您必须确保新的 Operator 不会监视与现有 Operator 相同的任何命名空间。有关如何识别现有 Operator 所监视的命名空间的信息，请参阅 识别现有 Operator 监视的命名空间。

    1. 在您下载并提取的 Operator 归档的 deploy 目录中，打开 operator_yaml 文件。

    2. 如果您希望 Operator 监控集群中的所有命名空间，在 WATCH_NAMESPACE 部分中添加一个 value 属性，并将值设为星号。注释掉 WATCH_NAMESPACE 部分中的现有属性。例如：

       - name: WATCH_NAMESPACE
         value: "*"
       # valueFrom:
       #   fieldRef:
       #     fieldPath: metadata.namespace

       注意

       为了避免冲突，请确保多个 Operator 不会监视相同的命名空间。例如，如果您部署一个 Operator 来监控 集群中的所有命名空间，则无法部署另一个 Operator 来监控单独的命名空间。如果 Operator 已在集群中部署，您可以指定新 Operator 监视的命名空间列表，如下所述。

    3. 如果您希望 Operator 观察多个，但并非集群中的所有命名空间，在 WATCH_NAMESPACE 部分指定命名空间列表。确保排除现有 Operator 监视的任何命名空间。例如：

       - name: WATCH_NAMESPACE
         value: "namespace1, namespace2"`.

    4. 在您下载并提取的 Operator 归档的 deploy 目录中，打开 cluster_role_binding.yaml 文件。

    5. 在 Subjects 部分中，指定一个 与部署 Operator 的 OpenShift Container Platform 项目对应的命名空间。例如：

       Subjects:
       - kind: ServiceAccount
         name: activemq-artemis-controller-manager
         namespace: operator-project

       注意

       如果您之前使用早期版本的 Operator 部署代理，并且希望部署 Operator 来监控多个命名空间，请参阅 升级前。

    6. 在项目中创建集群角色。

       $ oc create -f deploy/cluster_role.yaml

    7. 在项目中创建集群角色绑定。

       $ oc create -f deploy/cluster_role_binding.yaml

流程

1. 在 OpenShift 命令行界面(CLI)中，以集群管理员的身份登录到 OpenShift。例如：

   $ oc login -u system:admin

2. 切换到您之前为 Operator 部署准备的项目。例如：

   $ oc project <project_name>

3. 切换到之前提取 Operator 安装存档时创建的目录。例如：

   $ cd ~/broker/operator/amq-broker-operator-7.10.7-ocp-install-examples

4. 部署 Operator 中包含的 CRD。您必须在部署和启动 Operator 前，在 OpenShift 集群中安装 CRD。

   1. 部署主代理 CRD。

      $ oc create -f deploy/crds/broker_activemqartemis_crd.yaml

   2. 部署地址 CRD。

      $ oc create -f deploy/crds/broker_activemqartemisaddress_crd.yaml

   3. 部署 scaledown 控制器 CRD。

      $ oc create -f deploy/crds/broker_activemqartemisscaledown_crd.yaml

   4. 部署安全 CRD：

      $ oc create -f deploy/crds/broker_activemqartemissecurity_crd.yaml

5. 将与 Red Hat Ecosystem Catalog 进行身份验证时使用的账户相关联的 pull secret 与您的 OpenShift 项目的 default, deployer, 和 builder 服务账户进行链接。

   $ oc secrets link --for=pull default <secret_name>
   $ oc secrets link --for=pull deployer <secret_name>
   $ oc secrets link --for=pull builder <secret_name>

6. 在您下载并提取的 Operator 归档的 deploy 目录中，打开 operator.yaml 文件。确保 spec.containers.image 属性的值对应于 Operator 的 7.10.7-opr-1 版本，如下所示。

   spec:
       template:
           spec:
               containers:
                   #image: registry.redhat.io/amq7/amq-broker-rhel8-operator:7.10
                   image: registry.redhat.io/amq7/amq-broker-rhel8-operator@sha256:1a7aa54d2799d238eb5f49f7a95a78a896f6bf8d222567e9118e0e3963cc9aad

   注意

   在 operator.yaml 文件中，Operator 使用一个由 Secure Hash Algorithm (SHA) 值代表的镜像。注释行以数字符号 (#) 符号开头，注明 SHA 值对应于特定的容器镜像标签。

7. 部署 Operator。

   $ oc create -f deploy/operator.yaml

   在 OpenShift 项目中，Operator 会在新 Pod 中启动。

   在 OpenShift Container Platform Web 控制台中，Operator Pod 的 Events 选项卡的信息确认 OpenShift 已部署了您指定的 Operator 镜像，已向 OpenShift 集群中的节点分配新容器，并已启动新的容器。

   另外，如果您点击 Pod 中的 Logs 选项卡，输出应包含以下几行：

   ...
   {"level":"info","ts":1553619035.8302743,"logger":"kubebuilder.controller","msg":"Starting Controller","controller":"activemqartemisaddress-controller"}
   {"level":"info","ts":1553619035.830541,"logger":"kubebuilder.controller","msg":"Starting Controller","controller":"activemqartemis-controller"}
   {"level":"info","ts":1553619035.9306898,"logger":"kubebuilder.controller","msg":"Starting workers","controller":"activemqartemisaddress-controller","worker count":1}
   {"level":"info","ts":1553619035.9311671,"logger":"kubebuilder.controller","msg":"Starting workers","controller":"activemqartemis-controller","worker count":1}

   前面的输出确认新部署的 Operator 与 Kubernetes 通信，代理和寻址的控制器正在运行，这些控制器已启动一些 worker。

流程

1. 以集群管理员身份登录 OpenShift Container Platform Web 控制台。
2. 在左侧导航菜单中，点 Operators → OperatorHub。
3. 在 OperatorHub 页面顶部的 Project 下拉菜单中，选择要在其上部署 Operator 的项目。

4. 在 OperatorHub 页面中，使用 Filter by keyword…​ 复选框 为 RHEL 8(Multiarch)Operator 找到 Red Hat Integration - AMQ Broker。

   注意

   在 OperatorHub 中，您可能会发现多个 Operator 多于在其名称中包含 AMQ Broker。确保为 RHEL 8(Multiarch)Operator 点 Red Hat Integration - AMQ Broker。当点此 Operator 时，请查看打开的信息窗格。对于 AMQ Broker 7.10，Operator 的最新次要版本标签为 7.10.7-opr-1。

5. 点 Red Hat Integration - AMQ Broker for RHEL 8(Multiarch) Operator。在出现的对话框中，点 Install。

6. 在 Install Operator 页面中：

   1. 在 Update Channel 下，选择 7.10.x 频道，以只接收版本 7.10 的更新。7.10.x 频道是当前的 Long Term Support (LTS)频道。

      注意

      以下频道也可见：

      • 7.x - 当前，此频道只为版本 7.9 提供更新。
      • 7.8.x - 此频道仅为版本 7.8 提供更新，并且是之前的 Long Term Support (LTS)频道。
      • 根据安装 OpenShift Container Platform 集群的时间，您可能还会看到 Alpha, current and current-76 等频道，这些频道适用于较旧版本的 AMQ Broker，可以被忽略。

   2. 在 Installation Mode 下，选择 Operator 监视的命名空间：

      • 集群上的特定命名空间 - Operator 已安装在该命名空间中，仅监控该命名空间以了解 CR 更改。
      • All namespaces - Operator 会监控所有命名空间以了解 CR 更改。
      注意

      如果您之前使用早期版本的 Operator 部署代理，而您希望部署 Operator 以观察多个命名空间，请参阅升级前的操作。

7. 在 Installed Namespace 下拉菜单中选择您要在其中安装 Operator 的项目。
8. 在 批准策略 下，确保选择了授权 Automatic 的单选按钮。这个选项指定对 Operator 的更新不需要手动批准才能进行安装。
9. 点 Install。

1. 开始为代理部署配置自定义资源(CR)实例。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在用于创建部署的项目中部署 CR 的用户身份登录 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在用于创建部署的项目中部署 CR 的用户登录到控制台。
      2. 根据主代理 CRD 启动一个新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemis。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

   对于基本的代理部署，配置可能类似以下示例。

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true

   观察到 broker_activemqartemis_cr.yaml 示例 CR 文件中，image 属性设为 占位符 默认值。此值表示默认情况下，image 属性不指定用于部署的代理容器镜像。要了解 Operator 如何确定要使用的适当代理容器镜像，请参阅 第 2.4 节 “Operator 如何选择容器镜像”。

   注意

   broker_activemqartemis_cr.yaml 示例 CR 使用 ex-aao 的命名约定。这个命名惯例表示 CR 是 AMQ Broker Operator 的示例 资源。AMQ Broker 基于 ActiveMQ Artemis 项目。部署此示例 CR 时，生成的 StatefulSet 会使用名称 ex-aao-s。另外，部署中的代理 Pod 直接基于 StatefulSet 名称，如 ex-aao-s-0、ex-aao-s-1 等等。CR 中的应用程序名称作为 StatefulSet 上的标签出现在部署中。例如，您可以在 Pod 选择器中使用该标签。

2. size 属性指定要部署的代理数量。指定为 2 个或更多个集群代理部署。但是，要部署单个代理实例，请确保该值设置为 1。

3. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到您要在其中创建代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 配置完 CR 后，点 Create。

4. 在 OpenShift Container Platform web 控制台中，点击 Workloads → StatefulSets。您会看到一个名为 ex-aao-ss 的新 StatefulSet。

   1. 点 ex-aao-s StatefulSet。您会看到一个 Pod，对应于您在 CR 中定义的单个代理。
   2. 在 StatefulSet 中，点 Pods 选项卡。点 ex-aao-ss Pod。在运行 Pod 的 Events 选项卡中，您会看到 broker 容器已启动。Logs 选项卡显示代理本身正在运行。

5. 要测试代理是否正常运行，请访问代理 Pod 中的 shell 来发送一些测试消息。

   1. 使用 OpenShift Container Platform Web 控制台：

      1. 单击 Workloads → Pods。
      2. 点 ex-aao-ss Pod。
      3. 点击 Terminal 选项卡。

   2. 使用 OpenShift 命令行界面：

      1. 获取项目的 Pod 名称和内部 IP 地址。

         $ oc get pods -o wide
         
         NAME                          STATUS   IP
         amq-broker-operator-54d996c   Running  10.129.2.14
         ex-aao-ss-0                   Running  10.129.2.15

      2. 访问代理 Pod 的 shell。

         $ oc rsh ex-aao-ss-0

6. 在 shell 中，使用 artemis 命令发送一些测试消息。在 URL 中指定代理 Pod 的内部 IP 地址。例如：

   sh-4.2$ ./amq-broker/bin/artemis producer --url tcp://10.129.2.15:61616 --destination queue://demoQueue

   以上命令会在代理上自动创建一个名为 demoQueue 的队列，并将默认数量 1000 个消息发送到队列。

   您应该看到类似如下的输出：

   Connection brokerURL = tcp://10.129.2.15:61616
   Producer ActiveMQQueue[demoQueue], thread=0 Started to calculate elapsed time ...
   
   Producer ActiveMQQueue[demoQueue], thread=0 Produced: 1000 messages
   Producer ActiveMQQueue[demoQueue], thread=0 Elapsed time in second : 3 s
   Producer ActiveMQQueue[demoQueue], thread=0 Elapsed time in milli second : 3492 milli seconds

流程

1. 打开用于基本代理部署的 CR 文件。

2. 对于集群的部署，请确保 deploymentPlan.size 的值为 2 或更高。例如：

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
     deploymentPlan:
       size: 4
       image: placeholder
       ...

   注意

   在 metadata 部分中，您需要包含 namespace 属性，只有在 使用 OpenShift Container Platform Web 控制台来创建 CR 实例时才指定一个值。您应该指定的值是代理部署的 OpenShift 项目的名称。

3. 保存修改后的 CR 文件。

4. 以有权在项目中创建基本代理部署的项目中部署 CR 的用户身份登录 OpenShift。

   $ oc login -u <user> -p <password> --server=<host:port>

5. 切换到您之前在其中创建基本代理部署的项目。

   $ oc project <project_name>

6. 在命令行中应用更改：

   $ oc apply -f <path/to/custom_resource_instance>.yaml

   在 OpenShift Container Platform Web 控制台中，根据 CR 中指定的数量，其他代理 Pod 会在您的项目中启动。默认情况下，在项目中运行的代理会被集群。

7. 打开每个 Pod 的 Logs 选项卡。日志显示 OpenShift 在每个代理上建立了一个集群连接桥接。具体来说，日志输出包括如下一行：

   targetConnector=ServerLocatorImpl (identity=(Cluster-connection-bridge::ClusterConnectionBridge@6f13fb88

1. Operator 在代理应用程序容器前运行 Init 容器。Init 容器生成 默认 地址设置配置。默认地址设置配置如下所示。

   <address-settings>
       <!--
       if you define auto-create on certain queues, management has to be auto-create
       -->
       <address-setting match="activemq.management#">
           <dead-letter-address>DLQ</dead-letter-address>
           <expiry-address>ExpiryQueue</expiry-address>
           <redelivery-delay>0</redelivery-delay>
           <!--
           with -1 only the global-max-size is in use for limiting
           -->
           <max-size-bytes>-1</max-size-bytes>
           <message-counter-history-day-limit>10</message-counter-history-day-limit>
           <address-full-policy>PAGE</address-full-policy>
           <auto-create-queues>true</auto-create-queues>
           <auto-create-addresses>true</auto-create-addresses>
           <auto-create-jms-queues>true</auto-create-jms-queues>
           <auto-create-jms-topics>true</auto-create-jms-topics>
       </address-setting>
   
       <!-- default for catch all -->
       <address-setting match="#">
           <dead-letter-address>DLQ</dead-letter-address>
           <expiry-address>ExpiryQueue</expiry-address>
           <redelivery-delay>0</redelivery-delay>
           <!--
           with -1 only the global-max-size is in use for limiting
           -->
           <max-size-bytes>-1</max-size-bytes>
           <message-counter-history-day-limit>10</message-counter-history-day-limit>
           <address-full-policy>PAGE</address-full-policy>
           <auto-create-queues>true</auto-create-queues>
           <auto-create-addresses>true</auto-create-addresses>
           <auto-create-jms-queues>true</auto-create-jms-queues>
           <auto-create-jms-topics>true</auto-create-jms-topics>
       </address-setting>
   <address-settings>

2. 如果您在自定义资源(CR)实例中指定了地址设置配置，Init 容器进程会进行配置并将其转换为 XML。
3. 根据 CR 中的 applyRule 属性的值，Init 容器 合并 或者将 上面显示的默认地址设置配置替换为您在 CR 中指定的配置。这种合并或替换后是代理将使用的最终地址设置配置。
4. 当 Init 容器完成生成代理配置（包括地址设置）时，代理应用程序容器会启动。开始时，代理容器会复制之前由 Init 容器使用的安装目录中的配置。您可以检查 broker.xml 配置文件中的地址设置配置。对于正在运行的代理，这个文件位于 /home/jboss/amq-broker/etc 目录中。

流程

1. 开始配置自定义资源(CR)实例，以定义代理部署的地址和队列。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemisaddress_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在项目中部署 CR 的用户登录到控制台，以进行代理部署。
      2. 根据地址 CRD 启动新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemisAddresss CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemisAddress。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

2. 在 CR 的 spec 部分，添加行来定义地址、队列和路由类型。例如：

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemisAddress
   metadata:
       name: myAddressDeployment0
       namespace: myProject
   spec:
       ...
       addressName: myAddress0
       queueName: myQueue0
       routingType: anycast
       ...

   上述配置定义了名为 myAddress0 的地址，其队列名为 myQueue0，以及任何 广播 路由类型。

   注意

   在 metadata 部分中，您需要包含 namespace 属性，只有在 使用 OpenShift Container Platform Web 控制台来创建 CR 实例时才指定一个值。您应该指定的值是代理部署的 OpenShift 项目的名称。

3. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/address_custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 配置完 CR 后，点 Create。

4. （可选）若要使用 CR 实例删除之前添加到部署的地址和队列，请使用以下命令：

   $ oc delete -f <path/to/address_custom_resource_instance>.yaml

流程

1. 开始配置 CR 实例，以添加死信地址和队列，以接收部署中的每个代理的消息。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemisaddress_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在项目中部署 CR 的用户登录到控制台，以进行代理部署。
      2. 根据地址 CRD 启动新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemisAddresss CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemisAddress。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

2. 在 CR 的 spec 部分，添加行以指定死信地址和队列以接收未传输的消息。例如：

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemisAddress
   metadata:
     name: ex-aaoaddress
   spec:
     ...
     addressName: myDeadLetterAddress
     queueName: myDeadLetterQueue
     routingType: anycast
     ...

   上述配置定义了一个名为 myDeadLetterAddress 的死信地址，其死信队列为 myDeadLetterQueue 和 anycast 路由类型。

   注意

   在 metadata 部分中，您需要包含 namespace 属性，只有在 使用 OpenShift Container Platform Web 控制台来创建 CR 实例时才指定一个值。您应该指定的值是代理部署的 OpenShift 项目的名称。

3. 部署地址 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到代理部署的项目。

         $ oc project <project_name>

      3. 创建地址 CR。

         $ oc create -f <path/to/address_custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 配置完 CR 后，点 Create。

4. 启动为代理部署配置自定义资源(CR)实例。

   1. 在示例 CR 文件中：

      1. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 根据主代理 CRD 启动一个新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      2. 单击 ActiveMQArtemis CRD。
      3. 点 实例 选项卡。

      4. 单击 Create ActiveMQArtemis。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

   对于基本的代理部署，配置可能类似以下示例。

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true

   观察到 broker_activemqartemis_cr.yaml 示例 CR 文件中，image 属性设为 占位符 默认值。此值表示默认情况下，image 属性不指定用于部署的代理容器镜像。要了解 Operator 如何确定要使用的适当代理容器镜像，请参阅 第 2.4 节 “Operator 如何选择容器镜像”。

   注意

   在 metadata 部分中，您需要包含 namespace 属性，只有在 使用 OpenShift Container Platform Web 控制台来创建 CR 实例时才指定一个值。您应该指定的值是代理部署的 OpenShift 项目的名称。

5. 在 CR 的 deploymentPlan 部分中，添加一个包含单个 addressSetting 部分的新 addressSettings 部分，如下所示。

   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true
     addressSettings:
       addressSetting:

6. 将 match 属性的单个实例添加到 addressSetting 块。指定地址匹配表达式。例如：

   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true
     addressSettings:
       addressSetting:
       -  match: myAddress

   匹配

   指定代理将配置应用到的地址 或一组 地址。在本例中，match 属性的值与一个名为 myAddress 的单个地址对应。

7. 添加与未传输的消息相关的属性并指定值。例如：

   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true
     addressSettings:
       addressSetting:
       - match: myAddress
         deadLetterAddress: myDeadLetterAddress
         maxDeliveryAttempts: 5

   deadLetterAddress

   代理发送未接收的消息的地址。

   maxDeliveryAttempts

   代理在将消息移动到配置的死信地址前进行的最大交付尝试数。

   在前面的示例中，如果代理失败试图将消息发送到以 myAddress 开头的地址，代理会将消息移到指定的死信地址 myDeadLetterAddress 中。

8. （可选）将类似的配置应用到另一个地址或一组地址。例如：

   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true
     addressSettings:
       addressSetting:
       - match: myAddress
         deadLetterAddress: myDeadLetterAddress
         maxDeliveryAttempts: 5
       - match: 'myOtherAddresses*'
         deadLetterAddress: myDeadLetterAddress
         maxDeliveryAttempts: 3

   在本例中，第二个 match 属性的值包含一个星号通配符。通配符字符表示上述配置应用于以字符串 myOtherAddresses 开头的任何地址。

   注意

   如果您使用通配符表达式作为 match 属性的值，则必须将值放在单引号中，如 'myOtherAddresses*'。

9. 在 addressSettings 部分的开头，添加 applyRule 属性并指定一个值。例如：

   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true
     addressSettings:
       applyRule: merge_all
       addressSetting:
       - match: myAddress
         deadLetterAddress: myDeadLetterAddress
         maxDeliveryAttempts: 5
       - match: 'myOtherAddresses*'
         deadLetterAddress: myDeadLetterAddress
         maxDeliveryAttempts: 3

   applyRule 属性指定 Operator 如何为每个匹配地址或一组地址应用您添加到 CR 的配置。您可以指定的值有：

   merge_all

   • 对于 CR 中指定的地址设置，以及 符合相同地址或一组地址的默认配置：

     • 将默认配置中指定的任何属性值替换为 CR 中指定的值。
     • 保留在 CR 或 默认配置中指定的任何属性值。请在最终合并的配置中包含其中之一。
   • 对于在 CR 中指定的地址设置，或者唯一匹配一个特定地址或一组地址的默认配置，将它们包括在最终合并的配置中。

   merge_replace

   • 对于 CR 中指定的地址设置，以及 符合相同地址或一组地址的默认配置，请将 CR 中指定的设置包括在最终合并的配置中。不要 包括默认配置中指定的任何属性，即使 CR 中没有指定这些属性。
   • 对于在 CR 中指定的地址设置，或者唯一匹配一个特定地址或一组地址的默认配置，将它们包括在最终合并的配置中。

   replace_all

   使用在 CR 中指定的内容替换默认配置中指定的所有地址设置最后，合并的配置与 CR 中指定的完全相同。

   注意

   如果您没有在 CR 中明确包含 applyRule 属性，Operator 将使用默认值 merge_all。

10. 部署代理 CR 实例。

    1. 使用 OpenShift 命令行界面：

       1. 保存 CR 文件。

       2. 创建 CR 实例。

          $ oc create -f <path/to/broker_custom_resource_instance>.yaml

    2. 使用 OpenShift Web 控制台：

       1. 配置完 CR 后，点 Create。

1. 开始配置自定义资源(CR)实例，以定义代理部署的用户和相关安全配置。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemissecurity_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在项目中部署 CR 的用户登录到控制台，以进行代理部署。
      2. 根据地址 CRD 启动新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemisSecurity CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemisSecurity。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

2. 在 CR 的 spec 部分，添加行来定义用户和角色。例如：

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemisSecurity
   metadata:
     name: ex-prop
   spec:
     loginModules:
       propertiesLoginModules:
         - name: "prop-module"
           users:
             - name: "sam"
               password: "samspassword"
               roles:
                 - "sender"
             - name: "rob"
               password: "robspassword"
               roles:
                 - "receiver"
     securityDomains:
       brokerDomain:
         name: "activemq"
         loginModules:
           - name: "prop-module"
             flag: "sufficient"
     securitySettings:
       broker:
         - match: "#"
           permissions:
             - operationType: "send"
               roles:
                 - "sender"
             - operationType: "createAddress"
               roles:
                 - "sender"
             - operationType: "createDurableQueue"
               roles:
                 - "sender"
             - operationType: "consume"
               roles:
                 - "receiver"
                 ...

   注意

   始终为上例中的元素指定值。例如，如果没有为 role 指定 securityDomains.brokerDomain 或 values 的值，则生成的配置可能会导致意外结果。

   上述配置定义了两个用户：

   • 名为 prop-module 的 propertiesLoginModule 定义一个名为 sam 的用户，角色名为 sender。
   • 名为 prop-module 的 propertiesLoginModule，它定义名为 rob 的角色以及名为 receiver 的角色。

   这些角色的属性在 securityDomains 的 brokerDomain 和 broker 部分中定义。例如，定义了 send 角色，以允许具有该角色的用户在任何地址上创建持久队列。默认情况下，配置会应用到当前命名空间中 CR 定义的所有已部署代理。要将配置限制为特定的代理部署，请使用 第 8.1.3 节 “安全自定义资源配置参考” 中描述的 applyToCrNames 选项。

   注意

   在 metadata 部分中，您需要包含 namespace 属性，只有在 使用 OpenShift Container Platform Web 控制台来创建 CR 实例时才指定一个值。您应该指定的值是代理部署的 OpenShift 项目的名称。

3. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/address_custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 配置完 CR 后，点 Create。

流程

1. 使用 oc create secret 命令创建 secret，并添加每个用户名和密码。secret 名称必须遵循 security-properties-module name 的命名约定，其中 module name 是 CR 中配置的登录模块的名称。例如：

   oc create secret generic security-properties-prop-module \
     --from-literal=sam=samspassword \
     --from-literal=rob=robspassword

2. 在 CR 的 spec 部分中，添加您在 secret 中指定的用户名以及角色信息，但不包括每个用户的密码。例如：

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemisSecurity
   metadata:
     name: ex-prop
   spec:
     loginModules:
       propertiesLoginModules:
         - name: "prop-module"
           users:
             - name: "sam"
               roles:
                 - "sender"
             - name: "rob"
               roles:
                 - "receiver"
     securityDomains:
       brokerDomain:
         name: "activemq"
         loginModules:
           - name: "prop-module"
             flag: "sufficient"
     securitySettings:
       broker:
         - match: "#"
           permissions:
             - operationType: "send"
               roles:
                 - "sender"
             - operationType: "createAddress"
               roles:
                 - "sender"
             - operationType: "createDurableQueue"
               roles:
                 - "sender"
             - operationType: "consume"
               roles:
                 - "receiver"
                 ...

3. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/address_custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 完成配置 CR 后，点 Create。

流程

1. 开始为代理部署配置自定义资源(CR)实例。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在用于创建部署的项目中部署 CR 的用户身份登录 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在用于创建部署的项目中部署 CR 的用户登录到控制台。
      2. 根据主代理 CRD 启动一个新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemis。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

   对于基本的代理部署，配置可能类似以下示例。

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true

   观察到 broker_activemqartemis_cr.yaml 示例 CR 文件中，image 属性设为 占位符 默认值。此值表示默认情况下，image 属性不指定用于部署的代理容器镜像。要了解 Operator 如何确定要使用的适当代理容器镜像，请参阅 第 2.4 节 “Operator 如何选择容器镜像”。

2. 要指定代理存储大小，在 CR 的 deploymentPlan 部分中添加 storage 部分。添加 size 属性并指定值。例如：

   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true
       storage:
         size: 4Gi

   storage.size

   每个代理 Pod 需要用于持久性存储的持久性卷声明(PVC)大小（以字节为单位）。此属性仅在将 persistenceEnabled 设为 true 时才适用。您指定的值 必须使用 字节表示法（例如 K、M、G）或者二进制等同的单元（Ki、Mi、Gi）。

3. 要在 storage 部分指定每个代理 Pod 需要持久性存储的存储类，请添加 storageClassName 属性并指定值。例如：

   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true
       storage:
         size: 4Gi
         storageClassName: gp3

   storage.storageClassName

   在持久性卷声明(PVC)中请求的存储类的名称。存储类为管理员提供描述和分类可用存储的方法。例如，不同的存储类可能会映射到特定的服务质量级别、备份策略等。

   如果没有指定存储类，则 PVC 声明具有为集群配置的默认存储类的持久性卷。

   注意

   如果您指定了存储类，只有在卷的存储类与指定的存储类匹配时，PVC 才会声明持久性卷。

4. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到您要在其中创建代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 配置完 CR 后，点 Create。

流程

1. 开始为代理部署配置自定义资源(CR)实例。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在用于创建部署的项目中部署 CR 的用户身份登录 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在用于创建部署的项目中部署 CR 的用户登录到控制台。
      2. 根据主代理 CRD 启动一个新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemis。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

   对于基本的代理部署，配置可能类似以下示例。

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true

   观察到 broker_activemqartemis_cr.yaml 示例 CR 文件中，image 属性设为 占位符 默认值。此值表示默认情况下，image 属性不指定用于部署的代理容器镜像。要了解 Operator 如何确定要使用的适当代理容器镜像，请参阅 第 2.4 节 “Operator 如何选择容器镜像”。

2. 在 CR 的 deploymentPlan 部分中，添加一个 resources 部分。添加 limits 和 requests 子项。在每个子部分中，添加一个 cpu 和 memory 属性并指定值。例如：

   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true
       resources:
         limits:
           cpu: "500m"
           memory: "1024M"
         requests:
           cpu: "250m"
           memory: "512M"

   limits.cpu

   在部署 Pod 中运行的每个代理容器都不能超过此数量 host-node CPU 用量。

   limits.memory

   在部署 Pod 中运行的每个代理容器都不能超过此数量的主机节点内存用量。

   requests.cpu

   在部署 Pod 中运行的每个代理容器都会请求这个数量 host-node CPU。这个值是代理容器运行 所需的最小 CPU 量。

   requests.memory

   在部署 Pod 中运行的每个代理容器都会请求这个数量的主机节点内存。这个值是代理容器运行所需的 最小内存量。

3. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到您要在其中创建代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 配置完 CR 后，点 Create。

流程

1. 在初始安装过程中下载并提取的 Operator 归档中的 deploy/crs 目录中，打开 broker_activemqartemis_cr.yaml 自定义资源(CR)文件。

2. 在 acceptors 元素中，添加命名的 acceptor。添加 protocols 和 port 参数。设置值，以指定接受者使用的消息传递协议，以及每个代理 Pod 上的端口来公开这些协议。例如：

   spec:
   ...
     acceptors:
     - name: my-acceptor
       protocols: amqp
       port: 5672
   ...

   配置的接受器将端口 5672 公开给 AMQP 客户端。您可以在表中显示您可以为 protocol 参数指定 的完整值。

   协议	值
   核心协议	core
   AMQP	amqp
   OpenWire	OpenWire
   MQTT	mqtt
   STOMP	STOMP
   所有支持的协议	all

   注意
   • 对于部署中的每个代理 Pod，Operator 还会创建一个使用端口 61616 的默认接受器。代理集群需要这个默认接受器，并启用了 Core Protocol。
   • 默认情况下，AMQ Broker 管理控制台使用代理 Pod 上的端口 8161。部署中的每个代理 Pod 都有一个专用的服务，它提供对控制台的访问。更多信息请参阅 第 5 章 连接到基于 Operator 的代理部署的 AMQ Management Console。

3. 要在同一接收器中使用另一个协议，请修改 protocol 参数。指定以逗号分隔的协议列表。例如：

   spec:
   ...
     acceptors:
     - name: my-acceptor
       protocols: amqp,openwire
       port: 5672
   ...

   配置的接收器现在将端口 5672 公开给 AMQP 和 OpenWire 客户端。

4. 要指定接受器允许的并发客户端连接数量，请添加 connectionAllowed 参数并设置值。例如：

   spec:
   ...
     acceptors:
     - name: my-acceptor
       protocols: amqp,openwire
       port: 5672
       connectionsAllowed: 5
   ...

5. 默认情况下，接受者仅公开给与代理部署相同的 OpenShift 集群中的客户端。要也会将接受者公开给 OpenShift 之外的客户端，请添加 expose 参数，并将值设为 true。

   spec:
   ...
     acceptors:
     - name: my-acceptor
       protocols: amqp,openwire
       port: 5672
       connectionsAllowed: 5
       expose: true
       ...
   ...

   当您向 OpenShift 外部的客户端公开接收器时，Operator 会自动为部署中的每个代理 Pod 创建一个专用的服务和路由。

6. 要启用与 OpenShift 外部客户端的接受器的安全连接，请添加 sslEnabled 参数，并将值设为 true。

   spec:
   ...
     acceptors:
     - name: my-acceptor
       protocols: amqp,openwire
       port: 5672
       connectionsAllowed: 5
       expose: true
       sslEnabled: true
       ...
   ...

   当您启用 SSL（即，安全套接字层）安全性在接收器（或连接器）安全性时，您可以添加相关的配置，例如：

   • 用于在 OpenShift 集群中存储身份验证凭据的机密名称。当您在 acceptor 上启用 SSL 时，需要一个 secret。有关生成此 secret 的更多信息，请参阅 第 4.8.2 节 “保护 broker-client 连接”。
   • 用于安全网络通信的传输层安全(TLS)协议。TLS 是一个更新的、更加安全的 SSL 版本。您在 enabledProtocols 参数中指定 TLS 协议。
   • 接收器是否在代理和客户端之间使用双向 TLS（也称为 mutual 身份验证 ）。您可以通过将 needClientAuth 参数的值设置为 true 来指定。

流程

1. 打开您之前定义 AMQP acceptor 的自定义资源(CR)实例。

   1. 使用 OpenShift 命令行界面：

      $ oc edit -f <path/to/custom_resource_instance>.yaml

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 在左侧导航菜单中点 Administration → Custom Resource Definitions
      2. 单击 ActiveMQArtemis CRD。
      3. 点 Instances 选项卡。
      4. 查找与项目命名空间对应的 CR 实例。

   之前配置的 AMQP 接受程序可能类似如下：

   spec:
   ...
     acceptors:
     - name: my-acceptor
       protocols: amqp
       port: 5672
       connectionsAllowed: 5
       expose: true
       sslEnabled: true
   ...

2. 指定代理作为较大消息的 AMQP 消息的最小大小，以字节为单位。例如：

   spec:
   ...
     acceptors:
     - name: my-acceptor
       protocols: amqp
       port: 5672
       connectionsAllowed: 5
       expose: true
       sslEnabled: true
       amqpMinLargeMessageSize: 204800
       ...
   ...

   在前面的示例中，代理配置为接受端口 5672 上的 AMQP 信息。根据 amqpMinLargeMessageSize 的值，如果 acceptor 收到一个大于 204800 字节的 AMQP 消息（即 200 KB），代理会将消息存储为大消息。

   代理将消息存储在大型消息目录中（/opt/ <custom_resource_name> /data/large-messages，默认为代理用于消息存储的持久性卷(PV)）。

   如果您没有显式指定 amqpMinLargeMessageSize 属性的值，则代理使用默认值 102400（即 100 KB）。

   如果将 amqpMinLargeMessageSize 设置为 -1，则会禁用 AMQP 消息的大型消息处理。

流程

1. 创建 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在项目中部署 CR 的用户登录到控制台，以进行代理部署。
      2. 根据主代理 CRD 启动一个新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemis。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

2. 要配置存活度探测，在 CR 的 deploymentPlan 部分中添加一个 livenessProbe 部分。例如：

   spec:
     deploymentPlan:
       livenessProbe:
         initialDelaySeconds: 5
         periodSeconds: 5

   initialDelaySeconds

   探测在容器启动后运行前的延迟（以秒为单位）。默认值为 5。

   periodSeconds

   探测运行的时间间隔（以秒为单位）。默认值为 5。

   注意

   如果您没有配置存活度探测，或者配置探测中缺少处理程序，AMQ Operator 会创建一个具有以下配置的默认 TCP 探测。默认 TCP 探测尝试打开指定端口上的代理容器的套接字。

   spec:
     deploymentPlan:
       livenessProbe:
         tcpSocket:
           port: 8181
         initialDelaySeconds: 30
         timeoutSeconds: 5

3. 要配置就绪度探测，在 CR 的 deploymentPlan 部分中添加一个 readinessProbe 部分。例如：

   spec:
     deploymentPlan:
       readinessProbe:
         initialDelaySeconds: 5
         periodSeconds: 5

   如果您没有配置就绪度探测，内置 脚本会 检查所有接收器是否可以接受连接。

4. 如果要配置更全面的健康检查，请将 artemis 检查 命令行工具添加到存活度或就绪度探测配置中。

   1. 如果要配置健康检查以在 livenessProbe 或 readinessProbe 部分中创建一个与代理的完整客户端连接，请添加 exec 部分。在 exec 部分中，添加 command 部分。在 command 部分中，添加 artemis 检查节点 命令语法。例如：

      spec:
        deploymentPlan:
          readinessProbe:
            exec:
              command:
                - bash
                - '-c'
                - /home/jboss/amq-broker/bin/artemis
                - check
                - node
                - '--silent'
                - '--acceptor'
                - <acceptor name>
                - '--user'
                - $AMQ_USER
                - '--password'
                - $AMQ_PASSWORD
            initialDelaySeconds: 30
            timeoutSeconds: 5

      默认情况下，artemis 检查节点 命令使用名为 artemis 的 acceptor 的 URI。如果代理有一个名为 artemis 的接受器，您可以在该命令中排除 --acceptor <acceptor name > 选项。

      注意

      $AMQ_USER 和 $AMQ_PASSWORD 是 AMQ Operator 配置的环境变量。

   2. 如果要配置生成和使用消息的健康检查，在 livenessProbe 或 readinessProbe 部分中验证代理文件系统的健康状况，请添加 exec 部分。在 exec 部分中，添加 command 部分。在 command 部分中，添加 artemis 检查队列 命令语法。例如：

      spec:
        deploymentPlan:
          readinessProbe:
            exec:
              command:
                - bash
                - '-c'
                - /home/jboss/amq-broker/bin/artemis
                - check
                - queue
                - '--name'
                - livenessqueue
                - '--produce'
                - "1"
                - '--consume'
                - "1"
                - '--silent'
                - '--user'
                - $AMQ_USER
                - '--password'
                - $AMQ_PASSWORD
            initialDelaySeconds: 30
            timeoutSeconds: 5

      注意

      您指定的队列名称必须在代理上配置，且 anycast 为 routingType。例如：

      apiVersion: broker.amq.io/v1beta1
      kind: ActiveMQArtemisAddress
      metadata:
        name: livenessqueue
        namespace: activemq-artemis-operator
      spec:
        addressName: livenessqueue
        queueConfiguration:
          purgeOnNoConsumers: false
          maxConsumers: -1
          durable: true
          enabled: true
        queueName: livenessqueue
        routingType: anycast

5. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到您要在其中创建代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 完成配置 CR 后，点 Create。

1. 当部署中的代理 Pod 因部署的意图而关闭时，Operator 会自动启动缩减控制器以准备消息迁移。scaledown 控制器在与代理集群相同的 OpenShift 项目名称中运行。
2. scaledown 控制器注册自己，并侦听项目中与持久性卷声明(PVC)相关的 Kubernetes 事件。

3. 要检查已经孤立的持久性卷(PV)，扩展控制器会在卷声明上查看 或dinal。控制器将卷声明上的 ordinal 与项目中仍然在 StatefulSet 中运行的代理 Pod（即代理集群）进行比较。

   如果卷声明上的 ordinal 大于仍在代理集群中任何代理 Pod 的 ordinal，则 scaledown 控制器会确定代理 Pod 已关闭，且消息传递数据必须迁移到另一个代理 Pod。

4. scaledown 控制器启动一个 drainer Pod。drainer Pod 运行代理并执行消息迁移。然后，drainer Pod 标识可迁移到孤立消息的替代代理 Pod。

   注意

   部署中必须至少有一个代理 Pod 仍在部署中运行，才能进行消息迁移。

流程

1. 在您最初下载并提取的 Operator 存储库的 deploy/crs 目录中，打开主代理 CR broker_activemqartemis_cr.yaml。

2. 在主代理 CR 中，将 messageMigration 和 persistenceEnabled 设置为 true。

   这些设置意味着，当您稍后缩减集群代理部署的大小时，Operator 会自动启动扩展控制器，并将信息迁移到仍然运行的代理 Pod。

3. 在现有代理部署中，验证哪些 Pod 正在运行。

   $ oc get pods

   您会看到类似如下的输出。

   activemq-artemis-operator-8566d9bf58-9g25l   1/1   Running   0   3m38s
   ex-aao-ss-0                                  1/1   Running   0   112s
   ex-aao-ss-1                                  1/1   Running   0   8s

   前面的输出显示，有三个 Pod 正在运行：一个用于 broker Operator 本身，以及部署中每个代理一个单独的 Pod。

4. 登录到每个 Pod，并将一些消息发送到每个代理。

   1. 作为 Pod ex-aao-s-0 的补充，其集群 IP 地址为 172.17.0.6，运行以下命令：

      $ /opt/amq/bin/artemis producer --url tcp://172.17.0.6:61616 --user admin --password admin

   2. 作为 Pod ex-aao-s-1 的补充，集群 IP 地址为 172.17.0.7，运行以下命令：

      $ /opt/amq/bin/artemis producer --url tcp://172.17.0.7:61616 --user admin --password admin

      前面的命令在每个代理上创建一个名为 TEST 的队列，并将 1000 个消息添加到每个队列。

5. 将集群从两个代理缩减为一个。

   1. 打开主代理 CR, broker_activemqartemis_cr.yaml。
   2. 在 CR 中，将 deploymentPlan.size 设置为 1。

   3. 在命令行中应用更改：

      $ oc apply -f deploy/crs/broker_activemqartemis_cr.yaml

      您会看到 Pod ex-aao-s-1 开始关闭。scaledown 控制器会启动同一名称的新 drainer Pod。这个 drainer Pod 也会在将信息从代理 Pod ex-ao-s-1 中迁移到集群（ex-aao-ss-0）中的其他代理 Pod 中后关闭。

6. 当 drainer Pod 关闭时，检查 broker Pod ex-aao-ss-0 的 TEST 队列的消息数。您会看到队列中的消息数量为 2000，表示 drainer Pod 已成功迁移了关闭的代理 Pod 中的 1000 信息。

流程

1. 根据主代理 CRD 创建自定义资源(CR)实例。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在项目中部署 CR 的用户登录到控制台，以进行代理部署。
      2. 根据主代理 CRD 启动一个新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemis。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

2. 在 CR 的 deploymentPlan 部分中，添加一个 nodeSelector 部分，并添加您要与为 pod 选择节点匹配的节点标签。例如：

   spec:
       deploymentPlan:
         nodeSelector:
           app: broker1

   在本例中，代理 pod 调度到具有 app: broker1 标签的节点上。

3. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到您要在其中创建代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 配置完 CR 后，点 Create。

流程

1. 根据主代理 CRD 创建自定义资源(CR)实例。

   1. 使用 OpenShift 命令行界面：

      1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

         oc login -u <user> -p <password> --server=<host:port>

      2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。

   2. 使用 OpenShift Container Platform Web 控制台：

      1. 以有权在项目中部署 CR 的用户登录到控制台，以进行代理部署。
      2. 根据主代理 CRD 启动一个新的 CR 实例。在左侧窗格中，单击 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。

      5. 单击 Create ActiveMQArtemis。

         在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

2. 在 CR 的 deploymentPlan 部分中，添加一个 tolerations 部分。在 tolerations 部分中，为您要匹配的节点污点添加容限。例如：

   spec:
        deploymentPlan:
           tolerations:
           - key: "app"
             value: "amq-broker"
             effect: "NoSchedule"

   在本例中，容限与节点污点的 app=amq-broker:NoSchedule 匹配，因此 pod 可以调度到配置了此污点的节点。

1. 部署 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 保存 CR 文件。

      2. 切换到您要在其中创建代理部署的项目。

         $ oc project <project_name>

      3. 创建 CR 实例。

         $ oc create -f <path/to/custom_resource_instance>.yaml

   2. 使用 OpenShift Web 控制台：

      1. 配置完 CR 后，点 Create。

流程

1. 在 Web 浏览器中，导航到 AMQ Broker 7.10.7 补丁的 Software Downloads 页面。
2. 确保 Version 下拉列表的值设为 7.10.7，并且选择了 Releases 选项卡。

3. 在 AMQ Broker 7.10.7 Operator Installation and Example Files 旁边，点 Download。

   下载 amq-broker-operator-7.10.7-ocp-install-examples.zip 压缩存档会自动开始。

4. 下载完成后，将存档移至您选择的安装目录。以下示例将存档 移到名为 ~/broker/operator 的目录。

   $ mkdir ~/broker/operator
   $ mv amq-broker-operator-7.10.7-ocp-install-examples.zip ~/broker/operator

5. 在您选择的安装目录中，提取存档的内容。例如：

   $ cd ~/broker/operator
   $ unzip amq-broker-operator-operator-7.10.7-ocp-install-examples.zip

6. 以包含现有 Operator 部署的项目的管理员身份登录 OpenShift Container Platform。

   $ oc login -u <user>

7. 切换到要升级 Operator 版本的 OpenShift 项目。

   $ oc project <project-name>

8. 在您下载并提取的最新 Operator 归档的 deploy 目录中，打开 operator.yaml 文件。

   注意

   在 operator.yaml 文件中，Operator 使用一个由 Secure Hash Algorithm (SHA) 值代表的镜像。注释行以数字符号 (#) 符号开头，注明 SHA 值对应于特定的容器镜像标签。

9. 为 以前的 Operator 部署打开 operator.yaml 文件。检查您在之前配置中指定的任何非默认值是否在 新的 operator.yaml 配置文件中复制。

10. 在新的 operator.yaml 文件中，Operator 默认命名为 controller-manager。将 controller-manager 的所有实例替换为 amq-broker-operator，这是之前版本中 Operator 的名称，并保存文件。例如：

    spec:
    ...
      selector
        matchLabels
          name: amq-broker-operator
    ...

11. 更新 Operator 中包含的 CRD。在部署 Operator 前，您必须更新 CRD。

    1. 更新主代理 CRD。

       $ oc apply -f deploy/crds/broker_activemqartemis_crd.yaml

    2. 更新地址 CRD。

       $ oc apply -f deploy/crds/broker_activemqartemisaddress_crd.yaml

    3. 更新 scaledown 控制器 CRD。

       $ oc apply -f deploy/crds/broker_activemqartemisscaledown_crd.yaml

    4. 更新安全 CRD。

       $ oc apply -f deploy/crds/broker_activemqartemissecurity_crd.yaml

12. 如果您只从 AMQ Broker Operator 7.10.0 升级，请删除 Operator 和 StatefulSet。

    默认情况下，新 Operator 删除 StatefulSet 以删除自定义和 Operator metering 标签，这些标签被 7.10.0 中的 Operator 错误地添加到 StatefulSet 选择器。当 Operator 删除 StatefulSet 时，它还会删除现有的代理 Pod，这会导致临时代理中断。如果要避免中断，请完成以下步骤以删除 Operator 和 StatefulSet 而不删除代理 Pod。

    1. 删除 Operator。

       $ oc delete -f deploy/operator.yaml

    2. 使用 --cascade=orphan 选项删除 StatefulSet，以孤立代理 Pod。孤立的代理 Pod 在删除 StatefulSet 后继续运行。

       $ oc delete statefulset <statefulset-name> --cascade=orphan

13. 如果您要从 AMQ Broker Operator 7.10.0 或 7.10.1 升级，请检查您的主代理 CR 是否有名为 application 或 ActiveMQArtemis 的标签，在 deploymentPlan.labels 属性中配置。

    这些标签为 Operator 保留，以分配标签到 Pod，且不允许在 7.10.1 后作为自定义标签。如果在主代理 CR 中配置了这些自定义标签，则 Pod 上的 Operator 分配标签会被自定义标签覆盖。如果在主代理 CR 中配置了任何自定义标签，请完成以下步骤以在 Pod 上恢复正确的标签并从 CR 中删除标签。

    1. 如果您要从 7.10.0 升级，请删除上一步中的 Operator。如果要从 7.10.1 升级，请删除 Operator。

       $ oc delete -f deploy/operator.yaml

    2. 运行以下命令以恢复正确的 Pod 标签。在以下示例中，'ex-aao' 是部署的 StatefulSet 的名称。

       $ for pod in $(oc get pods | grep -o '^ex-aao[^ ]*') do; oc label --overwrite pods $pod ActiveMQArtemis=ex-aao application=ex-aao-app; done

    3. 从 CR 中的 deploymentPlan.labels 属性中删除 application 和 ActiveMQArtemis 标签。

       1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

          oc login -u <user> -p <password> --server=<host:port>

       2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。
       3. 在 CR 的 deploymentPlan.labels 属性中，删除名为 application 或 ActiveMQArtemis 的任何自定义标签。
       4. 保存 CR 文件。

       5. 部署 CR 实例。

          1. 切换到代理部署的项目。

             $ oc project <project_name>

          2. 应用 CR。

             $ oc apply -f <path/to/broker_custom_resource_instance>.yaml

    4. 如果删除了以前的 Operator，请部署新的 Operator。

        $ oc create -f deploy/operator.yaml

14. 应用更新的 Operator 配置。

    $ oc apply -f deploy/operator.yaml

15. 新的 Operator 可以识别和管理之前的代理部署。如果在部署的 CR 中启用了自动更新，Operator 的协调过程会处理每个代理 pod 的协调过程。如果没有启用自动更新，您可以通过在 CR 中设置以下属性来启用它们：

    spec:
        ...
        upgrades:
            enabled: true
            minor: true

    有关启用自动更新的详情请参考 第 6.4 节 “通过指定 AMQ Broker 版本升级代理容器镜像”。

    注意

    如果协调过程没有启动，您可以通过扩展部署来开始该过程。更多信息请参阅 第 3.4.1 节 “部署基本代理实例”。

16. 根据需要在 CR 中为升级代理可用的新功能添加属性。

流程

1. 以集群管理员身份登录 OpenShift Container Platform Web 控制台。
2. 从项目中卸载现有的 AMQ Broker Operator。
3. 在左侧导航菜单中，点 Operators → Installed Operators。
4. 在页面顶部的 Project 下拉菜单中选择您要卸载 Operator 的项目。
5. 找到您要卸载的 Red Hat Integration - AMQ Broker 实例。
6. 对于 Operator 实例，点击右侧的 More Options 图标（三个垂直点）。点击 Uninstall Operator。
7. 在确认对话框中点 Uninstall。

8. 使用 OperatorHub 为 AMQ Broker 7.10 安装最新版本的 Operator。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

   如果在部署的 CR 中启用了自动更新，Operator 协调过程会在新 Operator 启动时升级每个代理 pod。如果没有启用自动更新，您可以通过在 CR 中设置以下属性来启用它们：

   spec:
       ...
       upgrades:
           enabled: true
           minor: true

   有关启用自动更新的详情请参考 第 6.4 节 “通过指定 AMQ Broker 版本升级代理容器镜像”。

   注意

   如果协调过程没有启动，您可以通过扩展部署来开始该过程。更多信息请参阅 第 3.4.1 节 “部署基本代理实例”。

流程

1. 以集群管理员身份登录 OpenShift Container Platform Web 控制台。

2. 从项目中卸载现有的 AMQ Broker Operator。

   1. 在左侧导航菜单中，点 Operators → Installed Operators。
   2. 在页面顶部的 Project 下拉菜单中选择您要卸载 Operator 的项目。
   3. 找到您要卸载的 Red Hat Integration - AMQ Broker 实例。
   4. 对于 Operator 实例，点击右侧的 More Options 图标（三个垂直点）。点击 Uninstall Operator。
   5. 在确认对话框中点 Uninstall。

3. 当您升级 7.10.0 Operator 时，新 Operator 会删除 StatefulSet 来删除自定义和 Operator metering 标签，这些标签会错误地添加到 7.10.0 中 Operator 的 StatefulSet 选择器。当 Operator 删除 StatefulSet 时，它也会删除现有的代理 pod，这会导致临时代理中断。如果要避免中断，请完成以下步骤以删除 StatefulSet 并孤立代理 pod，以便它们继续运行。

   1. 以包含现有 Operator 部署的项目的管理员用户身份登录 OpenShift Container Platform CLI：

      $ oc login -u <user>

   2. 切换到要升级 Operator 版本的 OpenShift 项目。

      $ oc project <project-name>

   3. 使用 --cascade=orphan 选项删除 StatefulSet，以孤立代理 Pod。孤立的代理 Pod 在删除 StatefulSet 后继续运行。

      $ oc delete statefulset <statefulset-name> --cascade=orphan

4. 检查您的主代理 CR 是否在 deploymentPlan.labels 属性中配置了名为 application 或 ActiveMQArtemis 的标签。

   在 7.10.0 中，可以在 CR 中配置这些自定义标签。这些标签是为 Operator 保留用于为 Pod 分配标签，且无法在 7.10.0 后作为自定义标签添加。如果在 7.10.0 中的主代理 CR 中配置了这些自定义标签，则自定义标签会覆盖 Pod 上的 Operator 分配标签。如果 CR 具有其中任一个标签，请完成以下步骤以在 Pod 上恢复正确的标签并从 CR 中删除标签。

   1. 在 OpenShift 命令行界面(CLI)中，运行以下命令来恢复正确的 Pod 标签。在以下示例中，'ex-aao' 是部署的 StatefulSet 的名称。

      $ for pod in $(oc get pods | grep -o '^ex-aao[^ ]*') do; oc label --overwrite pods $pod ActiveMQArtemis=ex-aao application=ex-aao-app; done

   2. 从 CR 中的 deploymentPlan.labels 属性中删除 application 和 ActiveMQArtemis 标签。

      1. 使用 OpenShift 命令行界面：

         1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

            oc login -u <user> -p <password> --server=<host:port>

         2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。
         3. 在 CR 的 deploymentPlan.labels 元素中，删除名为 application 或 ActiveMQArtemis 的任何自定义标签。
         4. 保存 CR 文件。

         5. 部署 CR 实例。

            1. 切换到代理部署的项目。

               $ oc project <project_name>

            2. 应用 CR。

               $ oc apply -f <path/to/broker_custom_resource_instance>.yaml

      2. 使用 OpenShift Container Platform Web 控制台：

         1. 以有权在项目中部署 CR 的用户登录到控制台，以进行代理部署。
         2. 在左侧窗格中，单击 Administration → Custom Resource Definitions。
         3. 单击 ActiveMQArtemis CRD。
         4. 点 实例 选项卡。
         5. 点代理部署的实例。

         6. 点 YAML 标签。

            在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

         7. 在 CR 的 deploymentPlan.labels 元素中，删除名为 application 或 ActiveMQArtemis 的任何自定义标签。
         8. 点 Save。

5. 使用 OperatorHub 为 AMQ Broker 7.10 安装最新版本的 Operator。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

   新的 Operator 可以识别和管理之前的代理部署。如果在部署的 CR 中启用了自动更新，Operator 协调过程会在新 Operator 启动时升级每个代理 pod。如果没有启用自动更新，您可以通过在 CR 中设置以下属性来启用它们：

   spec:
       ...
       upgrades:
           enabled: true
           minor: true

   有关启用自动更新的详情请参考 第 6.4 节 “通过指定 AMQ Broker 版本升级代理容器镜像”。

   注意

   如果协调过程没有启动，您可以通过扩展部署来开始该过程。更多信息请参阅 第 3.4.1 节 “部署基本代理实例”。

6. 根据需要在 CR 中为升级代理可用的新功能添加属性。

流程

1. 以集群管理员身份登录 OpenShift Container Platform Web 控制台。

2. 检查您的主代理 CR 是否在 deploymentPlan.labels 属性中配置了名为 application 或 ActiveMQArtemis 的标签。

   这些标签为 Operator 保留，以分配标签到 Pod，在 7.10.1 后无法使用。如果在主代理 CR 中配置了这些自定义标签，则 Pod 上的 Operator 分配标签会被自定义标签覆盖。

3. 如果在主代理 CR 中没有配置这些自定义标签，请使用 OperatorHub 为 AMQ Broker 7.10 安装 Operator 的最新版本。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

4. 如果在主代理 CR 中配置了任何自定义标签，请完成以下步骤来卸载现有的 Operator，在安装新 Operator 前恢复正确的 Pod 标签并从 CR 中删除标签。

   注意

   通过卸载 Operator，您可以在没有 Operator 删除 StatefulSet 的情况下删除自定义标签，这也会删除现有代理 pod 并导致临时代理中断。

   1. 从项目中卸载现有的 AMQ Broker Operator。

      1. 在左侧导航菜单中，点 Operators → Installed Operators。
      2. 在页面顶部的 Project 下拉菜单中选择您要卸载 Operator 的项目。
      3. 找到您要卸载的 Red Hat Integration - AMQ Broker 实例。
      4. 对于 Operator 实例，点击右侧的 More Options 图标（三个垂直点）。点击 Uninstall Operator。
      5. 在确认对话框中点 Uninstall。

   2. 在 OpenShift 命令行界面(CLI)中，运行以下命令来恢复正确的 Pod 标签。在以下示例中，'ex-aao' 是部署的 StatefulSet 的名称。

      $ for pod in $(oc get pods | grep -o '^ex-aao[^ ]*') do; oc label --overwrite pods $pod ActiveMQArtemis=ex-aao application=ex-aao-app; done

   3. 从 CR 中的 deploymentPlan.labels 属性中删除 application 和 ActiveMQArtemis 标签。

      1. 使用 OpenShift 命令行界面：

         1. 以有权在项目中部署代理部署的 CR 的用户登录到 OpenShift。

            oc login -u <user> -p <password> --server=<host:port>

         2. 打开名为 broker_activemqartemis_cr.yaml 的示例 CR 文件，该文件包含在您下载和提取的 Operator 安装存档的 deploy/crs 目录中。
         3. 在 CR 的 deploymentPlan.labels 属性中，删除名为 application 或 ActiveMQArtemis 的任何自定义标签。
         4. 保存 CR 文件。

         5. 部署 CR 实例。

            1. 切换到代理部署的项目。

               $ oc project <project_name>

            2. 应用 CR。

               $ oc apply -f <path/to/broker_custom_resource_instance>.yaml

      2. 使用 OpenShift Container Platform Web 控制台：

         1. 以有权在项目中部署 CR 的用户登录到控制台，以进行代理部署。
         2. 在左侧窗格中，单击 Administration → Custom Resource Definitions。
         3. 单击 ActiveMQArtemis CRD。
         4. 点 实例 选项卡。
         5. 点代理部署的实例。

         6. 点 YAML 标签。

            在控制台中，会打开 YAML 编辑器，供您配置 CR 实例。

         7. 在 CR 的 deploymentPlan.labels 属性中，删除名为 application 或 ActiveMQArtemis 的任何自定义标签。
         8. 点 Save。

5. 使用 OperatorHub 为 AMQ Broker 7.10 安装最新版本的 Operator。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

   新的 Operator 可以识别和管理之前的代理部署。如果在部署的 CR 中启用了自动更新，Operator 协调过程会在新 Operator 启动时升级每个代理 pod。如果没有启用自动更新，您可以通过在 CR 中设置以下属性来启用它们：

   spec:
       ...
       upgrades:
           enabled: true
           minor: true

   有关启用自动更新的详情请参考 第 6.4 节 “通过指定 AMQ Broker 版本升级代理容器镜像”。

   注意

   如果协调过程没有启动，您可以通过扩展部署来开始该过程。更多信息请参阅 第 3.4.1 节 “部署基本代理实例”。

6. 根据需要在 CR 中为升级代理可用的新功能添加属性。

流程

1. 打开用于代理部署的 CR 实例。例如，基本部署的 CR 可能类似以下：

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
     deploymentPlan:
       size: 4
       image: registry.redhat.io/amq7/amq-broker-rhel8:7.10
     ...

2. 在 deploymentPlan 部分中，添加 enableMetricsPlugin 属性并将值设为 true，如下所示。

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
     deploymentPlan:
       size: 4
       image: registry.redhat.io/amq7/amq-broker-rhel8:7.10
       ...
       enableMetricsPlugin: true

   enableMetricsPlugin

   指定部署中的代理是否启用 Prometheus 插件。

3. 保存 CR 实例。

4. 切换到之前创建的代理部署的项目。

   $ oc project <project_name>

5. 在命令行中应用更改。

   $ oc apply -f <path/to/custom_resource_instance>.yaml

   metrics 插件开始以 Prometheus 格式收集代理运行时指标。

流程

1. 使用包含代理部署的项目的管理员权限登录到 OpenShift Container Platform Web 控制台。
2. 在 Web 控制台中，点 Home → Projects。选择包含代理部署的项目。
3. 要查看项目中的 StatefulSets 或 DeploymentConfig，请点击 Workloads → StatefulSets 或 Workloads → DeploymentConfig。
4. 点击与代理部署对应的 StatefulSet 或 DeploymentConfig。
5. 要访问代理部署的环境变量，请单击 Environment 选项卡。

6. 添加新的环境变量 AMQ_ENABLE_METRICS_PLUGIN。将 变量的值设置为 true。

   当您设置 AMQ_ENABLE_METRICS_PLUGIN 环境变量时，OpenShift 会在 StatefulSet 或 DeploymentConfig 中重启每个代理 Pod。在部署中有多个 Pod 时，OpenShift 会依次重启每个 Pod。当每个代理 Pod 重启时，代理的 Prometheus 插件会开始收集代理运行时指标。

流程

1. 对于您要访问的指标的代理 Pod，您需要识别之前创建的路由，以将 Pod 连接到 AMQ Broker 管理控制台。访问指标所需的 URL 的 Route 名称表单部分。

   1. 点击 Networking → Routes。

   2. 对于您选择的代理 Pod，标识为将 Pod 连接到 AMQ Broker 管理控制台而创建的路由。在 Hostname 下，请注意显示的完整 URL。例如：

      http://rte-console-access-pod1.openshiftdomain

2. 要访问 Prometheus 指标，在网页浏览器中输入之前记录的 Route 名称，并附加 "/metrics "。例如：

   http://rte-console-access-pod1.openshiftdomain/metrics