クラスターの管理

OpenShift Cluster Manager 2021-02

OpenShift Cluster Manager を使用した OpenShift クラスターとの対話

Red Hat Customer Content Services

概要

以下では、OpenShift Cluster Manager を使用して OpenShift Container Platform および OpenShift Dedicated クラスターと連携する方法を説明します。OpenShift Cluster Manager を使用すると、単一ユーザーインターフェースからさまざまな種類の OpenShift クラスターを作成し、サブスクライブし、管理することができます。

第1章 OpenShift Cluster Manager の概要

OpenShift Cluster Manager は、Red Hat OpenShift 4 クラスターをインストールし、操作し、アップグレードできる管理サービスです。OpenShift Cluster Manager は、OpenShift Container Platform クラスターをインストールするためのリンクおよび手順を提供し、セルフインストール後に OpenShift Container Platform クラスターおよび OpenShift Dedicated クラスターの両方を管理します。

OpenShift Cluster Manager では、単一のダッシュボードから組織の OpenShift Container Platform および OpenShift マネージドクラスターをすべて操作できます。

OpenShift Cluster Manager からは、以下のことができます。

  • 高レベルのクラスター情報の表示
  • Red Hat サブスクリプションサービスへのクラスターの登録、および権利の付与
  • 新規クラスターの作成
  • Red Hat クラウドプラットフォーム で他のサービスを使用したクラスターの管理
  • クラスターで問題の有無の監視
  • クラスター管理コンソールへのアクセス

OpenShift Cluster Manager にアクセスするには、https://cloud.redhat.com/openshift/ に移動します。

追加リソース

これらの関連製品およびサービスに関するドキュメントは、以下を参照してください。

1.1. OpenShift Container Platform と OpenShift Dedicated の相違点

OpenShift Container Platform クラスターは自己管理型であり、オンプレミスまたはクラウドプロバイダーで実行します。OpenShift Dedicated クラスターは Red Hat によって管理され、クラウドプロバイダーで実行されます。

OpenShift Container Platform は自己管理のハイブリッドクラウドプラットフォームです。OpenShift Container Platform では、独自のインフラストラクチャーを使用して、クラスターをプライベートクラウド、パブリッククラウド、またはベアメタルに作成できます。

OpenShift Dedicated は、Amazon Web Services (AWS) または Google Cloud Platform を使用する Red Hat OpenShift の完全に管理されたサービスです。OpenShift Dedicated では、Red Hat の管理クラウドアカウント、または独自の AWS または Google Cloud Platform (GCP) クラウドプロバイダーアカウントでクラスターを実行できます。OpenShift Dedicated クラスターは マネージドクラスター と呼ばれます。

OpenShift Cluster Manager を使用すると、1 つのダッシュボードから OpenShift Container Platform クラスターおよび OpenShift Dedicated クラスターを作成し、管理できます。

追加リソース

1.2. OpenShift Container Platform での OpenShift Cluster Manager の使用

OpenShift Cluster Manager は、OpenShift Container Platform クラスターを作成し、サポートのために Red Hat にクラスターをサブスクライブするためのユーザーインターフェースを提供します。

OpenShift Cluster Manager には、OpenShift Container Platform のサポートされる各環境でクラスターを作成するためのインストーラーおよび手順が記載されています。

次に、OpenShift Cluster Manager で OpenShift Container Platform クラスターを表示して管理するか、または OpenShift Container Platform Web コンソールにログインしてクラスターにアクセスし、設定できます。

追加リソース

1.3. OpenShift Dedicated での OpenShift Cluster Manager の使用

OpenShift Cluster Manager は、OpenShift Dedicated クラスターを作成し、表示し、管理するためのユーザーインターフェースを提供します。

OpenShift Dedicated クラスターは Red Hat によって管理され、マネージドクラスター として知られています。Red Hat の管理クラウドアカウントまたは独自のクラウドプロバイダーアカウントを使用して、AWS または Google Cloud Platform で OpenShift Dedicated クラスターを作成できます。独自のクラウドプロバイダーアカウントを使用する場合、この請求モデルは OpenShift Cluster Manager では Customer Cloud Subscription (CCS) と呼ばれます。

追加リソース

1.4. クラウドプラットフォームでの OpenShift Cluster Manager の使用

OpenShift Cluster Manager は、Red Hat の クラウドプラットフォーム でホストされる他のサービスと統合されるため、他のサービスを使用して OpenShift クラスターを管理して理解を深めることができます。

  • OpenShift 向けの Red Hat Insights は、OpenShift Container Platform クラスターの正常性を監視し、セキュリティー、パフォーマンス、可用性、および安定性に対するリスクを特定し、優先順位を付け、解決するのに役立ちます。OpenShift の Red Hat Insights にアクセスするには、OpenShift Cluster Manager (https://cloud.redhat.com/openshift/) でクラスターを選択し、Insights タブを表示します。
  • Subscription Watch を使用すると、OpenShift Container Platform クラスターの Red Hat サブスクリプションを管理できます。https://cloud.redhat.com/subscriptions/openshift-sw から OpenShift の Subscription Watch にアクセスします。
  • コスト管理 は、AWS や Microsoft Azure を含むベアメタルサーバー、仮想マシン、プライベートクラウド、およびパブリッククラウドインフラストラクチャー全体の OpenShift デプロイメントおよびインフラストラクチャーのコストが集められ、表示します。https://cloud.redhat.com/cost-management からコスト管理にアクセスします。

OpenShift Cluster Manager およびクラウドプラットフォームにアクセスするには、Red Hat アカウントが必要です。その後、OpenShift Container Platform クラスターを OpenShift Cluster Manager にデプロイできます。Red Hat サブスクリプションをお持ちでない場合は、OpenShift クラスターには評価版のエンタイトルメントが付与されます。

追加リソース

1.5. ocm-cli コマンドラインツールでの OpenShift Cluster Manager の使用

OpenShift Cluster Manager ユーザーインターフェースの他に、OpenShift Cluster Manager コマンドラインインターフェース (CLI) (ocm-cli) を使用してマネージドクラスターを作成または削除し、API を使用してクラスターの情報を取得できます。ocm-cli ツールは、api.openshift.com で利用可能な OpenShift Cluster Manager API の使用を簡素化します。

ocm-cli ツールをインストールするには、お使いの環境の手順について ocm-cli ドキュメント を参照してください。

ocm-cli のインストール後に、https://cloud.redhat.com/openshift/token にある OpenShift Cluster Manager のオフラインアクセストークンを使用して OpenShift Cluster Manager にログインする必要があります。

追加リソース

第2章 クラスターのライフサイクルの管理

OpenShift Cluster Manager または ocm-cli コマンドラインツールを使用して、OpenShift クラスターを作成および削除し、クラスターライフサイクルを管理できます。

2.1. クラスターの作成

2.1.1. OpenShift Dedicated クラスターの作成

OpenShift Dedicated クラスターは Red Hat によって管理され、Amazon Web Services または Google Cloud Platform でプロビジョニングされます。このポリシーは、マネージドクラスター と呼ばれます。

独自の AWS または Google Cloud Platform クラウドプロバイダー (Customer Cloud Subscription) で OpenShift Dedicated クラスターを作成するか、Red Hat の完全に管理されたクラウドを使用して OpenShift Dedicated クラスターを実行できます。

前提条件

  • Red Hat ログイン
  • アクティブな Red Hat OpenShift Dedicated サブスクリプション詳細は、https://www.openshift.com/products/dedicated/ を参照してください。
  • 独自の AWS または Google Cloud (Customer Cloud Subscription) でクラスターを作成する場合は、クラスターを作成する前にクラウドアカウントを設定する必要があります。手順は、「Customer Cloud Subscription の要件」を参照してください。

手順

  1. https://cloud.redhat.com/openshift/ にアクセスし、Create cluster をクリックします。
  2. OpenShift Dedicated の横にある Cloud タブで、Create cluster をクリックします。この画面からクラスターを作成する前に、利用可能なクォータを表示することもできます。
  3. インフラストラクチャープロバイダーを選択して、AWS または Google Cloud でクラスターを実行します。
  4. 課金モデルを選択します。

    • 標準 は、Red Hat が所有するクラウドプロバイダーアカウントにクラスターをデプロイします。このオプションでは、Red Hat はクラスターのすべての課金と管理を処理します。
    • Customer Cloud Subscription は、独自のクラウドアカウントを使用します。ここで、請求を制御し、Red Hat はクラスターを管理します。クラスターを作成する前に、クラウドアカウントを設定する必要があります。手順は、「Customer Cloud Subscription の要件」を参照してください。
  5. 基本的なクラスター設定を行います。
  6. Create cluster をクリックしてクラスターをプロビジョニングします。

デフォルトで、OpenShift Dedicated クラスターは cloud.redhat.com/openshift で OpenShift Cluster Manager サービスに自動的に登録され、Red Hat Subscription Management のエンタイトルメントがあります。

インストールの完了後に追加のモニタリングデータがクラスターで利用可能になります。

検証手順

  • クラスターがプロビジョニングされている間は、OpenShift Cluster Manager の Clusters 一覧で確認できます。プロビジョニングが完了すると、クラスターの ステータスReady と表示されます。

次のステップ

OpenShift Dedicated クラスターを作成して、そのステータスが Ready になったら、以下を実行できます。

  • ユーザーアクセスを設定するアイデンティティープロバイダーを設定します。OpenShift Dedicated ドキュメントの『認証』参照してください。
  • クラスターの特権のある dedicated-admin ユーザーおよび cluster-admin (クラスター所有者とも呼ばれる) ユーザーを設定します。『認証』ガイドの OpenShift Dedicated ロールについて参照してください。
  • 必要なサブスクリプションを購入している場合は、OpenShift Dedicated クラスターを拡大または縮小します。手順は、「クラスターのスケーリング」を参照してください。
  • アドオンをインストールして、クラスターの機能を拡張します。

追加リソース

  • OpenShift Dedicated クラスターを作成する方法は、OpenShift Dedicated ドキュメントの「クラスターの作成」を参照してください。

2.1.2. OpenShift Container Platform クラスターの作成

OpenShift Container Platform クラスターは独自のインフラストラクチャーで実行されます。OpenShift Container Platform を使用して、コマンドラインインストーラーを使用して、プライベートクラウド、パブリッククラウド、またはベアメタルにクラスターを作成できます。

OpenShift Cluster Manager と、お使いの環境用またはクラウドアカウント用のインストーラーを使用して、クラスターを作成します。

前提条件

  • Red Hat ログイン
  • 独自のオンプレミスインフラストラクチャー。たとえば、Red Hat Virtualization や Red Hat OpenStack などのプラットフォーム、AWS などのクラウドプロバイダー、またはベアメタル Linux マシンなどです。

手順

  1. https://cloud.redhat.com/openshift/ にアクセスし、Create cluster をクリックします。
  2. クラスターをインストールする場所 (パブリッククラウド (Cloud > Run it yourself)、データセンター (Datacenter)、またはラップトップ (Sandbox)) を選択します。
  3. 提供された openshift-install プログラムをダウンロードします。
  4. プルシークレットをダウンロードします。

    重要

    プルシークレットは共有しないでください。プルシークレットはパスワードのように扱う必要があります。

  5. OpenShift Cluster Manager ユーザーインターフェースに記載されている手順に従って、OpenShift クラスターを作成します。

デフォルトでは、インストール後にクラスターの初回起動時に、クラスターは OpenShift Cluster Manager サービスに自動的に登録されます。クラスターは、サポートを含まない 60 日間の評価サブスクリプションで登録されます。

Red Hat サブスクリプションをクラスターにアタッチして、更新とサポートを受ける必要があります。手順は、「OpenShift Container Platform クラスターのサブスクライブ」を参照してください。

検証手順

  • クラスターのプロビジョニング後に、OpenShift Cluster Manager の Clusters 一覧に表示できます。

次のステップ

OpenShift Container Platform クラスターの作成後に、OpenShift Cluster Manager を使用して以下を実行できます。

  • Red Hat サブスクリプションをクラスターにアタッチして、クラスターのサポートを設定します。OpenShift Cluster Manager のクラスターの詳細ページのサブスクリプション設定を編集します。手順は、「OpenShift Container Platform クラスターのサブスクライブ」を参照してください。
  • クラスターの詳細ページからクラスターのヘルスモニタリングデータ、Insights からの推奨事項、およびクラスターの Telemetry メトリクスを表示します。
  • 問題が発生した場合は、Red Hat サポートにお問い合わせください。

追加リソース

2.1.3. ocm-cli ツールを使用したクラスターの作成

ocm-cli ツールを使用してマネージドクラスターを迅速に作成できます。

前提条件

手順

新しいマネージドクラスターを作成するには、標準入力または --body オプションで指定されたファイルのいずれかでオブジェクトの JSON 表現を指定して POST コマンドを使用します。

  1. ocm-cli ツールを使用するには、OpenShift Cluster Manager のオフラインアクセストークン (https://cloud.redhat.com/openshift/token) を使用して OpenShift Cluster Manager にログインします。

    $ ocm login --token=eyJ...

    これは、提供されたトークンを使用して OpenID アクセスを要求し、sso.redhat.com にトークンを更新します。今後の使用のために、トークンはホームディレクトリーの .ocm.json ファイルに保存されます。

  2. 以下のコマンドを実行して、<mycluster> という名前のクラスターを作成します。必要に応じて、クラスターを設定するために必要なフラグを追加します。

    $ ocm create cluster [flags] <mycluster>
    注記

    $ ocm --help を実行して、クラスターを作成するフラグおよびオプションを表示します。

ocm create cluster コマンドは、クラスター ID、およびクラスターに関するその他の情報を返します。

検証手順

クラスターは非同期的に作成され、使用する準備が整う前に作成するのに時間がかかります。ocm create cluster を実行してクラスターを作成した後に、クラスターの準備が整っていることを確認するには、state 属性を定期的に確認する必要があります。

  • クラスターが使用できる状態にあることを確認するには、クラスター ID を使用してクラスターの state を確認します。
$ ocm list cluster <id>

stateready になったら、作成プロセスが完了し、クラスターを使用できます。

追加リソース

  • ocm-cli ツールの使用方法に関する詳細は、$ ocm --help を実行するか、GitHub ページの ocm-cli を参照してください。
  • OpenShift Cluster Manager ユーザーインターフェースを使用してマネージドクラスターを作成する方法については、OpenShift Dedicated ドキュメントの「クラスターの作成」を参照してください。

2.2. クラスターの削除

2.2.1. OpenShift Cluster Manager からの OpenShift Dedicated クラスターの削除

前提条件

  • Red Hat ログイン
  • 削除する OpenShift Dedicated クラスター

手順

  1. https://cloud.redhat.com/openshift/ で、削除するクラスターを選択します。
  2. more options (その他のオプション) > Delete cluster をクリックして Delete cluster ダイアログを開きます。

    警告

    このアクションは元に戻せません。これにより、クラスターがアンインストールされ、すべてのデータが削除されます。

  3. ダイアログフィールドにクラスター名を入力し、Delete をクリックして、クラスターを削除します。

検証

  • お使いのクラスターで、Clusters ページの Status コラムに Uninstalling と表示されます。
  • クラスターの削除中、クラスターの詳細の Overview ページを開いて アンインストールログ を表示できます。

削除が完了すると、クラスターは OpenShift Cluster Manager の Clusters 一覧に表示されなくなります。

削除されたクラスターは、Clusters 一覧から more options (その他のオプション) > View cluster archives をクリックして表示できます。

追加リソース

  • ocm-cli ツールを使用して OpenShift Dedicated クラスターを削除することもできます。

2.2.2. ocm-cli ツールを使用したクラスターの削除

ocm-cli ツールを使用してマネージドクラスターを迅速に削除できます。

前提条件

手順

マネージドクラスターを削除するには、クラスター識別子で ocm delete コマンドを使用します。

  1. ocm-cli ツールを使用するには、https://cloud.redhat.com/openshift/token にある OpenShift Cluster Manager のオフラインアクセストークンを使用して OpenShift Cluster Manager にログインします。

    $ ocm login --token=eyJ...

    これは、提供されたトークンを使用して OpenID アクセスを要求し、sso.redhat.com にトークンを更新します。今後の使用のために、トークンはホームディレクトリーの .ocm.json ファイルに保存されます。

  2. クラスター ID を使用して ocm delete を実行します。

    警告

    このコマンドはクラスターを削除し、クラスターが使用しているすべての仮想マシン、ディスク、およびその他のリソースを破棄します。

    # ocm delete cluster <cluster_id>

検証手順

クラスターの削除は非同期的に行われ、クラスターを完全に削除するのに時間がかかります。

  • クラスター ID を使用して、ocm list cluster コマンドでクラスターのステータスを確認できます。
$ ocm list cluster <id>

クラスターが削除されると、このコマンドはクラスターに関する情報を返さなくなります。

追加リソース

  • ocm-cli ツールの使用方法に関する詳細は、$ ocm --help を実行するか、GitHub ページの ocm-cli を参照してください。
  • OpenShift Cluster Manager ユーザーインターフェースを使用したクラスターの削除に関する詳細は、「クラスターの削除」を参照してください。

第3章 Cluster サブスクリプション

すべての Red Hat OpenShift 機能を使用するには、クラスターを OpenShift Cluster Manager に登録し、Red Hat サブスクリプション管理へのエンタイトルメントが必要になります。

クラスターは作成後に自動的に OpenShift Cluster Manager に登録され、Red Hat サポートおよび更新へのアクセスを提供します。OpenShift Cluster Manager は、すべての既存クラスターを表示する単一のアプリケーションを提供し、クラスターのステータスおよびクラスター管理の推奨事項についての洞察を提供します。

注記

クラスターが OpenShift Cluster Manager に到達して作成されたことを OpenShift Cluster Manager に通知できないエアギャップ環境でクラスターが作成された場合、クラスターは自動的に登録されないため、切断されたクラスターとして手動で登録する必要があります。

クラスターの Red Hat サポートおよび更新にアクセスするには、Red Hat サブスクリプションを各クラスターに割り当てる必要があります。これはクラスターへのエンタイトルメント (付与) と呼ばれます。

OpenShift Container Platform クラスターには、作成時に 60 日間の Red Hat サブスクリプションが自動的に付与されます。OpenShift Container Platform クラスターを独自の Red Hat サブスクリプションにアップグレードするには、「OpenShift Container Platform クラスターのサブスクライブ」 を参照してください。

OpenShift Dedicated クラスターを作成するには、有効な Red Hat サブスクリプションを使用する必要があります。OpenShift Dedicated クラスターでサブスクリプションを設定するには、「OpenShift Dedicated クラスターサブスクリプションの管理」 を参照してください。

3.1. OpenShift Container Platform クラスターのサブスクライブ

デフォルトで、インストール後のクラスターの初回起動時に、OpenShift Container Platform クラスターは自動的に OpenShift Cluster Manager サービス (https://cloud.redhat.com/openshift/) に登録されます。

OpenShift Container Platform クラスターには、作成時に 60 日間の Red Hat サブスクリプションが自動的に付与されます。

クラスターでダウンタイムを回避するには、OpenShift Cluster Manager のクラスターサブスクリプション設定を編集して、トライアルサブスクリプションの期限が切れる前にこれを Red Hat サブスクリプションを登録する必要があります。

注記

Telemetry を無効にするか、またはクラスターが api.openshift.com に接続できない場合は、Red Hat 登録プロセスをオンライン (https://cloud.redhat.com/openshift/register) で完了することもできます。

詳細は、OpenShift Container Platform ドキュメント の「リモートヘルスレポートのオプトアウト」を参照してください。

前提条件

  • OpenShift Container Platform クラスター
  • Red Hat サブスクリプション
  • 組織管理者またはクラスター所有者の権限:

    • 組織管理者 は、お客様の Red Hat アカウントへのアクセスが許可されます。
    • クラスター所有者の権限はクラスター内で付与されます。

手順

  1. OpenShift Cluster Manager に OpenShift Container Platform クラスターを表示します。
  2. Actions > Edit subscription settings をクリックします。これは、クラスターの Overview ページの Subscription settings セクションからアクセスできます。
  3. ダイアログで、クラスターに適用されるオプションを選択します。
  4. Save settings をクリックします。

注記: Red Hat カスタマーポータルでの変更後に、クラスターのサブスクリプションステータスが OpenShift Cluster Manager で更新されるまでに最長 2 時間かかる場合があります。

検証手順

Subscription Watch でクラスターのサブスクリプションステータスを表示します。

追加リソース

3.2. OpenShift Dedicated クラスターサブスクリプションの管理

OpenShift Cluster Manager では、Red Hat サブスクリプションを使用して OpenShift Dedicated クラスターを作成できます。これらのクラスターは Red Hat によって管理されます。

OpenShift Dedicated クラスターは利用可能なクォータに基づいてプロビジョニングされます。クォータは Red Hat サブスクリプションから割り当てられ、クラスターを拡大するのに必要です。

https://cloud.redhat.com/openshift/subscriptions で、有効な OpenShift Dedicated サブスクリプションに基づいて、利用可能なクォータを確認できます。

前提条件

  • OpenShift Dedicated クラスター
  • OpenShift Dedicated ベースクラスターサブスクリプション。詳細は、Red Hat の営業部門にお問い合わせいただくか、https://www.openshift.com/products/dedicated/ を参照してください。
  • 組織管理者またはクラスター所有者の権限:

    • 組織管理者 は、お客様の Red Hat アカウントへのアクセスが許可されます。
    • クラスター所有者の権限はクラスター内で付与されます。

手順

  • OpenShift Cluster Manager で、Subscriptions メニュー (https://cloud.redhat.com/openshift/subscriptions) を選択し、組織が購入した、または Red Hat が付与した OpenShift Dedicated の全サブスクリプションの概要を表示します。要約は、OpenShift Dedicated クラスターで使用されるクォータの量も表示します。
  • Red Hat カスタマーポータルでは、サブスクリプションの詳細を https://access.redhat.com/management で確認し、必要に応じてクォータをさらに購入できます。
注記

Red Hat カスタマーポータルでの変更後に、クラスターのサブスクリプションステータスが OpenShift Cluster Manager で更新されるまでに最長 2 時間かかる場合があります。

第4章 クラスターの管理

OpenShift Cluster Manager では、OpenShift クラスターを表示し、さまざまなクラスター管理タスクを実行できます。

4.1. クラスター情報の表示

OpenShift Cluster Manager の クラスター 一覧は、組織内のすべての OpenShift Container Platform クラスターおよび OpenShift Dedicated クラスターの詳細を表示します。クラスターを選択して、その設定の確認し、使用方法の確認、問題の解決、およびその他の管理タスクの実行を行うことができます。

手順

  • 一覧からクラスターをクリックして、以下の内容を含む詳細を表示します。

    • Overview ページには、リソースの使用状況とクラスターに関する基本ファクトが表示されます。
    • クラスター履歴には、このクラスターで何が発生したかが表示されます (例: Red Hat サブスクリプションの登録およびエンタイトルメント時など)。
    • Monitoring タブには、OpenShift Container Platform クラスターの正常性が示され、Telemetry サービスを使用して OpenShift Cluster Manager でクラスターのステータスを報告します。モニタリングエリアには、クラスターの Operator が失敗する場合などに重要なアラートが表示されます。このエリアでは、リソースの使用量も表示されます。

追加リソース

  • OpenShift Cluster Manager でのクラスターのモニタリングに関する詳細は、OpenShift Container Platform ドキュメント の「接続クラスターを使用したリモートヘルスモニタリング」を参照してください。

4.1.1. クラスター ID の指定

すべての OpenShift クラスターには ID (UUID の形式) が割り当てられますが、各クラスターには OpenShift Cluster Manager で使用される内部クラスター ID もあります。必要な場合は、内部の OCM クラスター ID を人間が判読可能な名前に変更できます。

この情報は、OpenShift Cluster Manager、コマンドライン、または OpenShift Web コンソールで確認できます。

さらに、OpenShift Container Platform クラスターが OpenShift Cluster Manager に登録する時の識別情報はクラスターの UUID のみになる場合があります。複数の OCP クラスターが同時に登録された場合は、クラスターの UUID を使用してそのクラスターを分割しなければならない場合があります。

前提条件

  • OpenShift Container Platform 4.x クラスター

手順

クラスター ID を表示する方法は複数あります。

  • クラスターは、Clusters エリアの OpenShift Cluster Manager の ID で一覧表示されます。

    ここから、名前または ID でクラスターを検索し、クラスタータイプ、OpenShift Container Platform (OCP)、OpenShift Dedicated (OSD)、または Red Hat OpenShift Service on AWS (ROSA) でフィルターすることもできます。

クラスターの名前を、人間が判読可能な形式に変更するには、「クラスターの名前変更」 も参照してください。

  • (oc login を使用してクラスターにログインした後に) ローカルまたはクラスター自体で以下のコマンドを実行して、OpenShift クラスター ID を取得することもできます。
$ oc get clusterversion <version> -o jsonpath='{.spec.clusterID}{"\n"}'
  • 管理者としてログインしている場合は、OpenShift Container Platform Web コンソールで OpenShift クラスター ID を確認することもできます。

    • Home/Dashboards ページの詳細ペインで
    • Administration/Cluster Settings ページで

4.1.2. ocm-cli ツールを使用したクラスター情報の表示

OpenShift Cluster Manager コマンドラインインターフェース (ocm-cli) を使用して、API を使用してクラスターに関する情報を取得できます。

前提条件

手順

  1. ocm-cli ツールを使用するには、https://cloud.redhat.com/openshift/token にある OpenShift Cluster Manager のオフラインアクセストークンを使用して OpenShift Cluster Manager にログインします。

    $ ocm login --token=eyJ...

    これは、提供されたトークンを使用して OpenID アクセスを要求し、sso.redhat.com にトークンを更新します。今後の使用のために、トークンはホームディレクトリーの .ocm.json ファイルに保存されます。

  2. ocm get コマンドを実行して、JSON ファイルで必要な情報を取得します。

    たとえば、my で始まる名前のクラスターの一覧を取得するには、以下を実行します。

    $ ocm get /api/clusters_mgmt/v1/clusters --parameter search="name like 'my%'"
    注記
    • --parameter オプションはクエリーパラメーターを指定します。これは、get コマンドと併用するのが最も便利ですが、他のコマンドとも使用できます。各リソースでサポートされるクエリーパラメーターの詳細は、OpenShift API リファレンスドキュメント を参照してください。
    • search クエリーパラメーターは、検索をサポートするコレクションからオブジェクトを取得するのに役立ちます。このパラメーターの構文は SQL ステートメントの where 句の構文に似ていますが、テーブルのコラム名の代わりにオブジェクトの属性名を使用します。

    このコマンドにより、以下のようなクラスターの説明が含まれる JSON ファイルが出力されます。

    {
      "kind": "ClusterList",
      "page": 1,
      "size": 6,
      "total": 10
      "items": [
        {
          "kind": "Cluster",
          "id": "1GUAUWE3E1IS87Q99M0kxO1LpCG",
          "href": "/api/clusters_mgmt/v1/clusters/1GUAUWE3E1IS87Q99M0kxO1LpCG",
          "name": "mycluster",
          "api": {
            "url": "https://mycluster-api.example.com:6443"
          },
          "console": {
            "url": "https://console-openshift-console.apps.mycluster.example.com"
          },
          ...
        },
        ...
      ]
    }

ocm get コマンドで jq ツールを使用して、JSON クラスターの説明から必要な情報を抽出することができます。たとえば、クラスターの ID を一覧表示するには、以下を実行します。

$ ocm get /api/clusters_mgmt/v1/clusters | jq -r .items[].id

このコマンドにより、以下のような出力が返されます。

1FtmglZGw2byDzO8tb2cCtWxCNf
1FtRj13Fz2DIcm4zaDrcLvKAIyf
...

その他の例

  • example.com で終わる DNS ドメインで作成される my で始まる名前のクラスターを取得するには、以下を実行します。

    $ ocm get /api/clusters_mgmt/v1/clusters \
    --parameter search="name like 'my%' and dns.base_domain like '%.example.com'"
  • US で AWS リージョンを見つけるには、以下を実行します。

    $ ocm get /api/clusters_mgmt/v1/cloud_providers/aws/regions \
    --parameter search="name like 'US %'"
  • 2019 年 3 月 1 日以降に作成されたクラスターを検索するには、以下を実行します。

    $ ocm get /api/clusters_mgmt/v1/clusters \
    --parameter search="creation_timestamp >= '2019-03-01'"
  • 準備が整っているクラスターまたはインストールされているクラスターを見つけるには、以下を実行します。

    $ ocm get /api/clusters_mgmt/v1/clusters \
    --parameter search="state in ('ready', 'installing')"

追加リソース

4.2. クラスターの名前変更

接続クラスターに、クラスターの UUID ではなく人間が判読できる名前を指定して、Red Hat サポートに連絡したり、サポートケースを作成したり、OpenShift Cluster Manager でクラスターの一覧を確認したりする場合に簡単に参照できるようにします。

OpenShift クラスターが作成されると、すべての OpenShift クラスターには、他のクラスターと区別するために 36 文字の UUID 文字列が名前として割り当てられます。ただし、UUID の検索または参照が困難であるため、Red Hat は、リソースの検索と OpenShift 環境の管理を簡素化するためにクラスターのカスタム名を指定することを推奨します。

前提条件

  • OpenShift Container Platform 4.x または OpenShift Dedicated クラスター
  • 組織管理者アクセスを持つ Red Hat アカウントか、編集するクラスターの作成者または所有者である必要があります。
注記

組織管理者は、組織内のすべてのクラスターの表示名を編集できます。また、クラスターの作成者または所有者は、作成したクラスターの名前を変更できます。

手順

  1. OpenShift Cluster ManagerClusters 一覧に移動します。
  2. 名前を変更するクラスターの横にある more options (その他のオプション) をクリックします。
  3. Edit display name をクリックし、クラスターの名前を入力します。
  4. Edit をクリックして新しい名前を保存します。
注記

また、Actions メニューの Edit display name から、詳細ページのクラスターの名前を変更することもできます。

新しいクラスター名は OpenShift Cluster Manager のクラスター一覧に表示されます。

追加リソース

4.3. クラスター所有権の移動

OpenShift Cluster Manager を使用して、OpenShift Container Platform クラスターの所有権を組織内の別のユーザーに、または別の組織に移すことができます。

たとえば、ある Red Hat アカウントを使用して OpenShift Container Platform クラスターを作成し、関連するサブスクリプションにクラスターを登録するために別の Red Hat アカウントに移す場合は、クラスターの所有権をそのユーザーに移す必要があります。接続クラスターの所有権または非接続クラスターの所有権を移すことができます。

接続されたクラスターのクラスター所有権を移すには、移動を開始してからクラスターのプルシークレットを変更するという 2 段階の手順が必要になります。クラスタープルシークレットを 5 日以内に変更してから移動を開始するか、移動手順を再起動する必要があります。

この移動は、OpenShift Cluster Manager が新規プルシークレットを使用してクラスターから Telemetry データを受け取ると完了します。

非接続クラスターの所有権を移動するには、移動の開始のみが必要になります。プルシークレットは必要ありません。

前提条件

  • OpenShift Container Platform クラスター
  • 組織管理者またはクラスター所有者の権限:

    • 組織管理者 は、お客様の Red Hat アカウントへのアクセスが許可されます。
    • クラスター所有者の権限はクラスター内で付与されます。
  • クラスターを移動する Red Hat アカウントに関連付けられたプルシークレット。OpenShift Cluster Manager からプルシークレットをダウンロードまたはコピーします。非接続クラスターの所有権を移すのにプルシークレットは必要ありません。
重要

プルシークレットは共有しないでください。プルシークレットはパスワードのように扱う必要があります。

手順

  1. 移動を開始します。

    1. OpenShift Cluster Manager で、転送するクラスターを選択します。
    2. クラスターのページの上部にある Actions > Transfer cluster ownership をクリックします。
    3. Initiate transfer をクリックして、この操作を確認します。

      重要

      クラスターのプルシークレットを 5 日以内に変更し、クラスターを新しい Red Hat アカウントに登録する必要があります。そうでない場合には、移動がキャンセルされます。また、プルシークレットの変更前に所有権の移動をキャンセルするには、Actions > Cancel ownership transfer をクリックします。

      非接続クラスターの所有権を移動する場合は、新しい Red Hat アカウントが同じクラスターの UUID で登録されると、転送が完了します。クラスターが Telemetry に接続されている場合は、次の手順に進みます。

  2. クラスタープルシークレットを変更します。

    1. クラスターの所有権を取得するクラスターの所有者または組織管理者として OpenShift Cluster Manager にログインします。
    2. 新規クラスターの所有者として、OpenShift Cluster Manager からダウンロードしたプルシークレットを使用して以下のコマンドを実行し、プルシークレットを変更します。

      # oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=pull-secret.txt
    3. シークレットがまだ作成されていない場合は、以下のコマンドを実行してシークレットを作成します。

      # oc create secret generic pull-secret -n openshift-config --type=kubernetes.io/dockerconfigjson --from-file=.dockerconfigjson=/path/to/downloaded/pull-secret

検証手順

以下を確認すると、移動が正常に行われたことを確認できます。

  • クラスターの 概要:

    • DetailsOwner が更新されました。
    • Cluster history には、移動の詳細が表示されます。
  • クラスターを別の組織に移動すると、クラスターは新しい Red Hat アカウントのクラスター一覧に表示され、以前の Red Hat アカウントのクラスター一覧から削除されます。

追加リソース

4.4. プルシークレットのダウンロードおよび更新

4.4.1. OpenShift Cluster Manager からのプルシークレットのダウンロード

イメージプルシークレットは、OpenShift コンポーネントのコンテナーイメージを提供するサービスおよびレジストリーにアクセスするための認証を提供します。各ユーザーには単一のプルシークレットが生成されます。この同じプルシークレットは、OpenShift Container Platform または OpenShift Dedicated クラスターのインストール時に使用されます。

前提条件

  • OpenShift Container Platform または OpenShift Dedicated クラスター
  • 組織管理者またはクラスター所有者の権限:

    • 組織管理者 は、お客様の Red Hat アカウントへのアクセスが許可されます。
    • クラスター所有者の権限はクラスター内で付与されます。

手順

  1. クラスターの所有者権限を持つユーザーとしてクラスターにログインします。
  2. https://cloud.redhat.com/openshift/install/pull-secret からプルシークレットをダウンロードします。
重要

プルシークレットは共有しないでください。プルシークレットはパスワードのように扱う必要があります。

追加リソース

4.4.2. API を使用したプルシークレットのダウンロード

OpenShift Cluster Manager API トークンを使用して OpenShift Cluster Manager アカウントに対して認証を行い、OpenShift Container Platform のインストールに必要なプルシークレットのダウンロードを自動化することができます。

これは、OpenShift Container Platform クラスターのインストールを自動化するのに役立ちます。ただし、Red Hat は、OpenShift イメージレジストリーが変更された場合にクラスターのインストール時に毎回プルシークレットをダウンロードすることを推奨します。

注記

前提条件

  • OpenShift Container Platform クラスター
  • クラスターへのクラスターの所有者権限を持つユーザー
  • ocm-cli コマンドラインツールがインストールされている。ご使用の環境での手順については、https://github.com/openshift-online/ocm-cli を参照してください。
  • OpenShift Cluster Manager のオフラインアクセストークンが https://cloud.redhat.com/openshift/token にあること。

手順

  1. ocm-cli ツールを使用するには、https://cloud.redhat.com/openshift/token にある OpenShift Cluster Manager のオフラインアクセストークンを使用して OpenShift Cluster Manager にログインします。

    $ ocm login --token=eyJ...

    これは、提供された OpenShift Cluster Manager トークン (ベアラートークンとしても知られる) を使用して OpenID アクセスを要求し、トークンを sso.redhat.com に更新します。今後の使用のために、トークンはホームディレクトリーの .ocm.json ファイルに保存されます。

    注記

    詳細およびオプションについては、ocm login --help を実行します。

  2. OCM (ベアラー) トークンをエクスポートします。

    $ export BEARER=$(curl \
    --silent \
    --data-urlencode "grant_type=refresh_token" \
    --data-urlencode "client_id=cloud-services" \
    --data-urlencode "refresh_token=${OFFLINE_ACCESS_TOKEN}" \
    https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token | \
    jq -r .access_token)
  3. 以下の詳細を指定して、ocm post コマンドを実行します。

    $ echo '{}' | ocm post /api/accounts_mgmt/v1/access_token --header --header "Content-Type:application/json" --header "Authorization: Bearer $BEARER" | jq
    
    {
      "auths": {
        "cloud.openshift.com": {
          "auth": "<snip>",
          "email": "<user's email>"
        },
        "quay.io": {
          "auth": "<snip>",
          "email": "<user's email>"
        },
        "registry.connect.redhat.com": {
          "auth": "<snip>",
          "email": "<user's email>"
        },
        "registry.redhat.io": {
          "auth": "<snip>",
          "email": "<user's email>"
        }
      }
    }

これで、トークンはホームディレクトリーの .ocm.json ファイルに保存されます。

追加リソース

4.4.3. グローバルのプルシークレットの更新

クラスターのグローバルプルシークレットを更新できます。

警告

クラスターリソースは新規のプルシークレットに合わせて調整する必要がありますが、これにより、クラスターのユーザビリティーが一時的に制限される可能性があります。

グローバルプルシークレットを更新すると、Machine Config Operator はノードをドレイン (解放) し、その変更を適用し、ノードの遮断を解除します。

注記

OpenShift Container Platform 4.7 の時点で、グローバルプルシークレットへの変更によって再起動がトリガーされなくなりました。

前提条件

  • OpenShift Container Platform クラスター
  • アップロードする新規または変更されたプルシークレットファイル (OpenShift Cluster Manager の https://cloud.redhat.com/openshift/install/pull-secret からプルシークレットをダウンロードできます)。
  • クラスターの所有者権限を持つユーザーとしてクラスターにアクセスします。

手順

  1. クラスターの所有者権限を持つユーザーとしてクラスターにログインします。
  2. https://cloud.redhat.com/openshift/install/pull-secret からプルシークレットをダウンロードします。

    重要

    プルシークレットは共有しないでください。プルシークレットはパスワードのように扱う必要があります。

  3. 以下のコマンドを入力して、ダウンロードしたプルシークレットでクラスターのグローバルプルシークレットを更新します。

    oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson=pull-secret.txt1
    1
    新規プルシークレットファイルへのパスを指定します。

これにより、クラスターのすべてのノードへの更新が始まります。これには、クラスターのサイズに応じて多少時間がかかる場合があります。この間に、ノードがドレイン (解放) され、Pod は残りのノードで再スケジュールされます。

追加リソース

第5章 クラスターのサポートの利用

5.1. OpenShift Dedicated サポート

既存の Red Hat OpenShift Dedicated のインストールに関する質問は、Red Hat サポート にお問い合わせください。

ここから、以下を実行することができます。

詳細は、OpenShift Dedicated ドキュメント の『サポート』を参照してください。

5.2. OpenShift Container Platform サポート

OpenShift Container Platform クラスターのサポートの詳細は、Red Hat サポート にお問い合わせください。

ここから、以下を実行することができます。

法律上の通知

Copyright © 2021 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide 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 States and 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 States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries 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.