3scale の移行
3scale API Management およびそのコンポーネントの移行またはアップグレード
概要
前書き
本ガイドでは、Red Hat 3scale API Management をテンプレートベースから operator ベースのインストールに移行するための情報、3scale インストールを 2.9 から 2.10 にアップグレードするのに必要な詳細情報、および operator ベースのデプロイメントで APIcast をアップグレードする手順について説明します。
テンプレートベースから operator ベースのデプロイメントに移行するには、3scale の移行ガイド に記載の手順を参照してください。
オンプレミス型 3scale のデプロイメントを 2.9 から 2.10 にアップグレードするには、インストールのタイプに応じて以下のガイドのいずれかを参照してください。
operator ベースのデプロイメントで APIcast をアップグレードするには、operator ベースの APIcast のアップグレードガイド に記載の手順を参照してください。
多様性を受け入れるオープンソースの強化
Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、CTO である Chris Wright のメッセージ をご覧ください。
第1章 3scale の移行ガイド: テンプレートベースから operator ベースのデプロイメントへ
本セクションでは、Red Hat 3scale API Management を Red Hat OpenShift 3.11 を使用するテンプレートベースのデプロイメントから Red Hat OpenShift 4.x を使用する operator ベースのデプロイメントに移行する方法について説明します。
必要な条件および手順を理解するために、記載の手順を適用する前に、移行ガイド全体を読んでください。移行プロセスの手順が完了するまで、サービスの提供が中断されます。このサービス中断が生じるため、メンテナンス期間を設けるようにしてください。
1.1. 移行を行うための前提条件
3scale インストールをテンプレートベースから operator ベースのデプロイメントに移行する前に、以下のガイドを参照してデプロイメントがサポートされていることを確認してください。
1.2. 3scale のテンプレートベースから operator ベースのデプロイメントへの移行
移行前の基本セットアップは、3scale が OCP3 ドメインをポイントする設定です: 3scale.example.com
→ ocp3.example.com
3scale を Red Hat OpenShift 3.11 を使用するテンプレートベースのデプロイメントから Red Hat OpenShift 4.1 を使用する operator ベースのデプロイメントに移行するには、以下の手順に従います。
- テンプレートベースのデプロイメントから 3scale のバックアップを作成する。
- operator を使用して 3scale をデプロイする。
- operator ベースのデプロイメントでバックアップを復元する。
-
3scale WILDCARD_DOMAIN (ここでは
3scale.example.com
) をocp4.example.com
にポイントする。
上記の手順をすべて実施すると、3scale のテンプレートベースから operator ベースのデプロイメントへの移行が完了します。
第2章 テンプレートベースの 3scale のアップグレードガイド: 2.9 から 2.10 へ
本セクションでは、テンプレートベースのデプロイメントにおいて、Red Hat 3scale API Management をバージョン 2.9 から 2.10 にアップグレードする方法について説明します。
必要な条件および手順を理解するために、記載の手順を適用する前に、アップグレードガイド全体を読んでください。アップグレードプロセスの手順が完了するまで、サービスの提供が中断されます。このサービス中断が生じるため、メンテナンス期間を設けるようにしてください。
2.1. アップグレードを行うための前提条件
本セクションでは、テンプレートベースのインストール環境において、3scale を 2.9 から 2.10 にアップグレードするのに必要な設定、タスク、およびツールについて説明します。
2.1.1. 設定
- OpenShift 3.11 上の 3scale では、テンプレートを使用した 2.9 から 2.10 へのアップグレードパスがサポートされます。
2.1.2. 主要なタスク
- OpenShift CLI ツールが 3scale をデプロイしたプロジェクトに設定されるようにする。
- 3scale で使用しているデータベースのバックアップを行う。バックアップの手順は、データベースのタイプや設定により異なります。
2.1.3. ツール
アップグレードを行うには、以下のツールが必要です。
- テンプレートを使用して OpenShift 3.11 のプロジェクトにデプロイされた 3scale 2.9
- Bash シェル: アップグレード手順で詳細を説明するコマンドを実行します。
- base64: シークレットの情報をエンコードおよびデコードします。
- jq: JSON 変換用です。
2.2. テンプレートベースのインストール環境における 2.9 から 2.10 へのアップグレード
テンプレートベースのインストール環境において、3scale 2.9 を 2.10 にアップグレードするには、本セクションに記載の手順に従います。
アップグレードを開始するには、3scale がデプロイされているプロジェクトに移動します。
$ oc project <3scale-project>
続いて、以下の順序で手順を実行します。
2.2.1. 3scale プロジェクトのバックアップの作成
前の手順
なし
現在の手順
3scale プロジェクトのバックアップを作成するのに必要なアクションを以下のリストに示します。
3scale で使用するデータベースに応じて、${SYSTEM_DB} を以下のいずれかの値に設定します。
-
データベースが MySQL の場合:
SYSTEM_DB=system-mysql
-
データベースが PostgreSQL の場合:
SYSTEM_DB=system-postgresql
-
データベースが MySQL の場合:
既存の DeploymentConfigs でバックアップファイルを作成します。
$ THREESCALE_DC_NAMES="apicast-production apicast-staging backend-cron backend-listener backend-redis backend-worker system-app system-memcache ${SYSTEM_DB} system-redis system-sidekiq system-sphinx zync zync-database zync-que" for component in ${THREESCALE_DC_NAMES}; do oc get --export -o yaml dc ${component} > ${component}_dc.yml ; done
export all
コマンドでエクスポートされるプロジェクト内のすべての既存 OpenShift リソースをバックアップします。$ oc get -o yaml --export all > threescale-project-elements.yaml
export all
コマンドでエクスポートされない追加の要素でバックアップファイルを作成します。$ for object in rolebindings serviceaccounts secrets imagestreamtags cm rolebindingrestrictions limitranges resourcequotas pvc templates cronjobs statefulsets hpa deployments replicasets poddisruptionbudget endpoints do oc get -o yaml --export $object > $object.yaml done
- 生成されたすべてのファイルが空ではないこと、およびそれらすべての内容が予想どおりであることを確認します。
次の手順
2.2.2. 3scale のバージョン番号の更新
現在の手順
この手順では、system-environment
ConfigMap の 3scale のリリースバージョン番号を 2.9 から 2.10 に更新します。AMP_RELEASE は、一部の DeploymentConfig コンテナー環境で参照される ConfigMap のエントリーです。
AMP_RELEASE にパッチを適用するには、以下のコマンドを実行します。
$ oc patch cm system-environment --patch '{"data": {"AMP_RELEASE": "2.10"}}'
system-environment ConfigMap の AMP_RELEASE キーの値が
2.10
であることを確認します。$ oc get cm system-environment -o json | jq '.data["AMP_RELEASE"]'
次のステップ
2.2.3. 3scale イメージのアップグレード
前の手順
現在の手順
この手順では、アップグレードプロセスに必要な 3scale イメージを更新します。
2.2.3.1. system
イメージのパッチ
新しいイメージストリームタグを作成します。
$ oc patch imagestream/amp-system --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "AMP system 2.10"}, "from": { "kind": "DockerImage", "name": "registry.redhat.io/3scale-amp2/system-rhel7:3scale2.10"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
手順を進めるには、ご自分の 3scale デプロイメントで使用しているデータベースを考慮してください。
- データベースが Oracle DB の場合は、「システムイメージへのパッチ適用: 3scale が Oracle Database を使用する場合」に記載の手順に従ってください。
- データベースが Oracle DB 以外の場合は、「システムイメージへのパッチ適用: 3scale がその他のデータベースを使用する場合」に記載の手順に従ってください。
2.2.3.1.1. システムイメージへのパッチ適用: 3scale が Oracle Database を使用する場合
- Oracle Database を使用して 3scale のシステムイメージのパッチ適用を開始するには、Oracle 19c を使用した 3scale 2.9 から 2.10 へのアップグレード に記載の手順を実行します。
system-app ImageChange トリガーにパッチを適用します。
古い
2.9-oracle
トリガーを削除します。$ oc set triggers dc/system-app --from-image=amp-system:2.9-oracle --containers=system-master,system-developer,system-provider --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-app --from-image=amp-system:2.10-oracle --containers=system-master,system-developer,system-provider
これがトリガーとなり
system-app
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
system-sidekiq
ImageChange トリガーにパッチを適用します。古い
2.9-oracle
トリガーを削除します。$ oc set triggers dc/system-sidekiq --from-image=amp-system:2.9-oracle --containers=system-sidekiq,check-svc --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-sidekiq --from-image=amp-system:2.10-oracle --containers=system-sidekiq,check-svc
これがトリガーとなり
system-sidekiq
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
system-sphinx
ImageChange トリガーにパッチを適用します。古い
2.9-oracle
トリガーを削除します。$ oc set triggers dc/system-sphinx --from-image=amp-system:2.9-oracle --containers=system-sphinx,system-master-svc --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-sphinx --from-image=amp-system:2.10-oracle --containers=system-sphinx,system-master-svc
これがトリガーとなり
system-sphinx
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
- 3scale をスケールダウンした場合は、元に戻します。
2.2.3.1.2. システムイメージへのパッチ適用: 3scale がその他のデータベースを使用する場合
system-app
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/system-app --from-image=amp-system:2.9 --containers=system-master,system-developer,system-provider --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-app --from-image=amp-system:2.10 --containers=system-master,system-developer,system-provider
これがトリガーとなり
system-app
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
system-sidekiq
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/system-sidekiq --from-image=amp-system:2.9 --containers=system-sidekiq,check-svc --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-sidekiq --from-image=amp-system:2.10 --containers=system-sidekiq,check-svc
これがトリガーとなり
system-sidekiq
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
system-sphinx
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/system-sphinx --from-image=amp-system:2.9 --containers=system-sphinx,system-master-svc --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-sphinx --from-image=amp-system:2.10 --containers=system-sphinx,system-master-svc
これがトリガーとなり
system-sphinx
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
2.2.3.2. apicast
イメージのパッチ
amp-apicast
イメージストリームにパッチを適用します。$ oc patch imagestream/amp-apicast --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "AMP APIcast 2.10"}, "from": {"kind": "DockerImage", "name": "registry.redhat.io/3scale-amp2/apicast-gateway-rhel8:3scale2.10"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
apicast-staging
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/apicast-staging --from-image=amp-apicast:2.9 --containers=apicast-staging --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/apicast-staging --from-image=amp-apicast:2.10 --containers=apicast-staging
これがトリガーとなり
apicast-staging
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
apicast-production
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/apicast-production --from-image=amp-apicast:2.9 --containers=apicast-production,system-master-svc --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/apicast-production --from-image=amp-apicast:2.10 --containers=apicast-production,system-master-svc
これがトリガーとなり
apicast-production
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
2.2.3.3. backend
イメージのパッチ
amp-backend
イメージストリームにパッチを適用します。$ oc patch imagestream/amp-backend --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "AMP Backend 2.10"}, "from": {"kind": "DockerImage", "name": "registry.redhat.io/3scale-amp2/backend-rhel7:3scale2.10"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
backend-listener
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/backend-listener --from-image=amp-backend:2.9 --containers=backend-listener --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/backend-listener --from-image=amp-backend:2.10 --containers=backend-listener
これがトリガーとなり
backend-listener
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
backend-worker
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/backend-worker --from-image=amp-backend:2.9 --containers=backend-worker,backend-redis-svc --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/backend-worker --from-image=amp-backend:2.10 --containers=backend-worker,backend-redis-svc
これがトリガーとなり
backend-worker
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
backend-cron
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/backend-cron --from-image=amp-backend:2.9 --containers=backend-cron,backend-redis-svc --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/backend-cron --from-image=amp-backend:2.10 --containers=backend-cron,backend-redis-svc
これがトリガーとなり
backend-cron
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
2.2.3.4. zync
イメージへのパッチ適用
amp-zync
イメージストリームにパッチを適用します。$ oc patch imagestream/amp-zync --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "AMP Zync 2.10"}, "from": { "kind": "DockerImage", "name": "registry.redhat.io/3scale-amp2/zync-rhel7:3scale2.10"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
zync
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/zync --from-image=amp-zync:2.9 --containers=zync,zync-db-svc --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/zync --from-image=amp-zync:2.10 --containers=zync,zync-db-svc
これがトリガーとなり
zync
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
zync-que
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/zync-que --from-image=amp-zync:2.9 --containers=que --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/zync-que --from-image=amp-zync:2.10 --containers=que
これがトリガーとなり
zync-que
が再デプロイされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
2.2.3.5. system-memcached
イメージのパッチ
system-memcached
イメージストリームにパッチを適用します。$ oc patch imagestream/system-memcached --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "System 2.10 Memcached"}, "from": { "kind": "DockerImage", "name": "registry.redhat.io/3scale-amp2/memcached-rhel7:3scale2.10"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
system-memcache
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/system-memcache --from-image=system-memcached:2.9 --containers=memcache --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-memcache --from-image=system-memcached:2.10 --containers=memcache
これにより、
system-memcache
DeploymentConfig の再デプロイメントがトリガーされます。再デプロイが完了し、対応する新規 Pod が使用できる状態になり、古い Pod が終了するまで待ちます。
2.2.3.6. zync-database-postgresql
イメージのパッチ
zync-database-postgresql
イメージストリームにパッチを適用します。$ oc patch imagestream/zync-database-postgresql --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "Zync 2.10 PostgreSQL"}, "from": { "kind": "DockerImage", "name": "registry.redhat.io/rhscl/postgresql-10-rhel7"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
このパッチコマンドにより
zync-database-postgresql
イメージストリームが更新され、2.10 タグが含まれるようになります。以下の手順により、2.10 タグが作成されていることを確認することができます。実行コマンド
$ oc get is zync-database-postgresql
- Tags 欄に 2.10 タグが表示されていることを確認します。
zync-database
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/zync-database --from-image=zync-database-postgresql:2.9 --containers=postgresql --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/zync-database --from-image=zync-database-postgresql:2.10 --containers=postgresql
イメージに新しい更新があれば、このパッチがトリガーとなり
zync-database
DeploymentConfig も再デプロイされます。その場合は、新規 Pod の再デプロイが完了して使用できる状態になり、古い Pod が終了するまで待ちます。
2.2.3.7. その他のイメージの変更
3scale 2.10 のインストール環境で以下の DeploymentConfig の 1 つまたは複数が利用可能な場合は、該当するリンクをクリックして詳細な操作手順を確認してください。
backend-redis
DeploymentConfig
現在の 3scale インストール環境に backend-redis
DeploymentConfig が存在する場合は、backend-redis
用の redis
イメージにパッチを適用します。
backend-redis
イメージストリームにパッチを適用します。$ oc patch imagestream/backend-redis --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "Backend 2.10 Redis"}, "from": { "kind": "DockerImage", "name": "registry.redhat.io/rhscl/redis-32-rhel7:3.2"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
このパッチにより backend-redis イメージストリームが更新され、2.10 タグが含まれるようになります。以下のコマンドにより Tags 欄に 2.10 が表示されれば、タグが作成されていることを確認することができます。
$ oc get is backend-redis
backend-redis
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/backend-redis --from-image=backend-redis:2.9 --containers=backend-redis --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/backend-redis --from-image=backend-redis:2.10 --containers=backend-redis
イメージに新しい更新があれば、このパッチがトリガーとなり
backend-redis
DeploymentConfig も再デプロイされます。その場合は、新規 Pod の再デプロイが完了して使用できる状態になり、古い Pod が終了するまで待ちます。
system-redis
DeploymentConfig
現在の 3scale インストール環境に system-redis
DeploymentConfig が存在する場合は、system-redis
用の redis
イメージにパッチを適用します。
system-redis
イメージストリームにパッチを適用します。$ oc patch imagestream/system-redis --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "System 2.10 Redis"}, "from": { "kind": "DockerImage", "name": "registry.redhat.io/rhscl/redis-32-rhel7:3.2"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
このパッチにより
system-redis
イメージストリームが更新され、2.10 タグが含まれるようになります。以下のコマンドにより Tags 欄に 2.10 が表示されれば、タグが作成されていることを確認することができます。$ oc get is system-redis
system-redis
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/system-redis --from-image=system-redis:2.9 --containers=system-redis --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-redis --from-image=system-redis:2.10 --containers=system-redis
イメージに新しい更新があれば、このパッチがトリガーとなり
system-redis
DeploymentConfig も再デプロイされます。その場合は、新規 Pod の再デプロイが完了して使用できる状態になり、古い Pod が終了するまで待ちます。
system-mysql
DeploymentConfig
現在の 3scale インストール環境に system-mysql
DeploymentConfig が存在する場合は、system-mysql
用の MySQL イメージにパッチを適用します。
system-mysql
イメージストリームにパッチを適用します。$ oc patch imagestream/system-mysql --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "System 2.10 MySQL"}, "from": { "kind": "DockerImage", "name": "registry.redhat.io/rhscl/mysql-57-rhel7:5.7"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
このパッチにより
system-mysql
イメージストリームが更新され、2.10 タグが含まれるようになります。以下のコマンドにより Tags 欄に 2.10 が表示されれば、タグが作成されていることを確認することができます。$ oc get is system-mysql
system-mysql
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/system-mysql --from-image=system-mysql:2.9 --containers=system-mysql --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-mysql --from-image=system-mysql:2.10 --containers=system-mysql
イメージに新しい更新があれば、このパッチがトリガーとなり
system-mysql
DeploymentConfig も再デプロイされます。その場合は、新規 Pod の再デプロイが完了して使用できる状態になり、古い Pod が終了するまで待ちます。
system-postgresql
DeploymentConfig
現在の 3scale インストール環境に system-postgresql
DeploymentConfig が存在する場合は、system-postgresql
用の PostgreSQL イメージにパッチを適用します。
system-postgresql
イメージストリームにパッチを適用します。$ oc patch imagestream/system-postgresql --type=json -p '[{"op": "add", "path": "/spec/tags/-", "value": {"annotations": {"openshift.io/display-name": "System 2.10 PostgreSQL"}, "from": { "kind": "DockerImage", "name": "registry.redhat.io/rhscl/postgresql-10-rhel7"}, "name": "2.10", "referencePolicy": {"type": "Source"}}}]'
このパッチにより
system-postgresql
イメージストリームが更新され、2.10 タグが含まれるようになります。以下のコマンドにより Tags 欄に 2.10 が表示されれば、タグが作成されていることを確認することができます。$ oc get is system-postgresql
system-postgresql
ImageChange トリガーにパッチを適用します。古い
2.9
トリガーを削除します。$ oc set triggers dc/system-postgresql --from-image=system-postgresql:2.9 --containers=system-postgresql --remove
新しいバージョン固有のトリガーを追加します。
$ oc set triggers dc/system-postgresql --from-image=system-postgresql:2.10 --containers=system-postgresql
イメージに新しい更新があれば、このパッチがトリガーとなり
system-postgresql
DeploymentConfig も再デプロイされます。その場合は、新規 Pod の再デプロイが完了して使用できる状態になり、古い Pod が終了するまで待ちます。
2.2.3.8. イメージの URL の確認
DeploymentConfig のすべてのイメージ URL に、各 URL アドレスの最後に追加されたハッシュと共に新しいイメージレジストリーの URL が含まれていることを確認します。
$ THREESCALE_DC_NAMES="apicast-production apicast-staging backend-cron backend-listener backend-redis backend-worker system-app system-memcache system-mysql system-redis system-sidekiq system-sphinx zync zync-database zync-que" for component in ${THREESCALE_DC_NAMES}; do echo -n "${component} image: " && oc get dc $component -o json | jq .spec.template.spec.containers[0].image ; done
次のステップ
なし。上記の手順をすべて実施すると、テンプレートベースのデプロイメントにおける 3scale 2.9 から 2.10 へのアップグレードが完了します。
2.3. テンプレートベースのインストール環境での Oracle Database を使用した 3scale のアップグレード
本セクションでは、OpenShift 3.11 とテンプレートベースのインストール環境の組み合わせにおいて、Oracle Database で 3scale システムイメージを使用している場合に、Red Hat 3scale API Management をアップグレードする方法について説明します。
前提条件
Oracle Database を使用した 3scale インストール環境。Oracle Database を使用した 3scale システムイメージの設定 を参照してください。
テンプレートベースのインストール環境で Oracle Database を使用して 3scale のシステムイメージをアップグレードするには、以下の手順を実行します。
2.3.1. Oracle 19c を使用した 3scale のアップグレード
以下の手順では、Oracle Database 19c の更新、既存の 3scale 2.9 インストール環境から 3scale 2.10 への変更について説明します。
重要: データベースへの接続が失われると、3scale が破損する可能性があります。アップグレードを進める前にバックアップを作成します。公式の Oracle Database のドキュメント Database Backup and Recovery User's Guide を参照してください。
前提条件
- 3scale 2.9 のインストール
Oracle Database 19c のインストール
- Oracle を使用した 3scale の設定に関する詳細は、Oracle Database の準備 を参照してください。
手順
3scale 2.10 用の OpenShift テンプレート のクローンを作成します。
$ git clone --branch 3scale-2.10.0-GA https://github.com/3scale/3scale-amp-openshift-templates.git
-
Oracle Database の Instant Client パッケージファイルを
3scale-amp-openshift-templates/amp/system-oracle/oracle-client-files
ディレクトリーに置きます。 -f
オプションでbuild.yml
OpenShift テンプレートを指定して、oc process
コマンドを実行します。$ oc process -f build.yml | oc apply -f -
-f
オプションでamp.yml
OpenShift テンプレートを指定し、-p
オプションでWILDCARD_DOMAIN
パラメーターに OpenShift クラスターのドメインを指定して、oc new-app
コマンドを実行します。$ oc new-app -f amp.yml -p WILDCARD_DOMAIN=mydomain.com
注記以下の手順は任意です。インストール後やシステムアップグレード後に
ORACLE_SYSTEM_PASSWORD
を削除する場合に使用します。以下の
oc patch
コマンドを入力します。SYSTEM_PASSWORD
はOracle Database の準備 で設定した Oracle Database の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 $ oc patch dc/system-app -p '{"spec": {"strategy": {"rollingParams": {"post":{"execNewPod": {"env": [{"name": "ORACLE_SYSTEM_PASSWORD", "value": "SYSTEM_PASSWORD"}]}}}}}}'
以下のコマンドを入力します。
DATABASE_URL
はOracle Database の準備で指定した Oracle Database を参照するように置き換えます。$ oc patch secret/system-database -p '{"stringData": {"URL": "DATABASE_URL"}}'
oc start-build
コマンドを入力し、新しいシステムイメージをビルドします。$ oc start-build 3scale-amp-system-oracle --from-dir=.
ビルドが完了するまで待ちます。ビルドの状態を確認するには、以下のコマンドを実行します。
$ oc get build <build-name> -o jsonpath="{.status.phase}"
- ビルドが Complete の状態になるまで待ちます。
Oracle Database で 3scale システムイメージを設定したら、
system-app
DeploymentConfig からORACLE_SYSTEM_PASSWORD
を削除します。新しいバージョンの 3scale にアップグレードするまで、もう一度は必要ありません。$ oc set env dc/system-app ORACLE_SYSTEM_PASSWORD-
関連情報
3scale と Oracle Database のサポートについては、Red Hat 3scale API Management Supported Configurations を参照してください。
第3章 operator ベースの 3scale のアップグレードガイド: 2.9 から 2.10 へ
本セクションでは、operator ベースのデプロイメントにおいて、Red Hat 3scale API Management をバージョン 2.9 から 2.10 にアップグレードする方法について説明します。
3scale のマイクロリリースを自動的に取得するには、自動更新が有効であることを確認してください。これを確認するには、Setting up the 3scale operator for micro releases を参照してください。
必要な条件および手順を理解するために、記載の手順を適用する前に、アップグレードガイド全体を読んでください。アップグレードプロセスの手順が完了するまで、サービスの提供が中断されます。このサービス中断が生じるため、メンテナンス期間を設けるようにしてください。
3.1. アップグレードを行うための前提条件
本セクションでは、operator ベースのインストール環境において、3scale を 2.9 から 2.10 にアップグレードするのに必要な設定について説明します。
- 3scale operator によりデプロイされている 3scale 2.9
- OpenShift Container Platform (OCP) 4.x クラスターおよびその管理者アクセス
3.2. operator ベースのインストール環境における 2.9 から 2.10 へのアップグレード
operator ベースのデプロイメントにおいて、3scale をバージョン 2.9 から 2.10 にアップグレードするには、以下の手順を実施します。
- 管理者権限を持つアカウントを使用して OCP コンソールにログインします。
- 3scale-operator がデプロイされているプロジェクトを選択します。
- Operators > Installed Operators の順にクリックします。
- Red Hat Integration - 3scale > Subscription > Channel の順に選択します。
threescale-2.10 を選択してサブスクリプションのチャンネルを編集し、変更を保存します。
- これによりアップグレードプロセスが開始されます。
- APIManager のアップグレードプロセスが終了するまで待ちます。
プロジェクトの Pod ステータスのクエリーを行います。
oc get pods
- すべての新しいバージョンが動作して使用できる状態になり、エラーが無くなるまで待ちます。
アップグレードプロセス中、一時的にエラーが発生する場合があります。
注記所要時間はおよそ 5 - 10 分間の範囲で幅があります。すべての Pod が動作して使用できる状態になり、エラーが無くなるまで、Pod の状態確認を続けてください。
- 3scale 管理ポータルにログインして期待通りに動作することを確認し、アップグレードプロセスが正常に完了したことを確認します。
APIManager オブジェクトのステータスを確認し、以下のコマンドを実行して YAML のコンテンツを取得します。
oc get apimanager <myapimanager> -o yaml
新しいアノテーションおよび値は以下のようになります。
apps.3scale.net/apimanager-threescale-version: "2.10" apps.3scale.net/threescale-operator-version: "0.7.0"
上記の手順をすべて実施すると、operator ベースのデプロイメントにおける 3scale 2.9 から 2.10 へのアップグレードが完了します。
第4章 operator ベースの APIcast のアップグレードガイド: 2.9 から 2.10 へ
本セクションでは、operator ベースのデプロイメントにおいて、APIcast をバージョン 2.9 から 2.10 にアップグレードする方法について説明します。
必要な条件および手順を理解するために、記載の手順を適用する前に、アップグレードガイド全体を読んでください。アップグレードプロセスの手順が完了するまで、サービスの提供が中断されます。このサービス中断が生じるため、メンテナンス期間を設けるようにしてください。
4.1. アップグレードを行うための前提条件
本セクションでは、operator ベースのインストール環境において、APIcast を 2.9 から 2.10 にアップグレードするのに必要な設定について説明します。
- APIcast operator によりデプロイされている APIcast 2.9
- OpenShift Container Platform (OCP) 4.x クラスターおよびその管理者アクセス
4.2. operator ベースのインストール環境における APIcast 2.9 から 2.10 へのアップグレード
operator ベースのデプロイメントにおいて、APIcast をバージョン 2.9 から 2.10 にアップグレードするには、以下の手順を実施します。
- 管理者権限を持つアカウントを使用して OCP コンソールにログインします。
- APIcast operator がデプロイされているプロジェクトを選択します。
- Operators > Installed Operators の順にクリックします。
- Subscription > Channel の順に移動し、Red Hat Integration - 3scale APIcast gateway を選択します。
threescale-2.10 チャンネルを選択してサブスクリプションのチャンネルを編集し、変更を保存します。
- これによりアップグレードプロセスが開始されます。
- APIcast のアップグレードプロセスが終了するまで待ちます。
プロジェクトの Pod ステータスのクエリーを行います。
oc get pods
- すべての新しいバージョンが動作して使用できる状態になり、エラーが無くなるまで待ちます。
アップグレードプロセス中、一時的にエラーが発生する場合があります。
注記所要時間はおよそ 5 - 10 分間の範囲で幅があります。すべての Pod が動作して使用できる状態になり、エラーが無くなるまで、Pod の状態確認を続けてください。
APIcast オブジェクトのステータスを確認し、以下のコマンドを実行して YAML のコンテンツを取得します。
oc get apicast <myapicast> -o yaml
新しいアノテーションおよび値は以下のようになります。
apicast.apps.3scale.net/operator-version: “0.4.0”
上記の手順をすべて実施すると、operator ベースのデプロイメントにおける APIcast 2.9 から 2.10 へのアップグレードが完了します。