red hat 3scale api management 2.5 3scale のイン …...本ガイドは、openshift に red hat...

Red Hat 3scale API Management 2.5

3scale のインストール

3scale API Management のインストールおよび設定

Last Updated: 2020-05-13

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

3scale API Management のインストールおよび設定

法律上の通知法律上の通知

Copyright © 2020 Red Hat, Inc.

The text of and illustrations in this document are licensed by Red Hat under a Creative CommonsAttribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA isavailable athttp://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you mustprovide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift,Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United Statesand other countries.

Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.

Java ® is a registered trademark of Oracle and/or its affiliates.

XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United Statesand/or other countries.

MySQL ® is a registered trademark of MySQL AB in the United States, the European Union andother countries.

Node.js ® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by theofficial Joyent Node.js open source or commercial project.

The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marksor trademarks/service marks of the OpenStack Foundation, in the United States and othercountries and are used with the OpenStack Foundation's permission. We are not affiliated with,endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

概要概要

本ガイドは、3scale API Management のインストールおよび設定に関する情報を提供します。

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

目次目次

前書き前書き

第第1章章 3SCALE システムイメージとシステムイメージと ORACLE DATABASE1.1. 始める前に

1.1.1. Oracle ソフトウェアコンポーネントの取得1.1.2. 前提条件

1.2. ORACLE DATABASE の準備1.3. システムイメージのビルド

第第2章章 3SCALE 2.5 をを OPENSHIFT にインストールするためのガイドにインストールするためのガイド2.1. はじめに

2.1.1. 前提条件2.2. システム要件

2.2.1. 環境要件2.2.2. ハードウェア要件

2.3. ノードおよびエンタイトルメントの設定2.4. テンプレートを使用して 3SCALE を OPENSHIFT にデプロイ

2.4.1. 前提条件2.4.2. 3scale テンプレートのインポート2.4.3. SMTP 変数の設定 (任意)

2.5. 3SCALE テンプレートパラメーター2.6. OPENSHIFT 上で APICAST を 3SCALE と使用

2.6.1. 3scale が含まれる既存の OpenShift クラスターでの APIcast テンプレートのデプロイ2.6.2. 3scale が含まれる OpenShift クラスター外部の OpenShift クラスターから APIcast へ接続2.6.3. 別のデプロイメントからの APIcast への接続2.6.4. Embedded APIcast のデフォルト動作の変更2.6.5. 内部サービスルート上で単一の OpenShift クラスターの複数の APIcast デプロイメントを接続

2.7. オペレーターを使用した 3SCALE のデプロイ2.7.1. 前提条件2.7.2. APIManager カスタムリソースのデプロイ

2.8. トラブルシューティング2.8.1. 以前のデプロイメントがダーティーな永続ボリュームクレームを残す2.8.2. 誤って Docker レジストリーからプルされる2.8.3. 永続ボリュームがローカルでマウントされている場合の MySQL のパーミッション問題2.8.4. OpenShift が永続ボリュームに書き込みできないためロゴまたはイメージをアップロードできない2.8.5. OpenShift でテストコールが動作しない2.8.6. シークレットに問題があるため 3scale の異なるプロジェクトにある APIcast をデプロイできない

第第3章章 APICAST のインストールのインストール3.1. 前提条件3.2. デプロイメントのオプション3.3. 環境3.4. 統合設定3.5. サービスの設定

3.5.1. API バックエンドの宣言3.5.2. 認証の設定3.5.3. API テストコールの設定3.5.4. 設定の保存

第第4章章 RED HAT OPENSHIFT 上での上での APICAST の実行の実行4.1. 前提条件4.2. RED HAT OPENSHIFT の設定

4

555556

7777788899

1011

151516171717181919

20202021212222

23232323242424252525

272727

目次目次

1

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4.2.1. Docker のコンテナー環境のインストール4.2.2. OpenShift クラスターの起動4.2.3. リモートサーバーでの OpneShift クラスターの設定 (任意設定)

4.3. OPENSHIFT テンプレートを使用した APICAST のデプロイ4.4. OPENSHIFT コンソール経由でのルートの作成

第第5章章 DOCKER のコンテナー環境におけるのコンテナー環境における APICAST5.1. 前提条件5.2. DOCKER のコンテナー環境のインストール5.3. DOCKER のコンテナー環境ゲートウェイの実行

5.3.1. Docker コマンドオプション5.4. APICAST のテスト

第第6章章 3SCALE オペレーターのインストールオペレーターのインストール6.1. はじめに

6.1.1. 前提条件6.2. 新しい OPENSHIFT プロジェクトの作成

6.2.1. OpenShift API サーバーでの 3scale オペレーター CRD の登録6.2.2. 3scale オペレーターのロールおよび ServiceAccounts のデプロイ6.2.3. 3scale オペレーターのデプロイ

第第7章章 3SCALE 高可用性テンプレートおよび評価用テンプレート高可用性テンプレートおよび評価用テンプレート7.1. はじめに7.2. 前提条件7.3. 高可用性テンプレート

7.3.1. 前提条件7.3.2. HA テンプレートの使用

7.4. 評価用テンプレート

第第8章章 3SCALE のの RADIS 高可用性高可用性 (HA) サポートサポート8.1. はじめに8.2. ダウンタイムをゼロにするよう REDIS を設定8.3. バックエンドコンポーネントの 3SCALE 設定

2728282930

333333333434

35353535353636

38383838383839

40404041

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

2

目次目次

3

前書き

本ガイドは、3scale のインストールおよび設定に役立ちます。


4

第1章 3SCALE システムイメージと ORACLE DATABASEデフォルトでは、3scale には設定データを MySQL データベースに保存する system というコンポーネントが含まれています。任意で、デフォルトデータベースをオーバーライドし、情報を外部の OracleDatabase に格納することができます。本書の手順にしたがって独自の Oracle Database クライアントバイナリーでカスタムのシステムコンテナーイメージをビルドし、3scale を OpenShift にデプロイします。

1.1. 始める前に

1.1.1. Oracle ソフトウェアコンポーネントの取得

カスタムの 3scale システムコンテナーイメージをビルドする前に、以下の Oracle ソフトウェアコンポーネントのサポートされるバージョンを取得する必要があります。

Oracle Instant Client Package Basic または Basic Light

Oracle Instant Client Package SDK

Oracle Instant Client Package ODBC

1.1.2. 前提条件

以下の前提条件を満たしている必要もあります。

OpenShift クラスターからアクセスできる、サポートされるバージョンの Oracle Database。

インストール手順に必要な Oracle Database の system ユーザーへのアクセス。

Red Hat 3scale 2.5 amp.yml テンプレートの取得。

1.2. ORACLE DATABASE の準備

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 の system ユーザー名およびパスワード

Oracle Database のサービス名

Oracle Database で新しいデータベースを作成するための詳細は、Oracle のドキュメントを参照してください。

第第1章章 3SCALE システムイメージとシステムイメージと ORACLE DATABASE

5

https://access.redhat.com/articles/2798521


https://docs.oracle.com/cd/E11882_01/network.112/e41945/glossary.htm#BGBGIHFG

https://docs.oracle.com/en/database/

1.3. システムイメージのビルド

1. 3scale-amp-openshift-templates GitHub リポジトリーをクローンします。

2. Oracle Database の Instant Client Package ファイルを 3scale-amp-openshift-templates/amp/system-oracle/oracle-client-files ディレクトリーに置きます。

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

$ oc new-app -f build.yml

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

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

5. 「Oracle Database の準備」で収集した以下の情報を指定して、以下のシェル for ループコマンドを入力します。

{USER}: Oracle Database で 3scale を表すユーザー名。

{PASSWORD}: USER のパスワード。

{ORACLE_DB_URL}: Oracle Database の URL。

{DATABASE}: Oracle Database で作成したデータベースのサービス名。

{PORT}: Oracle Database のポート番号。

For dc in system-app system-resque system-sidekiq system-sphinx; do oc env dc/$dc --overwrite DATABASE_URL="oracle-enhanced://{USER}:{PASSWORD}@{ORACLE_DB_URL}:{PORT}/{DATABASE}"; done

6. 前述の手順で提供した USER、PASSWORD、ORACLE_DB_URL、PORT、および DATABASE の値をそのまま指定し、以下の oc patch コマンドを入力します。

$ oc patch dc/system-app -p '[{"op": "replace", "path": "/spec/strategy/rollingParams/pre/execNewPod/env/1/value", "value": "oracle-enhanced://{USER}:{PASSWORD}@{ORACLE_DB_URL}:{PORT}/{DATABASE}"}]' --type=json

7. 以下の oc patch コマンドを入力します。SYSTEM_PASSWORD フィールドには OracleDatabase の独自の system ユーザーパスワードを指定します。

$ 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

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

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


6

https://github.com/3scale/3scale-amp-openshift-templates

第2章 3SCALE 2.5 を OPENSHIFT にインストールするためのガイド

2.1. はじめに

本ガイドは、OpenShift に Red Hat 3scale API Management - On-premises 2.5 をデプロイする手順を説明します。

オンプレミスデプロイメントの 3scale ソリューションは以下で構成されます。

2 つの API ゲートウェイ: Embedded APIcast

1 つの 3scale Admin Portal および永続ストレージを持つ Developer Portal

3scale ソリューションをデプロイする方法は 2 つあります。

「テンプレートを使用して 3scale を OpenShift にデプロイ」

「オペレーターを使用した 3scale のデプロイ」

重要重要

3scale オペレーターはテクノロジープレビューの機能です。テクノロジープレビューの機能は、Red Hat の本番環境のサービスレベルアグリーメント (SLA) ではサポートされず、機能的に完全ではないことがあるため、Red Hat は本番環境での使用は推奨しません。テクノロジープレビューの機能は、最新の技術をいち早く提供して、開発段階で機能のテストやフィードバックの収集を可能にするために提供されます。Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、「テクノロジプレビュー機能のサポート範囲」を参照してください。

2.1.1. 前提条件

3scale サーバーを UTC (協定世界時) に設定する必要があります。

2.2. システム要件

ここでは、3scale API Management OpenShift テンプレートの要件を示します。

2.2.1. 環境要件

3scale API Management には「Red Hat 3scale API Management Supported Configurations 」に指定されている環境が必要です。

永続ボリューム

Redis および MySQL の永続用の 3 つの RWO (ReadWriteOnce) の永続ボリューム。

CMS および System-app Assets 用の 1 つの RWX (ReadWriteMany) 永続ボリューム。

RWX 永続ボリュームはグループ書き込みができるように設定する必要があります。必要なアクセスモードをサポートする永続ボリュームタイプのリストは、OpenShift のドキュメントを参照してください。

第第2章章 3SCALE 2.5 をを OPENSHIFT にインストールするためのガイドにインストールするためのガイド

7

https://access.redhat.com/ja/support/offerings/techpreview/


https://access.redhat.com/documentation/ja-jp/openshift_container_platform/3.9/html-single/architecture/index#persistent-volumes

2.2.2. ハードウェア要件

ハードウェア要件は、使用の必要性に応じて異なります。Red Hat は、特定の要件を満たすよう環境をテストおよび設定することを推奨します。OpenShift 上の 3scale の環境を設定する場合、以下が推奨されます。

クラウド環境へのデプロイメントには、コンピュートタスクに最適化したノードを使用します(AWS c4.2xlarge または Azure Standard_F8)。

メモリーの要件が現在のノードで使用できる RAM よりも大きい場合、非常に大きなインストールでは、Redis に別のノードが必要になることがあります (AWS c4.2xlarge または AzureStandard_F8)。

ルーティングタスクとコンピュートタスクには別のノードを使用します。

3scale 固有のタスクでは専用のコンピュートノードを使用します。

バックエンドリスナーの PUMA_WORKERS 変数をコンピュートノードのコア数に設定します。

2.3. ノードおよびエンタイトルメントの設定

3scale を OpenShift にデプロイする前に、環境に必要なノードとエンタイトルメントを設定し、RedHat からイメージを取得する必要があります。

以下の手順を実行し、エンタイトルメントを設定します。

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.5-rpms リポジトリーへのアクセスを有効にします。

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

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

sudo yum install 3scale-amp-template

2.4. テンプレートを使用して 3SCALE を OPENSHIFT にデプロイ


8

https://access.redhat.com/documentation/ja-jp/Red_Hat_Enterprise_Linux/7/html/Installation_Guide/index.html

https://access.redhat.com/documentation/ja-jp/red_hat_subscription_management/1/html-single/rhsm/index#reg-gui

https://access.redhat.com/documentation/ja-jp/red_hat_subscription_management/1/html/using_red_hat_subscription_management/registration_con#register_cli

https://access.redhat.com/documentation/ja-jp/red_hat_subscription_management/1/html/using_red_hat_subscription_management/manage_systems_con#attach_sub_system_proc

https://access.redhat.com/documentation/ja-jp/openshift_container_platform/3.9/html/installation_and_configuration/installing-a-cluster


https://access.redhat.com/documentation/ja-jp/openshift_container_platform/3.9/html/installation_and_configuration/configuring-persistent-storage

https://access.redhat.com/documentation/ja-jp/openshift_container_platform/3.9/html/cli_reference/cli-reference-get-started-cli#installing-the-cli

2.4.1. 前提条件

第 3 章の「ノードおよびエンタイトルメントの設定」で指定されたとおりに設定されたOpenShift クラスター。

OpenShift クラスターに対して解決するドメイン (できればワイルドカード)。

Red Hat Container Catalog へのアクセス。

(任意) 電子メール機能の作業用 SMTP サーバー。

手順にしたがって、.yml テンプレートを使用して 3scale を OpenShift にインストールします。

3scale テンプレートのインポート

SMTP 変数の設定 (任意)

2.4.2. 3scale テンプレートのインポート

以下の手順を実行し、3scale テンプレートを OpenShift クラスターにインポートします。

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

oc login

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

oc project <project_name>

oc new-project <project_name>

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

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

b. --param オプションと、OpenShift クラスターのドメインに設定された WILDCARD_DOMAIN パラメーターを指定します。

c. また、任意で --param オプションと subdomain に設定された WILDCARD_POLICY パラメーターを指定すると、ワイルドカードドメインルーティングを有効にすることができます。ワイルドカードルーティングを有効にしない場合ワイルドカードルーティングを有効にしない場合:

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

ワイルドカードルーティングを有効にする場合ワイルドカードルーティングを有効にする場合:

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

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


9

https://access.redhat.com/documentation/ja-jp/openshift_container_platform/3.9/html-single/installation_and_configuration/index#envirornment-requirements

https://access.redhat.com/containers/

マスター管理者のユーザー名

マスターのパスワード。

マスターのトークン情報。

テナントのユーザー名。

テナントのパスワード。

テナントのトークン情報。

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

--> SuccessAccess 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'

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

注記注記

3scale が OpenShift に完全にデプロイされ、ログインとクレデンシャルが有効になるまで、数分かかることがあります。

詳細詳細

OpenShift でのワイルドカードドメインに関する詳細は、「(サブドメインの) ワイルドカードルートの使用」を参照してください。

2.4.3. SMTP 変数の設定 (任意)

OpenShift は通知の送信および新規ユーザーの招待に電子メールを使用します。これらの機能を使用する場合は、独自の SMTP サーバーを提供し、SMTP config map に SMTP 変数を設定する必要があります。

以下の手順を実行し、SMTP config map で SMTP 変数を設定します。

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


10

https://user-admin.3scale-project.example.com

https://access.redhat.com/documentation/ja-jp/openshift_container_platform/3.9/html/installation_and_configuration/setting-up-a-router#using-wildcard-routes

https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.5/html-single/admin_portal_guide#notifications

https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.5/html-single/admin_portal_guide#inviting-users-managing-rights

oc login

a. SMTP config mapの変数を設定します。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 です。

例例

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

2.5. 3SCALE テンプレートパラメーター

テンプレートパラメーターは、デプロイメント中およびデプロイメント後に 3scale (amp.yml) テンプレートの環境変数を設定します。

注記注記

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

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


11

注記注記

3scale 2.5 では PostgreSQL バージョンが 9 から 10 に更新されました。PostgreSQL 設定でこの更新を行うことが推奨されます。『Migrating 3scale』の「Upgrade ZyncDatabase PostgreSQL 9.5 to 10」を参照してください。

名前名前説明説明デフォルト値デフォルト値必要の有無必要の有無

APP_LABEL オブジェクトのアプリレベルに使用されます。

3scale-api-management

必要

ZYNC_DATABASE_PASSWORD

PostgreSQL 接続ユーザーのパスワード。指定のない場合は無作為に生成されます。

該当なし必要

ZYNC_SECRET_KEY_BASE

Zync の秘密鍵ベース。指定のない場合は無作為に生成されます。

該当なし必要

ZYNC_AUTHENTICATION_TOKEN

Zync の認証トークン。指定のない場合は無作為に生成されます。

該当なし必要

AMP_RELEASE 3scale リリースタグ。 2.5.0 必要

ADMIN_PASSWORD 無作為に生成された3scale 管理者アカウントのパスワード。

該当なし必要

ADMIN_USERNAME 3scale 管理者アカウントのユーザー名。

admin 必要

APICAST_ACCESS_TOKEN

APIcast が設定のダウンロードに使用する読み取り専用アクセストークン。

該当なし必要

ADMIN_ACCESS_TOKEN

API アクセスの全範囲および書き込み権限を持つ管理者アクセストークン。

該当なし不要

WILDCARD_DOMAIN ワイルドカードルートのルートドメイン。たとえば、ルートドメイン example.com は 3scale-admin.example.comを生成します。

該当なし必要


12

https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.5/html-single/migrating_3scale#upgrade-zync

WILDCARD_POLICY 値を「Subdomain」として設定し、EmbeddedAPIcast ゲートウェイへのワイルドカードルートを有効にします。

None 必要

TENANT_NAME -admin 接尾辞で AdminPortal が利用できるルート下のテナント名。

3scale 必要

MYSQL_USER データベースのアクセスに使用される MySQLユーザーのユーザー名。

mysql 必要

MYSQL_PASSWORD MySQL ユーザーのパスワード。

該当なし必要

MYSQL_DATABASE アクセスされた MySQLデータベースの名前。

system 必要

MYSQL_ROOT_PASSWORD

Root ユーザーのパスワード。

該当なし必要

SYSTEM_BACKEND_USERNAME

内部 3scale api auth の内部 3scale API ユーザー名。

3scale_api_user 必要

SYSTEM_BACKEND_PASSWORD

内部 3scale api auth の内部 3scale API パスワード。

該当なし必要

REDIS_IMAGE 使用する Redis イメージ。

registry.access.redhat.com/rhscl/redis-32-rhel7:3.2

必要

MYSQL_IMAGE 使用する Mysql イメージ。

registry.access.redhat.com/rhscl/mysql-57-rhel7:5.7

必要

MEMCACHED_IMAGE 使用する Memcached イメージ。

registry.access.redhat.com/3scale-amp20/memcached:1.4.15

必要

POSTGRESQL_IMAGE 使用する Postgresql イメージ。

registry.access.redhat.com/rhscl/postgresql-10-rhel7

必要



13

AMP_SYSTEM_IMAGE 使用する 3scale システムイメージ。

registry.access.redhat.com/3scale-amp25/system

必要

AMP_BACKEND_IMAGE 使用する 3scale バックエンドイメージ。

registry.access.redhat.com/3scale-amp25/backend

必要

AMP_APICAST_IMAGE 使用する 3scale APIcastイメージ。

registry.access.redhat.com/3scale-amp25/apicast-gateway

必要

AMP_ROUTER_IMAGE 使用する 3scale ワイルドカードルーターイメージ。

registry.access.redhat.com/3scale-amp22/wildcard-router

必要

AMP_ZYNC_IMAGE 使用する 3scale Zync イメージ。

registry.access.redhat.com/3scale-amp25/zync

必要

SYSTEM_BACKEND_SHARED_SECRET

バックエンドからシステムにイベントをインポートするための共有シークレット。

該当なし必要

SYSTEM_APP_SECRET_KEY_BASE

システムアプリケーション秘密鍵のベース。

該当なし必要

APICAST_MANAGEMENT_API

APIcast ManagementAPI の範囲。disable、status、または debug を設定できます。最低でもヘルスチェックにはstatus が必要です。

status 不要

APICAST_OPENSSL_VERIFY

設定のダウンロード時にOpenSSL ピア検証をオンまたはオフにします。true または false を設定できます。

false 不要

APICAST_RESPONSE_CODES

APIcast のロギング応答コードを有効にします。

true 不要



14

APICAST_REGISTRY_URL

APIcast ポリシーの場所に解決する URL。

http://apicast-staging:8090/policies

必要

MASTER_USER マスター管理者アカウントのユーザー名。

master 必要

MASTER_NAME マスター Admin Portalのサブドメイン値。-master 接尾辞が付けられます。

master 必要

MASTER_PASSWORD 無作為に生成されたマスター管理者のパスワード。

該当なし必要

MASTER_ACCESS_TOKEN

API 呼び出しのマスターレベル権限を持つトークン。

該当なし必要

IMAGESTREAM_TAG_IMPORT_INSECURE

サーバーが証明書検証を回避したり、イメージのインポート中に HTTP 上で直接接続できる場合はtrue を設定します。

false 必要


2.6. OPENSHIFT 上で APICAST を 3SCALE と使用

ホスト型 3scale や、OpenShift Container Platform のオンプレミスインストールでは、API Manager を使用して APIcast を利用できます。設定手順は両方で異なります。ここでは、OpenShift で APIManager を使用して APIcast をデプロイする方法を説明します。

2.6.1. 3scale が含まれる既存の OpenShift クラスターでの APIcast テンプレートのデプロイ

3scale OpenShift テンプレートには Embedded APIcast API ゲートウェイが 2 つデフォルトで含まれています。より多くの API ゲートウェイが必要な場合や、別の APIcast デプロイメントが必要な場合は、追加の APIcast テンプレートを OpenShift クラスターにデプロイすることができます。

次の手順を実行して、追加の API ゲートウェイを OpenShift クラスターにデプロイします。

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

Account Management API へのスコープ指定

読み取り専用アクセスの取得

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

oc login


15

http://apicast-staging:8090/policies

https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.5/html-single/admin_portal_guide#tokens

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 は Admin Portal を利用できる、ルート下の名前です。TENANT_NAME のデフォルト値は 3scale です。3scale デプロイメントでカスタム値を使用した場合は、その値を使用する必要があります。

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

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

注記注記

最初に「ノードおよびエンタイトルメントの設定」を参照して APIcast テンプレートをインストールします。

2.6.2. 3scale が含まれる OpenShift クラスター外部の OpenShift クラスターからAPIcast へ接続

3scale クラスター外部の別の OpenShift クラスターに APIcast をデプロイする場合、パブリックルート経由で接続する必要があります。

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>

注記注記


16

https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.5/html/admin_portal_guide/tokens#access_tokens

注記注記

TENANT_NAME は Admin Portal を利用できる、ルート下の名前です。TENANT_NAME のデフォルト値は 3scale です。3scale デプロイメントでカスタム値を使用した場合は、その値を使用する必要があります。

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

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

5. URL backend の後に 3scale デプロイメントに含まれる OpenShift クラスターのワイルドカードドメインを指定して、apicast BACKEND_ENDPOINT_OVERRIDE 環境変数セットを更新します。

oc env dc/apicast --overwrite BACKEND_ENDPOINT_OVERRIDE=https://backend-<TENANT_NAME>.<WILDCARD_DOMAIN>

2.6.3. 別のデプロイメントからの APIcast への接続

別のデプロイメントに APIcast をデプロイした後、3scale OpenShift クラスターの BACKEND_ENDPOINT_OVERRIDE 環境変数を設定して、OpenShift 上の 3scale に接続できます。

1. 3scale OpenShift クラスターにログインします。

oc login

2. system-app オブジェクトの BACKEND_ENDPOINT_OVERRIDE 環境変数を設定します。

ネイティブインストールを使用している場合は、BACKEND_ENDPOINT_OVERRIDE=https://backend.<your_openshift_subdomain>bin/apicast を設定します。

Docker のコンテナー化環境を使用している場合は、docker run -eBACKEND_ENDPOINT_OVERRIDE=https://backend.<your_openshift_subdomain> を設定します。

2.6.4. Embedded APIcast のデフォルト動作の変更

外部の APIcast デプロイメントでデフォルトの動作を変更するには、APIcast OpenShift テンプレートでテンプレートパラメーターを変更します。

Embedded APIcast デプロイメントでは、3scale および APIcast は単一のテンプレートからデプロイされます。Embedded APIcast デプロイメントのデフォルト動作を変更する場合は、デプロイメントの後に環境変数を編集する必要があります。

2.6.5. 内部サービスルート上で単一の OpenShift クラスターの複数の APIcast デプロイメントを接続

同じ OpenShift クラスターに複数の APIcast ゲートウェイをデプロイする場合、デフォルトの外部ルート設定でなく、バックエンドリスナーサービスを介して内部ルートを使用して接続するよう設定できます。

内部サービスルート上で接続するには OpenShift SND プラグインがインストールされている必要があ


17

https://access.redhat.com/documentation/ja-jp/red_hat_3scale_api_management/2.5/html/installing_3scale/onpremises-installation#templateParams

内部サービスルート上で接続するには OpenShift SND プラグインがインストールされている必要があります。接続方法は、インストールされた SDN によって異なります。

ovs-subnet

ovs-subnet OpenShift SDN (Software-Defined Networking) プラグインを使用している場合は、以下の手順にしたがって、内部ルート上で接続します。

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

oc login

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

a. --param オプションと、OpenShift クラスターの 3scale プロジェクトのドメインに設定された BACKEND_ENDPOINT_OVERRIDE を指定します。

oc new-app -f apicast.yml --param BACKEND_ENDPOINT_OVERRIDE=http://backend-listener.<3SCALE_PROJECT>.svc.cluster.local:3000

ovs-multitenant

「ovs-multitenant」Openshift SDN プラグインを使用している場合は、以下の手順にしたがって、内部ルート上で接続します。

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

oc login

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

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

3. apicast.yml ファイルへのパスを指定して oc new-app オプションを入力します。

a. --param オプションと、OpenShift クラスターの 3scale プロジェクトのドメインに設定された BACKEND_ENDPOINT_OVERRIDE を指定します。

oc new-app -f apicast.yml --param BACKEND_ENDPOINT_OVERRIDE=http://backend-listener.<3SCALE_PROJECT>.svc.cluster.local:3000

詳細詳細

OpenShift SDN とプロジェクトネットワーク分離の詳細は、「Openshift SDN」を参照してください。

2.7. オペレーターを使用した 3SCALE のデプロイ

ここでは、APIManager カスタムリソースを使用して、3scale オペレーター経由で 3scale API ソリューションをインストールおよびデプロイする方法を説明します。

重要重要


18

https://access.redhat.com/documentation/ja-jp/openshift_container_platform/3.9/html/architecture/networking#architecture-additional-concepts-sdn

重要重要


2.7.1. 前提条件

最初に、オペレーターを使用して 3scale をデプロイするには、3scale オペレーターがインストールされている必要があります。

OpenShift Container Platform 3.11

OpenShift クラスターの管理者権限を持つユーザーアカウント

2.7.2. APIManager カスタムリソースのデプロイ

APIManager カスタムリソースをデプロイすると、オペレーターがプロセスを開始し、3scale ソリューションをデプロイします。

1. 以下の内容が含まれる新しい YAML ファイルを作成し、APIManager をデプロイします。

注記注記

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

apiVersion: apps.3scale.net/v1alpha1kind: APIManagermetadata: name: example-apimanagerspec: productVersion: "2.5" wildcardDomain: <wildcardDomain> wildcardPolicy: <None|Subdomain> resourceRequirementsEnabled: true

2. wildcardPolicy が Subdomain の場合、OpenShift ルーターレベルのワイルドカードルートを有効にします。

a. これには、以下のコマンドを実行します。

oc set env dc/router ROUTER_ALLOW_WILDCARD_ROUTES=true -n default

注記注記

APIManager フィールドに関する詳細は、リファレンスドキュメントを参照してください。


19


https://access.redhat.com/documentation/ja-jp/red_hat_3scale_api_management/2.5/html/installing_3scale/installing-3scale-operator#3scale-operator

https://github.com/3scale/3scale-operator/blob/3scale-2.5.0-CR1/doc/apimanager-reference.md

export NAMESPACE="operator-test"oc project ${NAMESPACE}oc create -f <yaml-name>

b. これにより、operator-test プロジェクトで 3scale ソリューションのデプロイメントが実行されます。

2.8. トラブルシューティング

ここでは、一般的なインストールの問題と、その問題を解決するためのアドバイスを提供します。

「以前のデプロイメントがダーティーな永続ボリュームクレームを残す」

「誤って Docker レジストリーからプルされる」

「永続ボリュームがローカルでマウントされている場合の MySQL のパーミッション問題」

「OpenShift が永続ボリュームに書き込みできないためロゴまたはイメージをアップロードできない」

「OpenShift でテストコールが動作しない」

「シークレットに問題があるため 3scale の異なるプロジェクトにある APIcast をデプロイできない」

2.8.1. 以前のデプロイメントがダーティーな永続ボリュームクレームを残す

問題問題

以前のデプロイメントがダーティーな永続ボリュームクレーム (PVC) を残そうとするため、MySQL コンテナーの起動に失敗します。

原因原因

OpenShift のプロジェクトを削除しても、それに関連する PVC は消去されません。

解決方法解決方法

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

2. OpenShift UI の cancel deployment をクリックして、system-mysql Pod のデプロイメントを停止します。

3. MySQL パス以下にあるものすべてを削除し、ボリュームをクリーンアップします。

4. 新たに system-mysql のデプロイメントを開始します。

2.8.2. 誤って Docker レジストリーからプルされる

# oc get pvcNAME STATUS VOLUME CAPACITY ACCESSMODES AGEbackend-redis-storage Bound vol003 100Gi RWO,RWX 4dmysql-storage Bound vol006 100Gi RWO,RWX 4dsystem-redis-storage Bound vol008 100Gi RWO,RWX 4dsystem-storage Bound vol004 100Gi RWO,RWX 4d


20

問題問題

インストール中に以下のエラーが発生します。

原因原因

OpenShift は docker コマンドを実行し、コンテナーイメージを検索およびプルします。このコマンドは、registry.access.redhat.com Red Hat コンテナーレジストリーではなく、docker.io Docker レジストリーを参照します。

これは、システムに予期せぬ Docker バージョンのコンテナー環境が含まれる場合に発生します。


Docker のコンテナー環境に適したバージョンを使用します。

2.8.3. 永続ボリュームがローカルでマウントされている場合の MySQL のパーミッション問題

問題問題

system-msql Pod がクラッシュし、デプロイされないため、それに依存する他のシステムのデプロイメントに失敗します。Pod ログには以下のエラーが記録されます。

原因原因

MySQL プロセスが不適切なユーザーパーミッションで起動されています。


1. 永続ボリュームに使用されるディレクトリーには、ルートグループの書き込みパーミッションが必要です。MySQL サービスはルートグループでは別のユーザーとして実行するため、ルートユーザーの rw パーミッションでは不十分です。

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

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

chcon -Rt svirt_sandbox_file_t /path/for/pvs

2.8.4. OpenShift が永続ボリュームに書き込みできないためロゴまたはイメージをアップロードできない

問題問題

ロゴをアップロードできず、system-app ログに以下が表示されます。

svc/system-redis - 1EX.AMP.LE.IP:6379 dc/system-redis deploys docker.io/rhscl/redis-32-rhel7:3.2-5.3 deployment #1 failed 13 minutes ago: config change

[ERROR] Can't start server : on unix socket: Permission denied[ERROR] Do you already have another mysqld server running on socket: /var/lib/mysql/mysql.sock ?[ERROR] Aborting


21

http://rhelblog.redhat.com/2015/04/15/understanding-the-changes-to-docker-search-and-docker-pull-in-red-hat-enterprise-linux-7-1/

Errno::EACCES (Permission denied @ dir_s_mkdir - /opt/system/public//system/provider-name/2

原因原因

OpenShift が永続ボリュームに書き込みできません。


OpenShift による永続ボリュームへの書き込みを可能にする必要があります。ルートグループが所有し、グループによる書き込みを可能にする必要があります。

2.8.5. OpenShift でテストコールが動作しない

問題問題

OpenShift で新しいサービスとルートを作成した後に、テストコールが動作しません。curl 経由のダイレクトコールも失敗し、service not available が出力されます。

原因原因

3scale はデフォルトで HTTPS ルートが必要で、OpenShift ルートはセキュアではありません。


OpenShift のルーター設定で secure route チェックボックスを選択する必要があります。

2.8.6. シークレットに問題があるため 3scale の異なるプロジェクトにある APIcast をデプロイできない

問題問題

APIcast のデプロイメントに失敗します (Pod が青になりません)。以下のエラーがログに記録されます。

update acceptor rejected apicast-3: pods for deployment "apicast-3" took longer than 600 seconds to become ready

以下のエラーが Pod に表示されます。

Error synching pod, skipping: failed to "StartContainer" for "apicast" with RunContainerError: "GenerateRunContainerOptions: secrets \"apicast-configuration-url-secret\" not found"

原因原因

シークレットが適切に設定されていません。


APIcast v3 でシークレットを作成するときに apicast-configuration-url-secret を指定します。

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


22

第3章 APICAST のインストールAPIcast は、内部および外部の API サービスを 3scale Platform と統合するために使用される NGINXベースの API ゲートウェイです。APIcast は、ラウンドロビン形式で負荷分散を行います。

本ガイドでは、デプロイメントオプション、提供される環境、および開始方法について説明します。

APIcast の最新リリースやサポートされるバージョンに関する情報は、「Red Hat 3scale APIManagement Supported Configurations」および「Red Hat 3scale API Management - ComponentDetails」を参照してください。

3.1. 前提条件

APIcast はスタンドアロンの API ゲートウェイではありません。3scale API マネージャーへの接続が必要です。

3scale のオンプレミスインスタンスが必要です。

3.2. デプロイメントのオプション

Hosted APIcast (ホストされた APIcast) または Self-managed APIcast (自己管理の APIcast) を使用できます。両方の場合で、APIcast は残りの 3scale API 管理プラットフォームに接続している必要があります。

Embedded APIcast (組み込み APIcast): 3scale API Management インストールにはデフォルトで 2 つの APIcast ゲートウェイ (ステージングと実稼働) が含まれています。これらのゲートウェイは事前設定されているため、そのまま使用することができます。

Self-managed APIcast (自己管理の APIcast): APIcast をどこでもデプロイすることができます。Self-managed (自己管理) モードは、実稼働環境での操作を目的としたモードです。APIcast のデプロイメントにおける推奨オプションの一部は次のとおりです。

Docker containerized environment (Docker のコンテナー環境): そのまま使用でき、Docker形式のコンテナーで APIcast を実行するための依存関係がすべて含まれる、Docker 形式のコンテナーイメージをダウンロードします。

OpenShift: APIcast をサポートされるバージョンの OpenShift で実行します。Self-managed APIcast (自己管理の APIcast) は 3scale インストールまたは 3scale オンラインアカウントに接続できます。

3.3. 環境

デフォルトでは、3scale アカウントを作成すると、2 つの異なる環境の Embedded APIcast が提供されます。

Staging (ステージング): API 統合の設定中またはテスト中でのみ使用することが目的です。設定が想定どおりに動作していることが確認されたら、実稼働環境にデプロイすることができます。OpenShift テンプレートは、設定が各 API 呼び出し APICAST_CONFIGURATION_LOADER: lazy、 APICAST_CONFIGURATION_CACHE: 0) でリロードされるよう、ステージング APIcast のパラメーターを設定します。APIcast の設定変更を即座にテストするのに便利です。

Production (実稼働): 実稼働向けの環境です。APICAST_CONFIGURATION_LOADER: boot、および APICAST_CONFIGURATION_CACHE: 300 パラメーターはOpenShift テンプレートのProduction APIcast のために設定されています。そのため、APIcast の開始時に設定が完全に

第第3章章 APICAST のインストールのインストール

23



https://access.redhat.com/documentation/ja-jp/red_hat_3scale_api_management/2.5/html/installing_3scale/onpremises-installation


ロードされ、300 秒 (5 分) 間キャッシュに保存されます。設定は 5 分後に再ロードされます。これにより、設定を実稼働に昇格すると、APIcast の新しいデプロイメントを実行しない限り、設定の適用に 5 分程度かかる場合があります。

3.4. 統合設定

[your_API_name] > Integration > Configuration と選択します。

Integration ページの上部に統合オプションが表示されます。デフォルトのデプロイメントオプションはHosted APIcast で、デフォルトの認証モードは API キーです。右上隅にある edit integration settingsをクリックすると設定を変更できます。

Integration ページの上部に、統合オプションがあります。デフォルトは以下の値になります。

デプロイメントオプション: Embedded APIcast

認証モード: API キー

右上隅の edit integration settings をクリックすると、設定を変更することができます。

3.5. サービスの設定

3.5.1. API バックエンドの宣言

Private Base URL フィールドに API バックエンドのエンドポイントホストを指定して、API バックエンドを宣言する必要があります。すべての認証、承認、流量制御、および統計が処理された後、APIcastはすべてのトラフィックを API バックエンドにリダイレクトします。

通常、API の Private Base URL は管理するドメイン (yourdomain.com) 上で https://api-backend.yourdomain.com:443 のようになります。たとえば、Twitter API と統合する場合の PrivateBase URL は https://api.twitter.com/ になります。この例では、3scale によってホストされる Echo APIを使用します。この API は、すべてのパスを許可し、リクエストに関する情報 (パス、リクエストパラメーター、ヘッダーなど) を返すシンプルな API です。その Private Base URL は https://echo-api.3scale.net:443 です。

プライベート (管理対象でない) API が動作することをテストします。たとえば、Echo API の場合では curl コマンドを使用して以下の呼び出しを実行できます。

curl "https://echo-api.3scale.net:443"

以下の応答が返されます。

{ "method": "GET", "path": "/", "args": "",


24

https://api-backend.yourdomain.com:443

https://api.twitter.com/

https://echo-api.3scale.net:443

"body": "", "headers": { "HTTP_VERSION": "HTTP/1.1", "HTTP_HOST": "echo-api.3scale.net", "HTTP_ACCEPT": "*/*", "HTTP_USER_AGENT": "curl/7.51.0", "HTTP_X_FORWARDED_FOR": "2.139.235.79, 10.0.103.58", "HTTP_X_FORWARDED_HOST": "echo-api.3scale.net", "HTTP_X_FORWARDED_PORT": "443", "HTTP_X_FORWARDED_PROTO": "https", "HTTP_FORWARDED": "for=10.0.103.58;host=echo-api.3scale.net;proto=https" }, "uuid": "ee626b70-e928-4cb1-a1a4-348b8e361733" }

3.5.2. 認証の設定

API の認証の設定は AUTHENTICATION SETTINGS セクションで行うことができます。以下のフィールドはすべて任意です。

フィールドフィールド説明説明

Host Header カスタムの Host リクエストヘッダーを定義します。これは、API バックエンドが特定のホストからのトラフィックのみを許可する場合に必要です。

Secret Token API バックエンドに直接送られる開発者リクエストをブロックするために使用します。ここにヘッダーの値を設定し、バックエンドがこのシークレットヘッダーを持つ呼び出しのみを許可するようにします。

Credentials location クレデンシャルが HTTP ヘッダー、クエリーパラメーター、または HTTP BASIC 認証として渡されるかどうかを定義します。

Auth user key credentials location に関連するキーを設定します。

Errors authentication failed、authentication missing、および no match エラーの応答コード、コンテンツの種類、および応答ボディーを定義します。

3.5.3. API テストコールの設定

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

3.5.4. 設定の保存

ページの右下部分にある Update & Test Staging Configuration ボタンをクリックして設定を保存します。これにより、APIcast 設定が 3scale Hosted ステージング環境にデプロイされます。すべてが正しく設定されていれば、左側の縦線が緑色に変わります。

第第3章章 APICAST のインストールのインストール

25

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

ステージングセクションの最後にある 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 と統合されました。と統合されました。

3scale Hosted APIcast ゲートウェイはクレデンシャルを検証し、アプリケーションプランで定義した流量制御を適用します。クレデンシャルがない状態やクレデンシャルが無効な状態で呼び出しを行うと、エラーメッセージが表示されます。


26

第4章 RED HAT OPENSHIFT 上での APICAST の実行このチュートリアルでは、Red Hat OpenShift に APIcast API Gateway をデプロイする方法を説明します。

4.1. 前提条件

以下のチュートリアルの手順を行うには、最初に「APIcast のインストール」にしたがって、3scaleAdmin Portal で APIcast を設定する必要があります。統合設定のデプロイメントオプションとしてSelf-managed Gateway が選択されているようにしてください。続行するには、Staging と Production環境の両方が設定されている必要があります。

4.2. RED HAT OPENSHIFT の設定

OpenShift クラスターが稼働中である場合は、この手順を省略できます。その他の場合は以下にしたがってください。

実稼働デプロイメントの場合は、OpenShift インストールの手順にしたがうことができます。

このチュートリアルでは、OpenShift クラスターは以下を使用してインストールされます。

Red Hat Enterprise Linux (RHEL) 7

Docker のコンテナー環境 (v1.10.3)

OpenShift Origin コマンドラインインターフェース (CLI) - v1.3.1

4.2.1. Docker のコンテナー環境のインストール

Red Hat が提供する Docker 形式のコンテナーイメージは、RHEL の Extras チャンネルの一部としてリリースされています。追加のリポジトリーを有効にするには、Subscription Manager または yum 設定マネージャーを使用できます。詳細は、RHEL の製品ドキュメントを参照してください。

AWS EC2 インスタンスにデプロイされた RHEL 7 では、以下の手順を使用します。

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 サービスを開始します。

第第4章章 RED HAT OPENSHIFT 上での上での APICAST の実行の実行

27

https://access.redhat.com/documentation/ja-jp/red_hat_3scale_api_management/2.5/html/installing_3scale/installing-apicast

https://docs.openshift.com/container-platform/3.11/install/running_install.html

https://access.redhat.com/solutions/392003

https://access.redhat.com/documentation/ja-jp/Red_Hat_Enterprise_Linux/7/html/System_Administrators_Guide/sec-Configuring_Yum_and_Yum_Repositories.html#sec-Managing_Yum_Repositories

sudo systemctl start docker

以下のコマンドを使用すると、コンテナーサービスが実行していることを確認できます。

sudo systemctl status docker

4.2.2. OpenShift クラスターの起動

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

注記注記

oc cluster コマンドセットは、1.3+ 以上のリリースでのみ使用できることに注意してください。

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

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

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

4.2.3. リモートサーバーでの OpneShift クラスターの設定 (任意設定)

OpenShift クラスターをリモートサーバーにデプロイする場合、クラスターの起動時にパブリックホスト名とルーティング接尾辞を明示的に指定し、OpenShift web コンソールへリモートアクセスできるようにする必要があります。

たとえば、AWS EC2 インスタンスでデプロイする場合は、以下のオプションを指定する必要があります。

oc cluster up --public-hostname=ec2-54-321-67-89.compute-1.amazonaws.com --routing-suffix=54.321.67.89.xip.io


28

https://github.com/openshift/origin/releases

ec2-54-321-67-89.compute-1.amazonaws.com はパブリックドメイン、 54.321.67.89 はインスタンスの IP アドレスに置き換えます。これにより、https://ec2-54-321-67-89.compute-1.amazonaws.com:8443 で OpenShift web コンソールにアクセスできるようになります。

4.3. OPENSHIFT テンプレートを使用した APICAST のデプロイ

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 Admin Portal の URL になります。

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

secret/apicast-configuration-url-secret

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

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

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

--> Creating resources with label app=3scale-gateway ... deploymentconfig "apicast" created


29

https://ec2-54-321-67-89.compute-1.amazonaws.com:8443

https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.5/html-single/admin_portal_guide#creating-access-tokens

service "apicast" created--> Success Run 'oc status' to view your app.

4.4. OPENSHIFT コンソール経由でのルートの作成

1. ブラウザーで OpenShift クラスターの web コンソール https://OPENSHIFT-SERVER-IP:8443/console/ を開きます。OpenShift クラスターをリモートサーバーで起動した場合は、OPENSHIFT-SERVER-IP ではなく、--public-hostname に指定された値を使用します。

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

注記注記

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

2. 上記の OpenShift 設定設定で作成または取得した developer クレデンシャルを使用してログインします。上記のコマンドラインから作成した gateway プロジェクトが含まれる、プロジェクトのリストが表示されます。


30

https://openshift-server-ip:8443/console/

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

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

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

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

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

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


31

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

定義する 3scale サービスごとに、新しいルートを作成する必要があります。この代わりに、Embedded APIcast のワイルドカードルーティングを設定すると、定義する 3scale サービスごとに新しいルートを作成する必要はありません。


32

https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.5/html/operating_3scale/onpremises-operations?lb_target=preview#apicast_built_in_wildcard_routing

第5章 DOCKER のコンテナー環境における APICASTここでは、3scale API ゲートウェイとして使用する準備が整っている Docker 形式のコンテナー内部にAPIcast をデプロイする方法をステップごとに説明します。

5.1. 前提条件

「APIcast のインストール」にしたがって、3scale Admin Portal で APIcast を設定する必要があります。

5.2. DOCKER のコンテナー環境のインストール

ここでは、Red Hat Enterprise Linux (RHEL) 7 に Docker のコンテナー環境を設定する方法をステップごとに説明します。

Red Hat が提供する Docker 形式のコンテナーは、RHEL の Extras チャンネルの一部としてリリースされています。追加のリポジトリーを有効にするには、Subscription Manager または yum-config-manager を使用できます。詳細は、RHEL の製品ドキュメントを参照してください。

AWS EC2 インスタンスで RHEL 7 をデプロイするには、以下の手順を実行します。

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 のコンテナー環境のパッケージをインストールします。

他のオペレーティングシステムをお使いの場合は、以下の Docker ドキュメントを参照してください。

Installing the Docker containerized environment on Linux distributions

Installing the Docker containerized environment on Mac

Installing the Docker containerized environment on Windows

5.3. 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-amp24/apicast-gateway.

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

sudo docker run --name apicast --rm -p 8080:8080 -e

第第5章章 DOCKER のコンテナー環境におけるのコンテナー環境における APICAST

33


https://access.redhat.com/solutions/392003

https://access.redhat.com/documentation/ja-jp/Red_Hat_Enterprise_Linux/7/html/System_Administrators_Guide/sec-Configuring_Yum_and_Yum_Repositories.html#sec-Managing_Yum_Repositories

https://docs.docker.com/engine/installation/linux/

https://docs.docker.com/docker-for-mac/

https://docs.docker.com/docker-for-windows/

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-amp24/apicast-gateway.

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

このコマンドは、"apicast" という Docker 形式のコンテナーをポート 8080 で実行し、3scale ポータルから JSON 設定ファイルを取得します。その他の設定オプションについては、「APIcast のインストール」を参照してください。

5.3.1. Docker コマンドオプション

docker run コマンドでは以下のオプションを使用できます。

--rm: 終了時にコンテナーを自動的に削除します。

-d または --detach: コンテナーをバックグラウンドで実行し、コンテナー ID を出力します。指定のない場合、コンテナーはフォアグラウンドモードで実行され、CTRL + c を使用して停止することができます。デタッチモードで起動された場合、docker attach コマンド (例: docker attach apicast) を使用するとコンテナーを再アタッチすることができます。

-p または --publish: コンテナーのポートをホストに公開します。値の書式は <host port="">:<container port=""> である必要があります。そのため -p 80:8080 の場合は、コンテナーのポート 8080 をホストマシンのポート 80 にバインドします。たとえば、Management API はポート 8090 を使用するため、-p 8090:8090 を docker run コマンドに追加してこのポートを公開します。

-e または --env: 環境変数を設定します。

-v または --volume: ボリュームをマウントします。通常、この値は <host path="">:<container path="">[:<options>] と示されます。<options> は任意の属性で、ボリュームが読み取り専用であることを指定するには :ro に設定します (例: -v /host/path:/container/path:ro)。デフォルトでは読み書きモードでマウントされます。

使用できるオプションの詳細は、「Docker run reference」を参照してください。

5.4. APICAST のテスト

次の手順は、Docker 形式のコンテナーが独自の設定ファイルと、3scale レジストリーからの Docker 形式のイメージで実行されるようにします。呼び出しは APIcast を介してポート 8080 でテストでき、3scale アカウントから取得できる正しい認証クレデンシャルを提供できます。

テストコールは、APIcast が適切に実行されていることを確認するだけでなく、認証とレポートが正常に処理されたことも確認します。

注記注記

呼び出しに使用するホストが Integration ページの Public Base URL フィールドに設定されたホストと同じであるようにしてください。


34


https://docs.docker.com/engine/reference/run/

第6章 3SCALE オペレーターのインストール

6.1. はじめに

ここでは、同じ設定のデプロイメントを複数の環境で管理するために、カスタムリソース定義 (CRD)、ロールベースのアクセス制御 (RBAC) 、および 3scale オペレーターイメージをデプロイする詳細について説明します。

重要重要


6.1.1. 前提条件

3scale 2.5 のオンプレミスインスタンスが必要です。

OpenShift Container Platform 3.11

OpenShift クラスターの管理者権限を持つユーザーアカウント

警告警告

3scale オペレーターとカスタム CRD を個別のプロジェクトプロジェクトにデプロイします。インフラストラクチャーが含まれる既存のプロジェクトプロジェクトにデプロイする場合は、既存の要素が変更または削除されることがあります。

6.2. 新しい OPENSHIFT プロジェクトの作成

以下のようなコマンドを実行して新しい OpenShift プロジェクトを作成する必要があります。このコマンドは、プロジェクト名の例を示しています。

oc new-project operator-test

これにより、オペレーター、APIManager カスタムリソース (CR)、および Capabilities カスタムリソースがインストールされる新しい OpenShift プロジェクトプロジェクトが作成されます。

6.2.1. OpenShift API サーバーでの 3scale オペレーター CRD の登録

1. tar ファイル deploy.tar.gz をダウンロードし、展開します。

2. 管理者としてクラスターにログインし、以下のコマンドを実行してすべての 3scale オペレーター CRD をデプロイします。

第第6章章 3SCALE オペレーターのインストールオペレーターのインストール

35


https://access.redhat.com/documentation/ja-jp/red_hat_3scale_api_management/2.5/html/installing_3scale/onpremises-installation

https://github.com/3scale/3scale-operator/releases/download/3scale-2.5.0-CR1/deploy.tar.gz

for i in `ls deploy/crds/*_crd.yaml`; do oc create -f $i ; done

a. これにより、APIManager CRD とオペレーターの Capabilities 機能に関する CRD がOpenShift API サーバーサーバーに登録されます。

b. コマンドが正常に実行されたら、oc get を使用して、この CRD によって定義されたリソースタイプをクエリーできるようになります。

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

oc get apimanagers

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

No resources found.

6.2.2. 3scale オペレーターのロールおよび ServiceAccounts のデプロイ

1. operator-test OpenShift プロジェクトプロジェクトに移動し、他の要素が存在しないことを確認します。

export NAMESPACE="operator-test"oc project ${NAMESPACE}oc get all // This shouldn't return any result

2. 3scale オペレーターによって使用される ServiceAccount をデプロイします。

oc create -f deploy/service_account.yaml

3. 管理者としてクラスターにログインし、作成された ServiceAccount にそのロールを割り当てる 3scale オペレーター Role および RoleBinding をデプロイします。

// As a cluster adminexport NAMESPACE="operator-test"oc project ${NAMESPACE}oc create -f deploy/role.yamloc create -f deploy/role_binding.yaml

6.2.3. 3scale オペレーターのデプロイ

1. 以下のコマンドを実行して 3scale オペレーターをデプロイします。

export NAMESPACE="operator-test"oc project ${NAMESPACE}oc create -f deploy/operator.yaml

a. これにより、Operator コードを持つ Pod が含まれる Deployment が作成され、受信APIManager および Capabilities リソースのリッスンを開始します。

2. 3scale オペレーターがデプロイされ、準備できていることを確認するには、以下のコマンドを実行します。

oc get deployment 3scale-operator


36

第第6章章 3SCALE オペレーターのインストールオペレーターのインストール

37

第7章 3SCALE 高可用性テンプレートおよび評価用テンプレート

7.1. はじめに

ここでは、オンプレミス型 Red Hat 3scale API Management 2.5 インストール環境で使用される高可用性テンプレートおよび評価用テンプレートについて説明します。

重要重要

3scale の高可用性テンプレートおよび評価用テンプレートはテクノロジープレビューの機能です。テクノロジープレビューの機能は、Red Hat の本番環境のサービスレベルアグリーメント (SLA) ではサポートされず、機能的に完全ではないことがあるため、RedHat は本番環境での使用は推奨しません。テクノロジープレビューの機能は、最新の技術をいち早く提供して、開発段階で機能のテストやフィードバックの収集を可能にするために提供されます。Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、「テクノロジプレビュー機能のサポート範囲」を参照してください。

7.2. 前提条件

高可用性テンプレートおよび評価用テンプレートの要素をデプロイできる OpenShift クラスターが必要です。

7.3. 高可用性テンプレート

高可用性 (HA) テンプレートを使用すると、重要なデータベースの HA を設定できます。

7.3.1. 前提条件

HA テンプレートをデプロイする前に、外部データベースをデプロイおよび設定し、負荷分散されたエンドポイントで HA を設定する必要があります。

7.3.2. HA テンプレートの使用

高可用性のために amp-ha-tech-preview.yml という名前のテンプレートを使用すると、OpenShift 外部の重要なデータベースをデプロイできます。これには、以下は除外されます。

Memcached

Sphinx

Zync

標準の amp.yml テンプレートと amp-ha-tech-preview.yml には以下の違いがあります。

以下の要素が削除されています。

backend-redis およびその関連コンポーネント

system-redis およびその関連コンポーネント

system-mysql およびその関連コンポーネント

Redis および MySQL 関連の ConfigMaps

MYSQL_IMAGE、REDIS_IMAGE、MYSQL_USER、MYSQL_ROOT_PASSWORD パラメー


38


MYSQL_IMAGE、REDIS_IMAGE、MYSQL_USER、MYSQL_ROOT_PASSWORD パラメーター

デフォルトでは、データベースでない DeploymentConfig オブジェクトタイプのレプリカの数が 1 から 2 に増加されます。

以下の必須パラメーターが追加されているため、外部データベースの場所を制御できます。

BACKEND_REDIS_STORAGE_ENDPOINT

BACKEND_REDIS_QUEUES_ENDPOINT

SYSTEM_REDIS_URL

APICAST_STAGING_REDIS_URL

APICAST_PRODUCTION_REDIS_URL

SYSTEM_DATABASE_URL

amp-ha-tech-preview.yml を使用する場合、新たに追加された必須のパラメーターを介してクラスター外のデータベース接続 (永続的なデータが含まれない system-memcache、zync-database、および system-sphinx は除外)を設定する必要があります。エンドポイントには、認証情報を含む、データベースの負荷分散された接続文字列が必要です。さらに、データベースでないデプロイメントでは、アプリケーションレベルでの冗長性を確保するためにデフォルトで Pod レプリカの数が 2 つに増えています。

7.4. 評価用テンプレート

評価の目的で、リソースのリクエストや制限のない 3scale 環境をデプロイする amp-eval-tech-preview.yml という名前のテンプレートが提供されています。

標準の amp.yml テンプレートとの唯一の機能的な違いは、リソースの制限とリクエストが削除されたことです。そのため、このバージョンでは CPU およびメモリーレベルでハードウェアの最低要件がPod で削除されました。このテンプレートは、指定のハードウェアリソースを使用して、可能な限りコンポーネントをデプロイしようとするため、評価、テスト、および開発のみの使用を目的としています。

第第7章章 3SCALE 高可用性テンプレートおよび評価用テンプレート高可用性テンプレートおよび評価用テンプレート

39

第8章 3SCALE の RADIS 高可用性 (HA) サポート

8.1. はじめに

高可用性 (HA) は、OpenShift Container Platform (OCP) によってほとんどのコンポーネントに提供されます。詳細は、OpenShift Container Platform 3.11『クラスター管理』の「第 30 章、高可用性」を参照してください。

3scale ではでは HA のデータベースコンポーネントに以下が含まれます。のデータベースコンポーネントに以下が含まれます。

system-redis: 3scale のバックグランドジョブの一時ストレージを提供し、system-app Podの Ruby プロセスのメッセージバスとしても使用されます。

backend-redis: 統計ストレージおよび一時ジョブストレージに使用されます。

注記注記

system-redis および backend-redis の両方は Redis Cluster (open-source または RedisLabs) に置き換えることができます。

以下の env vars は、Redis Enterprise の要件ですが、system-(app、sidekiq、sphinx)デプロイメント設定に設定できます

MESSAGE_BUS_REDIS_URL (redis の URL)

REDIS_NAMESPACE (ネームスペース Sidekiq の Redis キーへの短い文字列)

MESSAGE_BUS_REDIS_NAMESPACE (ネームスペース System メッセージバスの Redis キーへの短い文字列)

Redis Pod が使えなくなったり、OCP によって kill されると、新しい Pod が自動作成されます。データは永続ストレージから復元されるため、Pod は動作し続けます。このような場合、新しい Pod が起動するまで短いダウンタイムが発生します。これは、Redis がマルチマスター設定をサポートしない制限によるものです。Redis をデプロイしたすべてのノードに Redis イメージを事前に読み込むと、ダウンタイムを削減することができ、Pod の再起動をスピードアップすることができます。

8.2. ダウンタイムをゼロにするよう REDIS を設定

ダウンタイムをゼロにする必要がある場合は、Redis を OCP 外部に設定する必要があります。3scalePod の設定オプションを使用して設定する方法が複数あります。

独自の自己管理の Redis を設定する

Redis Sentinel を使用する (『Redis Sentinel Documentation』を参照)

サービスとして提供される Redis:例:

Amazon ElastiCache

Redis Labs

注記注記


40

https://access.redhat.com/documentation/ja-jp/openshift_container_platform/3.11/html/cluster_administration/admin-guide-high-availability

https://redis.io/topics/sentinel

注記注記

Red Hat は上記のサービスにサポートを提供しません。このようなサービスの言及は、Red Hat による製品やサービスの推奨を意味するものではありません。Red Hat は、Red Hat 外部のコンテンツを使用 (または依存) して発生した損失や費用の責任を負いません。

8.3. バックエンドコンポーネントの 3SCALE 設定

3scale 2.5 では、バックエンドコンポーネントの Redis HA (フェイルオーバー) を設定できます。backend-cron、backend-listener、および backend-worker のデプロイメント設定で、環境変数として設定することができます。

CONFIG_REDIS_SENTINEL_HOSTS および CONFIG_QUEUES_SENTINEL_HOSTS:メイン統計データベースに対する Sentinel ホストのコンマ区切りリストおよび Resque バックグランドジョブのデータベース。

注記注記

値の形式は、name:value <host>:<port> である必要があります (例: host1:26379、host2:26379、host3:26379)。

CONFIG_REDIS_SENTINEL_ROLE および CONFIG_QUEUES_SENTINEL_ROLE:各 Sentinels グループのロールで、master または slave のいずれか。現在 master (デフォルト)のみがサポートされます。

これにより、CONFIG_REDIS_PROXY および CONFIG_QUEUES_MASTER_NAME の値が、指定のサーバーではなく Sentinel グループ名の意味を取るようになります。

CONFIG_REDIS_PROXY および CONFIG_QUEUES_MASTER_NAME は URL を使用でき、パスワードで保護されるデータベースをサポートします (例: redis://user:password@server:port/database または redis://master_group)。

第第8章章 3SCALE のの RADIS 高可用性高可用性 (HA) サポートサポート

41

red hat 3scale api management 2.5 3scale のイン …...本ガイドは、openshift に red hat...

Documents