3scale のインストール

1. 以下の最低限のパーミッションで Identity and Access Management (IAM) ポリシーを作成します。

   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Effect": "Allow",
               "Action": "s3:ListAllMyBuckets",
               "Resource": "arn:aws:s3:::*"
           },
           {
               "Effect": "Allow",
               "Action": "s3:*",
               "Resource": [
                   "arn:aws:s3:::targetBucketName",
                   "arn:aws:s3:::targetBucketName/*"
               ]
           }
       ]
   }

2. 以下のルールで CORS 設定を作成します。

   <?xml version="1.0" encoding="UTF-8"?>
   <CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
   <CORSRule>
       <AllowedOrigin>https://*</AllowedOrigin>
       <AllowedMethod>GET</AllowedMethod>
   </CORSRule>
   </CORSConfiguration>

手順

1. Registry Service Accounts のページに移動し、ログインします。

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

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

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

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

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

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

      注記

      Token Information のページには、認証トークンの使用方法を説明したタブがあります。たとえば、Token Information タブには、12345678|username フォーマットのユーザー名およびその下にパスワードの文字列が表示されます。

手順

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. 後で確認できるようにするため、詳細を書き留めておきます。

6. 以下のコマンドが返されると、OpenShift での 3scale デプロイメントが成功しています。

   oc wait --for=condition=available --timeout=-1s $(oc get dc --output=name)

   注記

   OpenShift への 3scale のデプロイメントに成功すると、ログインクレデンシャルが機能します。

手順

1. amp-s3.yml ダウンロードします。

2. ターミナルセッションから OpenShift にログインします。

   oc login

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

   oc project <project_name>

   または

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

   • --file オプションを使用して、amp-s3.yml ファイルへのパスを指定します。

   • --param オプションを以下の値を指定します。

     • WILDCARD_DOMAIN: パラメーターは OpenShift クラスターのドメインに設定されます。
     • AWS_BUCKET: ターゲットバケット名に置き換えます。
     • AWS_ACCESS_KEY_ID: AWS 認証情報 ID に置き換えます。
     • AWS_SECRET_ACCESS_KEY: AWS 認証情報 KEY に置き換えます。
     • AWS_REGION: with the AWS: リージョンに置き換えます。
     • AWS_HOSTNAME: Amazon エンドポイント: AWS S3 と互換性のあるプロバイダーエンドポイントのホスト名。
     • AWS_PROTOCOL: デフォルト: HTTPS - AWS S3 と互換性のあるプロバイダーエンドポイントプロトコル。
     • AWS_PATH_STYLE: デフォルト: false - true に設定すると、バケット名は常にリクエスト URI に残り、サブドメインとしてホストに移動されません。

   • 管理ポータルでカスタム名を設定するには --param オプションを指定して TENANT_NAME パラメーターを指定します。省略した場合、デフォルトは 3scale に設定されます。

     oc new-app --file /path/to/amp-s3.yml \
     	--param WILDCARD_DOMAIN=<a-domain-that-resolves-to-your-ocp-cluster.com> \
     	--param TENANT_NAME=3scale \
     	--param AWS_ACCESS_KEY_ID=<your-aws-access-key-id> \
     	--param AWS_SECRET_ACCESS_KEY=<your-aws-access-key-secret> \
     	--param AWS_BUCKET=<your-target-bucket-name> \
     	--param AWS_REGION=<your-aws-bucket-region> \
     	--param FILE_UPLOAD_STORAGE=s3

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

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

2. 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'
   Access your application via route 'apicast-wildcard.3scale-project.example.com'
   
   ...

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

4. 以下のコマンドが返されると、OpenShift での 3scale デプロイメントが成功しています。

   oc wait --for=condition=available --timeout=-1s $(oc get dc --output=name)

   注記

   OpenShift への 3scale のデプロイメントに成功すると、ログインクレデンシャルが機能します。

手順

1. amp-postgresql.yml をダウンロードします。

2. ターミナルセッションから OpenShift にログインします。

   oc login

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

   oc project <project_name>

   または

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

   • --file オプションを使用して、amp-postgresql.yml ファイルへのパスを指定します。
   • --param オプションを以下の値を指定します。
   • WILDCARD_DOMAIN: パラメーターは OpenShift クラスターのドメインに設定されます。

   • 管理ポータルでカスタム名を設定するには --param オプションを指定して TENANT_NAME パラメーターを指定します。省略した場合、デフォルトは 3scale に設定されます。

     oc new-app --file /path/to/amp-postgresql.yml \
     	--param WILDCARD_DOMAIN=<a-domain-that-resolves-to-your-ocp-cluster.com> \
     	--param TENANT_NAME=3scale \

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

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

2. 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'
   Access your application via route 'apicast-wildcard.3scale-project.example.com'
   
   ...

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

4. 以下のコマンドが返されると、OpenShift での 3scale デプロイメントが成功しています。

   oc wait --for=condition=available --timeout=-1s $(oc get dc --output=name)

   注記

   OpenShift への 3scale のデプロイメントに成功すると、ログインとクレデンシャルが機能します。

手順

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

   oc login

   1. oc patch コマンドを使用して secret タイプを指定し (system-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 です。

      例

      oc patch secret system-smtp -p '{"stringData":{"address":"<your_address>"}}'
      oc patch secret system-smtp -p '{"stringData":{"username":"<your_username>"}}'
      oc patch secret system-smtp -p '{"stringData":{"password":"<your_password>"}}'

2. secret 変数を設定した後、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. Operators > Installed Operators の順にクリックします。

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

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

   • 3scale 2.8 より前のバージョンでは、highAvailability フィールドを true に設定してレプリカの自動追加を設定できるようになりました。3scale 2.8 以降、レプリカの追加は以下の例のように APIManager CR の replicas フィールドによって制御されます。

     注記

     wildcardDomain パラメーターには、有効な DNS ドメインである、IP アドレスに対して解決する任意の名前を指定できます。

   • 最小要件のある APIManager CR:

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

   • レプリカが設定された APIManager CR:

     apiVersion: apps.3scale.net/v1alpha1
     kind: APIManager
     metadata:
       name: apimanager-sample
     spec:
       system:
         appSpec:
           replicas: 1
         sidekiqSpec:
           replicas: 1
       zync:
         appSpec:
           replicas: 1
         queSpec:
           replicas: 1
       backend:
         cronSpec:
           replicas: 1
         listenerSpec:
           replicas: 1
         workerSpec:
           replicas: 1
       apicast:
         productionSpec:
           replicas: 1
         stagingSpec:
           replicas: 1
       wildcardDomain: example.com

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. Operators > Installed Operators の順にクリックします。
2. Installed Operators の一覧から 3scale API Management をクリックします。
3. Subscription タブをクリックします。Subscription Details の見出しの下に、小見出しの Approval が表示されます。
4. Approval の下のリンクをクリックします。リンクはデフォルトで Automatic に設定されます。小見出しのモーダル (Change Update Approval Strategy) が表示されます。
5. 選択するオプション Automatic (デフォルト) または Manual を選択し、Save をクリックします。

手順

1. 注入するカスタム環境を定義する Lua コードを記述します。たとえば、次の env1.lua ファイルは、3scale Operator がすべてのサービスに対してロードするカスタムログポリシーを示しています。

   local cjson = require('cjson')
   local PolicyChain = require('apicast.policy_chain')
   local policy_chain = context.policy_chain
   
   local logging_policy_config = cjson.decode([[
   {
     "enable_access_logs": false,
     "custom_logging": "\"{{request}}\" to service {{service.id}} and {{service.name}}"
   }
   ]])
   
   policy_chain:insert( PolicyChain.load_policy('logging', 'builtin', logging_policy_config), 1)
   
   return {
     policy_chain = policy_chain,
     port = { metrics = 9421 },
   }

2. カスタム環境を定義する Lua ファイルからシークレットを作成します。以下に例を示します。

   oc create secret generic custom-env-1 --from-file=./env1.lua

   シークレットには複数のカスタム環境を含めることができます。カスタム環境を定義する各ファイルの '-from-file オプションを指定します。Operator は各カスタム環境をロードします。

3. 作成したシークレットを参照する APIManager カスタムリソースを定義します。以下の例は、カスタム環境を定義するシークレットの参照に関連するコンテンツのみを示しています。

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIManager
   metadata:
     name: apimanager-apicast-custom-environment
   spec:
     wildcardDomain: <desired-domain>
     apicast:
       productionSpec:
         customEnvironments:
           - secretRef:
               name: custom-env-1
       stagingSpec:
         customEnvironments:
           - secretRef:
               name: custom-env-1

   APIManager カスタムリソースは、カスタム環境を定義する複数のシークレットを参照できます。Operator は各カスタム環境をロードします。

4. カスタム環境を追加する APIManager カスタムリソースを作成します。以下に例を示します。

   oc apply -f apimanager.yaml

手順

1. 1 つのカスタムポリシーを定義するファイルからシークレットを作成します。以下に例を示します。

   oc create secret generic my-first-custom-policy-secret \
    --from-file=./apicast-policy.json \
    --from-file=./init.lua \
    --from-file=./my-first-custom-policy.lua

   複数のカスタムポリシーがある場合は、カスタムポリシーごとにシークレットを作成します。シークレットには、カスタムポリシーを 1 つだけ含めることができます。

2. カスタムポリシーを含む各シークレットを参照する APIManager カスタムリソースを定義します。APIcast ステージングと APIcast 実稼働環境に同じシークレットを指定できます。次の例は、カスタムポリシーを含む参照シークレットに関連するコンテンツのみを示しています。

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIManager
   metadata:
     name: apimanager-apicast-custom-policy
   spec:
     apicast:
       stagingSpec:
         customPolicies:
           - name: my-first-custom-policy
             version: "0.1"
             secretRef:
               name: my-first-custom-policy-secret
           - name: my-second-custom-policy
             version: "0.1"
             secretRef:
               name: my-second-custom-policy-secret
       productionSpec:
         customPolicies:
           - name: my-first-custom-policy
             version: "0.1"
             secretRef:
               name: my-first-custom-policy-secret
           - name: my-second-custom-policy
             version: "0.1"
             secretRef:
               name: my-second-custom-policy-secret

   APIManager カスタムリソースは、さまざまなカスタムポリシーを定義する複数のシークレットを参照できます。Operator は各カスタムポリシーをロードします。

3. カスタムポリシーを含むシークレットを参照する APIManager カスタムリソースを作成します。以下に例を示します。

   oc apply -f apimanager.yaml

手順

1. stringData.config に OpenTracing 設定の詳細を含めて、シークレットを定義します。これは、OpenTracing 設定の詳細が含まれる属性の唯一有効な値です。その他の仕様では、APIcast が OpenTracing 設定の詳細を受け取れないようにします。以下の例は、有効なシークレット定義を示しています。

   apiVersion: v1
   kind: Secret
   metadata:
     name: myjaeger
   stringData:
     config: |-
         {
         "service_name": "apicast",
         "disabled": false,
         "sampler": {
           "type": "const",
           "param": 1
         },
         "reporter": {
           "queueSize": 100,
           "bufferFlushInterval": 10,
           "logSpans": false,
           "localAgentHostPort": "jaeger-all-in-one-inmemory-agent:6831"
         },
         "headers": {
           "jaegerDebugHeader": "debug-id",
           "jaegerBaggageHeader": "baggage",
           "TraceContextHeaderName": "uber-trace-id",
           "traceBaggageHeaderPrefix": "testctx-"
         },
         "baggage_restrictions": {
             "denyBaggageOnInitializationFailure": false,
             "hostPort": "127.0.0.1:5778",
             "refreshInterval": 60
         }
         }
   type: Opaque

2. シークレットを作成します。たとえば、以前のシークレット定義を myjaeger.yaml ファイルに保存した場合は、以下のコマンドを実行します。

   oc create secret generic myjaeger --from-file myjaeger.yaml

3. OpenTracing 属性を指定する APIManager カスタムリソースを定義します。CR 定義で、openTracing.tracingConfigSecretRef.name 属性を OpenTracing 設定の詳細が含まれるシークレットの名前に設定します。以下の例は、OpenTracing の設定に関するコンテンツのみを示しています。

   apiVersion: apps.3scale.net/v1alpha1
   kind: APIManager
   metadata:
     name: apimanager1
   spec:
     apicast:
       stagingSpec:
         ...
         openTracing:
           enabled: true
           tracingLibrary: jaeger
           tracingConfigSecretRef:
             name: myjaeger
       productionSpec:
         ...
           openTracing:
             enabled: true
             tracingLibrary: jaeger
             tracingConfigSecretRef:
               name: myjaeger

4. OpenTracing を設定する APIManager カスタムリソースを作成します。たとえば、APIManager カスタムリソースを apimanager1.yaml ファイルに保存した場合は、以下のコマンドを実行します。

   oc apply -f apimanager1.yaml

手順

1. 以下のように、有効な証明書からシークレットを作成します。

   oc create secret tls mycertsecret --cert=server.crt --key=server.key

   この設定は、APIManager CRD のシークレット参照を公開します。シークレットを作成してから、以下のように APIManager カスタムリソースでシークレットの名前を参照します。

   • 実稼働: APIManager CR は .spec.apicast.productionSpec.httpsCertificateSecretRef フィールドの証明書を公開します。

   • ステー個m技: APIManager CR は .spec.apicast.stagingSpec.httpsCertificateSecretRef フィールドの証明書を公開します。

     必要に応じて、以下を設定できます。

   • httpsPort は、APIcast が HTTPS 接続に対してリッスンを開始するポートを示します。これが HTTP ポートと競合する場合には、APIcast はこのポートを HTTPS にのみ使用します。

   • httpsVerifyDepth は、クライアント証明書チェーンの最大長を定義します。

     注記

     APImanager CR から有効な証明書および参照を指定します。設定で httpsPort にアクセスでき、httpsCertificateSecretRef ではない場合、APIcast は組み込まれた自己署名証明書を使用します。これは、推奨されません。

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

6. 以下の YAML 定義をエディターに追加します。

   1. production で有効にする場合は、以下の YAML 定義を設定します。

      spec:
        apicast:
          productionSpec:
            httpsPort: 8443
            httpsVerifyDepth: 1
            httpsCertificateSecretRef:
              name: mycertsecret

   2. staging で有効にする場合は、以下の YAML 定義を設定します。

      spec:
        apicast:
          stagingSpec:
            httpsPort: 8443
            httpsVerifyDepth: 1
            httpsCertificateSecretRef:
              name: mycertsecret

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

手順

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. [Your_product_name] > Integration > Configuration の順に移動して、APIcast 設定をステージング環境にプロモートします。

2. APIcast Configuration セクションに、プロダクトに追加された各バックエンドのマッピングルールが表示されます。Promote v.[n] to Staging APIcast をクリックします。

   • v.[n] は、プロモート先のバージョン番号を表します。

3. ステージング環境にプロモートしたら、実稼働環境にプロモートすることができます。Staging APIcast セクションで、Promote v.[n] to Production APIcast をクリックします。

   • v.[n] は、プロモート先のバージョン番号を表します。

4. コマンドラインで API へのリクエストをテストするには、Example curl for testing で提供されるコマンドを使用します。

   • curl コマンドの例は、プロダクトの最初のマッピングルールに基づいています。

手順

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

3. Red Hat レジストリーから、そのまま使用できる Docker コンテナーエンジンのイメージをダウンロードします。

   sudo docker pull registry.redhat.io/3scale-amp2/apicast-gateway-rhel8:3scale2.11

4. Docker コンテナーエンジンで APIcast を実行します。

   sudo docker run --name apicast --rm -p 8080:8080 -e THREESCALE_PORTAL_ENDPOINT=https://<access_token>@<domain>-admin.3scale.net registry.redhat.io/3scale-amp2/apicast-gateway-rhel8:3scale2.11

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

手順

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 をデプロイします。

   1. 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 のアップグレード を続行します。

手順

1. 環境変数内の現在の 3scale リリースを保存します。

   $ export THREESCALE_RELEASE=2.11

2. system-app ImageChange トリガーを更新します。

   $ oc set triggers dc/system-app --from-image=amp-system:${THREESCALE_RELEASE} --containers=system-master,system-developer,system-provider --remove
   
   $ oc set triggers dc/system-app --from-image=amp-system:${THREESCALE_RELEASE}-oracle --containers=system-master,system-developer,system-provider

   これにより、system-app DeploymentConfig の再デプロイメントがトリガーされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が停止するまで待ちます。

3. system-sidekiq ImageChange トリガーを更新します。

   $ oc set triggers dc/system-sidekiq --from-image=amp-system:${THREESCALE_RELEASE} --containers=system-sidekiq,check-svc --remove
   
   $ oc set triggers dc/system-sidekiq --from-image=amp-system:${THREESCALE_RELEASE}-oracle --containers=system-sidekiq,check-svc

   これにより、system-sidekiq DeploymentConfig の再デプロイメントがトリガーされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が停止するまで待ちます。

4. system-sphinx ImageChange トリガーを更新します。

   $ oc set triggers dc/system-sphinx --from-image=amp-system:${THREESCALE_RELEASE} --containers=system-sphinx,system-master-svc --remove
   
   $ oc set triggers dc/system-sphinx --from-image=amp-system:${THREESCALE_RELEASE}-oracle --containers=system-sphinx,system-master-svc

   これにより、system-sphinx DeploymentConfig の再デプロイメントがトリガーされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が停止するまで待ちます。

   注記

   以下の手順はオプションです。3scale のインストール後に ORACLE_SYSTEM_PASSWORD を削除します。

5. Oracle Database で 3scale システムイメージを設定したら、system-app DeploymentConfig から ORACLE_SYSTEM_PASSWORD を削除します。新しいバージョンの 3scale にアップグレードするまで、もう一度は必要ありません。

   $ oc set env dc/system-app ORACLE_SYSTEM_PASSWORD-