2.4. WildcardRouter から Zync Route Management への移行

手順

1. Zync が外部ゲートウェイのルートを管理しない場合、提案された代替案のいずれかの手順に従って、Zync で管理されない各サービスのデプロイメントオプションを変更できます。

   • 3scale で以下の操作を行います。

     1. Integration ページに移動し、edit integration settings をクリックします。
     2. 適切なデプロイメントオプションを選択し、変更があれば保存します。

   • API の使用

     1. サービス識別子 (ID) とアクセストークン (ACCESS_TOKEN) およびテナントエンドポイント (TENANT_URL) でサービスを更新します。

        $ curl -XPUT "${TENANT_URL}/admin/api/services/${ID}.json" -d deployment_option=self_managed -d access_token="${ACCESS_TOKEN}"

        Copy to Clipboard Toggle word wrap

        または、ホストされている APIcast を使用している場合は、次のコマンドを使用できます。

        $ curl -XPUT "${TENANT_URL}/admin/api/services/${ID}.json" -d deployment_option=hosted -d access_token="${ACCESS_TOKEN}"

        Copy to Clipboard Toggle word wrap

     2. 各テナントのサービスごとに、3scale または API を介して deployment_option フィールドを変更します。

        • deployment_option を self_managed に設定できるケースは次のとおりです。

          • APIcast は、OpenShift のカスタムルートにリンクされています。
          • APIcast は OpenShift の外部でホストされます。
          • APICAST_PATH_ROUTING が true に設定されています。
        • それ以外の場合は、deployment_option を hosts に設定します。

2. 存在する可能性のあるルートの中で、デフォルトのルートの中で 3scale が 2.5 で自動的に作成したものがあります。それらを削除することから始めます。

   $ oc delete route system-master
   $ oc delete route system-provider-admin
   $ oc delete route system-developer
   $ oc delete route api-apicast-production
   $ oc delete route api-apicast-staging

   Copy to Clipboard Toggle word wrap

   • WILDCARD_POLICY= Subdomain を指定して 3scale 2.5 をデプロイした場合は、以下を使用してワイルドカードルートを削除する必要があります。

     $ oc delete route apicast-wildcard-router

     Copy to Clipboard Toggle word wrap
   • それ以外の場合、WILDCARD_POLICY= Subdomain を指定せずに 3scale 2.5 をデプロイした場合は、Zync が作成するルートの重複を避けるために、3scale テナントおよびサービス用に手動で作成したルートを削除する必要があります。

1. Zync を使用して、すべての 3scale サービスとテナント OpenShift ルートを強制的に再度同期します。

   $ SYSTEM_SIDEKIQ_POD=$(oc get pods | grep sidekiq | awk '{print $1}')

   Copy to Clipboard Toggle word wrap

2. SYSTEM_SIDEKIQ_POD 環境変数の結果が空でないことを確認します。

   $ echo ${SYSTEM_SIDEKIQ_POD}

   Copy to Clipboard Toggle word wrap

3. 最後に、再同期を実行します。

   $ oc exec -it ${SYSTEM_SIDEKIQ_POD} -- bash -c 'bundle exec rake zync:resync:domains'

   Copy to Clipboard Toggle word wrap

   システムへの通知に関する情報を含むこのスタイルの出力が表示されます。

   $ No valid API key has been set, notifications will not be sent
   ActiveMerchant MODE set to 'production'
   [Core] Using http://backend-listener:3000/internal/ as URL
   OpenIdAuthentication.store is nil. Using in-memory store.
   [EventBroker] notifying subscribers of Domains::ProviderDomainsChangedEvent 59a554f6-7b3f-4246-9c36-24da988ca800
   [EventBroker] notifying subscribers of ZyncEvent caa8e941-b734-4192-acb0-0b12cbaab9ca
   Enqueued ZyncWorker#d92db46bdba7a299f3e88f14 with args: ["caa8e941-b734-4192-acb0-0b12cbaab9ca", {:type=>"Provider", :id=>1, :parent_event_id=>"59a554f6-7b3f-4246-9c36-24da988ca800", :parent_event_type=>"Domains::ProviderDomainsChangedEvent", :tenant_id=>1}]
   [EventBroker] notifying subscribers of Domains::ProviderDomainsChangedEvent 9010a199-2af1-4023-9b8d-297bd618096f
   …

   Copy to Clipboard Toggle word wrap

   強制的に Zync による再評価を行った後に、すべての既存テナントおよびサービスに対して新規ルートが作成されます。サービスおよびテナントの数によっては、ルートの作成に数分かかる場合があります。

   プロセスが完了するまでに、以下が作成されたことが分かります。

   • 1 つのマスター管理ポータルルート。

     3scale テナントごとに、以下の 2 つのルートが作成されます。

   • テナントの管理ポータルルート。

   • テナントの開発者ポータルルート。

     3scale サービスごとに 2 つのルートが作成されます。

   • サービスに対応する APIcast staging Route。
   • サービスに対応する APIcast production Route。

4. 上記で説明した予想されるすべてのルートが、既存のすべてのサービスとテナントに対して作成されていることを確認します。次のコマンドを実行すると、すべてのルートを表示できます。

   $ oc get routes

   Copy to Clipboard Toggle word wrap

   前のコマンドの出力として表示されるホスト/ポートフィールドは、ルートの URL である必要があります。

   • WILDCARD_POLICY を Subdomain に設定して 3scale 2.5 をデプロイした場合には、新しいルートはすべて、古い OpenShift ワイルドカードルートと同じベースの WildcardDomain を指定する必要があります。
   • それ以外の場合、WILDCARD_POLICY=Subdomain なしで 3scale 2.5 をデプロイした場合に、新しいルートは、2.5 リリースで 3scale によって自動的に作成されたものを含め、削除した古いルートと同じホストを指定する必要があります。
5. 最後に、古いワイルドカードルート、または手動で作成された古いルートにカスタム SSL 証明書を使用していた場合は、その証明書を Zync で作成された新しいルートにインストールします。これには、OpenShift Web パネルでルートを編集し、証明書をルートに追加します。

6. この移行の前に存在していたサービスとテナントが、新しいルートを使用して引き続き解決できることを確認します。このタスクを実行するには、以下のテストを実行します。

   1. この移行の前にすでに存在していた 3scale サービスに関連付けられた既存の APIcast 実稼働 URL のルートを解決します。
   2. この移行の前にすでに存在していた 3scale サービスに関連付けられた既存の APIcast ステージング URL のルートを解決します。
   3. この移行の前にすでに存在していた既存のテナントのルートを解決します。

7. 新しい Zync 機能が動作していることを確認するときに、新しいテナントとサービスの作成時に新しいルートが生成されることを確認します。このタスクを実行するには、以下のテストを実行します。

   1. マスターパネルから新しいテナントを作成し、数秒後にそれに関連付けられた新しいルートが OpenShift に表示されることを確認します。
   2. 既存のテナントの 1 つで新しいサービスを作成し、数秒後にそれに関連付けられた新しいルートが OpenShift に表示されることを確認します。

8. apicast-wildcard-router サービスを削除します。

   $ oc delete service apicast-wildcard-router

   Copy to Clipboard Toggle word wrap

9. 非推奨の WildcardRouter サブシステムを削除します。

   $ oc delete ImageStream amp-wildcard-router
   $ oc delete DeploymentConfig apicast-wildcard-router

   Copy to Clipboard Toggle word wrap

   上記の手順をすべて実施すると、テンプレートベースのデプロイメントにおける 3scale 2.6 から 2.7 へのアップグレードが完了します。