4.2. OLM を使用した 3scale operator のインストールと設定
Operator Lifecycle Manager (OLM) を使用して、OpenShift Container Platform (OCP) 4.6 クラスターに 3scale operator をインストールします。この際に、OCP コンソールの OperatorHub を使用します。以下のインストールモードを使用して、3scale operator をインストールできます。
- クラスター全体。Operator がクラスターのすべての namespace で利用できます。
- クラスター上の特定の namespace。
ネットワークが制限された環境または非接続クラスターで OpenShift Container Platform を使用している場合には、Operator Lifecycle Manager は OperatorHub を使用できなくなります。OLM の設定および使用については、Operator のネットワークが制限された環境での Operator Lifecycle Manager の使用 に記載の手順に従ってください。
前提条件
- 新しい OpenShift プロジェクトの作成 で定義したプロジェクトに 3scale operator をインストールおよびデプロイしている。
手順
OpenShift Container Platform コンソールにおいて、管理者権限を持つアカウントを使用してログインします。
注記メニュー構造は、使用している OpenShift のバージョンによって異なります。
- Operators > OperatorHub の順にクリックします。
- Filter by keyword ボックスに 3scale operator と入力し、3scale operator を検索します。
- 3scale operator をクリックします。operator に関する情報が表示されます。
- operator に関する情報を確認し、Install をクリックします。Install Operator ページが開きます。
- Install Operator ページで、任意のチャネルを選択して、Update channel セクションを更新します。
Installation mode セクションで、Operator のインストール先を選択します。
- All namespaces on the cluster(default): Operator はクラスターのすべての namespace で利用可能になります。
- A specific namespace on the cluster: operator は、選択したクラスター上の特定の単一 namespace でしか使用することができません。
- Subscribe をクリックします。3scale operator の詳細ページが表示され、Subscription Overview を確認できます。
- サブスクリプションの Upgrade Status が Up to date と表示されていることを確認します。
3scale operator の ClusterServiceVersion (CSV) が表示され、新しい OpenShift プロジェクトの作成 で定義したプロジェクトで operator の Status が最終的に InstallSucceeded となるのを確認します。
- Operators > Installed Operators の順にクリックします。この場合、インストールに成功すると、APIManager CRD および operator の Capabilities 機能に関連する CRD が OpenShift API サーバー に登録されます。
インストールが正常に完了したら、
oc getを使用して CRD によって定義されたリソースタイプのクエリーを行います。たとえば、APIManager CRD が適切に登録されたことを確認するには、以下のコマンドを実行します。
oc get apimanagers
以下の出力が表示されるはずです。
No resources found.
ネットワークが制限された環境で OCP を使用する場合、ここに示す手順に加えて、3scale デベロッパーポータルで使用する許可されるドメインのリストを作成します。以下の例を参照してください。
- デベロッパーポータルに追加するすべてのリンク
- GitHub などのサードパーティー SSO プロバイダーを使用した SSO インテグレーション
- 請求
- 外部 URL をトリガーする Webhook
4.2.1. ネットワーク接続が得られない環境における制約 リンクのコピーリンクがクリップボードにコピーされました!
3scale 2.12 の非接続環境での現在の制限の概要を以下に示します。
- デベロッパーポータルへの GitHub ログインができない
- サポートのリンクが機能しない
- 外部ドキュメントへのリンクが機能しない
- デベロッパーポータルの OpenAPI Specification (OAS) 検証ツールが機能しない (これにより、外部サービスへのリンクが影響を受けます)
ActiveDocs の製品 Overview ページにおいて、OAS へのリンクが機能しない
- 新たな ActiveDocs 仕様を作成する場合、オプション Skip swagger validations を選択する必要もあります。
関連情報
- トラブルシューティングに関する情報は、OpenShift Container Platform のドキュメント を参照してください。
- ネットワークが制限された環境での OLM の使用に関する詳細は、Operator のネットワークが制限された環境での Operator Lifecycle Manager の使用 を参照してください。
- ネットワークが制限された環境でのインストール準備の詳細は、インストール のネットワークが制限された環境でのインストール用のミラーレジストリーの作成 を参照してください。
- サポート対象設定の情報については、Red Hat 3scale API Management のサポート対象設定 のアーティクルを参照してください。