8.2. ROSA CLI を使用したオブジェクトの管理

--debug

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

-i, --interactive

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

-m, --mode string

操作の実行方法。有効なオプションは以下のとおりです。

--path 文字列

Operator ポリシーを含む、アカウント全体のロールとポリシーの Amazon Resource Name (ARN) パス。

--permissions-boundary 文字列

アカウントロールのアクセス許可の境界を設定するために使用されるポリシーの ARN。

--prefix 文字列

生成されたすべての AWS リソースのユーザー定義の接頭辞。デフォルトは ManagedOpenShift です。

--profile 文字列

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

-y, --yes

自動的に Yes と回答して操作を確定します。

--cluster <cluster_name>|<cluster_id>

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

--help

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

--debug

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

--interactive

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

--profile 文字列

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

--cluster <cluster_name>|<cluster_id>

必須。break glass 認証情報を追加するクラスターの名前または ID。

--expiration

オプション: break glass 認証情報が期限切れになるまでに使用できる期間。有効期限は、最小 10 分、最大 24 時間にする必要があります。値を入力しない場合、有効期限はデフォルトで 24 時間になります。

--username

オプション: break glass 認証情報のユーザー名。値を入力しない場合は、ランダムなユーザー名が生成されます。

--help

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

--debug

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

--interactive

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

--profile

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

--region

AWS_REGION 環境変数を上書きし、AWS リージョンを指定します。

--yes

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

--additional-compute-security-group-ids <sec_group_id>

クラスターと一緒に作成される標準マシンプール用のデフォルトセキュリティーグループとともに使用する、1 つ以上の追加セキュリティーグループの識別子。追加セキュリティーグループの詳細は、関連情報 の セキュリティーグループ の要件を参照してください。

--additional-infra-security-group-ids <sec_group_id>

クラスターと一緒に作成されるインフラノード用のデフォルトセキュリティーグループとともに使用する、1 つ以上の追加セキュリティーグループの識別子。追加セキュリティーグループの詳細は、関連情報 の セキュリティーグループ の要件を参照してください。

--additional-control-plane-security-group-ids <sec_group_id>

クラスターと一緒に作成されるコントロールプレーンノード用のデフォルトセキュリティーグループとともに使用する、1 つ以上の追加セキュリティーグループの識別子。追加セキュリティーグループの詳細は、関連情報 の セキュリティーグループ の要件を参照してください。

--additional-allowed-principals <arn>

追加の VPC エンドポイント接続要求の自動受け入れを可能にするために Hosted Control Plane の VPC エンドポイントサービスに追加される、追加の許可済みプリンシパル ARN のコンマ区切りリスト。

--cluster-name <cluster_name>

必須。クラスターの名前。create cluster コマンドで使用する場合、この引数はクラスター名の設定に使用され、最大 54 文字を保持できます。この引数の値は組織内で一意である必要があります。

--compute-machine-type <instance_type>

クラスター内のコンピュートノードのインスタンスタイプ。これは、各コンピュートノードに割り当てられるメモリーおよび仮想 CPU の容量を決定します。有効なインスタンスタイプの詳細は、ROSA サービス定義 の AWS インスタンスタイプ を参照してください。

--controlplane-iam-role <arn>

コントロールプレーンインスタンスにアタッチする IAM ロールの ARN。

--create-cluster-admin

オプション: クラスター作成の一環として、クラスターのローカル管理者ユーザー (cluster-admin) を作成します。これにより、cluster-admin ユーザーの htpasswd アイデンティティープロバイダーが自動的に設定されます。必要に応じて、--cluster-admin-user および --cluster-admin-password オプションを使用して、管理者ユーザーのユーザー名とパスワードを指定します。これらのオプションを省略すると、認証情報が自動的に生成され、その値がターミナルの出力として表示されます。

--cluster-admin-user

オプション: --create-cluster-admin オプションと組み合わせて使用する場合に、作成するクラスター管理者ユーザーのユーザー名を指定します。

--cluster-admin-password

オプション: --create-cluster-admin オプションと組み合わせて使用する場合に、作成するクラスター管理者ユーザーのパスワードを指定します。

--disable-scp-checks

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

--dry-run

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

--domain-prefix

オプション: create cluster コマンドで使用する場合、この引数は *.openshiftapps.com 上のクラスターのサブドメインを設定します。この引数の値は組織内で一意である必要があり、15 文字を超えてはならず、クラスターの作成後に変更できません。引数が指定されていない場合は、クラスター名の長さに応じて自動生成された値が作成されます。クラスター名が 15 文字以下の場合、その名前がドメイン接頭辞に使用されます。クラスター名が 15 文字を超える場合、ドメイン接頭辞は 15 文字の文字列にランダムに生成されます。

--ec2-metadata-http-tokens string

EC2 インスタンスに対する IMDSv2 の使用を設定します。有効な値は、optional (デフォルト) または required です。

--enable-autoscaling

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

--etcd-encryption

Red Hat OpenShift Service on AWS (クラシックアーキテクチャー) クラスターで ETCD キー値の暗号化を有効にします。

--etcd-encryption-kms-arn

AWS Key Management Service で管理される顧客管理の鍵を使用して、ETCD ストレージの暗号化を有効にします。

--host-prefix <subnet>

個々のノードに割り当てるサブネット接頭辞の長さを整数で指定します。たとえば、ホスト接頭辞が 23 に設定される場合は、各ノードに指定の CIDR から /23 サブネットが割り当てられます。

--machine-cidr <address_block>

クラスターのインストール中に ROSA によって使用される IP アドレスのブロック (ipNet) (例: 10.0.0.0/16)。

--max-replicas <number_of_nodes>

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

--min-replicas <number_of_nodes>

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

--multi-az

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

--no-cni

Container Network Interface (CNI) プラグインなしでクラスターを作成します。クラスターの作成後、お客様は独自の CNI プラグインを用意してインストールできます。

--operator-roles-prefix <string>

OpenShift インストーラーで必要な Operator によって使用されるすべての IAM ロールに使用する接頭辞。接頭辞を指定しない場合は、接頭辞が自動的に生成されます。

--pod-cidr <address_block>

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

--private

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

--private-link

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

--region <region_name>

ワーカープールが配置される AWS リージョンの名前 (例: us-east-1)。この引数は AWS_REGION 環境変数を上書きします。

--replicas n

アベイラビリティーゾーンごとにプロビジョニングするワーカーノードの数。シングルゾーンクラスターには、2 つ以上のノードが必要です。マルチゾーンクラスターには、3 つ以上のノードが必要です。デフォルト: シングルゾーンクラスターの場合は 2。マルチゾーンクラスターの場合は 3。

--role-arn <arn>

OpenShift Cluster Manager がクラスターの作成に使用するインストーラーロールの ARN。これは、アカウントのロールをまだ作成していない場合に必要です。

--service-cidr <address_block>

サービス用の IP アドレス (ipNet) のブロック (例: 172.30.0.0/16)。

--sts | --non-sts

クラスターをデプロイするために AWS Security Token Service (STS) と IAM 認証情報 (非 STS) のどちらを使用するかを指定します。

--subnet-ids <aws_subnet_id>

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

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

--support-role-arn 文字列

Red Hat Site Reliabilty Engineer (SRE) がクラスターアカウントへのアクセスを有効にしてサポートを提供するために使用するロールの ARN。

--tags

Red Hat OpenShift Service on AWS によって作成された AWS 内のリソースで使用されるタグ。タグは、AWS 内のリソースの管理、識別、整理、検索、フィルタリングに使用できます。タグはコンマで区切られます (例: "key value、foo bar")。

--version 文字列

クラスターまたはクラスターリソースのインストールに使用する ROSA のバージョン。cluster の場合は X.Y.Z 形式を使用します (例: 4.17.0)。account-role の場合は X.Y 形式 (例: 4.17) を使用します。

--worker-iam-role 文字列

コンピューティングインスタンスにアタッチされる IAM ロールの ARN。

--help

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

--debug

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

--interactive

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

--profile

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

--claim-mapping-groups-claim <string>

必須。ID トークンからの情報をクラスターアイデンティティーに変換する方法に関するルールを説明します。

--claim-validation-rule <strings>

ユーザーを認証するためにトークン要求を検証するために適用されるルール。入力は <claim>:<required_value> 形式になります。複数のクレーム検証ルールを設定するには、値を , で区切ります。たとえば、<claim>:<required_value>,<claim>:<required_value> です。

--claim-mapping-username-claim <string>

クラスターアイデンティティーのユーザー名を構築するために使用されるクレームの名前。

--cluster <cluster_name>|<cluster_id>

必須。IDP が追加されるクラスターの名前または ID。

--console-client-id <string>

OpenShift Cluster Manager Web コンソールの OIDC プロバイダーからの OIDC クライアントの識別子。

--console-client-secret <string>

コンソールアプリケーションの登録に関連付けられているシークレット。

--issuer-audiences <strings>

受信トークンをチェックするオーディエンスの配列。有効なトークンには、オーディエンス要求にこれらの値の少なくとも 1 つが含まれている必要があります。

--issuer-ca-file <string>

サーバーにリクエストを行うときに使用する PEM エンコードされた証明書ファイルへのパス。

--issuer-url <string>

トークン発行者のサービス URL。

--name <string>

外部認証プロバイダーを参照するために使用される名前。

--help

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

--debug

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

--interactive

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

--profile

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

--cluster <cluster_name>|<cluster_id>

必須。IDP が追加されるクラスターの名前または ID。

--ca <path_to_file>

サーバーにリクエストを行うときに使用する PEM エンコードされた証明書ファイルへのパス (/usr/share/cert.pem など)。

--client-id

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

--client-secret

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

--mapping-method

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

--name

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

--type

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

--hostname

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

--organizations

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

--teams

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

--host-url

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

--hosted-domain

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

--bind-dn

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

--bind-password

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

--email-attributes

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

--id-attributes

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

--insecure

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

--name-attributes

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

--url

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

--username-attributes

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

--email-claims

メールアドレスとして使用するクレームのリスト (文字列) です。

--extra-scopes

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

--issuer-url

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

--name-claims

表示名として使用するクレームのリスト (文字列) です。

--username-claims

ユーザーをプロビジョニングするときに優先ユーザー名として使用するクレームのリスト (文字列) です。

--groups-claims

グループ名として使用するクレームのリスト (文字列) です。

--help

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

--debug

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

--interactive

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

--profile

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

--cluster <cluster_name>|<cluster_id>

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

--label-match

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

--private

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

--help

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

--debug

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

--interactive

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

--profile

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

--pod-pids-limit <number>

必須。KubeletConfig オブジェクトに関連付けられたマシンプール内の各ノードの最大 PID 数。

-c, --cluster <cluster_name>|<cluster_id>

必須。KubeletConfig オブジェクトの作成先であるクラスターの名前または ID。

--name

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) で必要です。クラスターには KubeletConfig が 1 つしかないため、Red Hat OpenShift Service on AWS ではオプションです。KubeletConfig オブジェクトの名前を指定します。

-i, --interactive

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

-h、--help

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

--additional-security-group-ids <sec_group_id>

このマシンプールのデフォルトセキュリティーグループとともに使用する、1 つ以上の追加セキュリティーグループの識別子。追加セキュリティーグループの詳細は、関連情報 の セキュリティーグループ の要件を参照してください。

--cluster <cluster_name>|<cluster_id>

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

--disk-size

マシンプールのディスクボリュームサイズを Gib または TiB で設定します。デフォルトは 300 GiB です。

ROSA (クラシックアーキテクチャー) クラスターバージョン 4.13 以前では、最小ディスクサイズは 128 GiB、最大ディスクサイズは 1 TiB です。クラスターバージョン 4.14 以降では、最小値は 128 GiB、最大値は 16 TiB です。

ROSA with HCP クラスターでは、最小ディスクサイズは 75 GiB、最大ディスクサイズは 16,384 GiB です。

--enable-autoscaling

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

--instance-type

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

--kubelet-configs <kubeletconfig_name>

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、マシンプール内のノードに適用する KubeletConfig オブジェクトの名前。

--labels

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

--max-replicas

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

--min-replicas

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

--max-surge

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、max-surge パラメーターは、--replicas パラメーターを使用して設定された、または自動スケーリングが有効な場合に自動スケーラーによって決定された、マシンプールの必要なレプリカ数を超えてプロビジョニングできる新しいノードの数を定義します。これは絶対数 (例: 2) またはマシンプールサイズのパーセンテージ (例: 20%) にすることができますが、max-unavailable パラメーターと同じ単位を使用する必要があります。

デフォルト値は 1 です。つまり、アップグレード中のマシンプール内のノードの最大数は、マシンプールのレプリカの希望数に 1 を加えた数になります。このような状況では、既存のノードを使用不可にする前に、余分なノードを 1 つプロビジョニングできます。アップグレード中に同時にプロビジョニングできるノードの数は、max-surge と max-unavailable の合計です。

--max-unavailable

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、max-unavailable パラメーターは、アップグレード中に新しいノードがプロビジョニングされる前に、マシンプールで使用不可にできるノードの数を定義します。これは絶対数 (例: 2) またはマシンプール内の現在のレプリカ数のパーセンテージ (例: 20%) にすることができますが、max-surge パラメーターと同じ単位を使用する必要があります。

デフォルト値は 0 です。これは、新しいノードがプロビジョニングされる前に古いノードが削除されないことを意味します。この値の有効な範囲は、0 から現在のマシンプールサイズ、または 0% から 100% です。アップグレード中に同時にアップグレードできるノードの合計数は、max-surge と max-unavailable の合計です。

--name

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

--replicas

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

--tags

AWS で ROSA によって作成されたすべてのリソースに、ユーザー定義のタグを適用します。タグはコンマで区切られます (例: 'key value, foo bar')。

--taints

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

--help

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

--debug

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

--interactive

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

--profile

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

<template-name>

カスタムテンプレートを使用できます。テンプレートは、templates/<template-name>/cloudformation.yaml という構造でテンプレートフォルダーに配置する必要があります。テンプレート名が指定されていない場合、コマンドはデフォルトのテンプレートを使用します。バイナリービルドの場合、このテンプレートディレクトリーをダウンロード後に手動で参照する必要があります。

--template-dir

テンプレートディレクトリーへのパスを指定できます。OCM_TEMPLATE_DIR 環境変数がオーバーライドされます。テンプレートディレクトリー内でコマンドを実行していない場合は必須です。

--param Name

ネットワークの名前を定義します。カスタムテンプレートファイルを使用する場合は必須パラメーターです。

--param Region

ネットワークのリージョンを定義します。カスタムテンプレートファイルを使用する場合は必須パラメーターです。

--param <various>

使用可能なパラメーターはテンプレートによって異なります。使用可能なパラメーターを見つけるには、テンプレートディレクトリー内で --help を使用します。

--mode=manual

ネットワークスタックを作成するための AWS コマンドを提供します。

--admin

ロールの管理機能を有効にします。

--debug

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

-i, --interactive

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

-m, --mode string

操作の実行方法。有効なオプションは以下のとおりです。

--path 文字列

OCM ロールとポリシーの ARN パス。

--permissions-boundary 文字列

OCM ロールのアクセス許可の境界を設定するために使用されるポリシーの ARN。

--prefix 文字列

生成されたすべての AWS リソースのユーザー定義の接頭辞。デフォルトは ManagedOpenShift です。

--profile 文字列

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

-y, --yes

自動的に Yes と回答して操作を確定します。

--debug

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

-i, --interactive

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

-m, --mode string

操作の実行方法。有効なオプションは以下のとおりです。

--path 文字列

ユーザーロールとポリシーの ARN パス。

--permissions-boundary 文字列

ユーザーロールのアクセス許可の境界を設定するために使用されるポリシーの ARN。

--prefix 文字列

生成されたすべての AWS リソースのユーザー定義の接頭辞。デフォルトは ManagedOpenShift です。

--profile 文字列

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

-y, --yes

自動的に Yes と回答して操作を確定します。

--additional-allowed-principals <arn>

追加の VPC エンドポイント接続要求の自動受け入れを可能にするために Hosted Control Plane の VPC エンドポイントサービスに追加される、追加の許可済みプリンシパル ARN のコンマ区切りリスト。

--cluster

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

--private

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

--enable-delete-protection=true

削除保護機能を有効にします。

--enable-delete-protection=false

削除保護機能を無効にします。

--help

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

--debug

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

--interactive

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

--profile

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

--cluster

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

--cluster-routes-hostname

OAuth、コンソール、ダウンロードのコンポーネントルートのホスト名。

--cluster-routes-tls-secret-ref

OAuth、コンソール、ダウンロードのコンポーネントルートの TLS シークレット参照。

--excluded-namespaces

Ingress の除外対象の namespace。形式はコンマ区切りリスト value1、value2… です。値が指定されていない場合は、すべての namespace が公開されます。

--label-match

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

--lb-type

ロードバランサーのタイプ。オプションは classic、nlb です。

--namespace-ownership-policy

Ingress の namespace 所有権ポリシー。オプションは Strict および InterNamespaceAllowed です。デフォルトは Strict です。

--private

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

--route-selector

Ingress のルートセレクター。形式は key=value のコンマ区切りリストです。ラベルが指定されていない場合は、すべてのルートが両方のルーターで公開されます。従来の Ingress サポートの場合、このラベルは包含ラベルです。それ以外の場合は、除外ラベルとして扱われます。

--wildcard-policy

Ingress のワイルドカードポリシー。オプションは WildcardsDisallowed および WildcardsAllowed です。デフォルトは WildcardsDisallowed です。

--help

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

--debug

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

--interactive

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

--profile

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

-c, --cluster <cluster_name>|<cluster_id>

必須。KubeletConfig オブジェクトを編集するクラスターの名前または ID。

-i, --interactive

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

--pod-pids-limit <number>

必須。KubeletConfig オブジェクトに関連付けられたマシンプール内の各ノードの最大 PID 数。

--name

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) で必要です。クラスターには KubeletConfig が 1 つしかないため、Red Hat OpenShift Service on AWS ではオプションです。KubeletConfig オブジェクトの名前を指定します。

-h、--help

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

--cluster

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

--enable-autoscaling

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

--labels

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

--kubelet-configs <kubeletconfig_name>

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、マシンプール内のノードに適用する KubeletConfig オブジェクトの名前。

--max-replicas

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

--min-replicas

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

--max-surge

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、max-surge パラメーターは、--replicas パラメーターを使用して設定された、または自動スケーリングが有効な場合に自動スケーラーによって決定された、マシンプールの必要なレプリカ数を超えてプロビジョニングできる新しいノードの数を定義します。これは絶対数 (例: 2) またはマシンプールサイズのパーセンテージ (例: 20%) にすることができますが、max-unavailable パラメーターと同じ単位を使用する必要があります。

デフォルト値は 1 です。つまり、アップグレード中のマシンプール内のノードの最大数は、マシンプールのレプリカの希望数に 1 を加えた数になります。このような状況では、既存のノードを使用不可にする前に、余分なノードを 1 つプロビジョニングできます。アップグレード中に同時にプロビジョニングできるノードの数は、max-surge と max-unavailable の合計です。

--max-unavailable

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、max-unavailable パラメーターは、アップグレード中に新しいノードがプロビジョニングされる前に、マシンプールで使用不可にできるノードの数を定義します。これは絶対数 (例: 2) またはマシンプール内の現在のレプリカ数のパーセンテージ (例: 20%) にすることができますが、max-surge パラメーターと同じ単位を使用する必要があります。

デフォルト値は 0 です。これは、新しいノードがプロビジョニングされる前に古いノードが削除されないことを意味します。この値の有効な範囲は、0 から現在のマシンプールサイズ、または 0% から 100% です。アップグレード中に同時にアップグレードできるノードの合計数は、max-surge と max-unavailable の合計です。

--node-drain-grace-period

マシンプールをアップグレードまたは置き換えるときのノードドレイン猶予期間を指定します。(これは ROSA with HCP クラスターのみ対象です。)

--replicas

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

--taints

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

--help

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

--debug

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

--interactive

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

--profile

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

--cluster

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

--help

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

--debug

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

--interactive

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

--profile

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

--cluster

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

--watch

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

--best-effort

クラスター削除プロセスの失敗の原因となることが判明しているクラスター破棄チェーンのステップをスキップします。このオプションは慎重に使用してください。--best-effort を使用した後は、残っているリソースがないか AWS アカウントを手動で確認することを推奨します。

--help

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

--debug

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

--interactive

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

--profile

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

--yes

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

--cluster

必須。外部認証プロバイダーが削除されるクラスターの名前または ID 文字列。

--help

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

--debug

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

--interactive

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

--profile

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

--yes

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

--cluster

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

--help

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

--debug

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

--interactive

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

--profile

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

--yes

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

--cluster

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

--help

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

--debug

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

--interactive

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

--profile

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

--yes

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

-c, --cluster <cluster_name>|<cluster_id>

必須。KubeletConfig オブジェクトを削除するクラスターの名前または ID。

-h、--help

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

--name

Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) で必要です。クラスターには KubeletConfig が 1 つしかないため、Red Hat OpenShift Service on AWS ではオプションです。KubeletConfig オブジェクトの名前を指定します。

-y, --yes

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

--cluster

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

--help

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

--debug

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

--interactive

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

--profile

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

--yes

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

--cluster

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

--help

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

--debug

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

--profile

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

--yes

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

--cluster

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

--help

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

--debug

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

--profile

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

--yes

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

--cluster

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

--help

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

--debug

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

--profile

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

--cluster <cluster_name>|<cluster_id>

必須。break glass 認証情報が追加されたクラスターの名前または ID。

--help

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

--debug

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

--profile

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

--count

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

--help

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

--debug

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

--profile

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

--cluster

必須: 外部認証プロバイダーがリストされるクラスターの名前または ID 文字列。

--help

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

--debug

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

--profile

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

--cluster

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

--help

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

--debug

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

--profile

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

--cluster

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

--help

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

--debug

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

--profile

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

--help

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

--debug

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

--output

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

--profile

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

--cluster

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

--help

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

--debug

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

--cluster

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

--help

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

--debug

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

--profile

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

--multi-az

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

--help

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

--debug

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

--profile

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

--cluster

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

--help

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

--debug

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

--profile

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

--cluster

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

--help

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

--debug

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

--profile

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

--help

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

--debug

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

--profile

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

--cluster

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

--help

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

--debug

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

--profile

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

--help

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

--debug

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

--profile

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

--cluster

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

--id

必須: break glass 認証情報の ID (文字列)。

--kubeconfig

オプション: Break Glass 認証情報から kubeconfig を取得します。

--help

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

--debug

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

--profile

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

--cluster

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

--help

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

--debug

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

--profile

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

--get-role-policy-bindings

クラスターに割り当てられた STS ロールにアタッチされているポリシーをリスト表示します。

-c, --cluster <cluster_name>|<cluster_id>

必須。KubeletConfig オブジェクトを表示するクラスターの名前または ID。

-h、--help

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

--name

オプション: 記述する KubeletConfig オブジェクトの名前を指定します。

-o、--output string

-o、--output string

--cluster

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

--machinepool

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

--help

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

--debug

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

--profile

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

--cluster

必須: break glass 認証情報が削除されるクラスターの名前または ID (文字列)。

--help

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

--debug

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

--profile

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

--yes

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

--cluster

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

--interactive

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

--version

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

--schedule-date

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

--schedule-time

次回のアップグレードは、協定世界時 (UTC) で指定された日付に実行されます。形式は、HH:mm です。

--node-drain-grace-period ^[1]

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

--control-plane ^[2]

クラスターの Hosted Control Plane をアップグレードします。

--help

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

--cluster

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

--help

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

--debug

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

--yes

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

--cluster

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

--schedule-date

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

--schedule-time

次回のアップグレードは、協定世界時 (UTC) で指定された日付に実行されます。形式は、HH:mm です。

--help

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

--debug

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

--profile

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

--cluster

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

--help

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

--debug

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

--profile

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

--cluster

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

--help

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

--debug

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

--profile

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