Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

第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 が失敗する場合などに重要なアラートが表示されます。このエリアでは、リソースの使用量も表示されます。

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"}'
Copy to Clipboard Toggle word wrap

  • 管理者としてログインしている場合は、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...
    Copy to Clipboard Toggle word wrap

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

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

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

    $ ocm get /api/clusters_mgmt/v1/clusters --parameter search="name like 'my%'"
    Copy to Clipboard Toggle word wrap
    注記
    • --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"
      },
      ...
    },
    ...
  ]
}
    Copy to Clipboard Toggle word wrap

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

$ ocm get /api/clusters_mgmt/v1/clusters | jq -r .items[].id
Copy to Clipboard Toggle word wrap

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

1FtmglZGw2byDzO8tb2cCtWxCNf
1FtRj13Fz2DIcm4zaDrcLvKAIyf
...
Copy to Clipboard Toggle word wrap

その他の例

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

    $ ocm get /api/clusters_mgmt/v1/clusters \
--parameter search="name like 'my%' and dns.base_domain like '%.example.com'"
    Copy to Clipboard Toggle word wrap

  • US で AWS リージョンを見つけるには、以下を実行します。 

    $ ocm get /api/clusters_mgmt/v1/cloud_providers/aws/regions \
--parameter search="name like 'US %'"
    Copy to Clipboard Toggle word wrap

  • 2019 年 3 月 1 日以降に作成されたクラスターを検索するには、以下を実行します。 

    $ ocm get /api/clusters_mgmt/v1/clusters \
--parameter search="creation_timestamp >= '2019-03-01'"
    Copy to Clipboard Toggle word wrap

  • 準備が整っているクラスターまたはインストールされているクラスターを見つけるには、以下を実行します。 

    $ ocm get /api/clusters_mgmt/v1/clusters \
--parameter search="state in ('ready', 'installing')"
    Copy to Clipboard Toggle word wrap
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat