2.2. OpenShift への 3scale operator のインストール


注記

3scale は、直近 2 つの OpenShift Container Platform (OCP) 一般提供 (GA) リリースをサポートします。詳細は、Red Hat 3scale API Management のサポート対象構成 のアーティクル記事を参照してください。

本セクションでは、以下の項目の実施方法について説明します。

  • 新しいプロジェクトを作成する。
  • Red Hat 3scale API Management インスタンスをデプロイする。
  • Operator Lifecycle Manager (OLM) を使用して 3scale operator をインストールする。
  • operator をデプロイした後にカスタムリソースをデプロイする。

前提条件

  • 管理者権限を持つアカウントを使用して、サポート対象バージョンの OpenShift Container Platform 4 クラスターにアクセスできる。

警告

3scale operator とカスタムリソース定義 (CRD) は、新たに作成した空の プロジェクト にデプロイしてください。インフラストラクチャーが含まれる既存のプロジェクトにデプロイすると、既存の要素が変更または削除されることがあります。

OpenShift に 3scale operator をインストールするには、以下のセクションに概略を示す手順を実施します。

2.2.1. 新しい OpenShift プロジェクトの作成

以下の手順で、3scale-project という新しい OpenShift プロジェクトを作成する方法について説明します。このプロジェクト名を実際のプロジェクト名に置き換えてください。

手順

新しい OpenShift プロジェクトを作成するには、以下の手順を実施します。

  • 英数字とダッシュを使用して、有効な名前を指定します。たとえば、以下のコマンドを実行して 3scale-project を作成します。

    $ oc new-project 3scale-project

これにより、operator、APIManager カスタムリソース (CR)、および Capabilities カスタムリソースがインストールされる新しい OpenShift プロジェクト が作成されます。operator は、そのプロジェクトの OLM を通じてカスタムリソースを管理します。

2.2.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 の使用 に記載の手順に従ってください。

前提条件

手順

  1. OpenShift Container Platform コンソールにおいて、管理者権限を持つアカウントを使用してログインします。

    注記

    メニュー構造は、使用している OpenShift のバージョンによって異なります。

  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 と表示されます。

ネットワークが制限された環境で OCP を使用する場合、ここに示す手順に加えて、3scale 開発者ポータルで使用する許可されるドメインのリストを作成します。以下の例を参照してください。

  • 開発者ポータルに追加するすべてのリンク
  • GitHub などのサードパーティー SSO プロバイダーを使用した SSO インテグレーション
  • 請求
  • 外部 URL をトリガーする Webhook

2.2.2.1. ネットワーク接続が得られない環境における制約

ネットワーク接続が得られない環境の 3scale 2.13 に対する現在の制約の概要を、以下のリストに示します。

  • 開発者ポータルへの GitHub ログインができない
  • サポートのリンクが機能しない
  • 外部ドキュメントへのリンクが機能しない
  • 開発者ポータルの OpenAPI Specification (OAS) 検証ツールが機能しない (これにより、外部サービスへのリンクが影響を受けます)
  • ActiveDocs の製品 Overview ページにおいて、OAS へのリンクが機能しない

    • 新たな ActiveDocs 仕様を作成する場合、オプション Skip swagger validations を選択する必要もあります。

関連情報

2.2.3. OLM を使用した 3scale operator のアップグレード

Operator ベースのデプロイメントで、1 つの namespace から全 namespace のクラスター全体のインストールに、3scale Operator をアップグレードするには、その namespace から 3scale Operator を削除してから、クラスター上にその Operator を再インストールする必要があります。

クラスター管理者は Web コンソールを使用して、選択した namespace からインストールされた Operator を削除できます。Operator をアンインストールしても、既存の 3scale インスタンスはアンインストールされません。

3scale Operator を namespace からアンインストールしたら、OLM を使用してクラスター全体のモードで Operator をインストールできます。

前提条件

  • namespace の削除パーミッションがある 3scale 管理者権限または OpenShift ロール。

手順

  1. OpenShift Container Platform コンソールにおいて、管理者権限を持つアカウントを使用してログインします。

    注記

    メニュー構造は、使用している OpenShift のバージョンによって異なります。

  2. Operators > OperatorHub の順にクリックします。インストール済みの Operator ページが表示されます。
  3. 3scaleFilter 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 StatusUp to date と表示されていることを確認します。
  15. 3scale operator の ClusterServiceVersion (CSV) が表示されることを確認します。

関連情報

2.2.3.1. マイクロリリースの自動アプリケーションの設定

自動更新を取得するには、3scale operator の承認ストラテジーが Automatic に設定されている必要があります。これにより、マイクロリリースの更新を自動的に適用できます。ここでは、AutomaticManual の設定の違いを説明し、もう 1 つから別の設定に変更する手順を説明します。

自動および手動:

  • インストール時に、デフォルトで Automatic 設定が選択されたオプションになります。新規更新のインストールは、更新が利用可能になると行われます。これは、インストール時または後にいつでも変更できます。
  • インストール時に 手動 オプションを選択するか、その後のいつでも手動オプションを選択すると、更新が利用可能になった時点で受信されます。次に、インストール計画 を承認し、独自に適用する必要があります。

手順

  1. Operators > Installed Operators の順にクリックします。
  2. Installed Operators のリストから 3scale API Management をクリックします。
  3. Subscription タブをクリックします。Subscription Details の見出しの下に、小見出しの Approval が表示されます。
  4. Approval の下のリンクをクリックします。リンクはデフォルトで Automatic に設定されます。小見出しのモーダル (Change Update Approval Strategy) が表示されます。
  5. 選択するオプション Automatic (デフォルト) または Manual を選択し、Save をクリックします。

関連情報

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.