1. 新しいデータベースを作成します。

   Oracle Database が 3scale と動作するようにするには、以下の設定が必要です。

   ALTER SYSTEM SET max_string_size=extended SCOPE=SPFILE;
   ALTER SYSTEM SET compatible='12.2.0.1' SCOPE=SPFILE;

2. データベースの詳細を収集します。

   3scale の設定に必要な以下の情報を取得します。

   • Oracle Database の URL
   • Oracle Database の サービス名

   • Oracle Database の システム のパスワード

     DATABASE_URL パラメーターは次の形式に従う必要があります。

手順

1. 3scale OpenShift テンプレート GitHub リポジトリーのクローンを作成します。以下のコマンドを使用します。

   $ git clone --branch 2.6.0.GA https://github.com/3scale/3scale-amp-openshift-templates.git

2. Oracle Database の Instant Client パッケージファイルを 3scale-amp-openshift-templates/amp/system-oracle/oracle-client-files ディレクトリーに置きます。
3. 3scale 2.6 amp.yml テンプレートをダウンロードします。

4. -f オプションで build.yml OpenShift テンプレートを指定して、oc new-app コマンドを実行します。

   $ oc new-app -f build.yml

5. -f オプションで amp.yml OpenShift テンプレートを指定し、-p オプションで WILDCARD_DOMAIN パラメーターに OpenShift クラスターのドメインを指定して、oc new-app コマンドを実行します。

   $ oc new-app -f amp.yml -p WILDCARD_DOMAIN=mydomain.com

6. 次の oc patch コマンドを入力し、SYSTEM_PASSWORD を 「Oracle Database の準備」 で設定した Oracle データベースの システム パスワードに置き換えます。

   $ oc patch dc/system-app -p '[{"op": "add", "path": "/spec/strategy/rollingParams/pre/execNewPod/env/-", "value": {"name": "ORACLE_SYSTEM_PASSWORD", "value": "SYSTEM_PASSWORD"}}]' --type=json
   
   $ oc patch dc/system-app -p '{"spec": {"strategy": {"rollingParams": {"post":{"execNewPod": {"env": [{"name": "ORACLE_SYSTEM_PASSWORD", "value": "SYSTEM_PASSWORD"}]}}}}}}'

7. 次のコマンドを入力します。ただし、。DATABASE_URL は、「Oracle Database の準備」 で指定した Oracle データベースに置き換えます。

   $ oc patch secret/system-database -p '{"stringData": {"URL": "DATABASE_URL"}}'

8. 以下のコマンドを実行してプルシークレットをビルダーにリンクします。

   $ oc secrets link builder threescale-registry-auth

9. oc start-build コマンドを入力し、新しいシステムイメージをビルドします。

   $ oc start-build 3scale-amp-system-oracle --from-dir=.

1. 各ノードに Red Hat Enterprise Linux (RHEL) をインストールします。
2. インターフェイス または コマンドライン で Red Hat Subscription Manager (RHSM) を使用し、Red Hat にノードを登録します。
3. RHSM を使用して ノードを 3scale サブスクリプションに割り当てます。

4. 以下の要件に準拠して、ノードに OpenShift をインストールします。

   • サポート対象バージョンの OpenShift を使用する。
   • 複数書き込みをサポートするファイルシステムで 永続ストレージ を設定する。
5. OpenShift コマンドラインインターフェイス をインストールします。

6. Subscription Manager を使用して、rhel-7-server-3scale-amp-2.6-rpms リポジトリーへのアクセスを有効にします。

   sudo subscription-manager repos --enable=rhel-7-server-3scale-amp-2.6-rpms

7. 3scale テンプレート 3scale-amp-template をインストールします。このテンプレートは /opt/amp/templates に保存されます。

   sudo yum install 3scale-amp-template

1. デフォルトでは、developer としてログインしていて、次のステップに進むことができます。

   そうでなければ、前の手順でダウンロードおよびインストールした OpenShift クライアントツールから oc login コマンドを使用して OpenShift にログインします。デフォルトのログインクレデンシャルは username = "developer" と password = "developer" です。

   oc login https://OPENSHIFT-SERVER-IP:8443

   出力に Login successful. が表示されるはずです。

2. プロジェクトを作成します。この例では表示名を gateway と設定します。

   oc new-project "3scalegateway" --display-name="gateway" --description="3scale gateway demo"

   応答は以下のようになります。

   Now using project "3scalegateway" on server "https://172.30.0.112:8443".

   コマンドプロンプトのテキスト出力で提案される次のステップを無視し、以下に示す次のステップに進みます。

3. プロジェクトを参照する新しいシークレットを作成します。<access_token> および <domain> はご自分のクレデンシャルに置き換えます。<access_token> および <domain> の詳細は、以下を参照してください。

   oc create secret generic apicast-configuration-url-secret --from-literal=password=https://<access_token>@<admin_portal_domain>  --type=kubernetes.io/basic-auth

   ここでは、<access_token> は 3scale Account Management API の アクセストークン で (サービストークンではありません)、<domain>-admin.3scale.net は 3scale 管理ポータルの URL になります。

   応答は以下のようになります。

   secret/apicast-configuration-url-secret

4. テンプレートから APIcast ゲートウェイのアプリケーションを作成し、デプロイメントを開始します。

   oc new-app -f https://raw.githubusercontent.com/3scale/3scale-amp-openshift-templates/2.6.0.GA/apicast-gateway/apicast.yml

   出力の最後に以下のメッセージが表示されるはずです。

   --> Creating resources with label app=3scale-gateway ...
       deploymentconfig "apicast" created
       service "apicast" created
   --> Success
       Run 'oc status' to view your app.

1. ブラウザーで OpenShift クラスターの Web コンソール https://OPENSHIFT-SERVER-IP:8443/console/ を開きます。

   OpenShift クラスターをリモートサーバーで起動した場合は、OPENSHIFT-SERVER-IP ではなく、--public-hostname で指定した値を使用します。

   ログイン画面が表示されます。

   
   注記

   信頼できない Web サイトに関する警告が表示される可能性があります。有効な証明書を設定せずに、セキュアなプロトコルで Web コンソールにアクセスしようとしているため、この警告は想定内です。これは実稼働環境で行うべきではありませんが、このテスト設定では続行してこのアドレスの例外を作成することができます。

2. 上記の Red Hat OpenShift の設定 セクションで作成または取得した developer のクレデンシャルを使用してログインします。

   上記のコマンドラインから作成した gateway プロジェクトが含まれる、プロジェクトのリストが表示されます。

   

   gateway プロジェクトが表示されない場合は、別のユーザーで作成した可能性があり、ポリシーロールをこのユーザーに割り当てる必要があります。

3. gateway リンクをクリックすると、Overview タブが表示されます。

   OpenShift は APIcast のコードをダウンロードし、デプロイメントを開始しました。デプロイメントの進行中に Deployment #1 running というメッセージが表示されることがあります。

   ビルドが完了すると、UI が更新され、テンプレートで定義されたとおりに OpenShift によって起動された APIcast の 2 つのインスタンス (2 つの Pod) が表示されます。

   

   各 APIcast インスタンスが起動すると、3scale 管理ポータルの Integration ページの設定を使用して、3scale から必要な設定をダウンロードします。

   OpenShift は 2 つの APIcast インスタンスを維持し、両方のインスタンスの状態を監視します。状態の悪い APIcast インスタンスは自動的に新しいインスタンスに置き換えられます。

4. APIcast インスタンスでトラフィックを受信できるようにするには、ルートを作成する必要があります。Create Route をクリックして操作を開始します。

   

   上記の Public Base URL フィールドで 3scale に設定したホストを、http:// とポートを削除して入力し (例: gateway.openshift.demo)、Create ボタンをクリックします。

   

   定義するすべての 3scale サービスについて、新規ルートを作成する必要があります。

1. sudo yum repolist all ですべてのリポジトリーを一覧表示します。
2. *-extras リポジトリーを探します。
3. sudo yum-config-manager --enable rhui-REGION-rhel-server-extras を実行し、extras リポジトリーを有効にします。
4. sudo yum install docker を実行し、Docker コンテナー環境のパッケージをインストールします。

1. Docker デーモンを開始します。

   sudo systemctl start docker.service

2. Docker デーモンが実行されているか確認します。

   sudo systemctl status docker.service

   Red Hat レジストリーから、使用する準備ができている Docker 形式のコンテナーイメージをダウンロードします。

   sudo docker pull registry.access.redhat.com/3scale-amp26/apicast-gateway.

3. Docker 形式のコンテナーで APIcast を実行します。

   sudo docker run --name apicast --rm -p 8080:8080 -e THREESCALE_PORTAL_ENDPOINT=https://<access_token>@<domain>-admin.3scale.net registry.access.redhat.com/3scale-amp26/apicast-gateway.

   ここで、<access_token> は 3scale Account Management API のアクセストークンに置き換えます。アクセストークンの代わりにプロバイダーキーを使用することもできます。<domain>-admin.3scale.net は 3scale 管理ポータルの URL です。

手順

1. OpenShift Container Platform コンソールにおいて、管理者権限を持つアカウントを使用してログインします。
2. Catalog > OperatorHub の順にクリックします。
3. Filter by keyword ボックスに 3scale operator と入力し、3scale operator を検索します。
4. 3scale operator をクリックします。operator に関する情報が表示されます。
5. operator に関する情報を確認し、Install をクリックします。Create Operator Subscription のページが表示されます。

6. Create Operator Subscription ページで、すべてのデフォルト設定を受け入れ Subscribe をクリックします。

   注記

   operator は、選択したクラスター上の特定の単一 namespace でしか使用することができません。

   3scale-operator の詳細ページが表示されるので、Subscription Overview を確認します。

7. サブスクリプションの upgrade status が Up to date と表示されたら Catalog > Installed Operators の順にクリックし、3scale operator の ClusterServiceVersion (CSV) が表示されたら、その Status が operator-test プロジェクトで最終的に InstallSucceeded となるのを確認します。

   1. インストールに成功すると、APIManager CRD および operator の Capabilities 機能に関連する CDR が OpenShift API サーバー に登録されます。

8. インストールが正常に完了したら、oc get を使用して CRD によって定義されたリソースタイプのクエリーを行います。

   1. たとえば、APIManager CRD が適切に登録されたことを確認するには、以下のコマンドを実行します。

      oc get apimanagers

9. 以下の出力が表示されるはずです。

   No resources found.

   トラブルシューティングに関する情報は、OpenShift Container Platform のドキュメント を参照してください。

手順

1. オンプレミス型 3scale インスタンスをホストする OpenShift ノードにログインし、そのプロジェクトに切り替えます。

   oc login -u <user> <url>
   oc project <3scale-project>

   <user>、<url>、および <3scale-project> を、実際のクレデンシャルとプロジェクト名に置き換えます。

2. 以下に示す順序で手順実施し、すべての Pod をスケールダウンします。これにより、データの喪失が回避されます。

   オンプレミス型 3scale の停止

   OpenShift Web コンソールまたはコマンドラインインターフェイス (CLI) から、すべてのデプロイメント設定を以下の順序でゼロレプリカにスケールダウンします。

   • 3scale 2.6 より前のバージョンの場合は apicast-wildcard-router と zync、3scale 2.6 以降の場合は zync-que と zync
   • apicast-staging と apicast-production

   • system-sidekiq、backend-cron、および system-sphinx

     • 3scale 2.3 の場合には system-resque を対象に含めます。
   • system-app
   • backend-listener と backend-worker

   • backend-redis、system-memcache、system-mysql、system-redis、および zync-database

     以下の例は、apicast-wildcard-router と zync について、CLI でこの操作を実施する方法を示しています。

     oc scale dc/apicast-wildcard-router --replicas=0
     oc scale dc/zync --replicas=0

     注記

     各ステップのデプロイメント設定は同時にスケールダウンできます。たとえば、apicast-wildcard-router と zync を一緒にスケールダウンできます。ただし、各ステップの Pod が終了するのを待ってから、次の Pod をスケールダウンすることをお勧めします。3scale インスタンスは、完全に再起動されるまで一切アクセスできなくなります。

3. 3scale プロジェクトで実行中の Pod がないことを確認するには、以下のコマンドを使用します。

   oc get pod

   このコマンドは、No resources found を返すはずです。

4. 以下のコマンドを使用して、データベースレベルの Pod を再度スケールアップします。

   oc scale dc/{backend-redis,system-memcache,system-mysql,system-redis,zync-database} --replicas=1

5. 次のステップに進む前に、system-mysql Pod を通じて外部 MySQL データベースにログインできることを確認してください。

   oc rsh system-mysql-<system_mysql_pod_id>
   mysql -u root -p -h <host>

   • <system_mysql_pod_id>: system-mysql Pod の識別子

   • ユーザーには必ず root を使用する。詳細は、「外部 MySQL データベースに関する制約」 を参照してください。

     1. CLI に mysql> が表示されるようになります。exit と入力してから enter キーを押します。次のプロンプトで再度 exit と入力して、OpenShift ノードのコンソールに戻ります。

6. 以下のコマンドを使用して、MySQL のフルダンプを実行します。

   oc rsh system-mysql-<system_mysql_pod_id> /bin/bash -c "mysqldump -u root --single-transaction --routines --triggers --all-databases" > system-mysql-dump.sql

   • <system_mysql_pod_id> を一意の system-mysql Pod ID に置き換えます。

   • 次の例のように、ファイル system-mysql-dump.sql に有効な MySQL レベルのダンプが含まれていることを確認します。

     $ head -n 10 system-mysql-dump.sql
     -- MySQL dump 10.13  Distrib 5.7.24, for Linux (x86_64)
     --
     -- Host: localhost    Database:
     -- ------------------------------------------------------
     -- Server version   5.7.24
     
     /*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
     /*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
     /*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
     /*!40101 SET NAMES utf8 */;

7. system-mysql Pod をスケールダウンし、レプリカが 0 (ゼロ) のままにします。

   oc scale dc/system-mysql --replicas=0

8. <password> と <host> を適宜置き換え、URL mysql2://root:<password>@<host>/system の base64 変換値を取得します。

   echo "mysql2://root:<password>@<host>/system" | base64

9. リモート MySQL データベースのデフォルトの 'user'@'%' を作成します。これには SELECT 権限しか付与する必要はありません。また、その base64 変換値を取得します。

   echo "user" | base64
   echo "<password>" | base64

   • <password> を 'user'@'%' のパスワードに置き換えます。

10. バックアップを実行し、OpenShift シークレット system-database を編集します。

    oc get secret system-database -o yaml > system-database-orig.bkp.yml
    oc edit secret system-database

    • URL: これを [step-8] で取得した値に置き換えます。
    • DB_USER および DB_PASSWORD: 共に前のステップの値を使用します。

11. 以下のコマンドを使用して system-mysql-dump.sql をリモートデータベースサーバーに送信し、ダンプをサーバーにインポートします。

    mysql -u root -p < system-mysql-dump.sql

12. system という新しいデータベースが作成されたことを確認します。

    mysql -u root -p -se "SHOW DATABASES"

13. 以下の手順を使用して、オンプレミス型 3scale を起動します。これにより、すべての Pod が正しい順序でスケールアップされます。

    オンプレミス型 3scale の起動

    • backend-redis、system-memcache、system-mysql、system-redis、および zync-database
    • backend-listener と backend-worker
    • system-app

    • system-sidekiq、backend-cron、および system-sphinx

      • 3scale 2.3 の場合には system-resque を対象に含めます。
    • apicast-staging と apicast-production

    • 3scale 2.6 より前のバージョンの場合は apicast-wildcard-router と zync、3scale 2.6 以降の場合は zync-que と zync

      以下の例は、backend-redis、system-memcache、system-mysql、system-redis、および zync-database について、CLI でこの操作を実行する方法を示しています。

      oc scale dc/backend-redis --replicas=1
      oc scale dc/system-memcache --replicas=1
      oc scale dc/system-mysql --replicas=1
      oc scale dc/system-redis --replicas=1
      oc scale dc/zync-database --replicas=1

      system-app Pod が問題なく起動し、実行されるはずです。

14. 確認後、上記の順序 で他の Pod をスケールアップして元の状態に戻します。
15. system-mysql DeploymentConfig オブジェクトのバックアップを作成します。数日後、すべて正常に動作していることが確認できたら、削除してかまいません。system-mysql DeploymentConfig を削除することで、この手順を今後再び実行する場合の混乱を防ぐことができます。

1. system-database-orig.bkp.yml の元の値を使用して、シークレット system-database を編集します。[step-10] を参照してください。

   oc edit secret system-database

   URL、DB_USER、および DB_PASSWORD を元の値に置き換えます。

2. system-mysql を含め、すべての Pod をスケールダウンしてから、再度スケールアップして元の状態に戻します。system-app Pod およびその後に起動されるその他の Pod が、再び起動して実行されるはずです。以下のコマンドを実行して、すべての Pod が元どおりに起動、実行されていることを確認します。

   oc get pods -n <3scale-project>