ROSA CLI
Red Hat OpenShift Service on AWS コマンドラインツールの使用方法
概要
第1章 Red Hat OpenShift Service on AWS (ROSA) CLI (rosa) の使用開始
Red Hat OpenShift Service on AWS (ROSA) CLI、rosa の設定と基本的な使用法。
1.1. Red Hat OpenShift Service on AWS (ROSA) CLI である rosa
Red Hat OpenShift Service on AWS (ROSA) の rosa コマンドラインユーティリティーを使用して、Red Hat OpenShift Service on AWS クラスターおよびリソースを作成、更新、管理、および削除します。
1.2. ROSA CLI の設定
以下の手順を使用して、インストールホストに Red Hat OpenShift Service on AWS (ROSA) CLI (rosa) をインストールし、設定します。
手順
-
OpenShift Cluster Manager の Downloads ページから、お使いのオペレーティングシステムの ROSA CLI (
rosa) の最新バージョンをダウンロードします。 ダウンロードしたアーカイブから
rosaバイナリーファイルを展開します。以下の例は、Linux tar アーカイブからバイナリーを展開します。$ tar xvf rosa-linux.tar.gz
パスに
rosaを加えてください。以下の例では、/usr/local/binディレクトリーがユーザーのパスに含まれます。$ sudo mv rosa /usr/local/bin/rosa
rosaバージョンをクエリーして、ROSA CLI ツールが適切にインストールされていることを確認します。$ rosa version
出力例
1.2.15 Your ROSA CLI is up to date.
オプション: ROSA CLI のタブ補完を有効にします。タブ補完を有効にすると、
Tabキーを 2 回押すことでサブコマンドが自動的に補完され、コマンドの提案が表示されます。Linux ホストで Bash のタブ補完を永続的に有効にするには、以下を実行します。
Bash 用の
rosaタブ補完設定ファイルを生成し、/etc/bash_completion.d/ディレクトリーに保存します。# rosa completion bash > /etc/bash_completion.d/rosa
- 新しいターミナルを開き、設定を有効にします。
macOS ホストで Bash のタブ補完を永続的に有効にするには、以下を実行します。
Bash 用の
rosaタブ補完設定ファイルを生成し、/usr/local/etc/bash_completion.d/ディレクトリーに保存します。$ rosa completion bash > /usr/local/etc/bash_completion.d/rosa
- 新しいターミナルを開き、設定を有効にします。
Zsh ホストのタブ補完を永続的に有効にするには、以下を実行します。
Zsh 環境でタブ補完が有効になっていない場合は、以下のコマンドを実行して有効にします。
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
Zsh の
rosaタブ補完設定ファイルを生成し、関数パスの最初のディレクトリーに保存します。$ rosa completion zsh > "${fpath[1]}/_rosa"- 新しいターミナルを開き、設定を有効にします。
fish のタブ補完を永続的に有効にするには、以下を実行します。
fish 用の
rosaタブ補完設定ファイルを生成し、~/.config/fish/completions/ディレクトリーに保存します。$ rosa completion fish > ~/.config/fish/completions/rosa.fish
- 新しいターミナルを開き、設定を有効にします。
PowerShell のタブ補完を永続的に有効にするには、以下を実行します。
PowerShell の
rosaタブ補完設定ファイルを生成し、rosa.ps1という名前のファイルに保存します。PS> rosa completion powershell | Out-String | Invoke-Expression
-
PowerShell プロファイルから
rosa.ps1ファイルを取得します。
注記rosaタブ補完の設定に関する詳細は、rosa completion --helpコマンドを実行してヘルプメニューを参照してください。
1.3. ROSA CLI の設定
次のコマンドを使用して、Red Hat OpenShift Service on AWS (ROSA) CLI (rosa) を設定します。
1.3.1. login
Red Hat アカウントにログインし、認証情報を rosa 設定ファイルに保存します。ログイン時にトークンを指定する必要があります。Red Hat OpenShift Service on AWS のトークンページ からトークンをコピーすることができます。
ROSA CLI (rosa) は、以下の優先順位でトークンを検索します。
- コマンドライン引数
-
ROSA_TOKEN環境変数 -
rosa設定ファイル - コマンドラインプロンプトから対話的に
構文
$ rosa login [arguments]
| オプション | 定義 |
|---|---|
| --client-id |
OpenID クライアント識別子 (文字列)。デフォルトは、 |
| --client-secret | OpenID クライアントシークレット (文字列)。 |
| --insecure | サーバーとの非セキュアな通信を有効にします。これにより、TLS 証明書およびホスト名の検証が無効になります。 |
| --scope |
OpenID スコープ (文字列)。このオプションを使用する場合、デフォルトのスコープはこのオプションに置き換えられます。これは複数回繰り返して、複数のスコープを指定できます。デフォルトは、 |
| --token | トークンにアクセスまたは更新します (文字列)。 |
| --token-url |
OpenID トークン URL (文字列)。デフォルトは、 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
1.3.2. logout
rosa からログアウトします。ログアウトすると、rosa 設定ファイルも削除されます。
構文
$ rosa logout [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
1.3.3. verify permissions
ROSA クラスターの作成に必要な AWS パーミッションが正しく設定されていることを確認します。
構文
$ rosa verify permissions [arguments]
このコマンドは、AWS Security Token Service(STS) を使用しないクラスターに対してのみパーミッションを検証します。
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --region |
コマンドを実行する AWS リージョン (文字列)。この値は |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
AWS パーミッションが正しく設定されていることを確認します。
$ rosa verify permissions
AWS パーミッションが特定のリージョンで正しく設定されていることを確認します。
$ rosa verify permissions --region=us-west-2
1.3.4. verify quota
AWS クォータがデフォルトのリージョンに正しく設定されていることを確認します。
構文
$ rosa verify quota [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --region |
コマンドを実行する AWS リージョン (文字列)。この値は |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
AWS クォータがデフォルトのリージョンで正しく設定されていることを確認します。
$ rosa verify quota
AWS クォータが特定のリージョンで正しく設定されていることを確認します。
$ rosa verify quota --region=us-west-2
1.3.5. rosa をダウンロード
ROSA CLI の互換性のある最新バージョンをダウンロードします。
rosa をダウンロードした後、アーカイブの内容を抽出し、パスに追加します。詳細は、ROSA CLI の設定 を参照してください。
構文
$ rosa download rosa [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
1.3.6. download oc
OpenShift Container Platform CLI (oc) の最新の互換性のあるバージョンをダウンロードします。
oc をダウンロードした後、アーカイブの内容を抽出してパスに追加する必要があります。
構文
$ rosa download oc [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
例
oc クライアントツールをダウンロードします。
$ rosa download oc
1.3.7. verify oc
OpenShift Container Platform CLI (oc) が正常にインストールされていることを確認します。
構文
$ rosa verify oc [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
例
oc クライアントツールを確認します。
$ rosa verify oc
1.4. Red Hat OpenShift Service on AWS の初期化
非 STS を使用している場合にのみ、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]
| オプション | 定義 |
|---|---|
| --region |
クォータおよびパーミッションを確認する AWS リージョン (文字列)。この値は、 |
| --delete |
|
| --client-id |
OpenID クライアント識別子 (文字列)。デフォルトは、 |
| --client-secret | OpenID クライアントシークレット (文字列)。 |
| --insecure | サーバーとの非セキュアな通信を有効にします。これにより、TLS 証明書およびホスト名の検証が無効になります。 |
| --scope |
OpenID スコープ (文字列)。このオプションを使用する場合は、デフォルトのスコープを完全に置き換えます。これは複数回繰り返して、複数のスコープを指定できます。デフォルトは、 |
| --token | トークンにアクセスまたは更新します (文字列)。 |
| --token-url |
OpenID トークン URL (文字列)。デフォルトは、 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
AWS アカウントを設定して ROSA クラスターを許可します。
$ rosa init
既存の OpenShift Cluster Manager 認証情報を使用して新規 AWS アカウントを設定します。
$ rosa init --token=$OFFLINE_ACCESS_TOKEN
1.5. Bash スクリプトの使用
これは、Red Hat OpenShift Service on AWS (ROSA) CLI (rosa) で Bash スクリプトを使用する方法のワークフロー例です。
前提条件
AWS 認証情報が以下のオプションのいずれかとして利用可能であることを確認します。
- AWS プロファイル
-
環境変数 (
AWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEY)
手順
Red Hat の OpenShift Cluster Manager オフライントークンを使用して
rosaを初期化します。$ rosa init --token=<token>
Red Hat OpenShift Service on AWS (ROSA) クラスターを作成します。
$ rosa create cluster --cluster-name=<cluster_name>
アイデンティティープロバイダー (IDP) を追加します。
$ rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]
dedicated-adminユーザーを追加します。$ rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>
1.6. ROSA CLI の更新
Red Hat OpenShift Service on AWS (ROSA) CLI (rosa) の互換性のある最新バージョンに更新します。
手順
ROSA CLI (
rosa) の新しいバージョンが利用可能であることを確認します。$ rosa version
出力例
1.2.12 There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
ROSA CLI の互換性のある最新バージョンをダウンロードします。
$ rosa download rosa
このコマンドは、
rosa-*.tar.gzというアーカイブを現在のディレクトリーにダウンロードします。ファイルの正確な名前は、オペレーティングシステムとシステムアーキテクチャーによって異なります。アーカイブの内容を展開します。
$ tar -xzf rosa-linux.tar.gz
抽出したファイルをパスに移動して、新しいバージョンの ROSA CLI をインストールします。以下の例では、
/usr/local/binディレクトリーがユーザーのパスに含まれます。$ sudo mv rosa /usr/local/bin/rosa
検証
新しいバージョンの ROSA がインストールされていることを確認します。
$ rosa version
出力例
1.2.15 Your ROSA CLI is up to date.
第2章 ROSA CLI を使用したオブジェクトの管理
Red Hat OpenShift Service on AWS (ROSA) CLI (rosa) を使用したオブジェクトの管理 (dedicated-admin ユーザーの追加、クラスターの管理、クラスターのアップグレードのスケジュールなど)。
2.1. 一般的なコマンドおよび引数
これらの一般的なコマンドと引数は、Red Hat OpenShift Service on AWS (ROSA) CLI (rosa) で使用できます。
2.1.1. debug
トラブルシューティングに役立つように、親コマンドのデバッグモードを有効にします。
例
$ rosa create cluster --cluster-name=<cluster_name> --debug
2.1.2. ダウンロード
指定されたソフトウェアの互換性のある最新バージョンをアーカイブファイル内の現在のディレクトリーにダウンロードします。ソフトウェアを使用するには、アーカイブの内容を抽出し、その内容をパスに追加します。最新の Red Hat OpenShift Service on AWS CLI をダウンロードするには、rosa を指定します。最新の OpenShift CLI をダウンロードするには、oc を指定します。
例
$ rosa download <software>
2.1.3. help
ROSA CLI (rosa) の一般的なヘルプ情報および利用可能なコマンドの一覧を表示します。このオプションは、version、create などの親コマンドのヘルプ情報を表示する引数として使用することもできます。
例
ROSA CLI の一般的なヘルプを表示します。
$ rosa --help
version の一般的なヘルプを表示します。
$ rosa version --help
2.1.4. interactive
対話モードを有効にします。
例
$ rosa create cluster --cluster-name=<cluster_name> --interactive
2.1.5. profile
認証情報ファイルから AWS プロファイルを指定します。
例
$ rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile
2.1.6. version
rosa のバージョンを表示し、新しいバージョンが利用可能かどうかを確認します。
例
$ rosa version [arguments]
出力例
新しいバージョンの ROSA CLI が利用可能な場合に表示されます。
1.2.12 There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
2.2. 親コマンド
Red Hat OpenShift Service on AWS (ROSA) CLI の rosa は、親コマンドと子コマンドを使用してオブジェクトを管理します。親コマンドは、create、edit、delete、list、および 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 --cluster=mycluster
2.3. オブジェクトの作成
このセクションでは、クラスターおよびリソース向けの create コマンドを説明します。
2.3.1. account-roles の作成
クラスターに必要なアカウント全体のロールとポリシーリソースを作成します。
構文
$ rosa create account-roles [flags]
| オプション | 定義 |
|---|---|
| --debug | デバッグモードを有効化します |
| -i, --interactive | 対話モードを有効にします。 |
| -m, --mode string | 操作の実行方法。有効なオプションは以下のとおりです。
|
| --path 文字列 | Operator ポリシーを含む、アカウント全体のロールとポリシーの ARN パス。 |
| --permissions-boundary 文字列 | アカウントロールのアクセス許可の境界を設定するために使用されるポリシーの ARN。 |
| --prefix 文字列 |
生成されたすべての AWS リソースのユーザー定義の接頭辞。デフォルトは |
| --profile 文字列 | 認証情報ファイルから特定の AWS プロファイルを使用します。 |
| -y、--yes | 自動的に Yes と回答して操作を確定します。 |
2.3.2. create admin
クラスターへのログインが可能な自動生成されたパスワードが設定されたクラスター管理者を作成します。
構文
$ rosa create admin --cluster=<cluster_name>|<cluster_id>
| オプション | 定義 |
|---|---|
| --cluster <cluster_name>|<cluster_id> | 必須。アイデンティティープロバイダー (IDP) に追加するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile 文字列 | 認証情報ファイルから AWS プロファイルを指定します。 |
例
mycluster という名前のクラスターにログインできるクラスター管理者を作成します。
$ rosa create admin --cluster=mycluster
2.3.3. create cluster
新規クラスターを作成します。
構文
$ rosa create cluster --cluster-name=<cluster_name> [arguments]
| オプション | 定義 |
|---|---|
| --cluster-name <cluster_name> |
必須。クラスターの名前。 |
| --compute-machine-type <instance_type> | クラスター内のコンピュートノードのインスタンスタイプ。これは、各コンピュートノードに割り当てられるメモリーおよび仮想 CPU の容量を決定します。有効なインスタンスタイプの詳細は、Red Hat OpenShift Service on AWS サービス定義 の AWS インスタンスタイプ を参照してください。 |
| --compute-nodes n |
アベイラビリティーゾーンごとにプロビジョニングするワーカーノードの数。シングルゾーンクラスターには、2 つ以上のノードが必要です。マルチゾーンクラスターには、3 つ以上のノードが必要です。デフォルト: シングルゾーンクラスターの場合は |
| --controlplane-iam-role <arn> | コントロールプレーンインスタンスにアタッチする IAM ロールの Amazon Resource Name (ARN)。 |
| --disable-scp-checks | クラスターのインストールの試行時に、クラウドパーミッションチェックが無効になるかどうかを示します。 |
| --dry-run | クラスターの作成をシミュレーションします。 |
| --enable-autoscaling |
コンピュートノードの自動スケーリングを有効にします。デフォルトでは、自動スケーリングは |
| --host-prefix <subnet> |
個々のノードに割り当てるサブネット接頭辞の長さを整数で指定します。たとえば、ホスト接頭辞が |
| --machine-cidr <address_block> |
クラスターのインストール中に Red Hat OpenShift Service on AWS によって使用される IP アドレスのブロック (ipNet) (例: 重要
Red Hat OpenShift Service on AWS 4.11 以降のデフォルトのネットワークプロバイダーである OVN-Kubernetes は、IP アドレス範囲 |
| --max-replicas <number_of_nodes> |
自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。デフォルトは、 |
| --min-replicas <number_of_nodes> |
自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。デフォルトは、 |
| --multi-az | 複数のデータセンターにデプロイします。 |
| --operator-roles-prefix <string> | OpenShift インストーラーで必要な Operator によって使用されるすべての IAM ロールに使用する接頭辞。接頭辞を指定しない場合は、接頭辞が自動的に生成されます。 |
| --pod-cidr <address_block> |
Pod IP アドレスの割り当てに使用する IP アドレス (ipNet) のブロックです (例: 重要
Red Hat OpenShift Service on AWS 4.11 以降のデフォルトのネットワークプロバイダーである OVN-Kubernetes は、IP アドレス範囲 |
| --private | プライマリー API エンドポイントおよびアプリケーションルートを直接かつプライベートの接続に制限します。 |
| --private-link |
AWS PrivateLink を使用して VPC とサービス間のプライベート接続を提供することを指定します。 |
| --region <region_name> |
ワーカープールが配置される AWS リージョンの名前 (例: |
| --role-arn <arn> | OpenShift Cluster Manager がクラスターを作成するために使用するインストーラーロールの Amazon Resource Name (ARN)。これは、アカウントのロールをまだ作成していない場合に必要です。 |
| --service-cidr <address_block> |
サービス用の IP アドレス (ipNet) のブロック (例: 重要
Red Hat OpenShift Service on AWS 4.11 以降のデフォルトのネットワークプロバイダーである OVN-Kubernetes は、IP アドレス範囲 |
| --sts | --non-sts | クラスターをデプロイするために AWS Security Token Service (STS) と IAM 認証情報 (非 STS) のどちらを使用するかを指定します。 |
| --subnet-ids <aws_subnet_id> |
クラスターのインストール時に使用する AWS サブネット ID (例:
|
| --support-role-arn 文字列 | Red Hat Site Reliabilty Engineer (SRE) がクラスターアカウントへのアクセスを有効にしてサポートを提供するために使用するロールの Amazon リソースネーム (ARN)。 |
| --version 文字列 |
クラスターまたはクラスターリソースのインストールに使用される Red Hat OpenShift Service on AWS のバージョン。 |
| --worker-iam-role 文字列 | コンピューティングインスタンスにアタッチされる IAM ロールの Amazon リソースネーム (ARN)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスターを作成します。
$ rosa create cluster --cluster-name=mycluster
特定の AWS リージョンでクラスターを作成します。
$ rosa create cluster --cluster-name=mycluster --region=us-east-2
デフォルトのワーカーマシンプールで自動スケーリングを有効にして、クラスターを作成します。
$ rosa create cluster --cluster-name=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=5
2.3.4. create idp
アイデンティティープロバイダー (IDP) を追加して、ユーザーのクラスターへのログイン方法を定義します。
構文
$ rosa create idp --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster <cluster_name>|<cluster_id> | 必須。IDP が追加されるクラスターの名前または ID。 |
| --ca <path_to_file> |
サーバーにリクエストを行うときに使用する PEM エンコードされた証明書ファイルへのパス ( |
| --client-id | 登録されたアプリケーションのクライアント ID (文字列)。 |
| --client-secret | 登録したアプリケーションのクライアントシークレット (文字列)。 |
| --mapping-method |
新規アイデンティティー (文字列) がログイン時にユーザーにマップされる方法を指定します。デフォルトは、 |
| --name | アイデンティティープロバイダーの名前 (文字列)。 |
| --type |
アイデンティティープロバイダーのタイプ (文字列)。オプションは、 |
| オプション | 定義 |
|---|---|
| --hostname | GitHub Enterprise のホストされたインスタンスで使用するためのオプションのドメイン (文字列)。 |
| --organizations | ログインアクセス用の組織を指定します。一覧表示されている組織 (文字列) のうち、1 つ以上の組織のメンバーであるユーザーのみがログインできます。 |
| --teams |
ログインアクセスのためのチームを指定します。一覧表示されているチーム (文字列) のうち、1 つ以上のチームのメンバーであるユーザーのみがログインできます。形式は |
| オプション | 定義 |
|---|---|
| --host-url |
GitLab プロバイダーのホスト URL (文字列)。デフォルトは、 |
| オプション | 定義 |
|---|---|
| --hosted-domain | ユーザーを Google Apps ドメイン (文字列) に制限します。 |
| オプション | 定義 |
|---|---|
| --bind-dn | 検索フェーズでバインドするドメイン名 (文字列) です。 |
| --bind-password | 検索フェーズでバインドするパスワード (文字列) です。 |
| --email-attributes | メールアドレスとして使用する必要がある値を持つ属性の一覧 (文字列) です。 |
| --id-attributes |
ユーザー ID として使用する必要がある値を持つ属性の一覧 (文字列) です。デフォルトは、 |
| --insecure | サーバーへの TLS 接続を実行しません。 |
| --name-attributes |
表示名として使用する必要がある値を持つ属性の一覧 (文字列) です。デフォルトは、 |
| --url | 使用する LDAP 検索パラメーターを指定する RFC 2255 URL (文字列) です。 |
| --username-attributes |
優先ユーザー名として使用する必要がある値を持つ属性の一覧 (文字列) です。デフォルトは、 |
| オプション | 定義 |
|---|---|
| --email-claims | メールアドレスとして使用する要求の一覧 (文字列) です。 |
| --extra-scopes |
認可トークン要求時に |
| --issuer-url | OpenID プロバイダーが発行者 ID としてアサートする URL (文字列)。URL クエリーパラメーターまたはフラグメントのない HTTPS スキームを使用する必要があります。 |
| --name-claims | 表示名として使用する要求の一覧 (文字列) です。 |
| --username-claims | ユーザーをプロビジョニングする際に優先ユーザー名として使用される要求の一覧 (文字列) です。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
GitHub アイデンティティープロバイダーを mycluster という名前のクラスターに追加します。
$ rosa create idp --type=github --cluster=mycluster
インタラクティブなプロンプトに従って、アイデンティティープロバイダーを追加します。
$ rosa create idp --cluster=mycluster --interactive
2.3.5. create ingress
Ingress エンドポイントを追加して、クラスターへの API アクセスを有効にします。
構文
$ rosa create ingress --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster <cluster_name>|<cluster_id> | 必須: Ingress が追加されるクラスターの名前または ID。 |
| --label-match | Ingress のラベル一致 (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。ラベルが指定されていない場合は、すべてのルートが両方のルーターで公開されます。 |
| --private | アプリケーションルートを直接かつプライベートの接続に制限します。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスターに内部イングレスを追加します。
$ rosa create ingress --private --cluster=mycluster
mycluster という名前のクラスターにパブリックイングレスを追加します。
$ rosa create ingress --cluster=mycluster
ルートセレクターラベルが一致するイングレスを追加します。
$ rosa create ingress --cluster=mycluster --label-match=foo=bar,bar=baz
2.3.6. create machinepool
マシンプールを既存クラスターに追加します。
構文
$ rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<number> --name=<machinepool_name> [arguments]
| オプション | 定義 |
|---|---|
| --cluster <cluster_name>|<cluster_id> | 必須: マシンプールを追加するクラスターの名前または ID。 |
| --enable-autoscaling |
コンピュートノードの自動スケーリングを有効または無効にします。自動スケーリングを有効にするには、 |
| --instance-type |
使用する必要のあるインスタンスタイプ (文字列)。デフォルトは、 |
| --labels | マシンプールのラベル (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。この一覧は、継続的にノードラベルに加えられるすべての変更を上書きします。 |
| --max-replicas | 自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。 |
| --min-replicas | 自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。 |
| --name | 必須: マシンプールの名前 (文字列)。 |
| --replicas | 自動スケーリングが設定されていない場合に必要です。このマシンプールのマシンの数 (整数)。 |
| --taints |
マシンプールのテイント。この文字列値は、 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
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.3.7. ocm-role の作成
クラスターに必要な ocm-role リソースを作成します。
構文
$ rosa create ocm-role [flags]
| オプション | 定義 |
|---|---|
| --admin | ロールの管理機能を有効にします。 |
| --debug | デバッグモードを有効化します |
| -i, --interactive | 対話モードを有効にします。 |
| -m, --mode string | 操作の実行方法。有効なオプションは以下のとおりです。
|
| --path 文字列 | OCM ロールとポリシーの ARN パス。 |
| --permissions-boundary 文字列 | OCM ロールのアクセス許可の境界を設定するために使用されるポリシーの ARN。 |
| --prefix 文字列 |
生成されたすべての AWS リソースのユーザー定義の接頭辞。デフォルトは |
| --profile 文字列 | 認証情報ファイルから特定の AWS プロファイルを使用します。 |
| -y、--yes | 自動的に Yes と回答して操作を確定します。 |
rosa create ocm-role コマンドで作成された OCM ロールの詳細には、アカウント全体の IAM ロールとポリシー参照 を参照してください。
2.3.8. user-role の作成
クラスターに必要なユーザーロールリソースを作成します。
構文
$ rosa create user-role [flags]
| オプション | 定義 |
|---|---|
| --debug | デバッグモードを有効化します |
| -i, --interactive | 対話モードを有効にします。 |
| -m, --mode string | 操作の実行方法。有効なオプションは以下のとおりです。
|
| --path 文字列 | ユーザーロールとポリシーの ARN パス。 |
| --permissions-boundary 文字列 | ユーザーロールのアクセス許可の境界を設定するために使用されるポリシーの ARN。 |
| --prefix 文字列 |
生成されたすべての AWS リソースのユーザー定義の接頭辞。デフォルトは |
| --profile 文字列 | 認証情報ファイルから特定の AWS プロファイルを使用します。 |
| -y、--yes | 自動的に Yes と回答して操作を確定します。 |
rosa create user-role コマンドで作成されたユーザーロールの詳細は、AWS アカウントの関連付けについて を参照してください。
2.4. 関連情報
- サポートされているインスタンスタイプのリストは、AWS インスタンスタイプ を参照してください。
- クラスターの作成に必要な IAM ロールのリストについては、アカウント全体の IAM ロールとポリシー参照 を参照してください。
- OCM ロールとユーザーロールの詳細は、AWS アカウントの関連付けについて を参照してください。
2.5. オブジェクトの編集
このセクションでは、クラスターおよびリソースの edit コマンドを説明します。
2.5.1. edit cluster
既存のクラスターの編集を許可します。
構文
$ rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: 編集するクラスターの名前または ID (文字列)。 |
| --private | プライマリー API エンドポイントを直接のプライベート接続に制限します。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
クラスター mycluster を編集して、プライベートにします。
$ rosa edit cluster --cluster=mycluster --private
クラスター mycluster ですべてのクラスターオプションをインタラクティブに編集します。
$ rosa edit cluster --cluster=mycluster --interactive
2.5.2. edit ingress
クラスター向けの追加のデフォルト以外のアプリケーションルーターを編集します。
構文
$ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: Ingress が追加されるクラスターの名前または ID (文字列)。 |
| --label-match | Ingress のラベル一致 (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。ラベルが指定されていない場合は、すべてのルートが両方のルーターで公開されます。 |
| --private | アプリケーションルートを直接かつプライベートの接続に制限します。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
クラスター 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.5.3. edit machinepool
クラスターのマシンプールへの編集を許可します。
構文
$ rosa edit machinepool --cluster=<cluster_name> | <cluster_id> <machinepool_ID> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: 追加のマシンプールが編集されるクラスターの名前または ID (文字列)。 |
| --enable-autoscaling |
コンピュートノードの自動スケーリングを有効または無効にします。自動スケーリングを有効にするには、 |
| --labels | マシンプールのラベル (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。この値の編集は、ノード番号を増やして作成されたマシンプールの新しく作成されたノードにのみ影響し、既存のノードには影響しません。この一覧は、継続的にノードラベルに加えられるすべての変更を上書きします。 |
| --max-replicas | 自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。 |
| --min-replicas | 自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。 |
| --replicas | 自動スケーリングが設定されていない場合に必要です。このマシンプールのマシンの数 (整数)。 |
| --taints |
マシンプールのテイント。この文字列値は、 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
クラスター mycluster で、マシンプール mp1 に 4 つのレプリカを設定します。
$ rosa edit machinepool --cluster=mycluster --replicas=4 --name=mp1
クラスター mycluster で、マシンプール mp1 の自動スケーリングを有効にします。
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 --name=mp1
クラスター mycluster で、マシンプール mp1 の自動スケーリングを無効にします。
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling=false --replicas=3 --name=mp1
クラスター mycluster で、マシンプール mp1 の自動スケーリング範囲を変更します。
$ rosa edit machinepool --max-replicas=9 --cluster=mycluster --name=mp1
2.6. オブジェクトの削除
このセクションでは、クラスターおよびリソースの delete コマンドを説明します。
2.6.1. delete admin
指定されたクラスターからクラスター管理者を削除します。
構文
$ rosa delete admin --cluster=<cluster_name> | <cluster_id>
| オプション | 定義 |
|---|---|
| --cluster | 必須: アイデンティティープロバイダー (IDP) に追加するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
クラスター mycluster からクラスター管理者を削除します。
$ rosa delete admin --cluster=mycluster
2.6.2. delete cluster
クラスターを削除します。
構文
$ rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: 削除するクラスターの名前または ID (文字列)。 |
| --watch | クラスターのアンインストールログを監視します。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
| --yes |
操作を確認するために、自動的に |
例
クラスター mycluster を削除します。
$ rosa delete cluster --cluster=mycluster
2.6.3. delete idp
クラスターから特定のアイデンティティープロバイダー (IDP) を削除します。
構文
$ rosa delete idp --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: IDP を削除するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
| --yes |
操作を確認するために、自動的に |
例
クラスター mycluster から github という名前のアイデンティティープロバイダーを削除します。
$ rosa delete idp github --cluster=mycluster
2.6.4. delete ingress
デフォルト以外のアプリケーションルーター (ingress) をクラスターから削除します。
構文
$ rosa delete ingress --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: Ingress を削除するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
| --yes |
操作を確認するために、自動的に |
例
クラスター mycluster から ID a1b2 の Ingress を削除します。
$ rosa delete ingress --cluster=mycluster a1b2
クラスター mycluster から、サブドメイン名 apps2 のセカンダリー Ingress を削除します。
$ rosa delete ingress --cluster=mycluster apps2
2.6.5. delete machinepool
クラスターからマシンプールを削除します。
構文
$ rosa delete machinepool --cluster=<cluster_name> | <cluster_id> <machine_pool_id>
| オプション | 定義 |
|---|---|
| --cluster | 必須: マシンプールが削除されるクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --interactive | 対話モードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
| --yes |
操作を確認するために、自動的に |
例
クラスター mycluster から ID mp-1 のマシンプールを削除します。
$ rosa delete machinepool --cluster=mycluster mp-1
2.7. アドオンのインストールおよびアンインストール
本セクションでは、クラスターに Red Hat マネージドサービスアドオンをインストールおよびアンインストールする方法を説明します。
2.7.1. install addon
クラスターにマネージドサービスアドオンをインストールします。
構文
$ rosa install addon --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: アドオンがインストールされるクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから特定の AWS プロファイル (文字列) を使用します。 |
| --yes |
操作を確認するために、自動的に |
例
mycluster という名前のクラスターに dbaas-operator アドオンインストールを追加します。
$ rosa install addon --cluster=mycluster dbaas-operator
2.7.2. uninstall addon
クラスターからマネージドサービスアドオンをアンインストールします。
構文
$ rosa uninstall addon --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: アドオンのアンインストール元となるクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから特定の AWS プロファイル (文字列) を使用します。 |
| --yes |
操作を確認するために、自動的に |
例
mycluster という名前のクラスターから dbaas-operator アドオンインストールを削除します。
$ rosa uninstall addon --cluster=mycluster dbaas-operator
2.8. オブジェクトの一覧表示および説明
このセクションでは、クラスターおよびリソースの list コマンドおよび describe コマンドを説明します。
2.8.1. list addon
マネージドサービスアドオンインストールを一覧表示します。
構文
$ rosa list addons --cluster=<cluster_name> | <cluster_id>
| オプション | 定義 |
|---|---|
| --cluster | 必須: アドオンを一覧表示するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
2.8.2. list clusters
すべてのクラスターを一覧表示します。
構文
$ rosa list clusters [arguments]
| オプション | 定義 |
|---|---|
| --count |
表示するクラスターの数 (整数)。デフォルトは、 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
2.8.3. list idps
クラスターのすべてのアイデンティティープロバイダー (IDP) を一覧表示します。
構文
$ rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: IDP を一覧表示するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスターのアイデンティティープロバイダー (IDP) をすべて一覧表示します。
$ rosa list idps --cluster=mycluster
2.8.4. list ingresses
クラスターのすべての API および Ingress エンドポイントを一覧表示します。
構文
$ rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: IDP を一覧表示するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスターのすべての API およびイングレスエンドポイントを一覧表示します。
$ rosa list ingresses --cluster=mycluster
2.8.5. list instance-types
Red Hat OpenShift Service on AWS で使用できるすべてのインスタンスタイプを一覧表示します。可用性は、アカウントの AWS クォータに基づいています。
構文
$ rosa list instance-types [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --output |
出力フォーマット。許可される形式は |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
すべてのインスタンスタイプを一覧表示します。
$ rosa list instance-types
2.8.6. list machinepools
クラスターに設定されたマシンプールを一覧表示します。
構文
$ rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: マシンプールを一覧表示するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスター上のすべてのマシンプールを一覧表示します。
$ rosa list machinepools --cluster=mycluster
2.8.7. list regions
現在の AWS アカウントで利用可能なリージョンの一覧を表示します。
構文
$ rosa list regions [arguments]
| オプション | 定義 |
|---|---|
| --multi-az | 複数のアベイラビリティーゾーンのサポートを提供するリージョンを一覧表示します。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
利用可能なすべてのリージョンを一覧表示します。
$ rosa list regions
2.8.8. list upgrades
利用可能かつスケジュールされたクラスターバージョンのアップグレードをすべて一覧表示します。
構文
$ rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: 利用可能なアップグレードを一覧表示するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスターで利用可能なすべてのアップグレードを一覧表示します。
$ rosa list upgrades --cluster=mycluster
2.8.9. list users
指定されたクラスターのクラスター管理者および専用の管理者のユーザーを一覧表示します。
構文
$ rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: クラスター管理者を一覧表示するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスターのすべてのクラスター管理者と専用管理者を一覧表示します。
$ rosa list users --cluster=mycluster
2.8.10. list versions
クラスターの作成に利用可能な OpenShift バージョン一覧を表示します。
構文
$ rosa list versions [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
OpenShift Container Platform のすべてのバージョンを一覧表示します。
$ rosa list versions
2.8.11. describe admin
指定した cluster-admin ユーザーの詳細と、クラスターにログインするコマンドを表示します。
構文
$ rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: cluster-admin が属するクラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスターの cluster-admin ユーザーを記述します。
$ rosa describe admin --cluster=mycluster
2.8.12. describe addon
マネージドサービスアドオンの詳細を表示します。
構文
$ rosa describe addon <addon_id> | <addon_name> [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
dbaas-operator という名前のアドオンを記述します。
$ rosa describe addon dbaas-operator
2.8.13. describe cluster
クラスターの詳細を表示します。
構文
$ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: クラスターの名前または ID (文字列)。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster という名前のクラスターを記述します。
$ rosa describe cluster --cluster=mycluster
2.9. クラスターのアップグレードおよびアップグレードの削除
本セクションでは、クラスターの upgrade コマンドの使用を説明します。
2.9.1. upgrade cluster
クラスターのアップグレードをスケジュールします。
構文
$ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: アップグレードがスケジュールされるクラスターの名前または ID (文字列)。 |
| --interactive | 対話モードを有効にします。 |
| --version | クラスターをアップグレードする OpenShift Container Platform のバージョン (文字列) です。 |
| --schedule-date |
指定した時間に次のアップグレードが実行される日付 (文字列)。形式は、 |
| --schedule-time |
指定した日付に次のアップグレードが実行される時間。形式は、 |
| --node-drain-grace-period |
アップグレード時に、Pod の Disruption Budget (停止状態の予算) で保護されるワークロードが尊重される期間の猶予期間 (文字列) を設定します。この猶予期間後に、ノードから正常にドレイン (解放) されていない Pod の Disruption Budget (停止状態の予算) で保護されるワークロードは、強制的にエビクトされます。デフォルトは、 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
例
mycluster という名前のクラスターでアップグレードをインタラクティブにスケジュールします。
$ rosa upgrade cluster --cluster=mycluster --interactive
mycluster という名前のクラスターで、1 時間以内にクラスターアップグレードをスケジュールします。
$ rosa upgrade cluster --cluster=mycluster --version 4.5.20
2.9.2. delete upgrade
スケジュールされたクラスターアップグレードをキャンセルします。
構文
$ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
| オプション | 定義 |
|---|---|
| --cluster | 必須: アップグレードがキャンセルされるクラスターの名前または ID (文字列) です。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --yes |
操作を確認するために、自動的に |
第3章 ROSA CLI でアカウントおよびバージョン情報の確認
3.1. ROSA CLI でアカウントおよびバージョン情報の確認
次のコマンドを使用して、Red Hat OpenShift Service on AWS (ROSA) CLI、rosa でアカウントとバージョン情報を確認します。
3.1.1. whoami
AWS および Red Hat アカウントに関する情報を表示します。
構文
$ rosa whoami [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
$ rosa whoami
3.1.2. version
Red Hat OpenShift Service on AWS (ROSA) CLI rosa のバージョンを表示します。
構文
$ rosa version [arguments]
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
$ rosa version
第4章 ROSA CLI を使用したログの確認
4.1. ROSA CLI を使用したログの確認
Red Hat OpenShift Service on AWS (ROSA) CLI (rosa) を使用してログを確認できます。以下のコマンドを使用して、インストールログおよびアンインストールログを確認します。
4.1.1. logs install
クラスターのインストールログを表示します。
構文
$ rosa logs install --cluster=<cluster_name> | <cluster_id> [arguments]
| オプション | 定義 |
|---|---|
| --cluster | 必須: ログを取得するためのクラスターの名前または ID (文字列)。 |
| --tail |
ログの最後から取得する行の数 (整数)。デフォルトは、 |
| --watch | ログの取得後に変更の有無を監視します。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
クラスター 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]
| オプション | 定義 |
|---|---|
| --cluster | ログを取得するためのクラスターの名前または ID (文字列)。 |
| --tail |
ログの最後から取得する行の数 (整数)。デフォルトは、 |
| --watch | ログの取得後に変更の有無を監視します。 |
| オプション | 定義 |
|---|---|
| --help | このコマンドのヘルプを表示します。 |
| --debug | デバッグモードを有効にします。 |
| --profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
クラスター mycluster の最新の 100 個のアンインストールログを表示します。
$ rosa logs uninstall --cluster=mycluster --tail=100
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman 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 Software Collections 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.
