流程

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

3. 在最新的 AMQ Broker 7.11.6 Operator Installation and Example Files 旁边，点 Download。

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

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

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

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

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

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

   $ cd amq-broker-operator-7.11.6-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 归档的部署目录中，打开 service_account.yaml 文件。
   2. 确保 kind 元素设为 ServiceAccount。
   3. 如果要更改默认服务帐户名称，在 metadata 部分中，将 amq-broker-controller-manager 替换为自定义名称。

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

      $ oc create -f deploy/service_account.yaml

10. 为 Operator 指定角色名称。

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

    4. 在项目中创建角色。

       $ oc create -f deploy/role.yaml

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

    1. 打开 role_binding.yaml 文件。

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

       metadata:
           name: amq-broker-operator-rolebinding
       subjects:
           kind: ServiceAccount
           name: amq-broker-controller-manager
       roleRef:
           kind: Role
           name: amq-broker-operator-role

    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 归档的部署目录中，打开 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 归档的部署目录中，打开 cluster_role_binding.yaml 文件。

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

       Subjects:
       - kind: ServiceAccount
         name: amq-broker-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.11.6-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 归档的部署目录中，打开 operator.yaml 文件。确保 spec.containers.image 属性的值与 Operator 的 7.11.6-opr-2 版本对应，如下所示。

   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:6a87f1a46da682870c4495bece5d8ef5b2fb62b4ecda9e6826664031757bf984

   注意

   在 operator.yaml 文件中，Operator 使用由 安全哈希算法 (SHA)值表示的镜像。注释行（以数字符号(DSL)符号开头），表示 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…​ 复选框来查找 Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) Operator。

   注意

   在 OperatorHub 中，您可能会找到多个 Operator，而不是在其名称中包含 AMQ Broker。确保点 Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) Operator。点此 Operator 时，请查看打开的信息窗格。对于 AMQ Broker 7.11，Operator 的最新次要版本标签是 7.11.6-opr-2。

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

6. 在 Install Operator 页面中：

   1. 在 Update Channel 下，选择 7.11.x 频道来仅接收版本 7.11 的更新。7.11.x 频道是一个长期支持(LTS)频道。

      根据安装 OpenShift Container Platform 集群的时间，您可能还会看到旧版本的 AMQ Broker 频道。唯一支持的频道是 7.10.x，这也是 LTS 频道。

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

      • 集群上的特定命名空间 - Operator 安装在该命名空间中，仅监控该命名空间是否有 CR 的变化。
      • All namespaces - Operator 监控所有命名空间是否有 CR 更改。
      注意

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

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

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

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权的用户身份登录 OpenShift，以便在您要在其中创建部署的项目中部署 CR。

         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
   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true

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

   注意

   broker_activemqartemis_cr.yaml 示例 CR 使用 ex-aao 的命名规则。这种命名约定表示 CR 是 AMQ Broker Operator 的示例 资源。AMQ Broker 基于 ActiveMQ Artemis 项目。当您部署此示例 CR 时，生成的 StatefulSet 使用名称 ex-aao-ss。另外，部署中的代理 Pod 直接基于 StatefulSet 名称，如 ex-aao-ss-0、ex-aao-ss-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-ss StatefulSet。您会看到有一个 Pod，对应于您在 CR 中定义的单个代理。
   2. 在 StatefulSet 中，点 Pods 选项卡。点 ex-aao-ss Pod。在运行 Pod 的 Events 选项卡中，您会看到代理容器已启动。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
   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 控制台中，其他代理 Pod 根据 CR 中指定的数量在项目中启动。默认情况下，在项目中运行的代理集群。

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

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

1. Operator 在代理应用程序容器前运行 Init Container。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)实例中还指定了地址设置配置，则初始容器进程其配置并将其转换为 XML。
3. 根据 CR 中的 applyRule 属性的值，初始容器 合并 或替换上面显示的默认地址设置配置，使用您在 CR 中指定的配置。此合并或替换的结果是代理要使用的最终地址设置配置。
4. 当初始容器完成生成代理配置（包括地址设置）时，代理应用程序容器会启动。在启动时，代理容器会从初始容器之前使用的安装目录中复制其配置。您可以在 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 和 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。

流程

1. 确保有一个带有详细信息的地址 CR 文件，例如：您要删除的地址和 队列的名称、addressName 和 queueName。例如：

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

2. 在 address CR 的 spec 部分中，添加 removeFromBrokerOnDelete 属性，并设置为 true 的值。

   ..
   spec:
      addressName: myAddress1
      queueName: myQueue1
      routingType: anycast
      removeFromBrokerOnDelete: true

   将 removeFromBrokerOnDelete 属性设置为 true 会导致 Operator 在删除地址 CR 时删除所有代理的地址和任何关联的消息。

3. 应用更新的地址 CR，为您要删除的地址设置 removeFromBrokerOnDelete 属性。

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

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. 使用 OpenShift 命令行界面：

      1. 以具有特权的用户身份登录到 OpenShift，以便在项目中为代理部署编辑和部署 CR。

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

      2. 编辑 CR。

          oc edit ActiveMQArtemis <CR instance name> -n <namespace>

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

      1. 以具有特权在项目中为代理部署 CR 的用户登录到控制台。
      2. 在左侧窗格中，点 Operators → Installed Operator。
      3. 点 Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) operator。
      4. 点 AMQ Broker 选项卡。
      5. 单击 ActiveMQArtemis 实例名称的名称。

      6. 点 YAML 标签。

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

         注意

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

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

   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

   指定代理将配置应用到的地址 或一组 地址。在本例中，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. 使用新的 JAAS 登录模块配置创建一个文本文件，并将文件保存为 login.config。通过将文件保存为 login.config，正确的密钥会插入到您从文本文件创建的机密中。以下是登录模块配置示例：

   activemq {
      org.apache.activemq.artemis.spi.core.security.jaas.PropertiesLoginModule sufficient
         reload=true
         org.apache.activemq.jaas.properties.user="new-users.properties"
         org.apache.activemq.jaas.properties.role="new-roles.properties";
   
      org.apache.activemq.artemis.spi.core.security.jaas.PropertiesLoginModule sufficient
         reload=false
         org.apache.activemq.jaas.properties.user="artemis-users.properties"
         org.apache.activemq.jaas.properties.role="artemis-roles.properties"
         baseDir="/home/jboss/amq-broker/etc";
   };

   在 secret 中配置 JAAS 登录模块并在 CR 中添加对 secret 的引用后，AMQ Broker 不再使用默认的登录模块。但是，Operator 需要 artemis-users.properties 文件中的用户（在默认登录模块中引用的）以便与代理进行身份验证。要确保 Operator 在配置新的 JAAS 登录模块后可以使用代理进行身份验证，您必须：

   • 在新的登录模块配置中包含默认属性登录模块，如上例所示。在示例中，默认属性登录模块使用 artemis-users.properties 和 artemis-roles.properties 文件。如果在新的登录模块配置中包含默认登录模块，您必须将 baseDir 设置为 /home/jboss/amq-broker/etc 目录，其中包含每个代理 Pod 的默认属性文件。

   • 将 Operator 所需的用户和角色信息添加到新登录模块配置中引用的属性文件中。您可以从代理 Pod 上的 /home/jboss/amq-broker/etc 目录中 复制此信息。

     注意

     只有在代理首次调用登录模块时，才会加载登录模块中引用的属性文件。代理会按照 login.config 文件中列出的顺序调用登录模块，直到它找到登录模块来验证用户。通过将包含 Operator 使用的凭证的登录模块放在 login.config 文件的末尾，当代理验证 Operator 时，所有前面的登录模块都会被调用。因此，任何状态消息都指出该属性文件在代理中不可见。

2. 如果创建的 login.config 文件包含属性登录模块，请确保该模块中指定的用户和角色文件包含用户和角色信息。例如：

   new-users.properties

   ruben=ruben01!
   anne=anne01!
   rick=rick01!
   bob=bob01!

   new-roles.properties

   admin=ruben, rick
   group1=bob
   group2=anne

3. 使用 oc create secret 命令从您使用新登录模块配置创建的文本文件创建 secret。如果登录模块配置包含属性登录模块，在机密中也包含关联的用户和角色文件。例如：

   oc create secret generic custom-jaas-config --from-file=login.config --from-file=new-users.properties --from-file=new-roles.properties

   注意

   secret 名称必须具有 -jaas-config 后缀，以便 Operator 可以识别 secret 包含登录模块配置，并将任何更新传播到每个代理 Pod。

   有关如何创建 secret 的更多信息，请参阅 Kubernetes 文档中的 Secret。

4. 将您创建的 secret 添加到代理部署的自定义资源(CR)实例中。

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权在项目中为代理部署 CR 的用户身份登录 OpenShift。

      2. 编辑部署的 CR。

          oc edit ActiveMQArtemis <CR instance name> -n <namespace>

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

      1. 以具有特权在项目中为代理部署 CR 的用户登录到控制台。
      2. 在左侧窗格中，点 Operators → Installed Operator。
      3. 点 Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) operator。
      4. 点 AMQ Broker 选项卡。
      5. 单击 ActiveMQArtemis 实例名称的名称。

      6. 点 YAML 标签。

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

5. 创建 extraMounts 元素和一个 secrets 元素，并添加 secret 的名称。以下示例将名为 custom-jaas-config 的 secret 添加到 CR 中。

   deploymentPlan:
     ...
     extraMounts:
       secrets:
       - "custom-jaas-config"
     ...

6. 在 CR 中，为代理中配置的角色授予权限。

   1. 在 CR 的 spec 部分中，添加一个 brokerProperties 元素并添加权限。您可以为单个地址授予角色权限。或者，您可以使用 192.168.1.0/24 符号指定 通配符匹配，以授予所有地址的角色权限。例如：

      spec:
        ...
        brokerProperties:
        - securityRoles.#.group2.send=true
        - securityRoles.#.group1.consume=true
        - securityRoles.#.group1.createAddress=true
        - securityRoles.#.group1.createNonDurableQueue=true
        - securityRoles.#.group1.browse=true
        ...

      在示例中，group2 角色被分配给所有地址的权限，并且分配了 group1 角色 消耗、createAddress、createNonDurableQueue 并浏览 所有地址的权限。

7. 保存 CR。

   Operator 在每个 Pod 上的 /amq/extra/secrets/secret 名称 目录中挂载 login.config 文件，并将代理 JVM 配置为读取挂载的 login.config 文件，而不是默认的 login.config 文件。如果 login.config 文件包含属性登录模块，则引用的用户和角色属性文件也会挂载到每个 Pod 上。

8. 查看 CR 中的状态信息，以验证部署中的代理是否使用 secret 中的 JAAS 登录模块进行身份验证。

   1. 使用 OpenShift 命令行界面：

      1. 在 CR 中为代理获取状态条件。

         $ oc get activemqartemis -o yaml

   2. 使用 OpenShift Web 控制台：

      1. 在 CR 中，进入 status 部分。

   3. 在状态信息中，验证 JaasPropertiesApplied 类型是否存在，这表示代理是否使用 secret 中配置的 JAAS 登录模块。例如：

      - lastTransitionTime: "2023-02-06T20:50:01Z"
        message: ""
        reason: Applied
        status: "True"
        type: JaasPropertiesApplied

      当您更新 secret 中的任何文件时，reason 字段的值会显示 OutofSync，直到 OpenShift Container Platform 将 secret 中的最新文件传播到每个代理 Pod。例如，如果您向 new-users-properties 文件中添加新用户并更新 secret，您会看到以下状态信息，直到更新的文件传播到每个 Pod：

      - lastTransitionTime: "2023-02-06T20:55:20Z"
        message: 'new-users.properties status out of sync, expected: 287641156, current: 2177044732'
        reason: OutOfSync
        status: "False"
        type: JaasPropertiesApplied

9. 当您在 secret 中引用的属性文件中更新用户或组信息时，请使用 oc set data 命令更新 secret。您必须再次将所有文件读取到 secret 中，包括 login.config 文件。例如，如果您在此流程前面创建的 new-users.properties 文件中添加新用户，请使用以下命令更新 custom-jaas-config secret：

   oc set data secret/custom-jaas-config --from-file=login.config=login.config --from-file=new-users.properties=new-users.properties --from-file=new-roles.properties=new-roles.properties

流程

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

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权的用户身份登录 OpenShift，以便在您要在其中创建部署的项目中部署 CR。

         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
   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true

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

2. 要指定代理存储大小，在 CR 的 deploymentPlan 部分添加一个 存储 部分。添加 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. 要指定每个代理 Pod 需要用于持久性存储的存储类，在 storage 部分添加一个 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. 以具有特权的用户身份登录 OpenShift，以便在您要在其中创建部署的项目中部署 CR。

         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
   spec:
     deploymentPlan:
       size: 1
       image: placeholder
       requireLogin: false
       persistenceEnabled: true
       journalType: nio
       messageMigration: true

   观察 broker_activemqartemis_cr.yaml 示例 CR 文件中的，image 属性被设置为 占位符 的默认值。这个值表示，默认情况下 image 属性没有指定用于部署的代理容器镜像。要了解 Operator 如何确定要使用的适当代理容器镜像，请参阅 第 2.6 节 “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 中运行的每个代理容器不能超过这个数量的主机节点 CPU 用量。

   limits.memory

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

   requests.cpu

   部署中运行的 Pod 中运行的每个代理容器都会请求这个数量的主机节点 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
   ...

   配置的 acceptor 将端口 5672 公开给 AMQP 客户端。表中显示了您可以为 protocol 参数指定的完整值集合。

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

   注意

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

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

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

   配置的 acceptor 现在向 AMQP 和 OpenWire 客户端公开端口 5672。

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

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

流程

1. 打开您之前定义了 AMQP 接受器的自定义资源(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 收到一个 AMQP 消息，其正文大于或等于 204800 字节（即 200 KB），代理会将消息存储为大消息。

   代理将消息存储在代理用于消息存储的大消息目录(/opt/ <custom_resource_name> /data/large-messages )中。

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

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

流程

1. 编辑代理部署的 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权在项目中为代理部署 CR 的用户身份登录 OpenShift Container Platform。

      2. 编辑部署的 CR。

          oc edit ActiveMQArtemis <CR instance name> -n <namespace>

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

      1. 以具有特权在项目中为代理部署 CR 的用户身份登录 OpenShift Container Platform。
      2. 在左侧窗格中，点 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。
      5. 点代理部署的实例。

      6. 点 YAML 标签。

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

2. 在 CR 的 deploymentPlan 部分中，添加一个 startupProbe 部分。例如：

   spec:
     deploymentPlan:
       startupProbe:
         exec:
           command:
             - /bin/bash
             - '-c'
             - /opt/amq/bin/artemis
             - 'check'
             - 'node'
             - '--up'
             - '--url'
             - 'tcp://$HOSTNAME:61616'
         initialDelaySeconds: 5
         periodSeconds: 10
         timeoutSeconds: 3
         failureThreshold: 30

   命令

   在容器内运行的启动探测命令。在示例中，启动探测使用 artemis check node 命令来验证是否在容器中为代理 Pod 启动 AMQ Broker。

   initialDelaySeconds

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

   periodSeconds

   探测在其中运行的时间间隔（以秒为单位）。默认值为 10。

   timeoutSeconds

   启动探测命令等待代理回复的时间（以秒为单位）。如果没有收到对命令的响应，命令将被终止。默认值为 1。

   failureThreshold

   连续失败（包括探测被认为已失败）的启动探测的最小失败。当探测被视为失败时，它会重启 Pod。默认值为 3。

   根据集群的资源和代理日志的大小，您可能需要增加故障阈值，以允许代理有足够的时间启动并传递探测检查。否则，代理会输入一个循环条件，其中会重复达到失败阈值，代理每次由启动探测重启。例如，如果您将 failureThreshold 设置为 30，且探测的默认间隔为 10 秒，则代理有 300 秒才能启动并传递探测检查。

3. 保存 CR。

流程

1. 编辑代理部署的 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权在项目中为代理部署 CR 的用户身份登录 OpenShift Container Platform。

      2. 编辑部署的 CR。

          oc edit ActiveMQArtemis <CR instance name> -n <namespace>

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

      1. 以具有特权在项目中为代理部署 CR 的用户身份登录 OpenShift Container Platform。
      2. 在左侧窗格中，点 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。
      5. 点代理部署的实例。
      6. 点 YAML 标签。

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

   spec:
     deploymentPlan:
       livenessProbe:
         initialDelaySeconds: 5
         periodSeconds: 5
         failureThreshold: 30

   initialDelaySeconds

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

   注意

   如果部署也配置了启动探测，则可以将存活度和就绪度探测的延迟设置为 0。这两个探测仅在启动探测通过后运行。如果启动探测已经通过，它会确认代理已成功启动，因此不需要延迟运行存活度和就绪度探测。

   periodSeconds

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

   failureThreshold

   连续最小失败，包括表示探测失败的存活度探测的超时。当探测失败时，它会重启 Pod。默认值为 3。

   如果您的部署没有配置启动探测，它会验证代理应用程序是否在存活度探测运行前启动，您可能需要增加故障阈值，以允许代理有足够的时间启动并传递存活度探测检查。否则，代理可能会输入一个循环条件，其中不再达到失败阈值，代理 Pod 每次由存活度探测重启。

   代理启动和传递存活度探测检查所需的时间取决于集群的资源和代理日志的大小。例如，如果您将 failureThreshold 设置为 30，且探测在默认间隔 5 秒运行，代理需要 150 秒才能启动并传递存活度探测检查。

   注意

   如果您没有配置存活度探测，或者没有配置的探测，AMQ Broker 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 check 命令行工具添加到存活度或就绪度探测配置中。

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

      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 check node 命令使用名为 artemis 的 acceptor 的 URI。如果代理有一个名为 artemis 的 acceptor，您可以从命令中排除 --acceptor <acceptor name& gt; 选项。

      注意

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

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

      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. 当部署中的代理 Pod 因部署的意图缩减而关闭时，Operator 会自动部署 scaledown 自定义资源以准备消息迁移。

2. 要检查已孤立的持久性卷(PV)，scaledown 控制器会查看卷声明的 等级。控制器将卷声明的 ordinal 与项目中仍在 StatefulSet （即代理集群）中运行的代理 Pod 进行比较。

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

3. scaledown 控制器启动一个 drainer Pod。drainer Pod 连接到集群中的其他实时代理 Pod 之一，并将信息迁移到该实时代理 Pod。

流程

1. 编辑代理部署的 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权在项目中为代理部署 CR 的用户身份登录 OpenShift Container Platform。

      2. 编辑部署的 CR。

          oc edit ActiveMQArtemis <CR instance name> -n <namespace>

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

      1. 以具有特权在项目中为代理部署 CR 的用户身份登录 OpenShift Container Platform。
      2. 在左侧窗格中，点 Administration → Custom Resource Definitions。
      3. 单击 ActiveMQArtemis CRD。
      4. 点 实例 选项卡。
      5. 点代理部署的实例。

      6. 点 YAML 标签。

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

2. 在 CR 的 deploymentPlan 部分中，添加一个 messageMigration 属性，并设置为 true。如果尚未配置，请添加 persistenceEnabled 属性，并设置为 true。例如：

   spec:
     deploymentPlan:
       messageMigration: true
       persistenceEnabled: true
     ...

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

3. 保存 CR。

4. （可选）完成以下步骤来缩减集群并查看消息迁移过程。

   1. 在现有代理部署中，验证哪个 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 正在运行：一个用于代理 Operator 本身，以及部署中每个代理的独立 Pod。

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

      1. Pod ex-aao-ss-0 具有集群 IP 地址 172.17.0.6，运行以下命令：

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

   3. Pod ex-aao-ss-1 具有集群 IP 地址 172.17.0.7，运行以下命令：

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

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

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

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

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

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

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

   5. 当 drainer Pod 关闭时，检查代理 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.11.6 的 Software Downloads 页面。
2. 确保 Version 下拉列表的值被设置为 7.11.6，并选择了 Patches 选项卡。

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

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

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

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

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

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

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

   $ oc login -u <user>

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

   $ oc project <project-name>

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

   注意

   在 operator.yaml 文件中，Operator 使用由 安全哈希算法 (SHA)值表示的镜像。注释行（以数字符号(DSL)符号开头），表示 SHA 值与特定容器镜像标签对应。

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

10. 在新的 operator.yaml 文件中，Operator 默认命名为 amq-broker-controller-manager。如果之前部署中的 Operator 名称不是 amq-broker-controller-manager，请将 amq-broker-controller-manager 的所有实例替换为之前的 Operator 名称。例如：

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

11. 在新的 operator.yaml 文件中，Operator 的服务帐户名为 amq-broker-controller-manager。在以前的版本中，Operator 的服务帐户名为 amq-broker-operator。

    1. 如果要在以前的部署中使用服务帐户名称，请将 新 operator.yaml 文件中的服务帐户名称替换为上一部署中使用的名称。例如：

       spec:
         ...
         serviceAccountName: amq-broker-operator
         ...

    2. 如果要将新服务帐户名称 amq-broker-controller-manager 用于 Operator，请更新项目中的服务帐户、角色和角色绑定。

       $ oc apply -f deploy/service_account.yaml

       $ oc apply -f deploy/role.yaml

       $ oc apply -f deploy/role_binding.yaml

12. 更新 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

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

    默认情况下，新的 Operator 会删除 StatefulSet 以删除自定义和 Operator metering 标签，该标签被 Operator in 7.10.0 中错误地添加到 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

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

    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

15. 应用更新的 Operator 配置。

    $ oc apply -f deploy/operator.yaml

16. 新的 Operator 可以识别和管理您之前的代理部署。如果您在 CR 中的 image 或 version 字段中设置了值，Operator 的协调过程会在 Operator 启动时将代理 Pod 升级到对应的镜像。如需更多信息，请参阅 第 6.4 节 “限制代理容器镜像的自动升级”。否则，Operator 会将每个代理 Pod 升级到最新的容器镜像。

    注意

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

17. 根据需要，为升级代理中可用的新功能在 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.11 安装最新版本的 Operator。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

   新的 Operator 可以识别和管理您之前的代理部署。如果您在 CR 中的 image 或 version 字段中设置了值，Operator 的协调过程会在 Operator 启动时将代理 Pod 升级到对应的容器镜像。如需更多信息，请参阅 第 6.4 节 “限制代理容器镜像的自动升级”。否则，Operator 会将每个代理 Pod 升级到最新的容器镜像。

   注意

   如果协调过程没有启动，您可以通过扩展部署来启动该过程。更多信息请参阅 第 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. 编辑部署的 CR。

            oc edit ActiveMQArtemis <statefulset name> -n <namespace>

         3. 在 CR 中的 deploymentPlan.labels 元素中，删除名为 application 或 ActiveMQArtemis 的任何自定义标签。
         4. 保存 CR。

      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.11 安装最新版本的 Operator。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

   新的 Operator 可以识别和管理您之前的代理部署。如果您在 CR 中的 image 或 version 字段中设置了值，Operator 的协调过程会在 Operator 启动时将代理 Pod 升级到对应的镜像。如需更多信息，请参阅 第 6.4 节 “限制代理容器镜像的自动升级”。否则，Operator 会将每个代理 Pod 升级到最新的容器镜像。

   注意

   如果协调过程没有启动，您可以通过扩展部署来启动该过程。更多信息请参阅 第 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.11 安装最新版本的 Operator。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

4. 如果在主代理 CR 中配置了其中任何一个自定义标签，请完成以下步骤卸载现有 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. 编辑部署的 CR。

            oc edit ActiveMQArtemis <statefulset name> -n <namespace>

         3. 在 CR 中的 deploymentPlan.labels 属性中，删除名为 application 或 ActiveMQArtemis 的任何自定义标签。
         4. 保存 CR 文件。

      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.11 安装最新版本的 Operator。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

   新的 Operator 可以识别和管理您之前的代理部署。如果您在 CR 中的 image 或 version 字段中设置了值，Operator 的协调过程会在 Operator 启动时将代理 Pod 升级到对应的镜像。如需更多信息，请参阅 第 6.4 节 “限制代理容器镜像的自动升级”。否则，Operator 会将每个代理 Pod 升级到最新的容器镜像。

   注意

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

6. 根据需要，为升级代理中可用的新功能在 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.11 安装最新版本的 Operator。更多信息请参阅 第 3.3.2 节 “从 OperatorHub 部署 Operator”。

   新的 Operator 可以识别和管理您之前的代理部署。如果您在 CR 中的 image 或 version 字段中设置了值，Operator 的协调过程会在 Operator 启动时将代理 Pod 升级到对应的镜像。如需更多信息，请参阅 第 6.4 节 “限制代理容器镜像的自动升级”。否则，Operator 会将每个代理 Pod 升级到最新的容器镜像。

   注意

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

流程

1. 编辑代理部署的主代理 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权的用户身份登录到 OpenShift，以便在项目中为代理部署编辑和部署 CR。

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

      2. 编辑 CR。

          oc edit ActiveMQArtemis <CR instance name> -n <namespace>

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

      1. 以具有特权在项目中为代理部署 CR 的用户登录到控制台。
      2. 在左侧窗格中，点 Operators → Installed Operator。
      3. 点 Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) operator。
      4. 点 AMQ Broker 选项卡。
      5. 单击 ActiveMQArtemis 实例名称的名称。

      6. 点 YAML 标签。

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

         注意

         在 CR 的 status 部分中，.status.version.brokerVersion 字段显示当前部署的 AMQ Broker 版本。

2. 在 spec.version 属性中，指定 Operator 可将代理和 init 容器镜像升级到的版本。以下是您可以指定的值示例。

   例子

   在以下示例中，Operator 会将部署中的当前容器镜像升级到 7.11.0。

   spec:
      version: '7.11.0'
       ...

   在以下示例中，Operator 会将部署中的当前容器镜像升级到最新可用的 7.10.x 镜像。例如，如果您的部署使用 7.10.1 容器镜像，Operator 会自动将镜像升级到 7.10.2，但不升级到 7.11.6。

   spec:
       version: '7.10'
       ...

   在以下示例中，Operator 会将部署中的当前容器镜像升级到最新的 7.x.x 镜像。例如，如果您的部署使用 7.10.2 镜像，Operator 会自动将镜像升级到 7.11.6。

   spec:
       version: '7'
       ...

   注意

   要在容器镜像的次版本（例如，从 7.10.x 升级到 7.11.x）之间升级，您需要有一个与新容器镜像相同的次版本的 Operator。例如，若要从 7.10.2 升级到 7.11.6，必须安装 7.11.x Operator。

3. 保存 CR。

流程

1. 获取 Operator 可以升级当前镜像的代理和 init 容器镜像的 URL。

   1. 在 Red Hat Catalog 中，打开 broker 容器组件页面： AMQ Broker for RHEL 8 (Multiarch)。
   2. 在 Architecture 下拉菜单中，选择您的架构。
   3. 在 Tag 下拉菜单中，选择与您要安装的镜像对应的标签。标签会根据发行日期按按时间顺序显示。标签由发行版本和分配的标签组成。
   4. 打开 Get this image 选项卡。
   5. 在 Manifest 字段中，点 Copy 图标。
   6. 将 URL 粘贴到文本文件中。
   7. 在 Red Hat Catalog 中，打开 init 容器组件页面： AMQ Broker Init for RHEL 8 (Multiarch)
   8. 要获取 init 容器镜像的 URL，请重复您遵循的步骤以获取代理容器镜像的 URL。

2. 编辑代理部署的主代理 CR 实例。

   1. 使用 OpenShift 命令行界面：

      1. 以具有特权的用户身份登录到 OpenShift，以便在项目中为代理部署编辑和部署 CR。

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

      2. 编辑 CR。

          oc edit ActiveMQArtemis <CR instance name> -n <namespace>

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

      1. 以具有特权在项目中为代理部署 CR 的用户登录到控制台。
      2. 在左侧窗格中，点 Operators → Installed Operator。
      3. 点 Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) operator。
      4. 点 AMQ Broker 选项卡。
      5. 单击 ActiveMQArtemis 实例名称的名称。

      6. 点 YAML 标签。

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

   3. 复制您在文本文件中记录的代理和 init 容器镜像的 URL，并将它们插入到 CR 中的 spec.deploymentPlan.image 和 spec.deploymentPlan.initImage 字段中。例如：

      spec:
        ...
        deploymentPlan:
          image: registry.redhat.io/amq7/amq-broker-rhel8@e8fa2a00e576ecb95561ffbdbf87b1c82d479c8791ab2c6ce741dd0d0b496d15
          initImage: registry.redhat.io/amq7/amq-broker-init-rhel8@f8c1fc7a4298ec691855c5067ed92b4859a92cea7b7ed9af1bba04469b5a315f
        ...

3. 保存 CR。

   保存 CR 时，Operator 会升级代理以使用新镜像，并使用这些镜像，直到您再次更新 spec.deploymentPlan.image 和 spec.deploymentPlan.initImage 属性的值。

流程

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

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

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

   apiVersion: broker.amq.io/v1beta1
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
   spec:
     deploymentPlan:
       size: 4
       image: registry.redhat.io/amq7/amq-broker-rhel8:7.11
       ...
       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 name 表单部分。

   1. 点 Networking → Routes。

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

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

2. 要访问 Prometheus 指标，在 Web 浏览器中输入之前记录的带有 "/metrics" 的路由名称。例如：

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