OpenShift での AMQ Broker のデプロイ

手順

1. Web ブラウザーで、AMQ Broker 7.11.8 リリース の ソフトウェアダウンロード ページに移動します。
2. Version ドロップダウンリストの値が 7.11.8 に設定され、Releases タブが選択されていることを確認します。

3. 最新の AMQ Broker 7.11.8 Operator インストールおよび Example Files の横にある Download をクリックします。

   amq-broker-operator-7.11.8-ocp-install-examples.zip 圧縮アーカイブのダウンロードが自動的に開始されます。

4. アーカイブを選択したディレクトリーに移動します。以下の例では、アーカイブを ~/broker/operator という名前のディレクトリーに移動します。

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

   Copy to Clipboard Toggle word wrap

5. 選択したディレクトリーで、アーカイブの内容を抽出します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

6. アーカイブのデプロイメント時に作成されたディレクトリーに移動します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

7. クラスター管理者として OpenShift Container Platform にログインします。以下に例を示します。

   $ oc login -u system:admin

   Copy to Clipboard Toggle word wrap

8. Operator をインストールするプロジェクトを指定します。新規プロジェクトを作成するか、既存プロジェクトに切り替えることができます。

   1. 新しいプロジェクトを作成します。

      $ oc new-project <project_name>

      Copy to Clipboard Toggle word wrap

   2. または、既存のプロジェクトに切り替えます。

      $ oc project <project_name>

      Copy to Clipboard Toggle word wrap

9. Operator で使用するサービスアカウントを指定します。

   1. デプロイメントした Operator アーカイブの deploy ディレクトリーで、service_account.yaml ファイルを開きます。
   2. kind 要素が ServiceAccount に設定されていることを確認します。
   3. デフォルトのサービスアカウント名を変更する場合は、metadata セクションで amq-broker-controller-manager をカスタム名に置き換えます。

   4. プロジェクトにサービスアカウントを作成します。

      $ oc create -f deploy/service_account.yaml

      Copy to Clipboard Toggle word wrap

10. Operator のロール名を指定します。

    1. role.yaml ファイルを開きます。このファイルは、Operator が使用できるリソースを指定し、変更します。
    2. kind 要素が Role に設定されていることを確認します。
    3. デフォルトのロール名を変更する場合は、metadata セクションで amq-broker-operator-role をカスタム名に置き換えます。

    4. プロジェクトにロールを作成します。

       $ oc create -f deploy/role.yaml

       Copy to Clipboard Toggle word wrap

11. Operator のロールバインディングを指定します。ロールバインディングは、指定した名前に基づいて、事前に作成されたサービスアカウントを Operator ロールにバインドします。

    1. role_binding.yaml ファイルを開きます。

    2. ServiceAccount と Role の name の値が 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

       Copy to Clipboard Toggle word wrap

    3. プロジェクトでロールバインディングを作成します。

       $ oc create -f deploy/role_binding.yaml

       Copy to Clipboard Toggle word wrap

12. Operator のリーダー選出ロールバインディングを指定します。ロールバインディングは、指定した名前に基づいて、事前に作成されたサービスアカウントをリーダー選出ロールにバインドします。

    1. Operator のリーダー選出ロールを作成します。

       $ oc create -f deploy/election_role.yaml

       Copy to Clipboard Toggle word wrap

    2. プロジェクトでリーダー選出ロールバインディングを作成します。

       $ oc create -f deploy/election_role_binding.yaml

       Copy to Clipboard Toggle word wrap

13. (オプション) Operator が複数の名前空間を監視するようにする場合は、以下の手順を実行します。

    注記

    OpenShift Container Platform クラスターに、インストール済みの Operators for AMQ Broker がすでに含まれている場合は、新しい Operator が既存の Operator と同じ名前空間を監視しないようにする必要があります。既存の Operator によって監視されている名前空間を識別する方法については、Identifying namespaces watched by existing Operators を参照してください。

    1. ダウンロードした Operator アーカイブの deploy ディレクトリーで、operator_yaml ファイルを開きます。

    2. Operator がクラスター内のすべての名前空間を監視するようにする場合は、WATCH_NAMESPACE セクションで value 属性を追加し、値をアスタリスクに設定します。WATCH_NAMESPACE セクションの既存の属性をコメントアウトします。以下に例を示します。

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

       Copy to Clipboard Toggle word wrap
       注記

       競合を避けるために、複数の Operator が同じ名前空間を監視しないようにしてください。たとえば、Operator をデプロイしてクラスター上の すべての 名前空間を監視する場合は、別の Operator をデプロイして個々の名前空間を監視することはできません。Operator がすでにクラスターにデプロイされている場合、次のステップで説明するように、新しい Operator が監視する名前空間のリストを指定できます。

    3. Operator がクラスター上のすべての名前空間ではなく、複数の名前空間を監視するようにする場合は、WATCH_NAMESPACE セクションで、名前空間のリストを指定します。既存の Operator によって監視されている名前空間を除外していることを確認してください。以下に例を示します。

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

       Copy to Clipboard Toggle word wrap
    4. ダウンロードして展開した Operator アーカイブの deploy ディレクトリーで、cluster_role_binding.yaml ファイルを開きます。

    5. Subjects セクションで、Operator を デプロイする OpenShift Container Platform プロジェクトに対応する名前空間を指定します。以下に例を示します。

       Subjects:
       - kind: ServiceAccount
         name: amq-broker-controller-manager
         namespace: operator-project

       Copy to Clipboard Toggle word wrap
       注記

       古いバージョンの Operator を使用してブローカーを以前にデプロイし、Operator をデプロイして複数の名前空間を監視する場合は、アップグレードする前に を参照してください。

    6. プロジェクトにクラスターロールを作成します。

       $ oc create -f deploy/cluster_role.yaml

       Copy to Clipboard Toggle word wrap

    7. プロジェクトにクラスターロールバインディングを作成します。

       $ oc create -f deploy/cluster_role_binding.yaml

       Copy to Clipboard Toggle word wrap

手順

1. OpenShift コマンドラインインターフェイス (CLI) で、クラスター管理者として OpenShift にログインします。以下に例を示します。

   $ oc login -u system:admin

   Copy to Clipboard Toggle word wrap

2. Operator デプロイメント用に以前に準備したプロジェクトに切り替えます。以下に例を示します。

   $ oc project <project_name>

   Copy to Clipboard Toggle word wrap

3. 以前の手順で Operator インストールアーカイブをデプロイメントする際に作成されたディレクトリーに移動します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

4. Operator に含まれる CRD をデプロイします。Operator をデプロイし、起動する前に CRD を OpenShift クラスターにインストールする必要があります。

   1. メインブローカー CRD をデプロイします。

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

      Copy to Clipboard Toggle word wrap

   2. アドレス CRD をデプロイします。

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

      Copy to Clipboard Toggle word wrap

   3. スケールダウンコントローラー CRD をデプロイします。

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

      Copy to Clipboard Toggle word wrap

   4. セキュリティー CRD をデプロイします。

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

      Copy to Clipboard Toggle word wrap

5. Red Hat Ecosystem Catalog での認証に使用されるアカウントに関連付けられたプルシークレットを、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>

   Copy to Clipboard Toggle word wrap

6. ダウンロードした Operator アーカイブの deploy ディレクトリーで、operator.yaml ファイルを開きます。以下に示すように、spec.containers.image プロパティーの値が Operator のバージョン 7.11.8-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:d2ae3defac36f00112c6b773e13626336ba15d6f50f905ad1c33f122bfe1a6a9

   Copy to Clipboard Toggle word wrap
   注記

   operator.yaml ファイルでは、Operator は Secure Hash Algorithm (SHA) 値で表されるイメージを使用します。数字記号 (#) 記号で始まるコメント行は、SHA 値が特定のコンテナーイメージタグに対応していることを示します。

7. Operator をデプロイします。

   $ oc create -f deploy/operator.yaml

   Copy to Clipboard Toggle word wrap

   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}

   Copy to Clipboard Toggle word wrap

   上記の出力では、新たにデプロイされた Operator が Kubernetes と通信していること、ブローカーおよびアドレス指定のコントローラーが実行されていることと、これらのコントローラーが一部のワーカーを起動していることを確認します。

手順

1. クラスター管理者として OpenShift Container Platform Web コンソールにログインします。
2. 左側のナビゲーションメニューで、Operators → OperatorHub をクリックします。
3. OperatorHub ページ上部の Project ドロップダウンメニューで、Operator をデプロイするプロジェクトを選択します。

4. OperatorHub ページで、Filter by keyword…​ ボックスを使用して Red Hat Integration - AMQ Broker Operator for RHEL 8 (Multiarch) を見つけます。

   注記

   OperatorHub では、名前に AMQ Broker が含まれているよりも多くの Operator を見つける可能性があります。Red Hat Integration-AMQ Broker for RHEL 8(Multiarch) Operator をクリックしてください。この Operator をクリックしたら、開いている情報ペインを確認します。AMQ Broker 7 .11 の場合、この Operator の最新のマイナーバージョンタグは 7.11.8-opr-1 です。

5. Red Hat Integration - AMQ Broker for RHEL 8 (Multiarch) Operator をクリックします。表示されるダイアログボックスで、Install をクリックします。

6. Install Operator ページで以下を行います。

   1. Update Channel で、バージョン 7.11 のみの更新を受信する 7.11.x チャネルを選択します。7.11.x チャネルは長期サポート (LTS) チャネルです。

      OpenShift Container Platform クラスターがインストールされた時期によっては、古いバージョンの AMQ Broker のチャネルが表示される場合もあります。他にサポートされているチャネルは 7.10.x のみで、これも LTS チャネルです。

   2. インストールモードで、Operator が監視する名前空間を選択します。

      • クラスター上の特定の名前空間: Operator は対象の名前空間にインストールされ、CR に変更がないか、対象の名前空間のみを監視します。
      • すべての名前空間 - Operator は、CR の変更がないか、すべての名前空間を監視します。
      注記

      以前のバージョンの Operator を使用してブローカーをデプロイし、Operator をデプロイして多くの名前空間を監視する場合は、アップグレードする前に を参照してください。

7. Installed Namespace ドロップダウンメニューから、Operator をインストールするプロジェクトを選択します。
8. Approval Strategy で、Automatic のラジオボタンが選択されていることを確認します。このオプションは、インストールを実行するために Operator への更新を手動で承認する必要がないように指定します。
9. Install をクリックします。

1. ブローカーデプロイメントのカスタムリソース (CR) インスタンスの設定を開始します。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. デプロイメントを作成するプロジェクトに CR をデプロイする権限を持つユーザーとして OpenShift にログインします。

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

         Copy to Clipboard Toggle word wrap
      2. ダウンロードした Operator インストールアーカイブの deploy/crs ディレクトリーに含まれる broker_activemqartemis_cr.yaml というサンプル CR ファイルを開きます。

   2. OpenShift Container Platform Web コンソールの使用

      1. デプロイメントを作成するプロジェクトに CR をデプロイする権限を持つユーザーとしてコンソールにログインします。
      2. メインブローカー CRD に基づいて新規 CR インスタンスを起動します。左側のペインで、Administration → Custom Resource Definitions をクリックします。
      3. ActiveMQArtemis CRD をクリックします。
      4. Instances タブをクリックします。

      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

   Copy to Clipboard Toggle word wrap

   broker_activemqartemis_cr.yaml サンプル CR ファイルで、image プロパティーが placeholder のデフォルト値に設定されていることを確認します。この値はデフォルトで、image プロパティーによってデプロイメントに使用するブローカーコンテナーイメージが指定されていないことを示します。Operator が使用する適切なブローカーコンテナーイメージを判別する方法については、「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>

         Copy to Clipboard Toggle word wrap

      3. CR インスタンスを作成します。

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

         Copy to Clipboard Toggle word wrap

   2. OpenShift Web コンソールの使用

      1. CR の設定が完了したら、Create をクリックします。

4. Open Shift Container Platform Web コンソールで、Workloads → StatefulSets をクリックします。ex-aao-ss という新しい StatefulSet が表示されます。

   1. ex-aao-ss StatefulSet をクリックします。CR で定義される単一ブローカーに対応する Pod が 1 つあることが分かります。
   2. StatefulSet 内で Pods タブをクリックします。ex-aao-ss Pod をクリックします。実行中の Pod の Events タブで、ブローカーコンテナーが起動したことを確認できます。Logs タブには、ブローカー自体が実行中であることを示します。

5. ブローカーは通常実行されていることをテストするには、ブローカー Pod のシェルにアクセスしてテストメッセージを送信します。

   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

         Copy to Clipboard Toggle word wrap

      2. ブローカー Pod のシェルにアクセスします。

         $ oc rsh ex-aao-ss-0

         Copy to Clipboard Toggle word wrap

6. シェルから artemis コマンドを使用して、一部のテストメッセージを送信します。URL にブローカー Pod の内部 IP アドレスを指定します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

   上記のコマンドは、ブローカーに 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

   Copy to Clipboard Toggle word wrap

手順

1. 基本的なブローカーデプロイメントに使用した CR ファイルを開きます。

2. クラスター化したデプロイメントの場合は、deploymentPlan.size の値が 2 以上であることを確認します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap
   注記

   metadata セクションで、namespace プロパティーを追加し、OpenShift Container Platform Web コンソールを使用して CR インスタンスを作成する場合にのみ値を指定する必要があります。指定する値は、ブローカーデプロイメントの OpenShift プロジェクトの名前です。

3. 変更された CR ファイルを保存します。

4. 基本的なブローカーデプロイメントを作成したプロジェクトに CR をデプロイする権限を持つユーザーとして OpenShift にログインします。

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

   Copy to Clipboard Toggle word wrap

5. 基本的なブローカーデプロイメントを先に作成したプロジェクトに切り替えます。

   $ oc project <project_name>

   Copy to Clipboard Toggle word wrap

6. コマンドラインで変更を適用します。

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

   Copy to Clipboard Toggle word wrap

   OpenShift Container Platform Web コンソールで、追加のブローカー Pod は CR で指定される数に基づいてプロジェクトで起動します。デフォルトで、プロジェクトで実行されているブローカーはクラスター化されます。

7. 各 Pod の Logs タブを開きます。ログには、OpenShift が各ブローカーでクラスター接続ブリッジが確立されていることが示されています。具体的には、ログ出力には以下のような行が含まれます。

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

   Copy to Clipboard Toggle word wrap

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>

   Copy to Clipboard Toggle word wrap
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>

         Copy to Clipboard Toggle word wrap
      2. ダウンロードした Operator インストールアーカイブの deploy/crs ディレクトリーに含まれる broker_activemqartemisaddress_cr.yaml というサンプル CR ファイルを開きます。

   2. OpenShift Container Platform Web コンソールの使用

      1. ブローカーデプロイメントのプロジェクトに CR をデプロイする権限を持つユーザーとしてコンソールにログインします。
      2. アドレス CRD に基づいて新規 CR インスタンスを起動します。左側のペインで、Administration → Custom Resource Definitions をクリックします。
      3. ActiveMQArtemisAddresss CRD をクリックします。
      4. Instances タブをクリックします。

      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
       ...

   Copy to Clipboard Toggle word wrap

   上記の設定では、myQueue0 という名前のキューと anycast ルーティングタイプを持つ myAddress0 という名前のアドレスが定義されます。

   注記

   metadata セクションで、namespace プロパティーを追加し、OpenShift Container Platform Web コンソールを使用して CR インスタンスを作成する場合にのみ値を指定する必要があります。指定する値は、ブローカーデプロイメントの OpenShift プロジェクトの名前です。

3. CR インスタンスをデプロイします。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. CR ファイルを保存します。

      2. ブローカーデプロイメントのプロジェクトに切り替えます。

         $ oc project <project_name>

         Copy to Clipboard Toggle word wrap

      3. CR インスタンスを作成します。

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

         Copy to Clipboard Toggle word wrap

   2. OpenShift Web コンソールの使用

      1. CR の設定が完了したら、Create をクリックします。

手順

1. 削除するアドレスとキューの詳細 (name、addressName、queueName など) が記載されたアドレス CR ファイルがあることを確認してください。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

2. アドレス CR の spec セクションに、removeFromBrokerOnDelete 属性を追加し、値を true に設定します。

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

   Copy to Clipboard Toggle word wrap

   removeFromBrokerOnDelete 属性を true に設定すると、アドレス CR を削除するときに、Operator はデプロイメント内のすべてのブローカーのアドレスと関連するメッセージを削除します。

3. 更新されたアドレス CR を適用して、削除するアドレスの removeFromBrokerOnDelete 属性を設定します。

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

   Copy to Clipboard Toggle word wrap

4. アドレス CR を削除して、デプロイメント内のブローカーからアドレスを削除します。

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

   Copy to Clipboard Toggle word wrap

手順

1. アドレス CR インスタンスの設定を開始して、デッドレターアドレスを追加し、デプロイメント内の各ブローカーの未配信メッセージを受信するキューを作成します。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. ブローカーデプロイメントのプロジェクトに CR をデプロイする権限を持つユーザーとして OpenShift にログインします。

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

         Copy to Clipboard Toggle word wrap
      2. ダウンロードした Operator インストールアーカイブの deploy/crs ディレクトリーに含まれる broker_activemqartemisaddress_cr.yaml というサンプル CR ファイルを開きます。

   2. OpenShift Container Platform Web コンソールの使用

      1. ブローカーデプロイメントのプロジェクトに CR をデプロイする権限を持つユーザーとしてコンソールにログインします。
      2. アドレス CRD に基づいて新規 CR インスタンスを起動します。左側のペインで、Administration → Custom Resource Definitions をクリックします。
      3. ActiveMQArtemisAddresss CRD をクリックします。
      4. Instances タブをクリックします。

      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
     ...

   Copy to Clipboard Toggle word wrap

   上記の設定では、myDeadLetterQueue という名前のデッドレターキューと anycast ルーティングタイプを持つ myDeadLetterAddress という名前のデッドレターアドレスを定義します。

   注記

   metadata セクションで、namespace プロパティーを追加し、OpenShift Container Platform Web コンソールを使用して CR インスタンスを作成する場合にのみ値を指定する必要があります。指定する値は、ブローカーデプロイメントの OpenShift プロジェクトの名前です。

3. アドレス CR インスタンスをデプロイします。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. CR ファイルを保存します。

      2. ブローカーデプロイメントのプロジェクトに切り替えます。

         $ oc project <project_name>

         Copy to Clipboard Toggle word wrap

      3. アドレス CR を作成します。

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

         Copy to Clipboard Toggle word wrap

   2. OpenShift Web コンソールの使用

      1. CR の設定が完了したら、Create をクリックします。

4. ブローカーデプロイメントのメインブローカー CR インスタンスを編集します。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. ブローカーデプロイメントのプロジェクトで CR を編集およびデプロイする権限を持つユーザーとして OpenShift にログインします。

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

         Copy to Clipboard Toggle word wrap

      2. CR を編集します。

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

         Copy to Clipboard Toggle word wrap

   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 セクションに、次に示すように、単一の addressSetting セクションを含む新しい addressSettings セクションを追加します。

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

   Copy to Clipboard Toggle word wrap

6. addressSetting ブロックに match プロパティーのインスタンスを 1 つ追加します。アドレス一致式を指定します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

   deadLetterAddress

   ブローカーが未達のメッセージを送信するアドレス。

   maxDeliveryAttempts

   メッセージを設定済みのデッドレターアドレスに移動する前にブローカーが行う最大配信試行数。

   上記の例では、ブローカーによって、myAddress で始まるアドレスにメッセージの配信が 5 回失敗する場合、ブローカーはメッセージを指定の dead letter address (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

   Copy to Clipboard Toggle word wrap

   この例では、2 つ目の 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

   Copy to Clipboard Toggle word wrap

   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";
   };

   Copy to Clipboard Toggle word wrap

   シークレットで JAAS ログインモジュールを設定し、CR でシークレットへの参照を追加すると、デフォルトのログインモジュールは AMQ Broker で使用されなくなります。ただし、デフォルトのログインモジュールで参照される artemis-users.properties ファイル内のユーザーは、Operator がブローカーで認証する必要があります。新しい JAAS ログインモジュールを設定した後、Operator がブローカーで認証できることを確認するには、次のいずれかを行う必要があります。

   • 上の例に示すように、新しいログインモジュール設定にデフォルトのプロパティーログインモジュールを含めます。この例では、デフォルトのプロパティーログインモジュールは artemis-users.properties ファイルと artemis-roles.properties ファイルを使用します。新しいログインモジュール設定にデフォルトのログインモジュールを含める場合は、baseDir を /home/jboss/amq-broker/etc ディレクトリーに設定する必要があります。このディレクトリーには、各ブローカー Pod のデフォルトのプロパティーファイルが含まれています。

   • オペレーターがブローカーで認証するために必要なユーザーとロールの情報を、新しいログインモジュール設定で参照されるプロパティーファイルに追加します。この情報は、ブローカー Pod の /home/jboss/amq-broker/etc directory にあるデフォルトの artemis-users.properties ファイルおよび artemis-roles.properties ファイルからコピーできます。

     注記

     ログインモジュールで参照されるプロパティーファイルは、ブローカーが初めてログインモジュールを呼び出したときにのみロードされます。ブローカーは、ユーザーを認証するためのログインモジュールが見つかるまで、login.config ファイルにリストされている順序でログインモジュールを呼び出します。Operator が使用する認証情報を含むログインモジュールを login.config ファイルの最後に配置すると、ブローカーが Operator を認証するときに、先行するすべてのログインモジュールが呼び出されます。その結果、プロパティーファイルがブローカー上で表示されないことを示すステータスメッセージはすべてクリアされます。

2. 作成した login.config ファイルにプロパティーログインモジュールが含まれている場合は、モジュール内で指定されたユーザーおよびロールファイルにユーザーおよびロールの情報が含まれていることを確認してください。以下に例を示します。

   new-users.properties

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

   Copy to Clipboard Toggle word wrap

   new-roles.properties

   admin=ruben, rick
   group1=bob
   group2=anne

   Copy to Clipboard Toggle word wrap

3. oc create secret コマンドを使用して、新しいログインモジュール設定で作成したテキストファイルからシークレットを作成します。ログインモジュール設定にプロパティーログインモジュールが含まれている場合は、関連するユーザーとロールファイルもシークレットに含めます。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap
   注記

   シークレットにログインモジュール設定が含まれていることを Operator が認識し、更新を各ブローカー Pod に伝播できるように、シークレット名には接尾辞 -jaas-config が必要です。

   シークレットを作成する方法の詳細は、Kubernetes ドキュメントの Secrets を参照してください。

4. 作成したシークレットをブローカーデプロイメントのカスタムリソース (CR) インスタンスに追加します。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. ブローカーデプロイメントのプロジェクトに CR をデプロイする権限を持つユーザーとして OpenShift にログインします。

      2. デプロイメントの CR を編集します。

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

         Copy to Clipboard Toggle word wrap

   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 要素を作成し、シークレットの名前を追加します。次の例では、custom-jaas-config という名前のシークレットを CR に追加します。

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

   Copy to Clipboard Toggle word wrap

6. CR で、ブローカー上で設定されているロールに権限を付与します。

   1. CR の spec セクションで、brokerProperties 要素を追加し、権限を追加します。単一のアドレスにロール権限を付与できます。または、# 記号を使用してワイルドカード一致を指定し、すべてのアドレスにロールの権限を付与することもできます。以下に例を示します。

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

      Copy to Clipboard Toggle word wrap

      この例では、group2 ロールにはすべてのアドレスへの send 権限が割り当てられ、group1 ロールにはすべてのアドレスへの consume、createAddress、createNonDurableQueue および browse 権限が割り当てられます。

7. CR を保存します。

   Operator は、/amq/extra/secrets/secret name ディレクトリー内のシークレットの login.config ファイルを各 Pod にマウントし、デフォルトの login.config ファイルの代わりに、マウントされた login.config ファイルを読み取るようにブローカー JVM を設定します。login.config ファイルにプロパティーログインモジュールが含まれている場合、参照されるユーザーとロールのプロパティーファイルも各 Pod にマウントされます。

8. CR のステータス情報を表示して、デプロイメント内のブローカーが認証にシークレット内の JAAS ログインモジュールを使用していることを確認します。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. ブローカーの CR でステータス条件を取得します。

         $ oc get activemqartemis -o yaml

         Copy to Clipboard Toggle word wrap

   2. OpenShift Web コンソールの使用

      1. CR で、status セクションに移動します。

   3. ステータス情報に JaasPropertiesApplied タイプが存在することを確認します。これは、ブローカーがシークレットで設定された JAAS ログインモジュールを使用していることを示します。以下に例を示します。

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

      Copy to Clipboard Toggle word wrap

      シークレット内のいずれかのファイルを更新すると、OpenShift Container Platform がシークレット内の最新のファイルを各ブローカー Pod に伝播するまで、reason フィールドの値に OutofSync が表示されます。たとえば、新しいユーザーを new-users-properties ファイルに追加してシークレットを更新すると、更新されたファイルが各 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

      Copy to Clipboard Toggle word wrap

9. シークレットで参照されるプロパティーファイル内のユーザーまたはロール情報を更新する場合は、oc set data コマンドを使用してシークレットを更新します。login.config ファイルを含むすべてのファイルをシークレットに再度追加する必要があります。たとえば、この手順の前半で作成した new-users.properties ファイルに新しいユーザーを追加する場合は、次のコマンドを使用して、custom-jaas-config シークレットを更新します。

   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

   Copy to Clipboard Toggle word wrap

手順

1. ブローカーデプロイメントのカスタムリソース (CR) インスタンスの設定を開始します。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. デプロイメントを作成するプロジェクトに CR をデプロイする権限を持つユーザーとして OpenShift にログインします。

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

         Copy to Clipboard Toggle word wrap
      2. ダウンロードした Operator インストールアーカイブの deploy/crs ディレクトリーに含まれる broker_activemqartemis_cr.yaml というサンプル CR ファイルを開きます。

   2. OpenShift Container Platform Web コンソールの使用

      1. デプロイメントを作成するプロジェクトに CR をデプロイする権限を持つユーザーとしてコンソールにログインします。
      2. メインブローカー CRD に基づいて新規 CR インスタンスを起動します。左側のペインで、Administration → Custom Resource Definitions をクリックします。
      3. ActiveMQArtemis CRD をクリックします。
      4. Instances タブをクリックします。

      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

   Copy to Clipboard Toggle word wrap

   broker_activemqartemis_cr.yaml サンプル CR ファイルで、image プロパティーが placeholder のデフォルト値に設定されていることを確認します。この値はデフォルトで、image プロパティーによってデプロイメントに使用するブローカーコンテナーイメージが指定されていないことを示します。Operator が使用する適切なブローカーコンテナーイメージを判別する方法については、「Operator によるコンテナーイメージの選択方法」 を参照してください。

2. ブローカーのストレージサイズを指定するには、CR の deploymentPlan セクションに storage セクションを追加します。size プロパティーを追加し、値を指定します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

   storage.size

   各ブローカー Pod が永続ストレージに必要な Persistent Volume Claim (永続ボリューム要求、PVC) のサイズ (バイト単位)。このプロパティーは、persistenceEnabled が true に設定されている場合にのみ適用されます。指定する値には、バイト表記 (K、M、G など) を使用する単位、または同等の 2 進数 (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

   Copy to Clipboard Toggle word wrap

   storage.storageClassName

   永続ボリューム要求 (PVC) で要求するストレージクラスの名前。ストレージクラスは、管理者が使用可能なストレージを記述および分類する方法を提供します。たとえば、さまざまなストレージクラスが、特定のサービス品質レベル、バックアップポリシーなどにマッピングされる場合があります。

   ストレージクラスを指定しない場合、クラスター用に設定されたデフォルトのストレージクラスを持つ永続ボリュームが PVC によって要求されます。

   注記

   ストレージクラスを指定すると、ボリュームのストレージクラスが指定されたストレージクラスと一致する場合にのみ、PVC によって永続ボリュームが要求されます。

4. CR インスタンスをデプロイします。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. CR ファイルを保存します。

      2. ブローカーデプロイメントを作成するプロジェクトに切り替えます。

         $ oc project <project_name>

         Copy to Clipboard Toggle word wrap

      3. CR インスタンスを作成します。

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

         Copy to Clipboard Toggle word wrap

   2. OpenShift Web コンソールの使用

      1. CR の設定が完了したら、Create をクリックします。

手順

1. ブローカーデプロイメントのカスタムリソース (CR) インスタンスの設定を開始します。

   1. OpenShift コマンドラインインターフェイスの使用:

      1. デプロイメントを作成するプロジェクトに CR をデプロイする権限を持つユーザーとして OpenShift にログインします。

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

         Copy to Clipboard Toggle word wrap
      2. ダウンロードした Operator インストールアーカイブの deploy/crs ディレクトリーに含まれる broker_activemqartemis_cr.yaml というサンプル CR ファイルを開きます。

   2. OpenShift Container Platform Web コンソールの使用

      1. デプロイメントを作成するプロジェクトに CR をデプロイする権限を持つユーザーとしてコンソールにログインします。
      2. メインブローカー CRD に基づいて新規 CR インスタンスを起動します。左側のペインで、Administration → Custom Resource Definitions をクリックします。
      3. ActiveMQArtemis CRD をクリックします。
      4. Instances タブをクリックします。

      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

   Copy to Clipboard Toggle word wrap

   broker_activemqartemis_cr.yaml サンプル CR ファイルで、image プロパティーが placeholder のデフォルト値に設定されていることを確認します。この値はデフォルトで、image プロパティーによってデプロイメントに使用するブローカーコンテナーイメージが指定されていないことを示します。Operator が使用する適切なブローカーコンテナーイメージを判別する方法については、「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"

   Copy to Clipboard Toggle word wrap

   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>

         Copy to Clipboard Toggle word wrap

      3. CR インスタンスを作成します。

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

         Copy to Clipboard Toggle word wrap

   2. OpenShift Web コンソールの使用

      1. CR の設定が完了したら、Create をクリックします。

手順

1. 初回インストール時にダウンロードしてデプロイメントした Operator アーカイブの deploy/crs ディレクトリーで、broker_activemqartemis_cr.yaml カスタムリソース (CR) ファイルを開きます。

2. acceptors 要素に名前付きアクセプターを追加します。protocols および port パラメーターを追加します。値を設定して、アクセプターおよび各ブローカー Pod のポートによってこれらのプロトコル用に公開されるメッセージングプロトコルを指定します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

   設定されたアクセプターはポート 5672 を AMQP クライアントに公開します。protocols パラメーターに指定できる値の完全なセットが表に表示されます。

   Expand

   プロトコル	値
   Core Protocol	core
   AMQP	amqp
   OpenWire	openwire
   MQTT	mqtt
   STOMP	stomp
   すべてのサポート対象プロトコル	all

   Show more
   注記
   • デプロイメントの各ブローカー Pod に対して、Operator はポート 61616 を使用するデフォルトのアクセプターも作成します。このデフォルトのアクセプターはブローカークラスタリングに必要ですが、Core Protocol は有効になっています。
   • デフォルトでは、AMQ Broker 管理コンソールはブローカー Pod で 8161 ポートを使用します。デプロイメントの各ブローカー Pod には、コンソールへのアクセスを提供する専用のサービスがあります。詳細は、5章Operator ベースのブローカーデプロイメント用の AMQ 管理コンソールへの接続 を参照してください。

3. 同じアクセプターで別のプロトコルを使用するには、protocol パラメーターを変更します。プロトコルのコンマ区切りリストを指定します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

   設定されたアクセプターはポート 5672 を AMQP および OpenWire クライアントに公開するようになりました。

4. アクセプターが許可する同時クライアント接続の数を指定するには、connectionAllowed パラメーターを追加して値を設定します。以下に例を示します。

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

   Copy to Clipboard Toggle word wrap

5. デフォルトでは、アクセプターはブローカーデプロイメントと同じ OpenShift クラスターのクライアントにのみ公開されます。アクセプターを OpenShift 外部のクライアントに公開するには、expose パラメーターを追加し、値を true に設定します。

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

   Copy to Clipboard Toggle word wrap

   OpenShift 外部にあるクライアントにアクセプターを公開すると、Operator はデプロイメント内のブローカー Pod ごとに専用のサービスとルートを自動作成します。

6. OpenShift 外部のクライアントからアクセプターへのセキュアな接続を有効にするには、sslEnabled パラメーターを追加し、値を true に設定します。

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

   Copy to Clipboard Toggle word wrap

   アクセプター (またはコネクター) で SSL (Secure Sockets Layer) セキュリティーを有効にすると、以下のような関連する設定を追加できます。

   • OpenShift クラスターに認証情報を保存するために使用されるシークレット名。アクセプターで SSL を有効にする場合は、シークレットが必要です。このシークレットの生成に関する詳細は、「ブローカークライアント接続のセキュリティー保護」 を参照してください。
   • セキュアなネットワーク通信に使用する TLS (Transport Layer Security) プロトコル。TLS は、よりセキュアな SSL バージョンで更新されています。enabledProtocols パラメーターで TLS プロトコルを指定します。
   • ブローカーとクライアント間で、アクセプターが相互認証とも呼ばれる双方向 TLS を使用するかどうか。これは、needClientAuth パラメーターの値を true に設定して指定します。