OpenShift での AMQ Broker のデプロイ

手順

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

3. AMQ Broker 7.7.0 Operator Installation and Example Files の横にある Download をクリックします。

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

4. ダウンロードが完了したら、アーカイブを選択したインストールディレクトリーに移動します。以下の例では、アーカイブを ~/broker/operator という名前のディレクトリーに移動します。

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

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

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

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

   $ oc login -u system:admin

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

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

      $ oc new-project <project_name>

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

      $ oc project <project_name>

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

   1. 展開した Operator アーカイブの deploy ディレクトリーで、service_account.yaml ファイルを開きます。
   2. kind 要素が ServiceAccount に設定されていることを確認します。
   3. metadata セクションで、カスタム名をサービスアカウントに割り当てるか、デフォルト名を使用します。デフォルトの名前は amq-broker-operator です。

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

      $ oc create -f deploy/service_account.yaml

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

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

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

      $ oc create -f deploy/role.yaml

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

    1. role_binding.yaml ファイルを開きます。ServiceAccount と Role の name の値が service_account.yaml および role.yaml ファイルで指定された値と一致していることを確認します。以下に例を示します。

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

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

       $ oc create -f deploy/role_binding.yaml

手順

1. OpenShift Container Platform Web コンソールで、ブローカーをデプロイするプロジェクトを開きます。

   新しいプロジェクトを作成した場合、現在は空です。Deployment、StatefulSet、Pod、Service、または Route がないことを確認します。

2. プロジェクトに以前のバージョンの AMQ Broker Operator をデプロイした場合は、ブローカーのデプロイ作成に使用したメインブローカーのカスタムリソース (CR) を削除します。メイン CR を削除すると、プロジェクト内の既存のブローカーデプロイメントが削除されます。以下に例を示します。

   oc delete -f deploy/crs/broker_v1alpha1_activemqartemis_cr.yaml.

3. プロジェクトに以前のバージョンの AMQ Broker Operator をデプロイした場合は、この Operator インスタンスを削除します。以下に例を示します。

   $ oc delete -f deploy/operator.yaml

4. 以前のバージョンの AMQ Broker Operator 用に OpenShift クラスターにカスタムリソース定義 (CRD) をデプロイした場合は、これらの CRD をクラスターから削除します。以下に例を示します。

   oc delete -f deploy/crds/broker_v1alpha1_activemqartemis_crd.yaml
   oc delete -f deploy/crds/broker_v1alpha1_activemqartemisaddress_crd.yaml
   oc delete -f deploy/crds/broker_v1alpha1_activemqartemisscaledown_crd.yaml

5. ダウンロードして展開した Operator アーカイブの deploy/crds ディレクトリーに含まれる CRD をデプロイします。Operator をデプロイし、起動する前に最新の CRD を OpenShift クラスターにインストールする必要があります。

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

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

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

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

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

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

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

   注記

   OpenShift Container Platform 4.1 以降では、Web コンソールを使用して、プルシークレットを AMQ Broker Operator などのコンテナーイメージをデプロイするプロジェクトに関連付けることもできます。そのためには、Administration → Service Accounts をクリックします。Red Hat コンテナーレジストリーでの認証に使用するアカウントに関連付けられたプルシークレットを指定します。

7. ダウンロードした Operator アーカイブの deploy ディレクトリーで、operator.yaml ファイルを開きます。以下に示すように、spec.containers.image プロパティーの値が AMQ Broker 7.7 の最新の Operator イメージに設定されていることを確認します。

   spec:
       template:
           spec:
               containers:
                   image: registry.redhat.io/amq7/amq-broker-rhel7-operator:0.17

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

   $ oc create -f deploy/operator.yaml

   OpenShift プロジェクトでは、デプロイした amq-broker-operator イメージが新しい Pod で起動します。

   新しい 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 と通信していること、ブローカーおよびアドレス指定のコントローラーが実行されていることと、これらのコントローラーが一部のワーカーを起動していることを確認します。

手順

1. Web ブラウザーで、AMQ Broker Software Downloads ページ に移動します。
2. Version ドロップダウンボックスで、値が最新の AMQ Broker バージョン 7.7.0 に設定されていることを確認します。
3. Patches タブをクリックします。

4. AMQ Broker 7.7.0 Operator Installation and Example Files の横にある Download をクリックします。

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

5. ダウンロードが完了したら、アーカイブを選択したインストールディレクトリーに移動します。以下の例では、アーカイブを ~/broker/operator という名前のディレクトリーに移動します。

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

6. 選択したインストールディレクトリーで、アーカイブの内容を展開します。以下に例を示します。

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

7. 展開した Operator アーカイブのディレクトリーに移動します。以下に例を示します。

   cd amq-broker-operator-7.7.0-ocp-install-examples

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

   $ oc login -u system:admin

9. OperatorHub に Operator をインストールします。

   $ oc create -f deploy/catalog_resources/activemq-artemis-operatorsource.yaml

   数分後に、AMQ Broker 7.7 の Operator は OpenShift Container Platform Web コンソールの OperatorHub セクションで利用可能になります。Operator の名前は Red Hat Integration - AMQ Broker です。

手順

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

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

   注記

   OperatorHub では、名前に AMQ Broker が含まれているよりも多くの Operator を見つける可能性があります。Red Hat Integration - AMQ Broker Operator をクリックします。この Operator をクリックしたら、開いている情報ペインを確認します。AMQ Broker 7.7 の場合、この Operator の最新バージョンタグは 0.17 です。

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

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

   1. Update Channel の下で、current というタイトルのラジオボタンが選択されていることを確認します。このオプションは、Operator の更新を追跡および受信するために使用されるチャネルを指定します。current の値は、AMQ Broker 7.7 チャネルが使用されることを指定します。
   2. Installation Mode で、A specific namespace on the cluster のラジオボタンが選択されていることを確認します。
   3. Installed Namespace ドロップダウンメニューから、Operator をインストールするプロジェクトを選択します。
   4. Approval Strategy で、Automatic のラジオボタンが選択されていることを確認します。このオプションは、インストールを実行するために Operator への更新を手動で承認する必要がないように指定します。
   5. Install をクリックします。

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

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

      1. デプロイメントを作成するプロジェクトの管理者権限で OpenShift にログインします。

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

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

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

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

      5. Create ActiveMQArtemis をクリックします。

         コンソールで、YAML エディターが開き、CR インスタンスを設定できます。

   基本的なブローカーデプロイメントの場合、設定が以下のように表示される可能性があります。この設定は、broker_activemqartemis_cr.yaml サンプル CR ファイルのデフォルトコンテンツです。

   apiVersion: broker.amq.io/v2alpha3
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
       version: 7.7.0
       deploymentPlan:
           size: 2
           image: registry.redhat.io/amq7/amq-broker:7.7
           ...

   注記

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

2. size の値は、デプロイするブローカーの数を指定します。デフォルト値の 2 は、2 つのブローカーを使用してクラスター化されたブローカーのデプロイメントを指定します。ただし、単一のブローカーインスタンスをデプロイするには、値を 1 に変更します。

3. image 値は、ブローカーの起動に使用するコンテナーイメージを指定します。以下に示すように、この値が Red Hat Container Registry 内の AMQ Broker 7.7 ブローカーコンテナーイメージの最新バージョンを指定していることを確認してください。

   image: registry.redhat.io/amq7/amq-broker:7.7

   注記

   前のステップで、イメージ 属性は、完全なイメージタグ (例: 7.7-2) ではなく、Floating イメージタグ (つまり、7.7) を指定します。このフローティングタグを指定すると、デプロイメントでは 7.7 イメージストリームで利用可能な最新のイメージが使用されます。さらに、このようなフローティングタグを指定すると、Stateful Set の imagePullPolicy 属性が Always に設定されている場合に、Red Hat Container Registry で利用可能になったときに、デプロイメントは自動的に新しい micro イメージバージョンをプルして使用します (例: 7.7-3、7-7-4 など)。

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

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

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

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

         $ oc project <project-name>

      3. CR を作成します。

         $ oc create -f <path/to/custom-resource-instance>.yaml

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

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

5. OpenShift Container Platform Web コンソールで、Workloads → StatefulSets (OpenShift Container Platform 4.1 以降) または Applications → StatefulSets (OpenShift Container Platform 3.11) をクリックします。ex-aao-ss という新しい StatefulSet が表示されます。

   ex-aao-ss Stateful Set セクションをデプロイメントします。CR で定義される単一ブローカーに対応する Pod が 1 つあることが分かります。

   実行中の Pod の Events タブで、ブローカーコンテナーが起動したことを確認できます。Logs タブには、ブローカー自体が実行中であることを示します。

手順

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

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

   apiVersion: broker.amq.io/v2alpha3
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
       version: 7.7.0
       deploymentPlan:
           size: 4
           image: registry.redhat.io/amq7/amq-broker:7.7
           ...

   注記

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

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

4. 以前に基本的なブローカーのデプロイメントを作成したプロジェクトの管理者権限で 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. カスタムリソース (CR) インスタンスの設定を開始し、ブローカーデプロイメントのアドレスおよびキューを定義します。

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

      1. ブローカーのデプロイメントを含むプロジェクトの管理者権限で OpenShift にログインします。

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

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

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

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

      5. Create ActiveMQArtemisAddress をクリックします。

         コンソールで、YAML エディターが開き、CR インスタンスを設定できます。

2. CR の spec セクションで、行を追加してアドレス、キュー、およびルーティングタイプを定義します。以下に例を示します。

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

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

   注記

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

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

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

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

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

         $ oc project <project-name>

      3. CR を作成します。

         $ oc create -f <path/to/address-custom-resource-instance>.yaml

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

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

4. (オプション) CR インスタンスを使用して以前にデプロイメントに追加されたアドレスおよびキューを削除するには、以下のコマンドを使用します。

   $ oc delete -f <path/to/address-custom-resource-instance>.yaml

手順

1. CR インスタンスを設定して、デッドレターアドレスとキューを追加して、デプロイメント内の各ブローカーの配信されていないメッセージを受信します。

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

      1. ブローカーのデプロイメントを含むプロジェクトの管理者権限で OpenShift にログインします。

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

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

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

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

      5. Create ActiveMQArtemisAddress をクリックします。

         コンソールで、YAML エディターが開き、CR インスタンスを設定できます。

2. CR の spec セクションで、未配信のメッセージを受信するデッドレターアドレスおよびキューを指定する行を追加します。以下に例を示します。

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

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

   注記

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

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

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

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

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

         $ oc project <project-name>

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

         $ oc create -f <path/to/address-custom-resource-instance>.yaml

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

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

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

   1. CR ファイルのサンプルの場合:

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

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

      1. メインブローカー CRD に基づいて新規 CR インスタンスを起動します。左側のペインで、Administration → Custom Resource Definitions をクリックします。
      2. ActiveMQArtemis CRD をクリックします。
      3. Instances タブをクリックします。

      4. Create ActiveMQArtemis をクリックします。

         コンソールで、YAML エディターが開き、CR インスタンスを設定できます。

   基本的なブローカーデプロイメントの場合、設定が以下のように表示される可能性があります。

   apiVersion: broker.amq.io/v2alpha3
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true

   注記

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

5. CR の deploymentPlan セクションで、以下に示すように単一の addressSetting セクションが含まれる新規 addressSettings セクションを追加します。

   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true
           addressSettings:
               addressSetting:

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

   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true
           addressSettings:
               addressSetting:
                -  match: myAddress

   match

   ブローカーが以下の設定を適用するアドレスまたはアドレスのセットを指定します。この例では、match プロパティーの値は myAddress と呼ばれる単一のアドレスに対応します。

7. 未配信メッセージに関連するプロパティーを追加し、値を指定します。以下に例を示します。

   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true
           addressSettings:
               addressSetting:
                -  match: myAddress
                   deadLetterAddress: myDeadLetterAddress
                   maxDeliveryAttempts: 5

   deadLetterAddress

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

   maxDeliveryAttempts

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

   上記の例では、ブローカーによって、myAddress で始まるアドレスにメッセージの配信が 5 回失敗する場合、ブローカーはメッセージを指定の dead letter address (myDeadLetterAddress) に移動します。

8. (オプション) 別のアドレスまたはアドレスセットに同様の設定を適用します。以下に例を示します。

   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true
           addressSettings:
               addressSetting:
                -  match: myAddress
                   deadLetterAddress: myDeadLetterAddress
                   maxDeliveryAttempts: 5
                -  match: 'myOtherAddresses*'
                   deadLetterAddress: myDeadLetterAddress
                   maxDeliveryAttempts: 3

   この例では、2 つ目の match プロパティーの値にはアスタリスクワイルドカード文字が含まれます。ワイルドカード文字では、上記の設定が文字列 myOtherAddresses で始まる任意のアドレスに適用されることを意味します。

   注記

   ワイルドカード式を match プロパティーの値として使用する場合には、値を単一引用符で囲む必要があります (例: 'myOtherAddresses*')。

9. addressSettings セクションの最初に applyRule プロパティーを追加し、値を指定します。以下に例を示します。

   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true
           addressSettings:
               applyRule: merge_all
               addressSetting:
                -  match: myAddress
                   deadLetterAddress: myDeadLetterAddress
                   maxDeliveryAttempts: 5
                -  match: 'myOtherAddresses*'
                   deadLetterAddress: myDeadLetterAddress
                   maxDeliveryAttempts: 3

   applyRule プロパティーは、Operator を一致するアドレスまたはアドレスのセットごとに CR に追加する設定を適用する方法を指定します。指定できる値は次のとおりです。

   merge_all

   • CR で指定されるアドレス設定と、同じアドレスまたはアドレスのセットに一致するデフォルト設定の両方の場合:

     • デフォルト設定で指定されるプロパティー値を CR で指定されたプロパティー値に置き換えます。
     • CR またはデフォルト設定で一意で指定されるプロパティー値を保持します。これらはそれぞれ最終マージされた設定の組み込みます。
   • CR で指定されるアドレス設定または特定のアドレスセットに一意になるデフォルト設定の場合は、これらを最終でマージされた設定に含めます。

   merge_replace

   • CR に指定されたアドレス設定と、同じアドレスまたはアドレスセットに一致するデフォルト設定について、最終的なマージされた設定の CR に指定された設定を含めます。それらのプロパティーが CR で指定されていない場合でも、デフォルト設定に指定されたプロパティーを含めないでください。
   • CR で指定されるアドレス設定または特定のアドレスセットに一意になるデフォルト設定の場合は、これらを最終でマージされた設定に含めます。

   replace_all

   デフォルト設定に指定されたすべてのアドレス設定を CR で指定されたアドレス設定に置き換えます。最後にマージされた設定は、CR で指定したものと完全に対応します。

   注記

   CR に applyRule プロパティーを明示的に含ない場合、Operator は merge_all のデフォルト値を使用します。

10. ブローカー CR インスタンスをデプロイします。

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

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

       2. CR を作成します。

          $ oc create -f <path/to/broker-custom-resource-instance>.yaml

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

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

手順

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

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

      1. デプロイメントを作成するプロジェクトの管理者権限で OpenShift にログインします。

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

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

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

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

      5. Create ActiveMQArtemis をクリックします。

         コンソールで、YAML エディターが開き、CR インスタンスを設定できます。

   基本的なブローカーデプロイメントの場合、設定が以下のように表示される可能性があります。

   apiVersion: broker.amq.io/v2alpha3
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true

   注記

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

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

   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true
           storage:
               size: 4Gi

   storage.size

   各ブローカー Pod が永続ストレージに必要な Persistent Volume Claim (永続ボリューム要求、PVC) のサイズ (バイト単位)。このプロパティーは、persistenceEnabled が true に設定されている場合にのみ適用されます。指定する値には単位が含まれている必要があります。バイト表記 (K、M、G など)、または同等のバイナリー (Ki、Mi、Gi) をサポートします。

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. ブローカーデプロイメントのカスタムリソース (CR) インスタンスの設定を開始します。

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

      1. デプロイメントを作成するプロジェクトの管理者権限で OpenShift にログインします。

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

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

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

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

      5. Create ActiveMQArtemis をクリックします。

         コンソールで、YAML エディターが開き、CR インスタンスを設定できます。

   基本的なブローカーデプロイメントの場合、設定が以下のように表示される可能性があります。

   apiVersion: broker.amq.io/v2alpha3
   kind: ActiveMQArtemis
   metadata:
     name: ex-aao
     application: ex-aao-app
   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           requireLogin: false
           persistenceEnabled: true
           journalType: nio
           messageMigration: true

   注記

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

2. CR の deploymentPlan セクションで、resources セクションを追加します。limits および requests サブセクションを追加します。各サブセクションで cpu および memory プロパティーを追加し、値を指定します。以下に例を示します。

   spec:
       version: 7.7.0
       deploymentPlan:
           size: 3
           image: registry.redhat.io/amq7/amq-broker:7.7
           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 要素に名前付きアクセプターを追加します。protocols および port パラメーターを追加します。値を設定して、アクセプターおよび各ブローカー Pod のポートによってこれらのプロトコル用に公開されるメッセージングプロトコルを指定します。以下に例を示します。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   ブローカーはメッセージを、メッセージストレージ用にブローカーが使用する永続ボリューム (PV) の永続ボリューム (デフォルトでは /opt/<custom-resource-name>/data/large-messages) にメッセージを保存します。

   amqpMinLargeMessageSize プロパティーの値を明示的に指定しないと、ブローカーは 102400 (つまり 100 キロバイト) のデフォルト値を使用します。

   amqpMinLargeMessageSize を -1 に設定すると、AMQP メッセージに対する大きなメッセージ処理が無効になります。

1. デプロイメントのブローカー Pod がデプロイメントの失敗または意図的にスケールダウンによってシャットダウンすると、Operator はスケールダウンコントローラーを自動的に起動してメッセージ移行の準備を行います。縮小コントローラーは、ブローカークラスターと同じ OpenShift プロジェクト名で実行されます。
2. 縮小コントローラーは、それ自体を登録し、プロジェクトの Persistent Volume Claim (永続ボリューム要求、PVC) に関連する Kubernetes イベントをリッスンします。

3. 孤立した永続ボリューム (PV) の有無を確認するには、縮小コントローラーはボリューム要求上の序数を探します。コントローラーは、ボリューム要求の序数を、プロジェクトの StatefulSet (ブローカークラスター) で実行されているブローカー Pod と比較します。

   ボリューム要求の序数がブローカー Pod の序数よりも高くなる場合、スケールダウンコントローラーは、その序数のブローカー Pod がシャットダウンされ、メッセージングデータが別のブローカー Pod に移行する必要があるかどうかを判断します。

4. 縮小コントローラーはドレイン Pod を起動します。ドレイン Pod はブローカーを実行し、メッセージ移行を実行します。次に、ドレイン Pod は孤立したメッセージを移行する代替ブローカー Pod を識別します。

   注記

   メッセージの移行を可能にするには、少なくとも 1 つ以上のブローカー Pod がデプロイメントで実行されている必要があります。

手順

1. 当初ダウンロードおよび抽出した Operator リポジトリーの deploy/crs ディレクトリーで、メインブローカー CR の broker_activemqartemis_cr.yaml を開きます。

2. メインブローカー CR では、messageMigration および persistenceEnabled を true に設定します。

   これらの設定は、クラスターブローカーデプロイメントのサイズを後でスケールダウンすると、Operator はスケールダウンコントローラーが自動的に起動し、メッセージを実行中のブローカー Pod に移行することができます。

3. 既存のブローカーデプロイメントで、実行中の Pod を確認します。

   $ oc get pods

   以下のような出力が表示されます。

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

   上記の出力では、3 つの Pod が実行されていることが示されています。1 つはブローカー Operator 自体用で、デプロイメントの各ブローカーに個別の Pod が実行されていることを示しています。

4. 各 Pod にログインし、各ブローカーにメッセージを送信します。

   1. Pod ex-aao-ss-0 にクラスター IP アドレスが 172.17.0.6 である場合は、以下のコマンドを実行します。

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

   2. Pod ex-aao-ss-1 にクラスター IP アドレスが 172.17.0.7 である場合は、以下のコマンドを実行します。

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

      前述のコマンドは、各ブローカーに TEST というキューを作成し、各キューに 1000 個のメッセージを追加します。

5. クラスターを 2 つのブローカーにスケールダウンします。

   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 がシャットダウンを開始したことを確認します。縮小コントローラーは、同じ名前の新しいドレイン Pod を起動します。このドレイン Pod は、ブローカー Pod ex-aao-ss-1 からクラスター内の他のブローカー Pod にすべてのメッセージを移行した後にシャットダウンします (ex-aao-ss-0)。

6. ドレイン Pod がシャットダウンされたら、ブローカー Pod ex-aao-ss-0 の TEST キューのメッセージ数を確認します。キューのメッセージ数が 2000 であることを確認できます。これは、ドレイン Pod がシャットダウンするブローカー Pod から 1000 個のメッセージを正常に移行しました。

手順

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

3. AMQ Broker 7.7.0 Operator Installation and Example Files の横にある Download をクリックします。

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

4. ダウンロードが完了したら、アーカイブを選択したインストールディレクトリーに移動します。以下の例では、アーカイブを ~/broker/operator という名前のディレクトリーに移動します。

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

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

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

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

   $ oc login -u system:admin

7. Operator バージョンをアップグレードする OpenShift プロジェクトに切り替えます。

   $ oc project <project-name>

8. プロジェクトに既存のブローカーデプロイメントのメインカスタムリソース (CR) を削除します。以下に例を示します。

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

9. OpenShift クラスターのメインブローカーカスタムリソース定義 (CRD) を最新バージョンに更新します。

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

   注記

   アドレス指定またはスケールダウンコントローラーのために、CRD の最新バージョンでクラスターを更新する必要はありません。これらの CRD は、以前の Operator バージョンと完全に互換性があります。

10. 以前のインストール中にダウンロードして展開した Operator アーカイブの deploy ディレクトリーで、operator.yaml ファイルを開きます。

11. 以下に示すように、spec.containers.image プロパティーを更新して、AMQ Broker 7.7 の最新の Operator イメージへの完全パスを指定します。

    spec:
        template:
            spec:
                containers:
                    image: registry.redhat.io/amq7/amq-broker-rhel7-operator:0.17

12. spec.containers.image を更新したら、変更を適用します。

    $ oc apply -f deploy/operator.yaml

    OpenShift は、最新の Operator バージョンを使用するようにプロジェクトを更新します。

13. 以前のブローカーデプロイメントを再作成するには、メインブローカー CR の新しいインスタンスをプロジェクトにデプロイします。詳細は、「基本的なブローカーインスタンスのデプロイ」 を参照してください。

手順

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

3. AMQ Broker 7.7.0 Operator Installation and Example Files の横にある Download をクリックします。

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

4. ダウンロードが完了したら、アーカイブを選択したインストールディレクトリーに移動します。以下の例では、アーカイブを ~/broker/operator という名前のディレクトリーに移動します。

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

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

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

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

   $ oc login -u system:admin

7. Operator バージョンをアップグレードする OpenShift プロジェクトに切り替えます。

   $ oc project <project-name>

8. プロジェクトに既存のブローカーデプロイメントのメインカスタムリソース (CR) を削除します。以下に例を示します。

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

9. OpenShift クラスターのメインブローカーカスタムリソース定義 (CRD) を最新バージョンに更新します。

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

10. OpenShift クラスターの アドレス CRD を、AMQ Broker 7.7 に含まれる最新バージョンに更新します。

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

    注記

    スケールダウンコントローラーのために、CRD の最新バージョンでクラスターを更新する必要はありません。AMQ Broker 7.7 では、この CRD は AMQ Broker 7.6 の Operator に含まれるものと完全に互換性があります。

11. 以前のインストール中にダウンロードして展開した Operator アーカイブの deploy ディレクトリーで、operator.yaml ファイルを開きます。

12. 以下に示すように、spec.containers.image プロパティーを更新して、AMQ Broker 7.7 の最新の Operator イメージへの完全パスを指定します。

    spec:
        template:
            spec:
                containers:
                    image: registry.redhat.io/amq7/amq-broker-rhel7-operator:0.17

13. spec.containers.image を更新したら、変更を適用します。

    $ oc apply -f deploy/operator.yaml

    OpenShift は、最新の Operator バージョンを使用するようにプロジェクトを更新します。

手順

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

3. AMQ Broker 7.7.0 Operator Installation and Example Files の横にある Download をクリックします。

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

4. ダウンロードが完了したら、アーカイブを選択したインストールディレクトリーに移動します。以下の例では、アーカイブを ~/broker/operator という名前のディレクトリーに移動します。

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

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

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

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

   $ oc login -u system:admin

7. Operator バージョンをアップグレードする OpenShift プロジェクトに切り替えます。

   $ oc project <project_name>

8. プロジェクトに既存のブローカーデプロイメントのメインカスタムリソース (CR) を削除します。以下に例を示します。

   $ oc delete -f deploy/crs/broker_v2alpha1_activemqartemis_cr.yaml

9. OpenShift クラスターのメインブローカーカスタムリソース定義 (CRD) を AMQ Broker 7.7 に含まれる最新バージョンに更新します。

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

10. OpenShift クラスターのアドレス CRD を、AMQ Broker 7.7 に含まれる最新バージョンに更新します。

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

    注記

    スケールダウンコントローラーのために、CRD の最新バージョンでクラスターを更新する必要はありません。AMQ Broker 7.7 では、この CRD は直前の Operator バージョンに含まれるものと完全に互換性があります。

11. 以前のインストール中にダウンロードして展開した Operator アーカイブの deploy ディレクトリーで、operator.yaml ファイルを開きます。

12. 以下に示すように、spec.containers.image プロパティーを更新して、AMQ Broker 7.7 の最新の Operator イメージへの完全パスを指定します。

    spec:
        template:
            spec:
                containers:
                    image: registry.redhat.io/amq7/amq-broker-rhel7-operator:0.17

13. spec.containers.image を更新したら、変更を適用します。

    $ oc apply -f deploy/operator.yaml

    OpenShift は、最新の Operator バージョンを使用するようにプロジェクトを更新します。

14. 以前のブローカーデプロイメントを再作成するには、メインブローカー CR の新しいインスタンスをプロジェクトにデプロイします。詳細は、「基本的なブローカーインスタンスのデプロイ」 を参照してください。

手順

1. 以前のインストール時にダウンロードして抽出した Operator アーカイブの deploy/crs ディレクトリーで、メインブローカー CR である broker_activemqartemis_cr.yaml を開きます。

2. 以下に示すように、image 要素を編集して、最新の AMQ Broker 7.7 コンテナーイメージを指定します。

   spec:
       ...
       deploymentPlan:
           ...
           image: registry.redhat.io/amq7/amq-broker:7.7

   注記

   前の手順では、完全なイメージタグ (例: 7.7-2) ではなく、floating イメージタグ (つまり、7.7) を指定します。このフローティングタグを指定して変更を適用すると、デプロイメントは 7.7 イメージストリームで利用可能な最新のイメージを 自動的に プルして使用します。さらに、フローティングタグを指定するときに、Stateful Set の imagePullPolicy 属性が Always に設定されている場合に、Red Hat Container Registry で利用可能になったときに、デプロイメントは新しい micro イメージバージョン (例: 7.7-3、7-7-4 など) を自動的にプルして使用します)。

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

4. CR 変更を適用します。

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

   CR の変更を適用すると、デプロイ内の各ブローカー Pod がシャットダウンされ、新しいブローカーコンテナーイメージを使用して再起動されます。デプロイメントに複数のブローカーがある場合、1 つのブローカー Pod のみがシャットダウンし、一度に再起動します。

手順

1. 以前のインストール時にダウンロードして抽出した Operator アーカイブの deploy/crs ディレクトリーで、メインブローカー CR である broker_activemqartemis_cr.yaml を開きます。

2. CR の upgrades セクションで、7.6.0 と 7.7.0 の間など、AMQ Broker のマイナーバージョン間でのブローカーコンテナーイメージのアップグレードを有効にします。

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

   注記

   AMQ Broker のマイナーバージョン間のアップグレードを有効にするには、前述のオプションを 両方ともtrue に設定する必要があります。

3. CR の バージョン プロパティーを更新して、アップグレードされたブローカーコンテナーイメージが対応する AMQ Broker のマイナーバージョンを指定します。以下に例を示します。

   spec:
       version: 7.7.0
       ...
       upgrades:
           enabled: true
           minor: true

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

5. CR 変更を適用します。

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

   CR の変更を適用すると、Operator はまず、既存のデプロイメントで AMQ Broker の指定されたバージョンへの直接アップグレードが可能であることを検証します。アップグレードする無効なバージョンの AMQ Broker を指定している場合 (たとえば、まだ利用できないバージョンなど)、Operator は警告メッセージをログに記録し、それ以上のアクションを取ることができません。

   ただし、指定されたバージョンへのアップグレードが可能な場合、Operator はデプロイメントの CR インスタンスを自動的に変更して、AMQ Broker の指定されたバージョン (registry.redhat.io/amq7/amq-broker:7.7-2 など) のブローカーコンテナーイメージを指定します。Operator が使用するデフォルトのブローカーイメージは、Operator デプロイメントの環境変数で定義されています。環境変数名は、BROKER_IMAGE_770 など、AMQ Broker のバージョンと一致します。Operator が CR の変更を適用すると、デプロイメントで各ブローカー Pod が再起動し、各 Pod が指定されたイメージバージョンを使用するようにします。デプロイメントに複数のブローカーがある場合、1 つのブローカー Pod のみがシャットダウンし、一度に再起動します。

   CR を再オープンまたはリロードすると、Operator が image 属性を更新したことがわかります。以下に例を示します。

   spec:
       ...
       deploymentPlan:
           ...
           image: registry.redhat.io/amq7/amq-broker:7.7-2

手順

1. amq-demo プロジェクトスペースまたはブローカーをデプロイする既存のプロジェクトにログインします。

   $ oc login -u <USER_NAME>
   $ oc project <PROJECT_NAME>

2. 基本的なブローカーのテンプレートに基づいて、新しいブローカーアプリケーションを作成します。このテンプレートによって作成されるブローカーは一時的なもので、SSL はサポートしません。

   $ oc new-app --template=amq-broker-77-basic \
      -p AMQ_PROTOCOL=openwire,amqp,stomp,mqtt,hornetq \
      -p AMQ_QUEUES=demoQueue \
      -p AMQ_ADDRESSES=demoTopic \
      -p AMQ_USER=amq-demo-user \
      -p AMQ_PASSWORD=password \

   基本的なブローカーアプリケーションテンプレートは、以下の表に記載されている環境変数を設定します。

   表6.1 基本ブローカーアプリケーションテンプレート

   環境変数	表示名	値	説明
   AMQ_PROTOCOL	AMQ プロトコル	openwire,amqp,stomp,mqtt,hornetq	ブローカーによって使用されるプロトコル
   AMQ_QUEUES	キュー	demoQueue	demoQueue という名前のキャストキューを作成します。
   AMQ_ADDRESSES	アドレス	demoTopic	demoTopic という名前のアドレス (またはトピック) を作成します。デフォルトでは、このアドレスには割り当てられたルーティングタイプが割り当てられていません。
   AMQ_USER	AMQ ユーザー名	amq-demo-user	クライアントがブローカーへの接続に使用するユーザー名
   AMQ_PASSWORD	AMQ パスワード	パスワード	クライアントがユーザー名と使用してブローカーに接続するパスワード

手順

1. OpenShift Container Platform Web コンソールで Deployments をクリックします。
2. broker-amq アプリケーションをクリックします。

3. デプロイ をクリックします。

   注記

   アプリケーションがデプロイされない場合、Events タブをクリックして設定を確認できます。正しくない場合には、Actions ボタンをクリックしてデプロイメント設定を編集します。

4. ブローカーアプリケーションのデプロイ後に、ブローカー Pod の現在の状態を確認します。

   1. デプロイメント設定 をクリックします。

   2. broker-amq Pod をクリックした後、Logs タブをクリックしてブローカーの状態を確認します。アプリケーションテンプレートで以前に作成されたキューが表示されるはずです。

      ログに以下が表示される場合:

      • ブローカーが稼働しているため、この手順のステップ 9 に進みます。
      • ブローカーログが読み込まれておらず、Pod のステータスは ErrImagePull または ImagePullBackOff を表示し、デプロイメント設定は Red Hat Container Registry から指定されたブローカーイメージを直接プルできませんでした。この手順では、ステップ 5 に進みます。

5. ブローカーコンテナーイメージのインストール用に Pod を準備するには、実行されているブローカーの数を 0 にスケーリングします。

   1. Deployment Configs → broker-amq をクリックします。
   2. Actions → Edit Deployment Configs をクリックします。
   3. デプロイメントの .yaml ファイルで、replicas 属性の値を 0 に設定します。
   4. Save をクリックします。
   5. Pod は、稼働しているブローカーインスタンスがゼロで再起動します。

6. 最新のブローカーコンテナーイメージをインストールします。

   1. Web ブラウザーで Red Hat Container Catalog に移動します。
   2. 検索ボックスに AMQ Broker と入力します。Search をクリックします。

   3. 以下の表の情報をもとにイメージリポジトリーを選択します。

      プラットフォーム	コンテナーイメージ名	リポジトリー名
      OpenShift Container Platform	AMQ Broker	amq7/amq-broker
      OpenShift Container Platform on IBM Z	Eclipse OpenJ9 11 上の AMQ Broker	amq7/amq-broker-openj9-11-rhel8
      OpenShift Container Platform on IBM Power Systems	Eclipse OpenJ9 11 上の AMQ Broker	amq7/amq-broker-openj9-11-rhel8

      たとえば、OpenShift Container Platform ブローカーコンテナーイメージの場合は、AMQ Broker をクリックします。amq7/amq-broker リポジトリーが開き、最新のイメージバージョンが自動的に選択されます。以前のバージョンに変更するには、Tags タブをクリックして、別のバージョンタグを選択します。

   4. Get This Image タブをクリックします。

   5. レジストリートークンの認証 の下で、OpenShift シークレットの使用セクションのページの手順を確認してください。この手順では、Red Hat Container Registry の認証に使用されるアカウントに関連付けられたイメージプルシークレットおよび Pod デプロイメント設定ファイルへの参照を追加する方法について説明します。

      たとえば、amq-demo プロジェクト namespace の broker-amq デプロイメント設定でブローカーイメージおよびプルシークレットを参照するには、以下のような行を含めます。

      apiVersion: apps.openshift.io/v1
      kind: DeploymentConfig
      ..
      metadata:
        name: broker-amq
        namespace: amq-demo
      ..
        spec:
          containers:
              name: broker-amq
              image: 'registry.redhat.io/amq7/amq-broker:7.7'
          ..
          imagePullSecrets:
            - name: {PULL-SECRET-NAME}

1. Save をクリックします。

   1. 最新のブローカーイメージバージョンをプロジェクトの namespace にインポートします。以下に例を示します。

      $ oc import-image amq7/amq-broker:7.7 --from=registry.redhat.io/amq7/amq-broker --confirm

   2. 前述のように broker-amq デプロイメント設定を再度編集します。replicas 属性の値を元の値に設定します。

      ブローカー Pod は、新規ブローカーイメージを参照する実行中のブローカーすべてで再起動します。

   3. Terminal タブをクリックして、ブローカーを起動し、CLI を使用してメッセージの送受信をテストすることができるシェルにアクセスします。

      sh-4.2$ ./broker/bin/artemis run
      sh-4.2$ ./broker/bin/artemis producer --destination queue://demoQueue
      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 : 4 s
      Producer ActiveMQQueue[demoQueue], thread=0 Elapsed time in milli second : 4584 milli seconds
      sh-4.2$ ./broker/bin/artemis consumer --destination queue://demoQueue
      Consumer:: filter = null
      Consumer ActiveMQQueue[demoQueue], thread=0 wait until 1000 messages are consumed
      Received 1000
      Consumer ActiveMQQueue[demoQueue], thread=0 Consumed: 1000 messages
      Consumer ActiveMQQueue[demoQueue], thread=0 Consumer thread finished

      または、以下の例のように、OpenShift クライアントを使用して Pod 名を使用してシェルにアクセスします。

      // Get the Pod names and internal IP Addresses
      $ oc get pods -o wide
      
      // Access a broker Pod by name
      $ oc rsh <broker-pod-name>

手順

1. ブローカーキーストアの自己署名証明書を生成します。

   $ keytool -genkey -alias broker -keyalg RSA -keystore broker.ks

2. 証明書をクライアントと共有できるようにエクスポートします。

   $ keytool -export -alias broker -keystore broker.ks -file broker_cert

3. クライアントキーストア用に自己署名証明書を生成します。

   $ keytool -genkey -alias client -keyalg RSA -keystore client.ks

4. ブローカー証明書をインポートするクライアントトラストストアを作成します。

   $ keytool -import -alias broker -keystore client.ts -file broker_cert

5. キーストアからクライアントの証明書をエクスポートします。

   $ keytool -export -alias client -keystore client.ks -file client_cert

6. クライアントのエクスポートされた証明書をブローカーの SERVER トラストストアにインポートします。

   $ keytool -import -alias client -keystore broker.ts -file client_cert

手順

1. OpenShift Web コンソールに移動し、ログインします。
2. amq-demo プロジェクトスペースを選択します。
3. Add to Project をクリックした後に、Browse Catalog をクリックしてデフォルトのイメージストリームおよびテンプレートをすべて一覧表示します。
4. Filter 検索バーを使用して、一覧を amq に一致するものに限定します。See all をクリックして、必要なアプリケーションテンプレートを表示する必要がある場合があります。
5. Red Hat AMQ Broker 7.7 (Ephemeral, with SSL) というラベルが付いた amq-broker-77-ssl テンプレートを選択します。

6. 設定で以下の値を設定し、Create をクリックします。

   表7.1 テンプレートの例

   環境変数	表示名	値	説明
   AMQ_PROTOCOL	AMQ プロトコル	openwire,amqp,stomp,mqtt,hornetq	ブローカーによって使用されるプロトコル
   AMQ_QUEUES	キュー	demoQueue	demoQueue という名前のキャストキューを作成します。
   AMQ_ADDRESSES	アドレス	demoTopic	demoTopic という名前のアドレス (またはトピック) を作成します。デフォルトでは、このアドレスには割り当てられたルーティングタイプが割り当てられていません。
   AMQ_USER	AMQ ユーザー名	amq-demo-user	クライアントが使用するユーザー名
   AMQ_PASSWORD	AMQ パスワード	パスワード	クライアントがユーザー名で使用するパスワード
   AMQ_TRUSTSTORE	トラストストアファイル名	broker.ts	SSL トラストストアファイル名
   AMQ_TRUSTSTORE_PASSWORD	トラストストアのパスワード	パスワード	トラストストアの作成時に使用されるパスワード
   AMQ_KEYSTORE	AMQ キーストアファイル名	broker.ks	SSL キーストアのファイル名
   AMQ_KEYSTORE_PASSWORD	AMQ キーストアのパスワード	パスワード	キーストアの作成時に使用されるパスワード

手順

1. OpenShift Container Platform Web コンソールで Deployments をクリックします。
2. broker-amq デプロイメントをクリックします。
3. Deploy をクリックしてアプリケーションをデプロイします。

4. ブローカーの Pod をクリックした後、Logs タブをクリックしてブローカーの状態を確認します。

   ブローカーログが読み込まれておらず、Pod のステータスは ErrImagePull または ImagePullBackOff を表示し、デプロイメント設定は Red Hat Container Registry から指定されたブローカーイメージを直接プルできませんでした。この場合、デプロイメント設定を編集して、正しいブローカーイメージ名と、Red Hat Container Registry の認証に使用するアカウントに関連付けられたイメージプルシークレット名を参照します。これで、ブローカーイメージをインポートし、ブローカーを起動できます。方法は、ブローカーアプリケーションのデプロイおよび起動 に記載の手順を実施します。

手順

1. Services → broker-amq-tcp-ssl をクリックします。
2. Actions → Create a route をクリックします。
3. TLS パラメーターを表示するには、Secure route チェックボックスを選択します。
4. TLS Termination ドロップダウンメニューから、Passthrough を選択します。ここで選択する内容では、OpenShift ルーターが復号化および再送信せずに AMQ Broker との通信をすべてリレーします。

5. ルートを表示するには、Routes をクリックします。以下に例を示します。

   https://broker-amq-tcp-amq-demo.router.default.svc.cluster.local

手順

1. OpenShift Web コンソールに移動し、ログインします。
2. amq-demo プロジェクトスペースを選択します。
3. Add to Project → Browse catalog をクリックしてデフォルトのイメージストリームおよびテンプレートを一覧表示します。
4. Filter 検索バーを使用して、一覧を amq に一致するものに限定します。See all をクリックして、必要なアプリケーションテンプレートを表示する必要がある場合があります。
5. Red Hat AMQ Broker 7.7 (Persistence) とラベル付けされた amq-broker-77-persistence-ssl テンプレートを選択します。

6. 設定で以下の値を設定し、Create をクリックします。

   表7.2 テンプレートの例

   環境変数	表示名	値	説明
   AMQ_PROTOCOL	AMQ プロトコル	openwire,amqp,stomp,mqtt,hornetq	ブローカーによって使用されるプロトコル
   AMQ_QUEUES	キュー	demoQueue	demoQueue という名前のキャストキューを作成します。
   AMQ_ADDRESSES	アドレス	demoTopic	demoTopic という名前のアドレス (またはトピック) を作成します。デフォルトでは、このアドレスには割り当てられたルーティングタイプが割り当てられていません。
   VOLUME_CAPACITY	AMQ ボリュームのサイズ	1Gi	ジャーナル用に作成される永続ボリュームサイズ
   AMQ_USER	AMQ ユーザー名	amq-demo-user	クライアントが使用するユーザー名
   AMQ_PASSWORD	AMQ パスワード	パスワード	クライアントがユーザー名で使用するパスワード
   AMQ_TRUSTSTORE	トラストストアファイル名	broker.ts	SSL トラストストアファイル名
   AMQ_TRUSTSTORE_PASSWORD	トラストストアのパスワード	パスワード	トラストストアの作成時に使用されるパスワード
   AMQ_KEYSTORE	AMQ キーストアファイル名	broker.ks	SSL キーストアのファイル名
   AMQ_KEYSTORE_PASSWORD	AMQ キーストアのパスワード	パスワード	キーストアの作成時に使用されるパスワード

手順

1. OpenShift Container Platform Web コンソールで StatefulSets をクリックします。
2. broker-amq デプロイメントをクリックします。
3. Deploy をクリックしてアプリケーションをデプロイします。

4. ブローカーの Pod をクリックした後、Logs タブをクリックしてブローカーの状態を確認します。テンプレートから作成されたキューが表示されます。

   ブローカーログが読み込まれておらず、Pod のステータスは ErrImagePull または ImagePullBackOff を表示し、設定は Red Hat Container Registry から指定されたブローカーイメージを直接プルできませんでした。この場合、デプロイメント設定を編集して、正しいブローカーイメージ名と、Red Hat Container Registry の認証に使用するアカウントに関連付けられたイメージプルシークレット名を参照します。これで、ブローカーイメージをインポートし、ブローカーを起動できます。方法は、ブローカーアプリケーションのデプロイおよび起動 に記載の手順を実施します。

5. Terminal タブをクリックして、CLI で一部のメッセージを送信できるシェルにアクセスします。

   sh-4.2$ ./broker/bin/artemis producer --destination queue://demoQueue
   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 : 4 s
   Producer ActiveMQQueue[demoQueue], thread=0 Elapsed time in milli second : 4584 milli seconds
   
   sh-4.2$ ./broker/bin/artemis consumer  --destination queue://demoQueue
   Consumer:: filter = null
   Consumer ActiveMQQueue[demoQueue], thread=0 wait until 1000 messages are consumed
   Received 1000
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumed: 1000 messages
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumer thread finished

   または、以下の例のように、OpenShift クライアントを使用して Pod 名を使用してシェルにアクセスします。

   // Get the Pod names and internal IP Addresses
   oc get pods -o wide
   
   // Access a broker Pod by name
   oc rsh <broker-pod-name>

6. oc コマンドを使用してブローカーをスケールダウンします。

   $ oc scale statefulset broker-amq --replicas=0
   statefulset "broker-amq" scaled

   コンソールを使用して、Pod 数が 0 であることを確認します。

7. 次に、ブローカーを 1 に再びスケールアップします。

   $ oc scale statefulset broker-amq --replicas=1
   statefulset "broker-amq" scaled

8. ターミナルを使用してメッセージを再度消費します。以下に例を示します。

   sh-4.2$ broker/bin/artemis consumer --destination queue://demoQueue
   Consumer:: filter = null
   Consumer ActiveMQQueue[demoQueue], thread=0 wait until 1000 messages are consumed
   Received 1000
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumed: 1000 messages
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumer thread finished

手順

1. Services → broker-amq-tcp-ssl をクリックします。
2. Actions → Create a route をクリックします。
3. TLS パラメーターを表示するには、Secure route チェックボックスを選択します。
4. TLS Termination ドロップダウンメニューから、Passthrough を選択します。ここで選択する内容では、OpenShift ルーターが復号化および再送信せずに AMQ Broker との通信をすべてリレーします。

5. ルートを表示するには、Routes をクリックします。以下に例を示します。

   https://broker-amq-tcp-amq-demo.router.default.svc.cluster.local

手順

1. OpenShift Web コンソールに移動し、ログインします。
2. amq-demo プロジェクトスペースを選択します。
3. Add to Project > Browse catalog の順にクリックしてデフォルトのイメージストリームおよびテンプレートを一覧表示します。
4. Filter 検索バーを使用して、一覧を amq に一致するものに限定します。See all をクリックして、必要なアプリケーションテンプレートを表示します。
5. Red Hat AMQ Broker 7.7 (no SSL, clustered) とラベル付けされた amq-broker-77-persistence-ssl テンプレートを選択します。

6. 設定で以下の値を設定し、Create をクリックします。

   表7.3 テンプレートの例

   環境変数	表示名	値	説明
   AMQ_PROTOCOL	AMQ プロトコル	openwire,amqp,stomp,mqtt,hornetq	ブローカーによって使用されるプロトコル
   AMQ_QUEUES	キュー	demoQueue	demoQueue という名前のキャストキューを作成します。
   AMQ_ADDRESSES	アドレス	demoTopic	demoTopic という名前のアドレス (またはトピック) を作成します。デフォルトでは、このアドレスには割り当てられたルーティングタイプが割り当てられていません。
   VOLUME_CAPACITY	AMQ ボリュームのサイズ	1Gi	ジャーナル用に作成される永続ボリュームサイズ
   AMQ_CLUSTERED	クラスター化	true	ブローカーがクラスター化されるようにするには、true に指定する必要があります。
   AMQ_CLUSTER_USER	クラスターユーザー	generated	ブローカーが相互の接続に使用するユーザー名
   AMQ_CLUSTER_PASSWORD	クラスターパスワード	generated	ブローカーが相互接続に使用するパスワード
   AMQ_USER	AMQ ユーザー名	amq-demo-user	クライアントが使用するユーザー名
   AMQ_PASSWORD	AMQ パスワード	パスワード	クライアントがユーザー名で使用するパスワード

手順

1. OpenShift Container Platform Web コンソールで StatefulSets をクリックします。
2. broker-amq デプロイメントをクリックします。

3. Deploy をクリックしてアプリケーションをデプロイします。

   注記

   クラスター化されたテンプレートのデフォルトのレプリカ数は 0 です。Pod は表示されないはずです。

4. Pod を 3 つにスケールアップし、ブローカーのクラスターを作成します。

   $ oc scale statefulset broker-amq --replicas=3
   statefulset "broker-amq" scaled

5. 3 つの Pod が実行されていることを確認します。

   $ oc get pods
   NAME           READY     STATUS    RESTARTS   AGE
   broker-amq-0   1/1       Running   0          33m
   broker-amq-1   1/1       Running   0          33m
   broker-amq-2   1/1       Running   0          29m

6. 表示される Pod のステータスが ErrImagePull または ImagePullBackOff の場合には、デプロイメントは Red Hat Container Registry から指定されたブローカーイメージを直接プルできていません。この場合、StatefulSet を編集して、正しいブローカーイメージ名と、Red Hat Container Registry の認証に使用するアカウントに関連付けられたイメージプルシークレット名を参照します。次に、ブローカーイメージをインポートし、ブローカーを起動できます。方法は、ブローカーアプリケーションのデプロイおよび起動 に記載の手順を実施します。

7. ログをチェックして、ブローカーが新しい Pod でクラスター化されていることを確認します。

   $ oc logs broker-amq-2

   これにより、新しいブローカーのログと、ブローカー間で作成されるクラスター化されたブリッジのエントリーが表示されます。

   2018-08-29 07:43:55,779 INFO  [org.apache.activemq.artemis.core.server] AMQ221027: Bridge ClusterConnectionBridge@1b0e9e9d [name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, queue=QueueImpl[name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, postOffice=PostOfficeImpl [server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c], temp=false]@5e0c0398 targetConnector=ServerLocatorImpl (identity=(Cluster-connection-bridge::ClusterConnectionBridge@1b0e9e9d [name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, queue=QueueImpl[name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, postOffice=PostOfficeImpl [server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c], temp=false]@5e0c0398 targetConnector=ServerLocatorImpl [initialConnectors=[TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-110], discoveryGroupConfiguration=null]]::ClusterConnectionImpl@806813022[nodeUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c, connector=TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-108, address=, server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c])) [initialConnectors=[TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-110], discoveryGroupConfiguration=null]] is connected

手順

1. StatefulSet セレクターを使用して Pod 間を選択し、クラスターの各 Pod に通常のサービスを作成します。これを実行するには、以下のようなサービステンプレートを .yaml 形式でデプロイします。

   apiVersion: v1
   kind: Service
   metadata:
     annotations:
       description: 'Service for the management console of broker pod XXXX'
     labels:
       app: application2
       application: application2
       template: amq-broker-77-persistence-clustered
     name: amq2-amq-console-XXXX
     namespace: amq75-p-c-ssl-2
   spec:
     ports:
       - name: console-jolokia
         port: 8161
         protocol: TCP
         targetPort: 8161
     selector:
       deploymentConfig: application2-amq
       statefulset.kubernetes.io/pod-name: application2-amq-XXXX
     type: ClusterIP

   上記のテンプレートの XXXX は、サービスに関連付けるブローカー Pod の ordinal 値に置き換えます。たとえば、サービス をクラスターの最初の Pod に関連付けるには、XXXX を 0 に設定します。サービスと 2 つ目の Pod を関連付けるには、XXXX を 1 に設定するなどです。

   クラスターにある各ブローカー Pod のテンプレートのインスタンスを保存してデプロイします。

   注記

   上記のテンプレート例では、セレクターは Kubernetes 定義の Pod 名を使用します。

2. AMQ Broker 管理コンソールが Pod に接続できるように、各ブローカー Pod のルートを作成します。

   Routes → Create Route の順にクリックします。

   Edit Route ページが表示されます。

   1. Services ドロップダウンメニューで、以前に作成したブローカーサービスで、ルートの関連付け先を選択します (例: amq2-amq-console-0 )。
   2. Target Port を 8161 に設定し、AMQ Broker 管理コンソールへのアクセスを有効にします。

   3. TLS パラメーターを表示するには、Secure route チェックボックスを選択します。

      1. TLS Termination ドロップダウンメニューから、Passthrough を選択します。

         ここで選択する内容では、OpenShift ルーターが復号化および再送信せずに AMQ Broker との通信をすべてリレーします。

   4. Create をクリックします。

      ブローカー Pod の 1 つに関連付けられたルートを作成する場合には、生成される .yaml ファイルには以下のような行が含まれます。

      spec:
        host: amq2-amq-console-0-amq75-p-c-2.apps-ocp311.example.com
        port:
          targetPort: console-jolokia
        tls:
          termination: passthrough
        to:
          kind: Service
          name: amq2-amq-console-0
          weight: 100
        wildcardPolicy: None

3. 特定のブローカーインスタンスの管理コンソールにアクセスするには、上記の ホスト URL を Web ブラウザーにコピーします。

手順

1. OpenShift Web コンソールに移動し、ログインします。
2. amq-demo プロジェクトスペースを選択します。
3. Add to Project > Browse catalog の順にクリックしてデフォルトのイメージストリームおよびテンプレートを一覧表示します。
4. Filter 検索バーを使用して、一覧を amq に一致するものに限定します。See all をクリックして、必要なアプリケーションテンプレートを表示します。
5. Red Hat AMQ Broker 7.7(SSL, clustered) というラベルが付いた amq-broker-77-persistence-clustered-ssl テンプレートを選択します。

6. 設定で以下の値を設定し、Create をクリックします。

   表7.4 テンプレートの例

   環境変数	表示名	値	説明
   AMQ_PROTOCOL	AMQ プロトコル	openwire,amqp,stomp,mqtt,hornetq	ブローカーによって使用されるプロトコル
   AMQ_QUEUES	キュー	demoQueue	demoQueue という名前のキャストキューを作成します。
   AMQ_ADDRESSES	アドレス	demoTopic	demoTopic という名前のアドレス (またはトピック) を作成します。デフォルトでは、このアドレスには割り当てられたルーティングタイプが割り当てられていません。
   VOLUME_CAPACITY	AMQ ボリュームのサイズ	1Gi	ジャーナル用に作成される永続ボリュームサイズ
   AMQ_CLUSTERED	クラスター化	true	ブローカーがクラスター化されるようにするには、true に指定する必要があります。
   AMQ_CLUSTER_USER	クラスターユーザー	generated	ブローカーが相互の接続に使用するユーザー名
   AMQ_CLUSTER_PASSWORD	クラスターパスワード	generated	ブローカーが相互接続に使用するパスワード
   AMQ_USER	AMQ ユーザー名	amq-demo-user	クライアントが使用するユーザー名
   AMQ_PASSWORD	AMQ パスワード	パスワード	クライアントがユーザー名で使用するパスワード
   AMQ_TRUSTSTORE	トラストストアファイル名	broker.ts	SSL トラストストアファイル名
   AMQ_TRUSTSTORE_PASSWORD	トラストストアのパスワード	パスワード	トラストストアの作成時に使用されるパスワード
   AMQ_KEYSTORE	AMQ キーストアファイル名	broker.ks	SSL キーストアのファイル名
   AMQ_KEYSTORE_PASSWORD	AMQ キーストアのパスワード	パスワード	キーストアの作成時に使用されるパスワード

手順

1. OpenShift Container Platform Web コンソールで StatefulSets をクリックします。
2. broker-amq デプロイメントをクリックします。

3. Deploy をクリックしてアプリケーションをデプロイします。

   注記

   クラスター化されたテンプレートのデフォルトのレプリカ数は 0 であるため、Pod は表示されません。

4. Pod を 3 つにスケールアップし、ブローカーのクラスターを作成します。

   $ oc scale statefulset broker-amq --replicas=3
   statefulset "broker-amq" scaled

5. 3 つの Pod が実行されていることを確認します。

   $ oc get pods
   NAME           READY     STATUS    RESTARTS   AGE
   broker-amq-0   1/1       Running   0          33m
   broker-amq-1   1/1       Running   0          33m
   broker-amq-2   1/1       Running   0          29m

6. 表示される Pod のステータスが ErrImagePull または ImagePullBackOff の場合には、デプロイメントは Red Hat Container Registry から指定されたブローカーイメージを直接プルできていません。この場合、StatefulSet を編集して、正しいブローカーイメージ名と、Red Hat Container Registry の認証に使用するアカウントに関連付けられたイメージプルシークレット名を参照します。次に、ブローカーイメージをインポートし、ブローカーを起動できます。これを実行するには、ブローカーアプリケーションのデプロイおよび起動 にある手順と同様の手順を実行します。

7. ログをチェックして、ブローカーが新しい Pod でクラスター化されたことを確認します。

   $ oc logs broker-amq-2

   これにより、以下のように、新しいブローカーのログと、ブローカー間で作成されたクラスター化されたブリッジのエントリーがすべて表示されます。

   2018-08-29 07:43:55,779 INFO  [org.apache.activemq.artemis.core.server] AMQ221027: Bridge ClusterConnectionBridge@1b0e9e9d [name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, queue=QueueImpl[name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, postOffice=PostOfficeImpl [server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c], temp=false]@5e0c0398 targetConnector=ServerLocatorImpl (identity=(Cluster-connection-bridge::ClusterConnectionBridge@1b0e9e9d [name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, queue=QueueImpl[name=$.artemis.internal.sf.my-cluster.4333c830-ab5f-11e8-afb8-0a580a82006e, postOffice=PostOfficeImpl [server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c], temp=false]@5e0c0398 targetConnector=ServerLocatorImpl [initialConnectors=[TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-110], discoveryGroupConfiguration=null]]::ClusterConnectionImpl@806813022[nodeUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c, connector=TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-108, address=, server=ActiveMQServerImpl::serverUUID=9cedb69d-ab5e-11e8-87a4-0a580a82006c])) [initialConnectors=[TransportConfiguration(name=artemis, factory=org-apache-activemq-artemis-core-remoting-impl-netty-NettyConnectorFactory) ?port=61616&host=10-130-0-110], discoveryGroupConfiguration=null]] is connected

手順

1. OpenShift Web コンソールに移動し、ログインします。
2. amq-demo プロジェクトスペースを選択します。
3. Add to Project > Browse catalog の順にクリックしてデフォルトのイメージストリームおよびテンプレートを一覧表示します。
4. Filter 検索バーを使用して、amq に一致するものだけに結果を限定します。See all をクリックして、必要なアプリケーションテンプレートを表示します。
5. Red Hat AMQ Broker 7.7(Ephemeral, no SSL) というラベルが付いた amq-broker-77-custom テンプレートを選択します。

6. 設定で broker.xml を、使用するカスタム設定に更新します。Create をクリックします。

   注記

   テキストエディターを使用してブローカーの XML 設定を作成します。次に、変更詳細を broker.xml フィールドに切り取って貼り付けます。

   注記

   OpenShift Container Platform では、このプラットフォームにデプロイされる多くのアプリケーションに共通するので、ConfigMap オブジェクトを使用して broker.xml フィールドに指定するカスタム設定は保存されません。代わりに、ブローカーコンテナーの起動時に設定をスタンドアロンファイルに転送する前に、OpenShift は指定された設定を環境変数に一時的に保存します。

手順

1. OpenShift Container Platform Web コンソールで Deployments をクリックします。
2. broker-amq デプロイメントをクリックします。
3. Deploy をクリックしてアプリケーションをデプロイします。

手順

1. /etc/hosts ファイルにエントリーを追加して、ルート名を OpenShift クラスターの IP アドレスにマッピングします。

   10.0.0.1 broker-amq-tcp-amq-demo.router.default.svc.cluster.local

2. 以下のように、jndi.properties 設定ファイルは、前のステップで作成したルート、トラストストア、およびキーストアを使用するように更新します。

   connectionfactory.myFactoryLookup = amqps://broker-amq-tcp-amq-demo.router.default.svc.cluster.local:8443?transport.keyStoreLocation=<keystore-path>client.ks&transport.keyStorePassword=password&transport.trustStoreLocation=<truststore-path>/client.ts&transport.trustStorePassword=password&transport.verifyHost=false

3. jndi.properties 設定ファイルは、先に作成したキューを使用するように更新します。

   queue.myDestinationLookup = demoQueue

4. 送信側のクライアントを実行してテキストメッセージを送信します。

5. 受信側クライアントを実行して、テキストメッセージを受信します。以下が表示されるはずです。

   Received message: Message Text!

手順

1. Add to Project ドロップダウンから import YAML/JSON を選択します。

2. 以下を入力し、Create をクリックします。

   apiVersion: v1
   kind: Route
   metadata:
     labels:
       app: broker-amq
       application: broker-amq
     name: tcp-ssl
   spec:
     port:
       targetPort: ow-multi-ssl
     tls:
       termination: passthrough
     to:
       kind: Service
       name: broker-amq-headless
       weight: 100
     wildcardPolicy: Subdomain
     host: star.broker-ssl-amq-headless.amq-demo.svc

   注記

   ここで重要な設定は、Subdomain のワイルドカードポリシーです。これにより、各ブローカーは独自のホスト名からアクセスできます。

手順

1. /etc/hosts ファイルにエントリーを追加して、ルート名をブローカーの実際の IP アドレスにマッピングします。

   10.0.0.1 broker-amq-0.broker-ssl-amq-headless.amq-demo.svc broker-amq-1.broker-ssl-amq-headless.amq-demo.svc broker-amq-2.broker-ssl-amq-headless.amq-demo.svc

2. 以下のように、jndi.properties 設定ファイルを、前のステップで作成したルート、トラストストア、およびキーストアを使用するように更新します。

   connectionfactory.myFactoryLookup = amqps://broker-amq-0.broker-ssl-amq-headless.amq-demo.svc:443?transport.keyStoreLocation=/home/ataylor/projects/jboss-amq-7-broker-openshift-image/client.ks&transport.keyStorePassword=password&transport.trustStoreLocation=/home/ataylor/projects/jboss-amq-7-broker-openshift-image/client.ts&transport.trustStorePassword=password&transport.verifyHost=false

3. jndi.properties 設定ファイルは、先に作成したキューを使用するように更新します。

   queue.myDestinationLookup = demoQueue

4. 送信側のクライアントコードを実行してテキストメッセージを送信します。

5. 受信側クライアントコードを実行して、テキストメッセージを受信します。以下が表示されるはずです。

   Received message: Message Text!

手順

1. Add to Project ドロップダウンから import YAML/JSON を選択します。

2. 以下を入力し、Create をクリックします。

   apiVersion: v1
   kind: Service
   metadata:
     annotations:
       description: The broker's OpenWire port.
       service.alpha.openshift.io/dependencies: >-
         [{"name": "broker-amq-amqp", "kind": "Service"},{"name":
         "broker-amq-mqtt", "kind": "Service"},{"name": "broker-amq-stomp", "kind":
         "Service"}]
     creationTimestamp: '2018-08-29T14:46:33Z'
     labels:
       application: broker
       template: amq-broker-77-statefulset-clustered
     name: broker-external-tcp
     namespace: amq-demo
     resourceVersion: '2450312'
     selfLink: /api/v1/namespaces/amq-demo/services/broker-amq-tcp
     uid: 52631fa0-ab9a-11e8-9380-c280f77be0d0
   spec:
     externalTrafficPolicy: Cluster
     ports:
      -  nodePort: 30001
         port: 61616
         protocol: TCP
         targetPort: 61616
     selector:
       deploymentConfig: broker-amq
     sessionAffinity: None
     type: NodePort
   status:
     loadBalancer: {}

   注記

   NodePort 設定は重要です。NodePort はクライアントがブローカーにアクセスするポートで、タイプは NodePort です。

手順

1. 端末でコンシューマーを作成し、OpenShift が実行している IP アドレスにアタッチします。

   artemis consumer --url tcp://<IP_ADDRESS>:30001 --message-count 100 --destination queue://demoQueue

2. ステップ 1 を 2 回繰り返して、2 つのコンシューマーを起動します。

   注記

   これで、3 つのブローカー全体で 3 つのコンシューマー負荷が分散されます。

3. メッセージを送信するプロデューサーを作成します。

   artemis producer --url tcp://<IP_ADDRESS>:30001 --message-count 300 --destination queue://demoQueue

4. 各コンシューマーがメッセージを受信することを確認します。

   Consumer:: filter = null
   Consumer ActiveMQQueue[demoQueue], thread=0 wait until 100 messages are consumed
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumed: 100 messages
   Consumer ActiveMQQueue[demoQueue], thread=0 Consumer thread finished

手順

1. ブローカーのデプロイメントなどのプロジェクトに対する管理者権限で、OpenShift Container Platform Web コンソールにログインします。
2. Web コンソールで、Home → Projects (OpenShift Container Platform 4.1 以降) または左上隅 (OpenShift Container Platform 3.11) のドロップダウンリストをクリックします。ブローカーのデプロイメントが含まれるプロジェクトを選択します。

3. プロジェクトで StatefulSets または DeploymentConfigs を表示するには、以下を実行します。

   1. Workloads → StatefulSets または Workloads → DeploymentConfigs (OpenShift Container Platform 4.1 以降)。
   2. Applications → StatefulSets または Applications → Deployments (OpenShift Container Platform 3.11).
4. ブローカーのデプロイメントに対応する StatefulSet または DeploymentConfig をクリックします。
5. ブローカーデプロイメントの環境変数にアクセスするには、環境 タブをクリックします。

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 の一部に、ルート名が含まれます。

   1. Networking → Routes (OpenShift Container Platform 4.1 以降) または Applications → Routes (OpenShift Container Platform 3.11) をクリックします。

   2. 選択したブローカー Pod で、AMQ Broker 管理コンソールへの Pod の接続用に作成されたルートを特定します。ホスト名に表示される完全な URL をメモします。以下に例を示します。

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

2. Prometheus メトリクスにアクセスするには、Web ブラウザーで、先程メモをしたルート名に / metrics が付けて入力します。以下に例を示します。

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