OpenShift での AMQ Online のインストールと管理

手順

1. cluster-admin 権限を持つユーザーとしてログインしてます。

   oc login -u system:admin

2. (オプション) amq-online-infra 以外のプロジェクトにデプロイする場合は、次のコマンドを実行し、後続の手順で amq-online-infra を置き換える必要があります。

   sed -i 's/amq-online-infra/my-project/' install/bundles/amq-online/*.yaml

3. AMQ Online をデプロイするプロジェクトを作成します。

   oc new-project amq-online-infra

4. ダウンロードしたリリースファイルの場所にディレクトリーを変更します。

5. amq-online バンドルを使用してデプロイします。

   oc apply -f install/bundles/amq-online

6. (オプション) サンプルプランとインフラストラクチャー設定をインストールします。

   oc apply -f install/components/example-plans

7. (オプション) サンプルのロールをインストールします。

   oc apply -f install/components/example-roles

8. (オプション) 標準 認証サービスをインストールします。

   oc apply -f install/components/example-authservices/standard-authservice.yaml

9. (オプション) Service Catalog 統合をインストールします。

   oc apply -f install/components/service-broker
   oc apply -f install/components/cluster-service-broker

手順

1. インベントリーファイルを作成します。

2. Ansible Playbook の実行:

   ansible-playbook -i inventory-file ansible/playbooks/openshift/deploy_all.yml

手順

1. サービスオペレーターとしてログインします。

   oc login -u system:admin

2. AMQ Online がインストールされているプロジェクトを選択します。

   oc project amq-online-infra

3. 新しいリリースバンドルを適用します。

   oc apply -f install/bundles/amq-online

4. 再起動中に Pod を監視します。

   oc get pods -w

   Pod が再起動し、数分以内にアクティブになります。

5. アップグレード後に不要になった api-server リソースを削除します。

   oc delete sa api-server -n amq-online-infra
   oc delete clusterrolebinding enmasse.io:api-server-amq-online-infra
   oc delete clusterrole enmasse.io:api-server
   oc delete rolebinding api-server -n amq-online-infra
   oc delete role enmasse.io:api-server -n amq-online-infra

手順

1. サービスオペレーターとしてログインします。

   oc login -u system:admin

2. 新しいリリースから Ansible Playbook を実行します。

   ansible-playbook -i inventory-file ansible/playbooks/openshift/deploy_all.yml

3. 再起動中に Pod を監視します。

   oc get pods -w

   Pod が再起動し、数分以内にアクティブになります。

4. アップグレード後に不要になった api-server リソースを削除します。

   oc delete sa api-server -n amq-online-infra
   oc delete clusterrolebinding enmasse.io:api-server-amq-online-infra
   oc delete clusterrole enmasse.io:api-server
   oc delete rolebinding api-server -n amq-online-infra
   oc delete role enmasse.io:api-server -n amq-online-infra

手順

1. cluster-admin 権限を持つユーザーとしてログインしてます。

   oc login -u system:admin

2. クラスターレベルのリソースを削除します。

   oc delete crd -l app=enmasse,enmasse-component=iot
   oc delete crd -l app=enmasse --timeout=600s
   oc delete clusterrolebindings -l app=enmasse
   oc delete clusterroles -l app=enmasse
   oc delete apiservices -l app=enmasse
   oc delete oauthclients -l app=enmasse

3. (OpenShift 4) コンソール統合を削除します。

   oc delete consolelinks -l app=enmasse

4. (オプション) サービスカタログ統合を削除します。

   oc delete clusterservicebrokers -l app=enmasse

5. AMQ Online がデプロイされているプロジェクトを削除します。

   oc delete project amq-online-infra

手順

1. Ansible Playbook を実行します。ここで、inventory-file は、インストール時に使用されるインベントリーファイルを指定します。

   ansible-playbook -i inventory-file ansible/playbooks/openshift/uninstall.yml

手順

1. cluster-admin 権限を持つユーザーとしてログインしてます。

   oc login -u system:admin

2. すべての IoTProject および AddressSpace インスタンスを削除します。

   oc delete iotprojects -A --all
   oc delete addressspaces -A --all --timeout=600s

3. サブスクリプションを削除します (amq-online をインストールで使用したサブスクリプションの名前に置き換えます)。

   oc delete subscription amq-online -n amq-online-infra

4. Operator の CSV を削除します。

   oc delete csv -l app=enmasse -n amq-online-infra

5. 残りのリソースをすべて削除します (amq-online-infra は、AMQ Online をインストールしたプロジェクトに置き換えます)。

   oc delete all -l app=enmasse -n amq-online-infra
   oc delete cm -l app=enmasse -n amq-online-infra
   oc delete secret -l app=enmasse amq-online-infra
   oc delete consolelinks -l app=enmasse
   oc delete oauthclients -l app=enmasse
   oc delete crd -l app=enmasse

6. (オプション: AMQ Online が openshift-operators namespace にインストールされている場合は、この手順をスキップします) AMQ Online がインストールされた namespace を削除します。

   oc delete namespace amq-online-infra

手順

1. プロジェクトリストから、AMQ Online をインストールしたプロジェクトを選択します。
2. Catalog → Operator Management をクリックします。Operator 管理ページが開きます。
3. Operator Subscriptions タブをクリックします。
4. アンインストールする AMQ Online Operator を見つけます。右端の列で、縦の省略記号アイコンをクリックし、Remove Subscription を選択します。

5. Remove Subscription ウィンドウでプロンプトが表示されたら、Operator に関連するすべてのコンポーネントを削除する場合は、Also completely remove the AMQ Online Operator from the selected namespace チェックボックスを選択してください。

   • Remove をクリックします。AMQ Online Operator は実行を停止し、更新を受信しなくなります。

6. 次のコマンドを実行して、残りのリソースをすべて削除します (amq-online-infra は、AMQ Online をインストールしたプロジェクトに置き換えます)。

   oc delete all -l app=enmasse -n amq-online-infra
   oc delete cm -l app=enmasse -n amq-online-infra
   oc delete secret -l app=enmasse amq-online-infra
   oc delete consolelinks -l app=enmasse
   oc delete oauthclients -l app=enmasse

7. (オプション: AMQ Online が openshift-operators namespace にインストールされている場合は、この手順をスキップします) AMQ Online がインストールされた namespace を削除します。

   oc delete namespace amq-online-infra

手順

1. 設定例を保存します。

   apiVersion: admin.enmasse.io/v1beta1
   kind: StandardInfraConfig
   metadata:
     name: default
   spec: {}
   ---
   apiVersion: admin.enmasse.io/v1beta2
   kind: AddressPlan
   metadata:
     name: standard-small-queue
   spec:
     addressType: queue
     resources:
       router: 0.01
       broker: 0.1
   ---
   apiVersion: admin.enmasse.io/v1beta2
   kind: AddressSpacePlan
   metadata:
     name: standard-small
   spec:
     addressSpaceType: standard
     infraConfigRef: default
     addressPlans:
     - standard-small-queue
     resourceLimits:
       router: 2.0
       broker: 3.0
       aggregate: 4.0
   ---
   apiVersion: admin.enmasse.io/v1beta1
   kind: AuthenticationService
   metadata:
     name: none-authservice
   spec:
     type: none

2. 設定例を適用します。

   oc apply -f service-config.yaml

手順

1. サービス管理者としてログインします。

   oc login -u system:admin

2. AMQ Online がインストールされているプロジェクトを選択します。

   oc project amq-online-infra

3. アドレス空間計画定義を作成します。

   apiVersion: admin.enmasse.io/v1beta2
   kind: AddressSpacePlan
   metadata:
     name: restrictive-plan
     labels:
       app: enmasse
   spec:
     displayName: Restrictive Plan
     displayOrder: 0
     infraConfigRef: default
     shortDescription: A plan with restrictive quotas
     longDescription: A plan with restrictive quotas for the standard address space
     addressSpaceType: standard
     addressPlans:
     - small-queue
     - small-anycast
     resourceLimits:
       router: 2.0
       broker: 2.0
       aggregate: 2.0

4. アドレス空間を作成します。

   oc create -f restrictive-plan.yaml

5. スキーマが更新され、計画が含まれていることを確認します。

   oc get addressspaceschema standard -o yaml

手順

1. サービス管理者としてログインします。

   oc login -u system:admin

2. AMQ Online がインストールされているプロジェクトを選択します。

   oc project amq-online-infra

3. アドレス計画定義を作成します。

   apiVersion: admin.enmasse.io/v1beta2
   kind: AddressPlan
   metadata:
     name: small-anycast
     labels:
       app: enmasse
   spec:
     addressType: anycast
     resources:
       router: 0.2

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

   oc create -f small-anycast-plan.yaml

5. スキーマが更新され、計画が含まれていることを確認します。

   oc get addressspaceschema standard -o yaml

手順

1. サービスオペレーターとしてログインします。

   oc login -u developer

2. AMQ Online がインストールされているプロジェクトに切り替えます。

   oc project _amq-online-infra_

3. 既存のインフラストラクチャー設定を編集するか、次の例を使用して新しいインフラストラクチャー設定を作成します。

   apiVersion: admin.enmasse.io/v1beta1
   kind: StandardInfraConfig
   metadata:
     name: myconfig
   spec:
     version: "0.32"
     admin:
       resources:
         memory: 256Mi
     broker:
       resources:
         memory: 2Gi
         storage: 100Gi
       addressFullPolicy: PAGE
     router:
       resources:
         memory: 256Mi
       linkCapacity: 1000
       minReplicas: 1

4. 設定の変更を適用します。

   oc apply -f standard-infra-config-example.yaml

5. 再起動中に Pod を監視します。

   oc get pods -w

   設定の変更は数分以内に適用されます。

手順

1. cluster-admin 権限を持つユーザーとしてログインしてます。

   oc login -u system:admin

2. (オプション) enmasse-monitoring 以外の namespace にデプロイする場合は、次のコマンドを実行し、後続の手順で enmasse-monitoring を置き換える必要があります。

   sed -i 's/enmasse-monitoring/my-namespace/' install/bundles/amq-online/*.yaml

3. enmasse-monitoring namespace を作成します。

   oc new-project enmasse-monitoring

4. monitoring-operator リソースをデプロイします。

   oc apply -f install/components/monitoring-operator

5. monitoring-operator コンポーネントをデプロイします。

   oc apply -f install/components/monitoring-deployment

手順

1. cluster-admin 権限を持つユーザーとしてログインしてます。

   oc login -u system:admin

2. amq-online-infra プロジェクトを選択します。

   oc project amq-online-infra

3. kube-state-metrics コンポーネントをデプロイします。

   oc apply -f install/components/kube-state-metrics

手順

1. amq-online-infra namespace にラベルを付けます。

   oc label namespace amq-online-infra monitoring-key=middleware

2. Operator でのモニターを有効にします。

   oc set env deployment -n amq-online-infra enmasse-operator ENABLE_MONITORING=true

手順

1. デフォルト設定を含むシークレットを削除します。

   oc delete secret alertmanager-application-monitoring

2. 新しい設定を含むシークレットを作成します。

   oc create secret generic alertmanager-application-monitoring --from-file=alertmanager.yaml

手順

1. すべてのルーター Pod を一覧表示し、関連するアドレス空間の Pod を選択します。

   oc get pods -l name=qdrouterd -o go-template --template '{{range .items}}{{.metadata.name}}{{"\t"}}{{.metadata.annotations.addressSpace}}{{"\n"}}{{end}}'

2. Pod のログを表示します。

   oc logs pod -c router

手順

1. すべてのブローカー Pod を一覧表示し、関連するアドレス空間の Pod を選択します。

   oc get pods -l role=broker -o go-template --template '{{range .items}}{{.metadata.name}}{{"\t"}}{{.metadata.annotations.addressSpace}}{{"\n"}}{{end}}'

2. Pod のログを表示します。

   oc logs pod

手順

1. サービスオペレーターとしてログインします。

   oc login -u developer

2. AMQ Online がインストールされているプロジェクトに切り替えます。

   oc project amq-online-infra

3. 関連するアドレス空間の addresspaceplan 名を決定します。

   oc get addressspace -n namespace address-space-name --output 'jsonpath={.spec.plan}{"\n"}'

4. addressspaceplan 名の standardinfraconfig または brokeredinfraconfig 名を決定します。

   oc get addressspaceplan address-space-plan --output 'jsonpath={.spec.infraConfigRef}{"\n"}'

5. その standardinfraconfig または brokeredinfraconfig を使用して、すべてのアドレス空間のすべてのブローカーのプロトコルトレースを有効にします。

   oc patch infraconfig-resource infraconfig-name --type=merge -p '{"spec":{"broker":{"podTemplate":{"spec":{"containers":[{"env":[{"name":"PN_TRACE_FRM","value":"true"}],"name":"broker"}]}}}}}'

6. プロトコルトレースを含む Pod のログを表示します。

   oc logs pod

7. プロトコルトレースを無効にします。

   oc patch infraconfig-resource infraconfig-name --type=merge -p '{"spec":{"broker":{"podTemplate":{"spec":{"containers":[{"env":[{"name":"PN_TRACE_FRM"}],"name":"broker"}]}}}}}'

手順

1. サービス管理者としてログインします。

   oc login -u admin

2. AMQ Online がインストールされているプロジェクトに切り替えます。

   oc project amq-online-infra

3. アドレス空間の uuid を取得します。

   oc get addressspace myspace -o jsonpath='{.metadata.annotations.enmasse\.io/infra-uuid}'

4. アドレス空間のブローカーサポート認証情報 (ユーザー名とパスワード) を取得します。

   oc get secret broker-support-uuid  --template='{{.data.username}}' | base64 --decode
   oc get secret broker-support-uuid  --template='{{.data.password}}' | base64 --decode

5. ブローカー Pod 名を特定します。

   oc get pods -l infraUuid=uuid,role=broker

   標準アドレスでは、多くのブローカーが存在する場合があります。特定のキューをホストしているブローカーを特定するには、次のコマンドを使用します。

   oc get address address-resource-name  -o jsonpath="{.status.brokerStatuses[*].containerId}"

6. ブローカーの Pod でサポートコマンドを実行します。

   AMQ Broker CLI コマンドを実行するには、次のようなコマンドを使用します。

   oc exec broker-pod-name -- /opt/amq/bin/artemis address show --user username --password password

   AMQ Broker Jolokia JMX コマンドを実行するには、次のようなコマンドを使用します。

   oc exec broker-pod-name -- curl --silent --insecure --user username:_password_ -H "Origin: https://localhost:8161" 'https://localhost:8161/console/jolokia/read/org.apache.activemq.artemis:broker="broker pod name"/AddressMemoryUsage'

   重要

   URL 内のブローカー Pod 名を二重引用符で囲む必要があります。上記のコマンドに示すように、URL 全体を一重引用符で囲んで、コマンドシェルからそれらを保護してください。それらが存在しない場合は、認証エラーが発生します。