3scale の移行
3scale API Management およびそのコンポーネントの移行またはアップグレード
概要
はじめに リンクのコピーリンクがクリップボードにコピーされました!
本ガイドでは、Red Hat 3scale API Management をテンプレートベースから operator ベースのインストールに移行するための情報、3scale インストールを 2.12 から 2.13 にアップグレードするのに必要な詳細情報、および operator ベースのデプロイメントで APIcast をアップグレードする手順について説明します。
3scale オンプレミスデプロイメントを 2.12 から 2.13 にアップグレードするには、次のガイドを参照してください。
operator ベースのデプロイメントで APIcast をアップグレードするには、operator ベースの APIcast のアップグレードガイド に記載の手順を参照してください。
多様性を受け入れるオープンソースの強化 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、CTO である Chris Wright のメッセージ をご覧ください。
第1章 operator ベースの 3scale アップグレードガイド: 2.12 から 2.13 へ リンクのコピーリンクがクリップボードにコピーされました!
- 3scale 2.13.1 では、Red Hat OpenShift Container Platform (OCP) 4.12 へのサポートが導入されます。
- OCP 4.12 にアップグレードする前に、3scale 2.13.1 にアップグレードする必要があります。
operator ベースのインストールで Red Hat 3scale API Management をバージョン 2.12 から 2.13 にアップグレードして、Open Shift 4.x で 3scale を管理できるようにします。
3scale のマイクロリリースを自動的に取得するには、自動更新が有効であることを確認してください。これを確認するには、マイクロリリースの自動適用の設定 を参照してください。
必要な条件および手順を理解するために、記載の手順を適用する前に、アップグレードガイド全体を読んでください。アップグレードプロセスの手順が完了するまで、サービスの提供が中断されます。このサービス中断が生じるため、メンテナンス期間を設けるようにしてください。
アップグレード手順中にレプリカをスケールアップまたはスケールダウンするには、3scale の 調整 セクションに記載されているフィールドを使用します。
1.1. アップグレードを行うための前提条件 リンクのコピーリンクがクリップボードにコピーされました!
本セクションでは、operator ベースのインストール環境において、3scale を 2.12 から 2.13 にアップグレードするのに必要な設定について説明します。
- OpenShift Container Platform (OCP) 4.8、4.9、4.10 または 4.11 クラスターおよびその管理者アクセス
- 3scale operator によりデプロイされている 3scale 2.12
threescale-2.12
チャネルの最新 CSV が使用されていることを確認します。以下を確認してください。- サブスクリプションの承認設定が自動の場合は、すでに最新の CSV バージョンのチャンネルになっているはずです。
- サブスクリプションの承認設定が手動の場合、保留中のすべての Install Plans を承認し、最新の CSV バージョンがあることを確認してください。
- 保留中のインストールプランがある場合、さらに保留中のインストールプランがある可能性があり、既存の保留中のプランがインストールされた後にのみ表示されることに注意してください。
1.2. operator ベースのインストール環境における 2.12 から 2.13 へのアップグレード リンクのコピーリンクがクリップボードにコピーされました!
operator ベースのデプロイメントにおいて、3scale をバージョン 2.12 から 2.13 にアップグレードするには、以下の手順を実施します。
- 管理者権限を持つアカウントを使用して OCP コンソールにログインします。
- 3scale-operator がデプロイされているプロジェクトを選択します。
- Operators > Installed Operators の順にクリックします。
- Red Hat Integration - 3scale > Subscription > Channel の順に選択します。
threescale-2.13 を選択してサブスクリプションのチャンネルを編集し、変更を保存します。
これによりアップグレードプロセスが開始されます。
すべての新しいバージョンが実行され、エラーなく準備ができていることを確認するまで、プロジェクトで Pod の状態を照会します。
oc get pods -n <3scale_namespace>
$ oc get pods -n <3scale_namespace>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記- Pod ではアップグレードプロセス中、一時的にエラーが発生する場合があります。
- Pod のアップグレードに必要な時間は、5~10 分程度です。
- 新しい Pod のバージョンの実行後に、3scale Admin Portal にログインして、想定どおりに動作することをチェックし、アップグレードが正常に行われたことを確認します。
以下のコマンドを実行して、APIManagerオブジェクトのステータスを確認し、YAMLコンテンツを取得します。 <myapimanager> は、APIManagerの名前を表します。
oc get apimanager <myapimanager> -n <3scale_namespace> -o yaml
$ oc get apimanager <myapimanager> -n <3scale_namespace> -o yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 新しいアノテーションおよび値は以下のようになります。
apps.3scale.net/apimanager-threescale-version: "2.13" apps.3scale.net/threescale-operator-version: "0.10.0"
apps.3scale.net/apimanager-threescale-version: "2.13" apps.3scale.net/threescale-operator-version: "0.10.0"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
上記の手順をすべて実施すると、operator ベースのデプロイメントにおける 3scale 2.12 から 2.13 へのアップグレードが完了します。
第2章 operator ベースの APIcast のアップグレードガイド: 2.12 から 2.13 へ リンクのコピーリンクがクリップボードにコピーされました!
オペレータベースのインストールで APIcast を 2.12 から 2.13 にアップグレードすると、APIcast API ゲートウェイを使用して、内部および外部の API サービスを 3scale と統合できます。
必要な条件および手順を理解するために、記載の手順を適用する前に、アップグレードガイド全体を読んでください。アップグレードプロセスの手順が完了するまで、サービスの提供が中断されます。このサービス中断が生じるため、メンテナンス期間を設けるようにしてください。
2.1. アップグレードを行うための前提条件 リンクのコピーリンクがクリップボードにコピーされました!
operator ベースのインストールで APIcast を 2.12 から 2.13 にアップグレードするには、以下の前提条件を満たしている必要があります。
- OpenShift Container Platform (OCP) 4.8、4.9、4.10 または 4.11 クラスターおよびその管理者アクセス
- APIcast operator によりデプロイされている APIcast 2.12
threescale-2.12
チャネルの最新 CSV が使用されていることを確認します。この点を確認するには、以下を行います。- サブスクリプションの承認設定が自動の場合は、すでに最新の CSV バージョンのチャンネルになっているはずです。
- サブスクリプションの承認設定が手動の場合、保留中のすべての Install Plans を承認し、最新の CSV バージョンがあることを確認してください。
- 保留中のインストールプランがある場合、さらに保留中のインストールプランがある可能性があり、既存の保留中のプランがインストールされた後にのみ表示されることに注意してください。
2.2. operator ベースのインストール環境における APIcast 2.12 から 2.13 へのアップグレード リンクのコピーリンクがクリップボードにコピーされました!
operator ベースのインストールで、APIcast を 2.12 から 2.13 にアップグレードし、APIcast が 3scale のインストールで API ゲートウェイとして機能するようにします。
手順
- 管理者権限を持つアカウントを使用して OCP コンソールにログインします。
- APIcast operator がデプロイされているプロジェクトを選択します。
- Operators > Installed Operators の順にクリックします。
- Subscription > Channel の順に移動し、Red Hat Integration - 3scale APIcast gateway を選択します。
threescale-2.13 チャンネルを選択してサブスクリプションのチャンネルを編集し、変更を保存します。
これによりアップグレードプロセスが開始されます。
すべての新しいバージョンが実行され、エラーなく準備ができていることを確認するまで、プロジェクトで Pod の状態を照会します。
oc get pods -n <apicast_namespace>
$ oc get pods -n <apicast_namespace>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注記- Pod ではアップグレードプロセス中、一時的にエラーが発生する場合があります。
- Pod のアップグレードに必要な時間は、5~10 分程度です。
APIcast オブジェクトのステータスを確認し、以下のコマンドを実行して YAML のコンテンツを取得します。
oc get apicast <myapicast> -n <apicast_namespace> -o yaml
$ oc get apicast <myapicast> -n <apicast_namespace> -o yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
上記の手順をすべて実施すると、operator ベースのデプロイメントにおける APIcast 2.12 から 2.13 へのアップグレードが完了します。