Menu Close

ROSA CLI

Red Hat OpenShift Service on AWS 4

Red Hat OpenShift Service on AWS コマンドラインツールの使用方法

概要

本書では、Red Hat OpenShift Service on AWS (ROSA) コマンドラインツールのインストール、設定、および使用について説明します。また、CLI コマンドおよび例のリファレンスも含まれています。

第1章 rosa CLI の使用を開始する

rosa CLI のセットアップと基本的な使用方法

1.1. rosa CLI について

Red Hat OpenShift Service on AWS (ROSA) の rosa コマンドラインユーティリティーを使用して、Red Hat OpenShift Service on AWS クラスターおよびリソースを作成、更新、管理、および削除します。

1.2. rosa CLI のセットアップ

rosa CLI を設定するには、最新のリリースをダウンロードしてから、rosa を設定して初期化します。

手順

  1. お使いのオペレーティングシステム用の rosa CLI の最新リリースを Red Hat OpenShift Service on AWSDownload ページからダウンロードします。
  2. リリースのダウンロード後に、rosa にダウンロードした実行可能ファイルの名前を変更してから、rosa をパスに追加することが推奨されます。
  3. オプション: rosa のダウンロード後に、rosa の Bash 補完を有効にします。Bash 補完により、Tab を押す際にコマンドを自動的に完了し、オプションを提案することができます。このコマンドは、rosa 用の Bash 補完ファイルを生成し、これを現在のシェルセッションに提供します。

    各セッションに rosa 補完を読み込むように Bash シェルを設定するには、以下のコマンドを Bashrc ファイル (~/.Bashrc または ~/.profile) に追加します。

    $ . <(rosa completion)

1.3. rosa CLI の設定

以下のコマンドを使用して rosa CLI を設定します。

1.3.1. login

Red Hat アカウントにログインし、認証情報を rosa 設定ファイルに保存します。ログイン時にトークンを指定する必要があります。Red Hat OpenShift Service on AWS のトークンページ からトークンをコピーすることができます。

rosa CLI は、以下の優先順位でトークンを検索します。

  1. コマンドライン引数
  2. ROSA_TOKEN 環境変数
  3. rosa 設定ファイル
  4. コマンドラインプロンプトから対話的に

構文

$ rosa login [arguments]

表1.1 引数

オプション定義

--client-id

OpenID クライアント識別子 (文字列)。デフォルトは、cloud-services です。

--client-secret

OpenID クライアントシークレット (文字列)。

--insecure

サーバーとの非セキュアな通信を有効にします。これにより、TLS 証明書およびホスト名の検証が無効になります。

--scope

OpenID スコープ (文字列)。このオプションを使用する場合、デフォルトのスコープはこのオプションに置き換えられます。これは複数回繰り返して、複数のスコープを指定できます。デフォルトは、openid です。

--token

トークンにアクセスまたは更新します (文字列)。

--token-url

OpenID トークン URL (文字列)。デフォルトは、https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token です。

表1.2 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

1.3.2. logout

rosa からログアウトします。ログアウトすると、rosa 設定ファイルも削除されます。

構文

$ rosa logout [arguments]

表1.3 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

1.3.3. verify permissions

ROSA クラスターの作成に必要な AWS パーミッションが正しく設定されていることを確認します。

構文

$ rosa verify permissions [arguments]

注記

このコマンドは、AWS Security Token Service(STS)を使用しないクラスターに対してのみパーミッションを検証します。

表1.4 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--region

コマンドを実行する AWS リージョン (文字列)。この値は AWS_REGION 環境変数を上書きします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

AWS パーミッションが正しく設定されていることを確認します。

$ rosa verify permissions

AWS パーミッションが特定のリージョンで正しく設定されていることを確認します。

$ rosa verify permissions --region=us-west-2

1.3.4. verify quota

AWS クォータがデフォルトのリージョンに正しく設定されていることを確認します。

構文

$ rosa verify quota [arguments]

表1.5 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--region

コマンドを実行する AWS リージョン (文字列)。この値は AWS_REGION 環境変数を上書きします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

AWS クォータがデフォルトのリージョンで正しく設定されていることを確認します。

$ rosa verify quota

AWS クォータが特定のリージョンで正しく設定されていることを確認します。

$ rosa verify quota --region=us-west-2

1.3.5. download oc

OpenShift Container Platform CLI (oc) の最新の互換性のあるバージョンをダウンロードします。

oc のダウンロード後に、アーカイブを展開してパスに追加する必要があります。

構文

$ rosa download oc [arguments]

表1.6 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

oc クライアントツールをダウンロードします。

$ rosa download oc

1.3.6. verify oc

OpenShift Container Platform CLI (oc) が正常にインストールされていることを確認します。

構文

$ rosa verify oc [arguments]

表1.7 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--region

コマンドを実行する AWS リージョン (文字列)。この値は、AWS_REGION 環境変数を上書きします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

oc クライアントツールを確認します。

$ rosa verify oc

1.4. Red Hat OpenShift Service on AWS の初期化

init コマンドを使用して、Red Hat OpenShift Service on AWS (ROSA) を初期化します。

1.4.1. init

一連の確認項目を実行して、Red Hat OpenShift Service on AWS クラスターをデプロイする準備ができていることを確認します。

以下は、確認項目の一覧です。

  • ログインしていることを確認します (login を参照)。
  • AWS 認証情報が有効であることを確認します。
  • AWS パーミッションが有効であることを確認します (verify permissions を参照)。
  • AWS クォータレベルが十分にあることを確認します (verify quota を参照)。
  • クラスターシミュレーションを実行して、クラスターの作成が想定通りに実行されることを確認します。
  • osdCcsAdmin ユーザーが AWS アカウントに作成されていることを確認します。
  • OpenShift Container Platform コマンドラインツールがシステムで利用できることを確認します。

構文

$ rosa init [arguments]

表1.8 引数

オプション定義

--region

クォータおよびパーミッションを確認する AWS リージョン (文字列)。この値は、init コマンドを実行する場合にのみ AWS_REGION 環境変数を上書きしますが、これは AWS CLI 設定を変更しません。

--delete-stack

init コマンドの実行時に AWS アカウントに適用されるスタックテンプレートを削除します。

--client-id

OpenID クライアント識別子 (文字列)。デフォルトは、cloud-services です。

--client-secret

OpenID クライアントシークレット (文字列)。

--insecure

サーバーとの非セキュアな通信を有効にします。これにより、TLS 証明書およびホスト名の検証が無効になります。

--scope

OpenID スコープ (文字列)。このオプションを使用する場合は、デフォルトのスコープを完全に置き換えます。これは複数回繰り返して、複数のスコープを指定できます。デフォルトは、openid です。

--token

トークンにアクセスまたは更新します (文字列)。

--token-url

OpenID トークン URL (文字列)。デフォルトは、https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token です。

表1.9 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

AWS アカウントを設定して ROSA クラスターを許可します。

$ rosa init

既存の OpenShift Cluster Manager 認証情報を使用して新規 AWS アカウントを設定します。

$ rosa init --token=$OFFLINE_ACCESS_TOKEN

1.5. Bash スクリプトの使用

以下は、rosa CLI で Bash スクリプトを使用する方法のワークフローの例になります。

前提条件

AWS 認証情報が以下のオプションのいずれかとして利用可能であることを確認します。

  • AWS プロファイル
  • 環境変数 (AWS_ACCESS_KEY_IDAWS_SECRET_ACCESS_KEY)

手順

  1. Red Hat の OpenShift Cluster Manager オフライントークンを使用して rosa を初期化します。

    $ rosa init --token=<token>
  2. Red Hat OpenShift Service on AWS (ROSA) クラスターを作成します。

    $ rosa create cluster --cluster-name=<cluster_name>
  3. アイデンティティープロバイダー (IDP) を追加します。

    $ rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]
  4. dedicated-admin ユーザーを追加します。

    $ rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>

第2章 rosa CLI を使用したオブジェクトの管理

dedicated-admin ユーザーの追加、クラスターの管理、クラスターのアップグレードのスケジューリングなど、rosa CLI を使用したオブジェクトの管理。

2.1. 一般的なコマンドおよび引数

これらの一般的なコマンドおよび引数は、rosa CLI で利用できます。

2.1.1. debug

親コマンドのデバッグモードを有効にします。

$ rosa create cluster --cluster=<cluster_name> --debug

2.1.2. help

rosa CLI の一般的なヘルプ情報および利用可能なコマンドの一覧を表示します。このオプションは、versioncreate などの親コマンドのヘルプ情報を表示する引数として使用することもできます。

rosa CLI の一般的なヘルプ情報を表示します。

$ rosa --help

version の一般的なヘルプ情報を表示します。

$ rosa version --help

2.1.3. interactive

対話モードを有効にします。

$ rosa create cluster --cluster=<cluster_name> --interactive

2.1.4. profile

認証情報ファイルから AWS プロファイルを指定します。

$ rosa create cluster --cluster=<cluster_name> --profile=myAWSprofile

2.1.5. v level

V ログのログレベルを指定します。

$ rosa create cluster --cluster=<cluster_name> --v <level>

2.1.6. version

rosa バージョンを表示します。

$ rosa version [arguments]

2.2. 親コマンド

rosa CLI は、子コマンドと共に親コマンドを使用してオブジェクトを管理します。親コマンドは、createeditdeletelist、および describe です。すべての親コマンドをすべての子コマンドと共に使用できる訳ではありません。詳細は、子コマンドについて説明する特定の参照トピックを参照してください。

2.2.1. create

子コマンドとペアとなった場合に、オブジェクトまたはリソースを作成します。

$ rosa create cluster --cluster-name=mycluster

2.2.2. edit

クラスタープライベートの作成など、オブジェクトのオプションを編集します。

$ rosa edit cluster --cluster=mycluster --private

2.2.3. delete

子コマンドとペアとなった場合に、オブジェクトまたはリソースを削除します。

$ rosa delete ingress --cluster=mycluster

2.2.4. list

特定のクラスター向けにクラスターまたはリソースを一覧表示します。

$ rosa list users --cluster=mycluster

2.2.5. describe

クラスターの詳細を表示します。

$ rosa describe --cluster=mycluster

2.3. オブジェクトの作成

このセクションでは、クラスターおよびリソース向けの create コマンドについて説明します。

2.3.1. create admin

クラスターへのログインが可能な自動生成されたパスワードが設定されたクラスター管理者を作成します。

構文

$ rosa create admin --cluster=<cluster_name> | <cluster_id>

表2.1 引数

オプション定義

--cluster

必須: アイデンティティープロバイダー (IDP) に追加するクラスターの名前または ID (文字列)。

表2.2 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster にログインできるクラスター管理者を作成します。

$ rosa create admin --cluster=mycluster

2.3.2. create cluster

新規クラスターを作成します。

構文

$ rosa create cluster --cluster=<cluster_name> | <cluster_id> [arguments]

表2.3 引数

オプション定義

--cluster

必須: クラスターの名前または ID (文字列)。create cluster コマンドと併用する場合、この引数は openshiftapps.com でクラスターのサブドメインを生成するために使用されます。

--channel-group

チャネルグループ (文字列) は、このイメージが属するグループの名前です (例: stable または fast)。デフォルトは、stable です。

--compute-machine-type

コンピュートノードのインスタンスタイプ (文字列)。各コンピュートノードに割り当てられるメモリーおよび仮想 CPU の容量を決定します。

--compute-nodes

ゾーンごとにプロビジョニングするワーカーノードの数 (整数)。シングルゾーンクラスターには、2 つ以上のノードが必要です。マルチゾーンクラスターには、3 つ以上のノードが必要です。デフォルトは、単一 AZ の場合は 2、マルチ AZ の場合は 3 です。

--disable-scp-checks

クラスターのインストールの試行時に、クラウドパーミッションチェックが無効になるかどうかを示します。

--dry-run

クラスターの作成をシミュレーションします。

--enable-autoscaling

コンピュートノードの自動スケーリングを有効にします。デフォルトでは、自動スケーリングは 2 つのノードに設定されます。デフォルト以外のノード制限を設定するには、--min-replicas 引数および --max-replicas 引数と共にこの引数を使用します。

--host-prefix

それぞれの個別ノードに割り当てるサブネットプレフィックスの長さ (整数)。たとえば、ホストプレフィックスが 23 に設定される場合は、各ノードに指定の CIDR から /23 サブネットが割り当てられます。

--machine-cidr

クラスターのインストール中に OpenShift Container Platform によって使用される IP アドレス (ipNet) のブロック。たとえば、10.0.0.0/16 です。

--max-replicas

自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。デフォルトは、2 です。

--min-replicas

自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。デフォルトは、2 です。

--multi-az

複数のデータセンターにデプロイします。

--pod-cidr

Pod IP アドレスの割り当てに使用する IP アドレス (ipNet) のブロックです。たとえば、10.128.0.0/14 です。

--private

プライマリー API エンドポイントおよびアプリケーションルートを直接かつプライベートの接続に制限します。

--private-link

AWS PrivateLink を使用して VPC とサービス間のプライベート接続を提供することを指定します。--private-link を使用する場合は、--subnet-ids 引数が必要です。

--region

ワーカープールが置かれる AWS リージョン (文字列) です。この引数は AWS_REGION 環境変数を上書きします。

--service-cidr

サービス向け IP アドレス (ipNet) のブロックです。たとえば、172.30.0.0/16 です。

--subnet-ids

クラスターのインストール時に使用するサブネット ID (文字列) です。サブネット ID は、アベイラビリティーゾーンごとに、1 つのプライベートサブネット ID と 1 つのパブリックサブネット ID のペアでなければなりません。サブネットはコンマ区切りとなっています。たとえば、--subnet-ids=subnet-1,subnet-2 です。インストーラーでプロビジョニングされるサブネット ID の値は空のままにします。

--private-link を使用する場合は、-subnet-ids 引数が必要であり、ゾーンごとに 1 つのプライベートサブネットのみが許可されます。

--version

クラスターをインストールするために使用される OpenShift Container Platform のバージョン (文字列)。たとえば、4.3.10 です。

表2.4 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster を作成します。

$ rosa create cluster --cluster=mycluster

特定の AWS リージョンでクラスターを作成します。

$ rosa create cluster --cluster=mycluster --region=us-east-2

デフォルトのワーカーマシンプールで有効化された自動スケーリングでクラスターを作成します。

$ rosa create cluster --cluster=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=5

2.3.3. create idp

アイデンティティープロバイダー (IDP) を追加して、ユーザーのクラスターへのログイン方法を定義します。

構文

$ rosa create idp --cluster=<cluster_name> | <cluster_id> [arguments]

表2.5 引数

オプション定義

--cluster

必須: IDP が追加されるクラスターの名前または ID (文字列)。

--ca

サーバーへの要求を行う際に使用する PEM でエンコードされた証明書ファイルへのパス (文字列)。

--client-id

登録されたアプリケーションのクライアント ID (文字列)。

--client-secret

登録したアプリケーションのクライアントシークレット (文字列)。

--mapping-method

新規アイデンティティー (文字列) がログイン時にユーザーにマップされる方法を指定します。デフォルトは、claim です。

--name

アイデンティティープロバイダーの名前 (文字列)。

--type

アイデンティティープロバイダーのタイプ (文字列)。オプションは、githubgitlabgoogleldapopenid です。

表2.6 GitHub 引数

オプション定義

--hostname

GitHub Enterprise のホストされたインスタンスで使用するためのオプションのドメイン (文字列)。

--organizations

ログインアクセス用の組織を指定します。一覧表示されている組織 (文字列) のうち、1 つ以上の組織のメンバーであるユーザーのみがログインできます。

--teams

ログインアクセスのためのチームを指定します。一覧表示されているチーム (文字列) のうち、1 つ以上のチームのメンバーであるユーザーのみがログインできます。形式は <org>/<team> です。

表2.7 GitLab 引数

オプション定義

--host-url

GitLab プロバイダーのホスト URL (文字列)。デフォルトは、https://gitlab.com です。

表2.8 Google 引数

オプション定義

--hosted-domain

ユーザーを Google Apps ドメイン (文字列) に制限します。

表2.9 LDAP 引数

オプション定義

--bind-dn

検索フェーズでバインドするドメイン名 (文字列) です。

--bind-password

検索フェーズでバインドするパスワード (文字列) です。

--email-attributes

メールアドレスとして使用する必要がある値を持つ属性の一覧 (文字列) です。

--id-attributes

ユーザー ID として使用する必要がある値を持つ属性の一覧 (文字列) です。デフォルトは、dn です。

--insecure

サーバーへの TLS 接続を実行しません。

--name-attributes

表示名として使用する必要がある値を持つ属性の一覧 (文字列) です。デフォルトは、cn です。

--url

使用する LDAP 検索パラメーターを指定する RFC 2255 URL (文字列) です。

--username-attributes

優先ユーザー名として使用する必要がある値を持つ属性の一覧 (文字列) です。デフォルトは、uid です。

表2.10 OpenID 引数

オプション定義

--email-claims

メールアドレスとして使用する要求の一覧 (文字列) です。

--extra-scopes

認可トークン要求時に openid の範囲のほかに要求する範囲の一覧 (文字列) です。

--issuer-url

OpenID プロバイダーが発行者 ID としてアサートする URL (文字列)。URL クエリーパラメーターまたはフラグメントのない HTTPS スキームを使用する必要があります。

--name-claims

表示名として使用する要求の一覧 (文字列) です。

--username-claims

ユーザーをプロビジョニングする際に優先ユーザー名として使用される要求の一覧 (文字列) です。

表2.11 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

GitHub アイデンティティープロバイダーをクラスター mycluster に追加します。

$ rosa create idp --type=github --cluster=mycluster

対話プロンプトに従ってアイデンティティープロバイダーを追加します。

$ rosa create idp --cluster=mycluster --interactive

2.3.4. create ingress

Ingress エンドポイントを追加して、クラスターへの API アクセスを有効にします。

構文

$ rosa create ingress --cluster=<cluster_name> | <cluster_id> [arguments]

表2.12 引数

オプション定義

--cluster

必須: Ingress が追加されるクラスターの名前または ID (文字列)。

--label-match

Ingress のラベル一致 (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。ラベルが指定されていない場合は、すべてのルートが両方のルーターで公開されます。

--private

アプリケーションルートを直接かつプライベートの接続に制限します。

表2.13 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

内部 Ingress を mycluster クラスターに追加します。

$ rosa create ingress --private --cluster=mycluster

パブリック Ingress を mycluster クラスターに追加します。

$ rosa create ingress --cluster=mycluster

ルートセレクターラベルの match:s で ingress を追加します。

$ rosa create ingress --cluster=mycluster --label-match=foo=bar,bar=baz

2.3.5. create machinepool

マシンプールを既存クラスターに追加します。

構文

$ rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<number> --name=<machinepool_name> [arguments]

表2.14 引数

オプション定義

--cluster

必須: マシンプールを追加するクラスターの名前または ID (文字列)。

--enable-autoscaling

コンピュートノードの自動スケーリングを有効または無効にします。自動スケーリングを有効にするには、--min-replicas 引数および --max-replicas 引数と共にこの引数を使用します。自動スケーリングを無効にするには、--enable-autoscaling=false 引数を --replicas 引数と共に使用します。

--instance-type

使用する必要のあるインスタンスタイプ (文字列)。デフォルトは、m5.xlarge です。

--labels

マシンプールのラベル (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。この一覧は、継続的にノードラベルに加えられるすべての変更を上書きします。

--max-replicas

自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。

--min-replicas

自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。

--name

必須: マシンプールの名前 (文字列)。

--replicas

自動スケーリングが設定されていない場合に必要です。このマシンプールのマシンの数 (整数)。

--taints

マシンプールのテイント。この文字列値は、key=value:ScheduleType のコンマ区切りのリストとしてフォーマットする必要があります。このリストは、ノードのテイントに継続的に加えられた変更を上書きします。

表2.15 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster にマシンプールを対話的に追加します。

$ rosa create machinepool --cluster=mycluster --interactive

マシンプール mp-1 を、自動スケーリングが有効にされたクラスターに追加します。

$ rosa create machinepool --cluster=mycluster --enable-autoscaling --min-replicas=2 --max-replicas=5 --name=mp-1

m5.xlarge のレプリカが 3 つ設定されたマシンプール mp-1 をクラスターに追加します。

$ rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1

ラベルの付いたマシンプールをクラスターに追加します。

$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-1

2.4. オブジェクトの編集

このセクションでは、クラスターおよびリソースの edit コマンドについて説明します。

2.4.1. edit cluster

既存のクラスターの編集を許可します。

構文

$ rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]

表2.16 引数

オプション定義

--cluster

必須: 編集するクラスターの名前または ID (文字列)。

--private

プライマリー API エンドポイントを直接のプライベート接続に制限します。

表2.17 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster を編集して、プライベートにします。

$ rosa edit cluster --cluster=mycluster --private

クラスター mycluster ですべてのクラスターオプションをインタラクティブに編集します。

$ rosa edit cluster --cluster=mycluster --interactive

2.4.2. edit ingress

クラスター向けの追加のデフォルト以外のアプリケーションルーターを編集します。

構文

$ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]

表2.18 引数

オプション定義

--cluster

必須: Ingress が追加されるクラスターの名前または ID (文字列)。

--label-match

Ingress のラベル一致 (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。ラベルが指定されていない場合は、すべてのルートが両方のルーターで公開されます。

--private

アプリケーションルートを直接かつプライベートの接続に制限します。

表2.19 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster で、プライベート接続として ID a1b2 を使用して追加の入力を行います。

$ rosa edit ingress --private --cluster=mycluster a1b2

クラスター mycluster で、ID a1b2 の追加の入力用のルーターセレクターを更新します。

$ rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2

クラスター mycluster でサブドメイン識別子 apps を使用してデフォルトの入力を更新します。

$ rosa edit ingress --private=false --cluster=mycluster apps

2.4.3. edit machinepool

クラスターのマシンプールへの編集を許可します。

構文

$ rosa edit machinepool --cluster=<cluster_name> | <cluster_id> <machinepool_ID> [arguments]

表2.20 引数

オプション定義

--cluster

必須: 追加のマシンプールが編集されるクラスターの名前または ID (文字列)。

--enable-autoscaling

コンピュートノードの自動スケーリングを有効または無効にします。自動スケーリングを有効にするには、--min-replicas 引数および --max-replicas 引数と共にこの引数を使用します。自動スケーリングを無効にするには、--enable-autoscaling=false 引数を --replicas 引数と共に使用します。

--labels

マシンプールのラベル (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。この値の編集は、ノード番号を増やして作成されたマシンプールの新しく作成されたノードにのみ影響し、既存のノードには影響しません。この一覧は、継続的にノードラベルに加えられるすべての変更を上書きします。

--max-replicas

自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。

--min-replicas

自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。

--replicas

自動スケーリングが設定されていない場合に必要です。このマシンプールのマシンの数 (整数)。

--taints

マシンプールのテイント。この文字列値は、key=value:ScheduleType のコンマ区切りのリストとしてフォーマットする必要があります。この値の編集は、ノード番号を増やして作成されたマシンプールの新しく作成されたノードにのみ影響し、既存のノードには影響しません。この一覧は、継続的にノードラベルに加えられるすべての変更を上書きします。

表2.21 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster で、マシンプール mp1 に 4 つのレプリカを設定します。

$ rosa edit machinepool --cluster=mycluster --replicas=4 --name=mp1

クラスター mycluster で、マシンプール mp1 の自動スケーリングを有効にします。

$ rosa edit machinepool --cluster-name=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 --name=mp1

クラスター mycluster で、マシンプール mp1 の自動スケーリングを無効にします。

$ rosa edit machinepool --cluster-name=mycluster  --enable-autoscaling=false --replicas=3 --name=mp1

クラスター mycluster で、マシンプール mp1 の自動スケーリング範囲を変更します。

$ rosa edit machinepool --max-replicas=9 --cluster=mycluster --name=mp1

2.5. オブジェクトの削除

このセクションでは、クラスターおよびリソースの delete コマンドについて説明します。

2.5.1. delete admin

指定されたクラスターからクラスター管理者を削除します。

構文

$ rosa delete admin --cluster=<cluster_name> | <cluster_id>

表2.22 引数

オプション定義

--cluster

必須: アイデンティティープロバイダー (IDP) に追加するクラスターの名前または ID (文字列)。

表2.23 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster からクラスター管理者を削除します。

$ rosa delete admin --cluster=mycluster

2.5.2. delete cluster

クラスターを削除します。

構文

$ rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]

表2.24 引数

オプション定義

--cluster

必須: 削除するクラスターの名前または ID (文字列)。

--watch

クラスターのアンインストールログを監視します。

表2.25 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

--yes

操作を確認するために、自動的に yes と回答します。

クラスター mycluster を削除します。

$ rosa delete cluster --cluster=mycluster

2.5.3. delete idp

クラスターから特定のアイデンティティープロバイダー (IDP) を削除します。

構文

$ rosa delete idp --cluster=<cluster_name> | <cluster_id> [arguments]

表2.26 引数

オプション定義

--cluster

必須: IDP を削除するクラスターの名前または ID (文字列)。

表2.27 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

--yes

操作を確認するために、自動的に yes と回答します。

クラスター mycluster から github という名前のアイデンティティープロバイダーを削除します。

$ rosa delete idp github --cluster=mycluster

2.5.4. delete ingress

デフォルト以外のアプリケーションルーター (ingress) をクラスターから削除します。

構文

$ rosa delete ingress --cluster=<cluster_name> | <cluster_id> [arguments]

表2.28 引数

オプション定義

--cluster

必須: Ingress を削除するクラスターの名前または ID (文字列)。

表2.29 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

--yes

操作を確認するために、自動的に yes と回答します。

クラスター mycluster から ID a1b2 の Ingress を削除します。

$ rosa delete ingress --cluster=mycluster a1b2

クラスター mycluster から、サブドメイン名 apps2 のセカンダリー Ingress を削除します。

$ rosa delete ingress --cluster=mycluster apps2

2.5.5. delete machinepool

クラスターからマシンプールを削除します。

構文

$ rosa delete machinepool --cluster=<cluster_name> | <cluster_id> <machine_pool_id>

表2.30 引数

オプション定義

--cluster

必須: マシンプールが削除されるクラスターの名前または ID (文字列)。

表2.31 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--interactive

対話モードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

--yes

操作を確認するために、自動的に yes と回答します。

クラスター mycluster から ID mp-1 のマシンプールを削除します。

$ rosa delete machinepool --cluster=mycluster mp-1

2.6. アドオンのインストールおよびアンインストール

本セクションでは、クラスターに Red Hat マネージドサービスアドオンをインストールおよびアンインストールする方法を説明します。

2.6.1. install addon

クラスターにマネージドサービスアドオンをインストールします。

構文

$ rosa install addon --cluster=<cluster_name> | <cluster_id> [arguments]

表2.32 引数

オプション定義

--cluster

必須: アドオンがインストールされるクラスターの名前または ID (文字列)。

表2.33 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから特定の AWS プロファイル (文字列) を使用します。

--v level

V ログのログレベル。

--yes

操作を確認するために、自動的に yes と回答します。

codeready-workspaces アドオンインストールをクラスター mycluster に追加します。

$ rosa install addon --cluster=mycluster codeready-workspaces
注記

Red Hat CodeReady Workspace をインストールすると、openshift-workspaces を除くすべての名前空間にデプロイできます。詳細は、Red Hat CodeReady Workspaces Operator のインストール を参照してください。

2.6.2. uninstall addon

クラスターからマネージドサービスアドオンをアンインストールします。

構文

$ rosa uninstall addon --cluster=<cluster_name> | <cluster_id> [arguments]

表2.34 引数

オプション定義

--cluster

必須: アドオンのアンインストール元となるクラスターの名前または ID (文字列)。

表2.35 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから特定の AWS プロファイル (文字列) を使用します。

--v level

V ログのログレベル。

--yes

操作を確認するために、自動的に yes と回答します。

クラスター mycluster から codeready-workspaces アドオンインストールを削除します。

$ rosa uninstall addon --cluster=mycluster codeready-workspaces

2.7. オブジェクトの一覧表示および説明

このセクションでは、クラスターおよびリソースの list コマンドおよび describe コマンドについて説明します。

2.7.1. list addon

マネージドサービスアドオンインストールを一覧表示します。

構文

$ rosa list addons --cluster=<cluster_name> | <cluster_id>

表2.36 引数

オプション定義

--cluster

必須: アドオンを一覧表示するクラスターの名前または ID (文字列)。

表2.37 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

2.7.2. list clusters

すべてのクラスターを一覧表示します。

構文

$ rosa list clusters [arguments]

表2.38 引数

オプション定義

--count

表示するクラスターの数 (整数)。デフォルトは、100 です。

表2.39 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

2.7.3. list idps

クラスターのすべてのアイデンティティープロバイダー (IDP) を一覧表示します。

構文

$ rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]

表2.40 引数

オプション定義

--cluster

必須: IDP を一覧表示するクラスターの名前または ID (文字列)。

表2.41 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster のすべてのアイデンティティープロバイダー (IDP) を一覧表示します。

$ rosa list idps --cluster=mycluster

2.7.4. list ingresses

クラスターのすべての API および Ingress エンドポイントを一覧表示します。

構文

$ rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]

表2.42 引数

オプション定義

--cluster

必須: IDP を一覧表示するクラスターの名前または ID (文字列)。

表2.43 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster のすべての API および Ingress エンドポイントを一覧表示します。

$ rosa list ingresses --cluster=mycluster

2.7.5. list instance-types

Red Hat OpenShift Service on AWS で使用できるすべてのインスタンスタイプを一覧表示します。可用性は、アカウントの AWS クォータに基づいています。

構文

$ rosa list instance-types [arguments]

表2.44 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--output

出力フォーマット。許可される形式は json または yaml です。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

すべてのインスタンスタイプを一覧表示します。

$ rosa list instance-types

2.7.6. list machinepools

クラスターに設定されたマシンプールを一覧表示します。

構文

$ rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]

表2.45 引数

オプション定義

--cluster

必須: マシンプールを一覧表示するクラスターの名前または ID (文字列)。

表2.46 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster のすべてのマシンプールを一覧表示します。

$ rosa list machinepools --cluster=mycluster

2.7.7. list regions

現在の AWS アカウントで利用可能なリージョンの一覧を表示します。

構文

$ rosa list regions [arguments]

表2.47 引数

オプション定義

--multi-az

複数のアベイラビリティーゾーンのサポートを提供するリージョンを一覧表示します。

表2.48 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

利用可能なリージョン一覧を表示します。

$ rosa list regions

2.7.8. list upgrades

利用可能かつスケジュールされたクラスターバージョンのアップグレードの一覧を表示します。

構文

$ rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]

表2.49 引数

オプション定義

--cluster

必須: 利用可能なアップグレードを一覧表示するクラスターの名前または ID (文字列)。

表2.50 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster で利用可能なアップグレード一覧を表示します。

$ rosa list upgrades --cluster=mycluster

2.7.9. list users

指定されたクラスターのクラスター管理者および専用の管理者のユーザーを一覧表示します。

構文

$ rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]

表2.51 引数

オプション定義

--cluster

必須: クラスター管理者を一覧表示するクラスターの名前または ID (文字列)。

表2.52 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

すべてのクラスター管理者およびクラスター mycluster の専用の管理者を一覧表示します。

$ rosa list users --cluster=mycluster

2.7.10. list versions

クラスターの作成に利用可能な OpenShift バージョン一覧を表示します。

構文

$ rosa list versions [arguments]

表2.53 引数

オプション定義

--channel-group

指定されたチャネルグループ (文字列) のバージョンのみを一覧表示します。デフォルトは、stable です。

表2.54 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

OpenShift Container Platform のバージョンを一覧表示します。

$ rosa list versions

2.7.11. describe admin

指定した cluster-admin ユーザーの詳細と、クラスターにログインするコマンドを表示します。

構文

$ rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]

表2.55 引数

オプション定義

--cluster

必須: cluster-admin が属するクラスターの名前または ID (文字列)。

表2.56 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター myclustercluster-admin ユーザーを説明します。

$ rosa describe admin --cluster=mycluster

2.7.12. describe addon

マネージドサービスアドオンの詳細を表示します。

構文

$ rosa describe addon <addon_id> | <addon_name> [arguments]

表2.57 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

codeready-workspaces アドオンを説明します。

$ rosa describe addon codeready-workspaces

2.7.13. describe cluster

クラスターの詳細を表示します。

構文

$ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]

表2.58 引数

オプション定義

--cluster

必須: クラスターの名前または ID (文字列)。

表2.59 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster を説明します。

$ rosa describe cluster --cluster=mycluster

2.8. クラスターのアップグレードおよびアップグレードの削除

本セクションでは、クラスターの upgrade コマンドの使用について説明します。

2.8.1. upgrade cluster

クラスターのアップグレードをスケジュールします。

構文

$ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]

表2.60 引数

オプション定義

--cluster

必須: アップグレードがスケジュールされるクラスターの名前または ID (文字列)。

--interactive

対話モードを有効にします。

--version

クラスターをアップグレードする OpenShift Container Platform のバージョン (文字列) です。

--schedule-date

指定した時間に次のアップグレードが実行される日付 (文字列)。形式は、yyyy-mm-dd です。

--schedule-time

指定した日付に次のアップグレードが実行される時間。形式は、HH:mm です。

--node-drain-grace-period

アップグレード時に、Pod の Disruption Budget (停止状態の予算) で保護されるワークロードが尊重される期間の猶予期間 (文字列) を設定します。この猶予期間後に、ノードから正常にドレイン (解放) されていない Pod の Disruption Budget (停止状態の予算) で保護されるワークロードは、強制的にエビクトされます。デフォルトは、1 hour です。

表2.61 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

クラスター mycluster でアップグレードを対話的にスケジュールします。

$ rosa upgrade cluster --cluster=mycluster --interactive

クラスター mycluster で 1 時間以内にクラスターのアップグレードをスケジュールします。

$ rosa upgrade cluster --cluster=mycluster --version 4.5.20

2.8.2. delete upgrade

スケジュールされたクラスターのアップグレードをキャンセルします。

構文

$ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>

表2.62 引数

オプション定義

--cluster

必須: アップグレードがキャンセルされるクラスターの名前または ID (文字列) です。

表2.63 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--v level

V ログのログレベル。

--yes

操作を確認するために、自動的に yes と回答します。

第3章 rosa cli でアカウントおよびバージョン情報の確認

3.1. rosa CLI を使用したアカウントおよびバージョン情報の確認

次のコマンドを使用して、アカウントおよびバージョン情報を確認します。

3.1.1. whoami

AWS および Red Hat アカウントに関する情報を表示します。

構文

$ rosa whoami [arguments]

表3.1 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v level

V ログのログレベル。

$ rosa whoami

3.1.2. version

rosa CLI のバージョンを表示します。

構文

$ rosa version [arguments]

表3.2 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v level

V ログのログレベル。

$ rosa version

第4章 rosa CLI を使用したログの確認

4.1. rosa CLI を使用したログの確認

以下のコマンドを使用して、インストールログおよびアンインストールログを確認します。

4.1.1. logs install

クラスターのインストールログを表示します。

構文

$ rosa logs install --cluster=<cluster_name> | <cluster_id> [arguments]

表4.1 引数

オプション定義

--cluster

必須: ログを取得するためのクラスターの名前または ID (文字列)。

--tail

ログの最後から取得する行の数 (整数)。デフォルトは、2000 です。

--watch

ログの取得後に変更の有無を監視します。

表4.2 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster のインストールログの最後の 100 行を表示します。

$ rosa logs install mycluster --tail=100

クラスター mycluster のインストールログを表示します。

$ rosa logs install --cluster=mycluster

4.1.2. logs uninstall

クラスターのアンインストールログを表示します。

構文

$ rosa logs uninstall --cluster=<cluster_name> | <cluster_id> [arguments]

表4.3 引数

オプション定義

--cluster

ログを取得するためのクラスターの名前または ID (文字列)。

--tail

ログの最後から取得する行の数 (整数)。デフォルトは、2000 です。

--watch

ログの取得後に変更の有無を監視します。

表4.4 親コマンドから継承された任意の引数

オプション定義

--help

このコマンドのヘルプを表示します。

--debug

デバッグモードを有効にします。

--profile

認証情報ファイルから AWS プロファイル (文字列) を指定します。

--v <level>

V ログのログレベルです。

クラスター mycluster の最新の 100 個のアンインストールログを表示します。

$ rosa logs uninstall --cluster=mycluster --tail=100