手順

1. 以下のように、管理者として OpenShift サーバーにログインします。

   oc login -u system:admin

2. イメージストリームをインストールする OpenShift プロジェクトにログインします。Red Hat では、3scale OpenShift イメージストリーム用に openshift プロジェクトを使用することを推奨します。

   注記: プロジェクトには、ランダムな文字列からなる固有の接頭辞が付きます。

   oc project your-openshift-project

3. レジストリーサービスアカウントの作成 で作成するクレデンシャルを使用して、docker-registry シークレットを作成します。

   注記

   • your-registry-service-account-username を 12345678|username のフォーマットで作成したユーザー名に置き換えてください。
   • your-registry-service-account-password を Token Information タブでユーザー名の下に表示されるパスワードの文字列に置き換えてください。
   • イメージストリームが存在し registry.redhat.io を使用するすべての新規 namespace について、docker-registry シークレットを作成します。

   oc create secret docker-registry threescale-registry-auth \
     --docker-server=registry.redhat.io \
     --docker-username="your-registry-service-account-username" \
     --docker-password="your-registry-service-account-password"

手順

1. Registry Service Accounts のページに移動し、ログインします。
2. New Service Account をクリックします。

3. Create a New Registry Service Account のページに表示されるフォームに入力します。

   1. サービスアカウント の名前を追加します。

      注記: フォームのフィールドの前に、決められた桁数のランダムに生成された数字の文字列が表示されます。

4. Description を入力します。
5. Create をクリックします。
6. Registry Service Accounts のページに戻ります。
7. 作成した サービスアカウント をクリックします。

8. 接頭辞の文字列を含めたユーザー名 (例: 12345678|username) およびパスワードを書き留めます。

   1. このユーザー名およびパスワードは、registry.redhat.io へのログインに使用されます。

手順

1. ターミナルセッションから、OpenShift にクラスター管理者としてログインします。

   oc login

2. プロジェクトを選択するか新しいプロジェクトを作成します。

   oc project <project_name>

   oc new-project <project_name>

3. oc new-app コマンドを入力します。

   1. --file オプションを使用して、ノードおよびエンタイトルメントの設定 でダウンロードした amp.yml ファイルへのパスを指定します。

   2. --param オプションを使用して、WILDCARD_DOMAIN パラメーターに OpenShift クラスターのドメインを設定します。

      oc new-app --file /opt/amp/templates/amp.yml --param WILDCARD_DOMAIN=<WILDCARD_DOMAIN>

      ターミナルには、マスターおよびテナント URL と、新たに作成された 3scale 管理ポータルのクレデンシャルが表示されます。この出力には以下の情報が含まれます。

      • マスター管理者のユーザー名
      • マスターのパスワード
      • マスターのトークン情報
      • テナントのユーザー名
      • テナントのパスワード
      • テナントのトークン情報

4. https://user-admin.3scale-project.example.com に admin/xXxXyz123 としてログインします。

   * With parameters:
   
    * ADMIN_PASSWORD=xXxXyz123 # generated
    * ADMIN_USERNAME=admin
    * TENANT_NAME=user
   
    * MASTER_NAME=master
    * MASTER_USER=master
    * MASTER_PASSWORD=xXxXyz123 # generated
   
   --> Success
   Access your application via route 'user-admin.3scale-project.example.com'
   Access your application via route 'master-admin.3scale-project.example.com'
   Access your application via route 'backend-user.3scale-project.example.com'
   Access your application via route 'user.3scale-project.example.com'
   Access your application via route 'api-user-apicast-staging.3scale-project.example.com'
   Access your application via route 'api-user-apicast-production.3scale-project.example.com'

5. 後で確認できるようにするため、詳細を書き留めておきます。

   注記

   3scale が OpenShift に完全にデプロイされ、ログインとクレデンシャルが有効になるまで待ちます。

手順

1. OpenShift にログインしていない場合はログインします。

   oc login

   1. SMTP ConfigMap の変数を設定します。oc patch コマンドを使用して configmap および smtp オブジェクトを指定し、続いて -p オプションを指定し、以下の変数に対して JSON 形式で新しい値を指定します。

      変数	説明
      address	リモートメールサーバーをリレーとして指定できます。
      username	メールサーバーのユーザー名を指定します。
      password	メールサーバーのパスワードを指定します。
      domain	HELO ドメインを指定します。
      port	メールサーバーが新しい接続をリッスンするポートを指定します。
      authentication	メールサーバーの認証タイプを指定します。指定できる値は plain (パスワードをクリアテキストで送信)、login (パスワードを Base64 エンコードで送信)、または cram_md5 (ハッシュ関数に Message Digest 5 アルゴリズムを使用し認証情報を交換) です。
      openssl.verify.mode	TLS の使用時に OpenSSL が証明書をチェックする方法を指定します。指定できる値は none、peer、client_once、または fail_if_no_peer_cert です。

      例

      oc patch configmap smtp -p '{"data":{"address":"<your_address>"}}'
      oc patch configmap smtp -p '{"data":{"username":"<your_username>"}}'
      oc patch configmap smtp -p '{"data":{"password":"<your_password>"}}'

2. configmap 変数を設定した後、system-app および system-sidekiq Pod を再デプロイします。

   oc rollout latest dc/system-app
   oc rollout latest dc/system-sidekiq

3. ロールアウトのステータスを表示し、読み込みが完了したことを確認します。

   oc rollout status dc/system-app
   oc rollout status dc/system-sidekiq

手順

1. 以下の設定で アクセストークン を作成します。

   • スコープ: Account Management API
   • アクセス権限: 読み取り専用

2. APIcast クラスターにログインします。

   oc login

3. APIcast が 3scale と通信できるようにするシークレットを作成します。new-basicauth および apicast-configuration-url-secret を指定し、--password パラメーターで 3scale デプロイメントのアクセストークン、テナント名、およびワイルドカードドメインを設定します。

   oc secret new-basicauth apicast-configuration-url-secret --password=https://<APICAST_ACCESS_TOKEN>@<TENANT_NAME>-admin.<WILDCARD_DOMAIN>

   注記

   TENANT_NAME は、管理ポータルにアクセスすることのできるルート下の名前です。TENANT_NAME のデフォルト値は 3scale です。3scale デプロイメントでカスタム値を使用した場合は、ここでもその値を使用する必要があります。

4. --file オプションで apicast.yml ファイルを指定して、oc new-app コマンドを使用して APIcast テンプレートをインポートします。

   oc new-app --file /opt/amp/templates/apicast.yml

手順

1. 以下の設定で アクセストークン を作成します。

   • スコープ: Account Management API
   • アクセス権限: 読み取り専用

2. APIcast クラスターにログインします。

   oc login

3. APIcast が 3scale と通信できるようにするシークレットを作成します。new-basicauth および apicast-configuration-url-secret を指定し、--password パラメーターで 3scale デプロイメントのアクセストークン、テナント名、およびワイルドカードドメインを設定します。

   oc secret new-basicauth apicast-configuration-url-secret --password=https://<APICAST_ACCESS_TOKEN>@<TENANT_NAME>-admin.<WILDCARD_DOMAIN>

   注記

   TENANT_NAME は、管理ポータルにアクセスすることのできるルート下の名前です。TENANT_NAME のデフォルト値は 3scale です。3scale デプロイメントでカスタム値を使用した場合は、その値を使用する必要があります。

4. oc new-app コマンドで、別の OpenShift クラスターに APIcast をデプロイします。--file オプションで apicast.yml ファイルへのパスを指定します。

   oc new-app --file /path/to/file/apicast.yml

手順

1. OpenShift クラスターにログインしていない場合はログインします。

   oc login

2. 以下のコマンドを入力し、backend-listener ルートの URL を表示します。

   oc get route backend

3. apicast.yml へのパスを指定して oc new-app コマンドを入力します。

   oc new-app -f apicast.yml

手順

1. OpenShift クラスターにログインしていない場合はログインします。

   oc login

2. 管理者として、oadm コマンドに pod-network および join-projects オプションを指定し、両方のプロジェクト間の通信を設定します。

   oadm pod-network join-projects --to=<3SCALE_PROJECT> <APICAST_PROJECT>

3. 以下のコマンドを入力し、backend-listener ルートの URL を表示します。

   oc get route backend

4. apicast.yml へのパスを指定して oc new-app コマンドを入力します。

   oc new-app -f apicast.yml

手順

1. メニュー構造は、使用している OpenShift のバージョンによって異なります。

   • OCP 4.1 の場合は、Catalog > Installed Operators の順にクリックします。

   • OCP 4.2 の場合は、Operators > Installed Operators の順にクリックします。

     • Installed Operators のリストで、3scale Operator をクリックします。
2. API Manager タブをクリックします。
3. Create APIManager をクリックします。

4. サンプルのコンテンツを消去して以下の YAML 定義をエディターに追加し、続いて Create をクリックします。

   注記

   wildcardDomain パラメーターには、有効な DNS ドメインである、IP アドレスに対して解決する任意の名前を指定できます。パラメーターのプレースホルダーを表す記号 < > を必ず削除するようにしてください。

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIManager
   metadata:
     name: example-apimanager
   spec:
     wildcardDomain: <wildcardDomain>

1. 次のコマンドを実行して、管理ポータルの認証情報を取得します。

   oc get secret system-seed -o json | jq -r .data.ADMIN_USER | base64 -d
   oc get secret system-seed -o json | jq -r .data.ADMIN_PASSWORD | base64 -d

   1. Admin Portal 管理者としてログインして、これらの認証情報が機能していることを確認します。

2. 次のコマンドを実行して、マスター管理ポータルの認証情報を取得します。

   oc get secret system-seed -o json | jq -r .data.MASTER_USER | base64 -d
   oc get secret system-seed -o json | jq -r .data.MASTER_PASSWORD | base64 -d

   1. マスター管理ポータル管理者としてログインして、これらの認証情報が機能していることを確認します。

手順

1. oc get pvc コマンドを使用してエラーのある MySQL データが含まれる PVC を探します。

   # oc get pvc
   NAME                    STATUS    VOLUME    CAPACITY   ACCESSMODES   AGE
   backend-redis-storage   Bound     vol003    100Gi      RWO,RWX       4d
   mysql-storage           Bound     vol006    100Gi      RWO,RWX       4d
   system-redis-storage    Bound     vol008    100Gi      RWO,RWX       4d
   system-storage          Bound     vol004    100Gi      RWO,RWX       4d

2. OpenShift UI の cancel deployment をクリックして、system-mysql Pod のデプロイメントを停止します。
3. MySQL パス以下にあるものすべてを削除し、ボリュームをクリーンアップします。
4. 新たに system-mysql のデプロイメントを開始します。

手順

1. 次のコマンドを入力して、コンテナーレジストリー認証の設定を確認します。

   $ oc get secret

   • シークレットが存在する場合は、ターミナルに次の出力が表示されます。

     threescale-registry-auth          kubernetes.io/dockerconfigjson        1         4m9s

   • ただし、出力が表示されない場合は、次の操作を行う必要があります。
2. レジストリーサービスアカウントの作成 中に以前に設定した認証情報を使用して、シークレットを作成します。
3. 提供されている oc create secret コマンドの <your-registry-service-account-username> および <your-registry-service-account-password> を置き換えて、OpenShift でのレジストリー認証の設定 の手順を使用します。

4. APIManager リソースと同じ名前空間で threescale-registry-auth シークレットを生成します。<project-name> 内で次を実行する必要があります。

   oc project <project-name>
   oc create secret docker-registry threescale-registry-auth \
     --docker-server=registry.redhat.io \
     --docker-username="<your-registry-service-account-username>" \
     --docker-password="<your-registry-service-account-password>"
     --docker-email="<email-address>"

5. APIManager リソースを削除して再作成します。

   $ oc delete -f apimanager.yaml
   apimanager.apps.3scale.net "example-apimanager" deleted
   
   $ oc create -f apimanager.yaml
   apimanager.apps.3scale.net/example-apimanager created

検証

1. 次のコマンドを入力して、デプロイのステータスが Starting または Ready であることを確認します。その後、Pod が以下を生成し始めます。

   $ oc describe apimanager
   (...)
   Status:
     Deployments:
       Ready:
         apicast-staging
         system-memcache
         system-mysql
         system-redis
         zync
         zync-database
         zync-que
       Starting:
         apicast-production
         backend-cron
         backend-worker
         system-sidekiq
         system-sphinx
       Stopped:
         backend-listener
         backend-redis
         system-app

2. 以下のコマンドを実行して、各 Pod のステータスを確認します。

   $ oc get pods
   NAME                               READY   STATUS             RESTARTS   AGE
   3scale-operator-66cc6d857b-sxhgm   1/1     Running            0          17h
   apicast-production-1-deploy        1/1     Running            0          17m
   apicast-production-1-pxkqm         0/1     Pending            0          17m
   apicast-staging-1-dbwcw            1/1     Running            0          17m
   apicast-staging-1-deploy           0/1     Completed          0          17m
   backend-cron-1-deploy              1/1     Running            0          17m

手順

1. 永続ボリュームに使用されるディレクトリーには、root グループの書き込み権限が必要です。MySQL サービスは root グループの別のユーザーとして実行されるため、root ユーザーの読み取り/書き込み権限では不十分です。root ユーザーとして以下のコマンドを実行します。

   chmod -R g+w /path/for/pvs

2. 以下のコマンドを実行して、SELinux がアクセスをブロックしないようにします。

   chcon -Rt svirt_sandbox_file_t /path/for/pvs

手順

1. Hosted ステージング環境のテストコールを設定します。
2. API に存在するパスを API test GET request フィールドに入力します (例: /v1/word/good.json)。

3. ページ右下の Update Product ボタンをクリックして、設定を保存します。

   1. これにより、APIcast の設定が 3scale Hosted ステージング環境にデプロイされます。すべてが正しく設定されていれば、左側の縦線が緑色に変わります。

      注記

      Self-managed デプロイメントオプションの 1 つを使用してる場合 は、GUI から設定を保存し、Staging Public Base URL フィールドまたは Production Public Base URL フィールドに正しいホストを追加して、デプロイされた API ゲートウェイをポイントするようにします。実稼働ゲートウェイに呼び出しを行う前に、必ず Promote v.x to Production APIcast ボタンを押してください。

4. ステージングセクションの最後にある curl コマンドの例を確認し、コンソールからコマンドを実行します。

   curl "https://XXX.staging.apicast.io:443/v1/word/good.json?user_key=YOUR_USER_KEY"

   注記

   上記と同じレスポンスを取得するはずですが、今回はリクエストが 3scale Hosted APIcast インスタンスを通ります。注記: サービスに対して有効なクレデンシャルを持つアプリケーションが存在することを確認してください。3scale の登録時に作成されたデフォルトの API サービスを使用している場合はアプリケーションがすでにあるはずです。テストの curl に USER_KEY または APP_ID と APP_KEY の値が出力された場合は、最初にこのサービスのアプリケーションを作成する必要があります。

   これで API が 3scale と統合されました。

手順

1. すべてのリポジトリーを一覧表示します。

   sudo yum repolist all

2. *-extras リポジトリーを探し、有効にします。

   sudo yum-config-manager --enable rhui-REGION-rhel-server-extras

3. Docker 形式のコンテナーイメージをインストールします。

   sudo yum install docker docker-registry

4. /etc/sysconfig/docker ファイルに以下の行を追加するか、アンコメントして、172.30.0.0/16 のセキュアでないレジストリーを追加します。

   INSECURE_REGISTRY='--insecure-registry 172.30.0.0/16'

5. Docker サービスを開始します。

   sudo systemctl start docker

6. 以下のコマンドを使用して、コンテナーサービスが動作中であることを確認します。

   sudo systemctl status docker

手順

1. OpenShift リリースページ から、クライアントツールの最新の安定版リリース (openshift-origin-client-tools-VERSION-linux-64bit.tar.gz) をダウンロードし、アーカイブから抽出した Linux oc バイナリーを PATH に置きます。

   注記

   docker コマンドは root ユーザーとして実行されるため、oc または docker コマンドはすべて root 権限で実行する必要があります。

2. docker コマンドを実行する権限のあるユーザーでターミナルを開き、以下のコマンドを実行します。

   oc cluster up

   出力の最後に、デプロイされたクラスターの情報が表示されます。

       -- Server Information ...
         OpenShift server started.
         The server is accessible via web console at:
         https://172.30.0.112:8443
   
         You are logged in as:
           User:     developer
           Password: developer
   
         To login as administrator:
           oc login -u system:admin

3. OpenShift サーバーに割り当てられた IP アドレスを書き留めておきます。本チュートリアルでは OPENSHIFT-SERVER-IP をその IP アドレスに置き換えてください。

1. 以下のフィールドを指定して、backend-redis および system-redis シークレットを作成します。

   backend-redis

   REDIS_QUEUES_SENTINEL_HOSTS
   REDIS_QUEUES_SENTINEL_ROLE
   REDIS_QUEUES_URL
   REDIS_STORAGE_SENTINEL_HOSTS
   REDIS_STORAGE_SENTINEL_ROLE
   REDIS_STORAGE_URL

   system-redis

   MESSAGE_BUS_NAMESPACE
   MESSAGE_BUS_SENTINEL_HOSTS
   MESSAGE_BUS_SENTINEL_ROLE
   MESSAGE_BUS_URL
   NAMESPACE
   SENTINEL_HOSTS
   SENTINEL_ROLE
   URL

   • Redis と Sentinel を設定する場合、backend-redis および system-redis の該当する URL フィールドには、redis://[:redis-password@]redis-group[/db] のフォーマットで Redis グループを指定します。ここで、[x] はオプションの要素 x を意味し、redis-password、redis-group、および db 変数は適切な値に置き換えてください。

     例

     redis://:redispwd@mymaster/5

   • SENTINEL_HOSTS フィールドは、以下のフォーマットの Sentinel 接続文字列のコンマ区切りリストです。

     [redis://][:sentinel-password@]sentinel-hostname-or-ip[:port]

     • リスト内の各要素に関して、[x] はオプションの要素 x を意味し、sentinel-password、sentinel-hostname-or-ip、および port 変数は適切な値に置き換えてください。

       例

       :sentinelpwd@123.45.67.009:2711,:sentinelpwd@other-sentinel:2722

   • SENTINEL_ROLE フィールドの値は、master または slave のどちらかです。

2. 最新バージョンのテンプレートを使用して、テンプレートを使用した OpenShift への 3scale のデプロイ に記載の手順に従って 3scale をデプロイします。

   • backend-redis および system-redis がすでに存在するために表示されるエラーは無視します。

1. HA 用 3scale の新規インストールのデプロイ に記載のとおり、すべてのフィールドを指定して backend-redis および system-redis シークレットを編集します。

2. 以下の backend-redis 環境変数がバックエンド Pod に対して定義されていることを確認してください。

   name: BACKEND_REDIS_SENTINEL_HOSTS
     valueFrom:
       secretKeyRef:
         key: REDIS_STORAGE_SENTINEL_HOSTS
         name: backend-redis
   name: BACKEND_REDIS_SENTINEL_ROLE
     valueFrom:
       secretKeyRef:
         key: REDIS_STORAGE_SENTINEL_ROLE
         name: backend-redis

3. 以下の system-redis の環境変数が system-(app|sidekiq|sphinx) Pod に対して定義されていることを確認してください。

   name: REDIS_SENTINEL_HOSTS
     valueFrom:
       secretKeyRef:
         key: SENTINEL_HOSTS
         name: system-redis
   name: REDIS_SENTINEL_ROLE
     valueFrom:
       secretKeyRef:
         key: SENTINEL_ROLE
         name: system-redis
   name: MESSAGE_BUS_REDIS_SENTINEL_HOSTS
     valueFrom:
       secretKeyRef:
         key: MESSAGE_BUS_SENTINEL_HOSTS
         name: system-redis
   name: MESSAGE_BUS_REDIS_SENTINEL_ROLE
     valueFrom:
       secretKeyRef:
         key: MESSAGE_BUS_SENTINEL_ROLE
         name: system-redis

4. 指示に従って、テンプレートを使用した 3scale 2.6 から 2.7 へのアップグレード を続行します。

   1. 以下の順序で手順を実行します。

      • 3scale プロジェクトのバックアップを作成する
      • システムからの pre-hook pod を更新する
      • 3scale イメージをアップグレードする