Red Hat 3scale API Management のインストール

手順

1. OpenShift Container Platform コンソールにおいて、管理者権限を持つアカウントを使用してログインします。
2. Operators > OperatorHub の順にクリックします。
3. Filter by keyword ボックスに 3scale Operator と入力して、Red Hat Integration - 3scale を検索します。
4. Red Hat Integration - 3scale をクリックします。Operator に関する情報が表示されます。
5. Operator に関する情報を確認し、Install をクリックします。Install Operator ページが開きます。
6. Install Operator ページで、任意のチャネルを選択して、Update channel セクションを更新します。

7. Installation mode セクションで、Operator のインストール先を選択します。

   1. All namespaces on the cluster(default): Operator はクラスターのすべての namespace で利用可能になります。
   2. A specific namespace on the cluster: Operator は、選択したクラスター上の特定の単一 namespace でしか使用することができません。
8. Install をクリックします。
9. インストールが完了すると、Operator が使用できる状態になったことを示す確認メッセージが表示されます。

10. 3scale Operator の ClusterServiceVersion (CSV) が正しくインストールされていることを確認します。また、Operator のインストールが成功したことが報告されているかどうかも確認します。

    • Operators > Installed Operators の順にクリックします。
    • Red Hat Integration - 3scale Operator をクリックします。
    • Details タブで、Conditions セクションまで下にスクロールします。Succeeded 条件のReason 列の下に InstallSucceeded と表示されます。

手順

1. OpenShift Container Platform コンソールにおいて、管理者権限を持つアカウントを使用してログインします。
2. Operators > OperatorHub の順にクリックします。インストール済みの Operator ページが表示されます。
3. 3scale を Filter by name に入力して Operator を見つけ、クリックします。
4. Operator Details ページで、Actions ドロップダウンメニューから Uninstall Operator を選択して、特定の namespace から削除します。

5. Uninstall Operator? ダイアログボックスが表示され、以下が通知されます。

   Removing the operator will not remove any of its custom resource definitions or managed resources. If your operator has deployed applications on the cluster or configured off-cluster resources, these will continue to run and need to be cleaned up manually.
   This action removes the operator as well as the Operator deployments and pods, if any. Any operands and resources managed by the operator, including CRDs and CRs, are not removed. The web console enables dashboards and navigation items for some operators. To remove these after uninstalling the operator, you might need to manually delete the operator CRDs.

6. Uninstall を選択します。この Operator は実行を停止し、更新を受信しなくなります。
7. OpenShift Container Platform コンソールで、Operators > OperatorHub をクリックします。
8. Filter by keyword ボックスに 3scale Operator と入力して、Red Hat Integration - 3scale を検索します。
9. Red Hat Integration - 3scale をクリックします。Operator に関する情報が表示されます。
10. Install をクリックします。Install Operator ページが開きます。
11. Install Operator ページで、任意のチャネルを選択して、Update channel セクションを更新します。
12. Installation mode セクションで、All namespaces on the cluster(default) を選択します。Operator はクラスターのすべての namespace で利用可能になります。
13. Subscribe をクリックします。3scale Operator の詳細ページが表示され、Subscription Overview を確認できます。
14. サブスクリプションの Upgrade Status が Up to date と表示されていることを確認します。
15. 3scale Operator の ClusterServiceVersion (CSV) が表示されることを確認します。

手順

1. Operators > Installed Operators の順にクリックします。

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

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

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

     注記

     wildcardDomain パラメーターの値は、OpenShift Container Platform (OCP) ルーターのアドレスに解決される有効なドメイン名である必要があります。たとえば、apps.mycluster.example.com になります。

   • 最小要件のある APIManager CR:

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

     Copy to clipboard

   • レプリカが設定された 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

     Copy to clipboard

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

   Copy to clipboard
   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

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

手順

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 },
   }

   Copy to clipboard

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

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

   Copy to clipboard

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

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

   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

   Copy to clipboard

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

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

   $ oc apply -f apimanager.yaml

   Copy to clipboard

手順

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

   Copy to clipboard

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

2. 3scale Operator を使用してシークレットの変更を監視します。apimanager.apps.3scale.net/watched-by=apimanager ラベルを追加して、3scale Operator シークレットの変更の監視を開始します。

   $ oc label secret my-first-custom-policy-secret apimanager.apps.3scale.net/watched-by=apimanager

   Copy to clipboard
   注記

   デフォルトでは、シークレットへの変更は 3scale Operator によって追跡されません。ラベルを設定すると、シークレットに変更を加えるたびに 3scale Operator が APIcast デプロイメントを自動的に更新します。これは、シークレットが使用されているステージング環境と実稼働環境の両方で発生します。3scale Operator は、いかなる形でもシークレットの所有権を取得しません。

3. カスタムポリシーが含まれる各シークレットを参照する APIManager CR を定義します。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

   Copy to clipboard

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

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

   $ oc apply -f apimanager.yaml

   Copy to clipboard

手順

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

   Copy to clipboard

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

   $ oc create -f myjaeger.yaml

   Copy to clipboard

3. OpenTracing 属性を指定する APIManager カスタムリソース (CR) を定義します。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

   Copy to clipboard

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

   $ oc apply -f apimanager1.yaml

   Copy to clipboard

手順

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

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

   Copy to clipboard

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

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

   • ステージング: 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. 実稼働 環境で有効にする場合は、次の YAML 定義を設定します。

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

      Copy to clipboard

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

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

      Copy to clipboard
7. Create をクリックします。

手順

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

   oc login

   Copy to clipboard

2. oc patch コマンドを使用して、system-smtp がシークレットの名前であるシークレットタイプを指定し、その後に -p オプションを付けて、次の変数の JSON に新しい値を書き込みます。

   表1.4 system-smtp

   フィールド	説明	デフォルト値
   address	これは、使用するリモートメールサーバーのアドレス (ホスト名または IP) です。これが "" 以外の値に設定されている場合、システムはメールサーバーを使用して、API 管理ソリューションで発生するイベントに関連するメールを送信します。	""
   port	これは、使用するリモートメールサーバーのポートです。	""
   domain	メールサーバーで HELO ドメインが必要な場合は、domain を使用します。	""
   認証 (authentication)	メールサーバーで認証が必要な場合に使用します。認証タイプを設定します。plain はパスワードを plain で送信し、login は Base64 エンコードされたパスワードを送信します。cram_md5 は HMAC-MD5 アルゴリズムに基づくチャレンジ/レスポンスメカニズムを組み合わせます。	""
   username	メールサーバーが認証を必要とし、認証タイプがそれを必要とする場合は、username を使用します。	""
   password	メールサーバーが認証を必要とし、認証タイプがそれを必要とする場合は、password を使用します。	""
   openssl.verify.mode	TLS を使用する場合、OpenSSL が証明書をチェックする方法を設定できます。これは、自己署名証明書やワイルドカード証明書を検証する必要がある場合に役立ちます。OpenSSL 検証定数の名前 none または peer を使用できます。	""
   from_address	無返信メールの from アドレス値。	""

   例

   $ 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>"}}'

   Copy to clipboard

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

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

   Copy to clipboard

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

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

   Copy to clipboard

検証

1. 以下のコマンドを入力してデプロイメントを確認します。

   $ oc get dc/apicast-staging -o yaml

   $ oc get dc/apicast-production -o yaml

2. 環境変数が含まれていることを確認します。

   # apicast-staging
   - name: APICAST_SERVICE_CACHE_SIZE
      value: '10'

   # apicast-production
   - name: APICAST_SERVICE_CACHE_SIZE
      value: '20'

手順

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

2. 次の設定を適用します。

   ALTER SYSTEM SET max_string_size=extended SCOPE=SPFILE;

   Copy to clipboard

3. データベースユーザーを設定します。

   3scale で Oracle Database インテグレーションをセットアップするには、Oracle SYSTEM ユーザーパスワードを指定する場合と指定しない場合の 2 つのオプションがあります。

   3scale は、通常のユーザーを作成し、それに必要な権限を付与する初期セットアップでのみ SYSTEM ユーザーを使用します。次の SQL コマンドは、適切な権限を持つ通常のユーザーをセットアップします。({DB_USER} と {DB_PASSWORD} は、実際の値に置き換える必要があるプレースホルダーです)。

   CREATE USER {DB_USER} IDENTIFIED BY {DB_PASSWORD};
   GRANT unlimited tablespace TO {DB_USER};
   GRANT create session TO {DB_USER};
   GRANT create table TO {DB_USER};
   GRANT create view TO {DB_USER};
   GRANT create sequence TO {DB_USER};
   GRANT create trigger TO {DB_USER};
   GRANT create procedure TO {DB_USER};

   Copy to clipboard

   1. SYSTEM ユーザーの使用:

      • system-database シークレットの ORACLE_SYSTEM_PASSWORD フィールドに SYSTEM ユーザーのパスワードを指定します。
      • インストール前に通常のユーザーが存在する必要はありません。これは 3scale 初期化スクリプトによって作成されます。
      • system-database シークレットの URL フィールドの接続文字列 (例: oracle-enhanced://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}) に、通常のユーザー用の必要なユーザー名とパスワードを入力します。
      • 通常の Oracle Database 非システムユーザーのパスワードは一意である必要があり、SYSTEM ユーザーのパスワードとは一致しないようにする必要があります。

      • 指定されたユーザー名を持つユーザーがすでに存在する場合、3scale 初期化スクリプトは次のコマンドを使用して、パスワードの更新を試みます。

        ALTER USER {DB_USER} IDENTIFIED BY {DB_PASSWORD}

        Copy to clipboard

        パラメーター PASSWORD_REUSE_TIME および PASSWORD_REUSE_MAX が同じパスワードの再利用を制限するように設定されている場合、データベース設定によっては、このコマンドが正常に完了しない場合があります。

   2. 通常のデータベースユーザーの手動セットアップ:

      • system-database シークレットに ORACLE_SYSTEM_PASSWORD を指定する必要はありません。
      • system-database シークレットの URL フィールドの接続文字列で指定された通常のデータベースユーザー (SYSTEM 以外) は、3scale のインストール前に存在している必要があります。
      • インストールに使用する通常のユーザーは、上記のすべての権限を持っている必要があります。

手順

1. GitHub リポジトリーから 3scale OpenShift テンプレートをダウンロードし、アーカイブをデプロイメントします。

   tar -xzf 3scale-2.14.0-GA.tar.gz

   Copy to clipboard

2. Instant Client Downloads ページから、以下をダウンロードします。

   • クライアント: basic-lite または basic のいずれか
   • ODBC ドライバー

   • Oracle Database 19c の SDK

     • 3scale の場合は、Instant Client Downloads for Linux x86-64(64-bit) を使用します。
     • ppc64le および 3scale の場合は、Power Little Endian (64 ビット) 上の Linux の Oracle Instant Client Downloads for Linux を使用します。

3. 次の Oracle ソフトウェアコンポーネントのバージョンについては、表を確認してください。

   • Oracle Instant Client パッケージ: Basic または Basic Light
   • Oracle Instant Client パッケージ: SDK

   • Oracle Instant Client パッケージ: ODBC

     表1.6 3scale 向けの Oracle 19c パッケージの例

     Oracle 19c パッケージ名	圧縮ファイル名
     Basic	instantclient-basic-linux.x64-19.8.0.0.0dbru.zip
     Basic Light	instantclient-basiclite-linux.x64-19.8.0.0.0dbru.zip
     SDK	instantclient-sdk-linux.x64-19.8.0.0.0dbru.zip
     ODBC	instantclient-odbc-linux.x64-19.8.0.0.0dbru.zip

     表1.7 ppc64le および 3scale 用 Oracle 19c パッケージの例

     Oracle 19c パッケージ名	圧縮ファイル名
     Basic	instantclient-basic-linux.leppc64.c64-19.3.0.0.0dbru.zip
     Basic Light	instantclient-basiclite-linux.leppc64.c64-19.3.0.0.0dbru.zip
     SDK	instantclient-sdk-linux.leppc64.c64-19.3.0.0.0dbru.zip
     ODBC	instantclient-odbc-linux.leppc64.c64-19.3.0.0.0dbru.zip

   注記

   ローカルにダウンロードされて保存されたクライアントパッケージバージョンが、3scale が想定するバージョンと一致しない場合には、以下の手順で 3scale は適切なバージョンを自動的にダウンロードして使用します。

4. Oracle Database Instant Client Package ファイルを system-oracle-3scale-2.13.0-GA/oracle-client-files ディレクトリーに配置します。

5. システムの Oracle ベースのカスタムイメージをビルドします。以下の例に示すように、固定のイメージタグを設定する必要があります。

   $ docker build . --tag myregistry.example.com/system-oracle:2.14.0-1

6. システムの Oracle ベースのイメージを、OCP クラスターからアクセス可能なコンテナーレジストリーにプッシュします。このコンテナーレジストリーに、この後 3scale ソリューションがインストールされます。

   $ docker push myregistry.example.com/system-oracle:2.14.0-1

手順

1. 該当するフィールドを使用して system-database シークレットを作成し、Oracle Database URL の接続文字列および Oracle Database のシステムパスワードを設定します。Oracle Database については、外部データベースモードでのインストール を参照してください。

2. APIManager CR を作成して、3scale ソリューションをインストールします。Operator を使用した 3scale API Management のデプロイ の手順に従います。

   • APIManager CR は、以前にビルドしたシステムの Oracle ベースのイメージに設定された .spec.system.image フィールドを指定する必要があります。

     apiVersion: apps.3scale.net/v1alpha1
     kind: APIManager
     metadata:
       name: example-apimanager
     spec:
       imagePullSecrets:
       - name: threescale-registry-auth
       - name: custom-registry-auth
       system:
         image: "myregistry.example.com/system-oracle:2.14.0-1"
       externalComponents:
         system:
           database: true

手順

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

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

手順

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. 以下のフィールドを指定して、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

   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. Operator を使用した 3scale API Management のデプロイ に示されているように 3scale をデプロイします。

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

1. HA 用の 3scale API Management の新規インストールのデプロイ に記載のとおり、すべてのフィールドを指定して 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) 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

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