8.2. ROSA CLI を使用したオブジェクトの管理
Red Hat OpenShift Service on AWS (ROSA) CLI (rosa
) を使用したオブジェクトの管理 (dedicated-admin
ユーザーの追加、クラスターの管理、クラスターのアップグレードのスケジュールなど)。
HTTP プロキシーサーバー上でのみアクセスできるクラスターにアクセスするには、HTTP_PROXY
、HTTPS_PROXY
、および NO_PROXY
変数を設定できます。これらの環境変数は、クラスターとのすべての通信が HTTP プロキシーを経由するように rosa
CLI で使用されます。
8.2.1. 一般的なコマンドおよび引数
これらの一般的なコマンドと引数は、Red Hat OpenShift Service on AWS (ROSA) CLI (rosa
) で使用できます。
8.2.1.1. debug
トラブルシューティングに役立つように、親コマンドのデバッグモードを有効にします。
例
$ rosa create cluster --cluster-name=<cluster_name> --debug
8.2.1.2. download
指定されたソフトウェアの互換性のある最新バージョンをアーカイブファイル形式でカレントディレクトリーにダウンロードします。ソフトウェアを使用するには、アーカイブの内容を抽出し、その内容をパスに追加します。最新の ROSA CLI をダウンロードするには、rosa
を指定します。最新の OpenShift CLI をダウンロードするには、oc
を指定します。
例
$ rosa download <software>
8.2.1.3. help
ROSA CLI (rosa
) の一般的なヘルプ情報および利用可能なコマンドの一覧を表示します。このオプションは、version
、create
などの親コマンドのヘルプ情報を表示する引数として使用することもできます。
例
ROSA CLI の一般的なヘルプを表示します。
$ rosa --help
version
の一般的なヘルプを表示します。
$ rosa version --help
8.2.1.4. interactive
対話モードを有効にします。
例
$ rosa create cluster --cluster-name=<cluster_name> --interactive
8.2.1.5. profile
認証情報ファイルから AWS プロファイルを指定します。
例
$ rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile
8.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/
8.2.2. 親コマンド
Red Hat OpenShift Service on AWS (ROSA) CLI の rosa
は、親コマンドと子コマンドを使用してオブジェクトを管理します。親コマンドは、create
、edit
、delete
、list
、および describe
です。すべての親コマンドをすべての子コマンドと共に使用できる訳ではありません。詳細は、子コマンドを説明する特定の参照トピックを参照してください。
8.2.2.1. create
子コマンドとペアとなった場合に、オブジェクトまたはリソースを作成します。
例
$ rosa create cluster --cluster-name=mycluster
8.2.2.2. edit
クラスタープライベートの作成など、オブジェクトのオプションを編集します。
例
$ rosa edit cluster --cluster=mycluster --private
8.2.2.3. delete
子コマンドとペアとなった場合に、オブジェクトまたはリソースを削除します。
例
$ rosa delete ingress --cluster=mycluster
8.2.2.4. list
特定のクラスター向けにクラスターまたはリソースをリスト表示します。
例
$ rosa list users --cluster=mycluster
8.2.2.5. describe
クラスターの詳細を表示します。
例
$ rosa describe cluster --cluster=mycluster
8.2.3. オブジェクトの作成
このセクションでは、クラスターおよびリソース向けの create
コマンドを説明します。
8.2.3.1. account-roles の作成
クラスターに必要なアカウント全体のロールとポリシーリソースを作成します。
構文
$ rosa create account-roles [flags]
オプション | 定義 |
---|---|
--debug | デバッグモードを有効化します |
-i, --interactive | 対話モードを有効にします。 |
-m, --mode string | 操作の実行方法。有効なオプションは以下のとおりです。
|
--path 文字列 | Operator ポリシーを含む、アカウント全体のロールとポリシーの Amazon Resource Name (ARN) パス。 |
--permissions-boundary 文字列 | アカウントロールのアクセス許可の境界を設定するために使用されるポリシーの ARN。 |
--prefix 文字列 |
生成されたすべての AWS リソースのユーザー定義の接頭辞。デフォルトは |
--profile 文字列 | 認証情報ファイルから特定の AWS プロファイルを使用します。 |
-y, --yes | 自動的に Yes と回答して操作を確定します。 |
8.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
8.2.3.3. break glass 認証情報の作成
外部認証が有効になっている Hosted Control Plane クラスターの Break Glass 認証情報を作成します。
構文
$ rosa create break-glass-credential --cluster=<cluster_name> [arguments]
オプション | 定義 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必須。break glass 認証情報を追加するクラスターの名前または ID。 |
--expiration | オプション: break glass 認証情報が期限切れになるまでに使用できる期間。有効期限は、最小 10 分、最大 24 時間にする必要があります。値を入力しない場合、有効期限はデフォルトで 24 時間になります。 |
--username | オプション: break glass 認証情報のユーザー名。値を入力しない場合は、ランダムなユーザー名が生成されます。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--interactive | 対話モードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
--region |
|
--yes |
操作を確認するために、自動的に |
例
mycluster
という名前のクラスターに Break Glass 認証情報を追加します。
構文
$ rosa create break-glass-credential --cluster=mycluster
インタラクティブモードを使用して、mycluster
という名前のクラスターに Break Glass 認証情報を追加します。
構文
$ rosa create break-glass-credential --cluster=mycluster -i
8.2.3.4. create cluster
新規クラスターを作成します。
構文
$ rosa create cluster --cluster-name=<cluster_name> [arguments]
オプション | 定義 |
---|---|
--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> |
必須。クラスターの名前。 |
--compute-machine-type <instance_type> | クラスター内のコンピュートノードのインスタンスタイプ。これは、各コンピュートノードに割り当てられるメモリーおよび仮想 CPU の容量を決定します。有効なインスタンスタイプの詳細は、ROSA サービス定義 の AWS インスタンスタイプ を参照してください。 |
--controlplane-iam-role <arn> | コントロールプレーンインスタンスにアタッチする IAM ロールの ARN。 |
--create-cluster-admin |
オプション: クラスター作成の一環として、クラスターのローカル管理者ユーザー ( |
--cluster-admin-user |
オプション: |
--cluster-admin-password |
オプション: |
--disable-scp-checks | クラスターのインストールの試行時に、クラウドパーミッションチェックが無効になるかどうかを示します。 |
--dry-run | クラスターの作成をシミュレーションします。 |
--domain-prefix |
オプション: |
--ec2-metadata-http-tokens string |
EC2 インスタンスに対する IMDSv2 の使用を設定します。有効な値は、 |
--enable-autoscaling |
コンピュートノードの自動スケーリングを有効にします。デフォルトでは、自動スケーリングは |
--etcd-encryption | Red Hat OpenShift Service on AWS (クラシックアーキテクチャー) クラスターで ETCD キー値の暗号化を有効にします。 |
--etcd-encryption-kms-arn | AWS Key Management Service で管理される顧客管理の鍵を使用して、ETCD ストレージの暗号化を有効にします。 |
--host-prefix <subnet> |
個々のノードに割り当てるサブネット接頭辞の長さを整数で指定します。たとえば、ホスト接頭辞が |
--machine-cidr <address_block> |
クラスターのインストール中に ROSA によって使用される IP アドレスのブロック (ipNet) (例: 重要
ROSA 4.11 以降のデフォルトのネットワークプロバイダーである OVN-Kubernetes は、IP アドレス範囲 |
--max-replicas <number_of_nodes> |
自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。デフォルトは、 |
--min-replicas <number_of_nodes> |
自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。デフォルトは、 |
--multi-az | 複数のデータセンターにデプロイします。 |
--no-cni | Container Network Interface (CNI) プラグインなしでクラスターを作成します。クラスターの作成後、お客様は独自の CNI プラグインを用意してインストールできます。 |
--operator-roles-prefix <string> | OpenShift インストーラーで必要な Operator によって使用されるすべての IAM ロールに使用する接頭辞。接頭辞を指定しない場合は、接頭辞が自動的に生成されます。 |
--pod-cidr <address_block> |
Pod IP アドレスの割り当てに使用する IP アドレス (ipNet) のブロックです (例: 重要
ROSA 4.11 以降のデフォルトのネットワークプロバイダーである OVN-Kubernetes は、IP アドレス範囲 |
--private | プライマリー API エンドポイントおよびアプリケーションルートを直接かつプライベートの接続に制限します。 |
--private-link |
AWS PrivateLink を使用して VPC とサービス間のプライベート接続を提供することを指定します。 |
--region <region_name> |
ワーカープールが配置される AWS リージョンの名前 (例: |
--replicas n |
アベイラビリティーゾーンごとにプロビジョニングするワーカーノードの数。シングルゾーンクラスターには、2 つ以上のノードが必要です。マルチゾーンクラスターには、3 つ以上のノードが必要です。デフォルト: シングルゾーンクラスターの場合は |
--role-arn <arn> | OpenShift Cluster Manager がクラスターの作成に使用するインストーラーロールの ARN。これは、アカウントのロールをまだ作成していない場合に必要です。 |
--service-cidr <address_block> |
サービス用の IP アドレス (ipNet) のブロック (例: 重要
ROSA 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) がクラスターアカウントへのアクセスを有効にしてサポートを提供するために使用するロールの ARN。 |
--tags | Red Hat OpenShift Service on AWS によって作成された AWS 内のリソースで使用されるタグ。タグは、AWS 内のリソースの管理、識別、整理、検索、フィルタリングに使用できます。タグはコンマで区切られます (例: "key value、foo bar")。 重要 Red Hat OpenShift Service on AWS は、クラスター作成時に Red Hat OpenShift リソースへのカスタムタグのみをサポートします。タグを追加すると、削除したり編集したりすることはできません。Red Hat が追加したタグは、クラスターが Red Hat の実稼働サービスレベルアグリーメント (SLA) への準拠を維持するために必要です。これらのタグは削除してはいけません。 Red Hat OpenShift Service on AWS では、ROSA クラスターマネージドリソース以外へのタグの追加はサポートされていません。AWS リソースが ROSA クラスターによって管理されている場合、これらのタグが失われる可能性があります。このような場合、タグを調整してそのままの状態に保つためのカスタムソリューションまたはツールが必要になる可能性があります。 |
--version 文字列 |
クラスターまたはクラスターリソースのインストールに使用する ROSA のバージョン。 |
--worker-iam-role 文字列 | コンピューティングインスタンスにアタッチされる IAM ロールの 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
8.2.3.5. external-auth-provider の作成
OpenShift OAuth2 サーバーの代わりに外部 ID プロバイダーを追加します。
ROSA with HCP クラスターでは外部認証プロバイダーしか使用できません。
構文
$ rosa create external-auth-provider --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--claim-mapping-groups-claim <string> | 必須。ID トークンからの情報をクラスターアイデンティティーに変換する方法に関するルールを説明します。 |
--claim-validation-rule <strings> |
ユーザーを認証するためにトークン要求を検証するために適用されるルール。入力は |
--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 プロファイル文字列を指定します。 |
例
mycluster
という名前のクラスターに Microsoft Entra ID アイデンティティープロバイダーを追加します。
$ rosa create external-auth-provider --cluster=mycluster --name <provider_name> --issuer-audiences <audience_id> --issuer-url <issuing id> --claim-mapping-username-claim email --claim-mapping-groups-claim groups
8.2.3.6. 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 | ユーザーをプロビジョニングするときに優先ユーザー名として使用するクレームのリスト (文字列) です。 |
--groups-claims | グループ名として使用するクレームのリスト (文字列) です。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--interactive | 対話モードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
GitHub アイデンティティープロバイダーを mycluster
という名前のクラスターに追加します。
$ rosa create idp --type=github --cluster=mycluster
インタラクティブなプロンプトに従って、アイデンティティープロバイダーを追加します。
$ rosa create idp --cluster=mycluster --interactive
8.2.3.7. 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
8.2.3.8. create kubeletconfig
マシンプール内のノードのカスタム設定を可能にするために、カスタム KubeletConfig
オブジェクトを作成します。Red Hat OpenShift Service on AWS クラスターの場合、これらの設定はクラスター全体に適用されます。Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、各マシンプールを別々に設定できます。
構文
$ rosa create kubeletconfig --cluster=<cluster_name|cluster_id> --name=<kubeletconfig_name> --pod-pids-limit=<number> [flags]
オプション | 定義 |
---|---|
--pod-pids-limit <number> |
必須。 |
-c, --cluster <cluster_name>|<cluster_id> |
必須。 |
--name |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) で必要です。クラスターには |
-i, --interactive | 対話モードを有効にします。 |
-h、--help | このコマンドのヘルプを表示します。 |
クラスターの PID 制限の設定の詳細は、PID 制限の設定 を参照してください。
8.2.3.9. create machinepool
マシンプールを既存クラスターに追加します。
構文
$ rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<number> --name=<machinepool_name> [arguments]
オプション | 定義 |
---|---|
--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 |
コンピュートノードの自動スケーリングを有効または無効にします。自動スケーリングを有効にするには、 |
--instance-type |
使用する必要のあるインスタンスタイプ (文字列)。デフォルトは、 |
--kubelet-configs <kubeletconfig_name> |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、マシンプール内のノードに適用する |
--labels | マシンプールのラベル (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。このリストは、継続的にノードラベルに加えられるすべての変更を上書きします。 |
--max-replicas | 自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。 |
--min-replicas | 自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。 |
--max-surge |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、
デフォルト値は |
--max-unavailable |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、
デフォルト値は |
--name | 必須: マシンプールの名前 (文字列)。 |
--replicas | 自動スケーリングが設定されていない場合に必要です。このマシンプールのマシンの数 (整数)。 |
--tags |
AWS で ROSA によって作成されたすべてのリソースに、ユーザー定義のタグを適用します。タグはコンマで区切られます (例: |
--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
Hosted Control Plane (HCP) クラスターを使用して Red Hat OpenShift Service on AWS (ROSA) にマシンプール (mp-1
) を追加し、6 つのレプリカと次のアップグレード動作を設定します。
- アップグレード中に最大 2 つの余分なノードをプロビジョニングできるようにします。
- アップグレード中に使用できないノードが 3 つ以下であることを確認します。
$ rosa create machinepool --cluster=mycluster --replicas=6 --name=mp-1 --max-surge=2 --max-unavailable=3
ラベル付きのマシンプールをクラスターに追加します。
$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-1
タグ付きのマシンプールをクラスターに追加します。
$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --tags='foo bar,bar baz' --name=mp-1
8.2.3.10. create network
AWS CloudFormation テンプレートを通じて、必要な AWS リソースを作成するネットワークを作成します。このヘルパーコマンドは、ROSA with HCP で使用する VPC の作成と設定を支援することを目的としています。このコマンドは、ゼロ Egress クラスターもサポートしています。
このコマンドを実行すると、AWS アカウント内にリソースが作成されます。
カスタム設定または詳細設定を指定する場合は、aws cloudformation
コマンドを使用して AWS CLI を直接使用するか、必要な設定を含む新しいカスタムテンプレートを作成することを強く推奨します。
構文
$ rosa create network [flags]
オプション | 定義 |
---|---|
<template-name> |
カスタムテンプレートを使用できます。テンプレートは、 |
デフォルトテンプレート YAML
AWSTemplateFormatVersion: '2010-09-09' Description: CloudFormation template to create a ROSA Quickstart default VPC. This CloudFormation template may not work with rosa CLI versions later than 1.2.47. Please ensure that you are using the compatible CLI version before deploying this template. Parameters: AvailabilityZoneCount: Type: Number Description: "Number of Availability Zones to use" Default: 1 MinValue: 1 MaxValue: 3 Region: Type: String Description: "AWS Region" Default: "us-west-2" Name: Type: String Description: "Name prefix for resources" VpcCidr: Type: String Description: CIDR block for the VPC Default: '10.0.0.0/16' Conditions: HasAZ1: !Equals [!Ref AvailabilityZoneCount, 1] HasAZ2: !Equals [!Ref AvailabilityZoneCount, 2] HasAZ3: !Equals [!Ref AvailabilityZoneCount, 3] One: Fn::Or: - Condition: HasAZ1 - Condition: HasAZ2 - Condition: HasAZ3 Two: Fn::Or: - Condition: HasAZ3 - Condition: HasAZ2 Resources: VPC: Type: AWS::EC2::VPC Properties: CidrBlock: !Ref VpcCidr EnableDnsSupport: true EnableDnsHostnames: true Tags: - Key: Name Value: !Ref Name - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' S3VPCEndpoint: Type: AWS::EC2::VPCEndpoint Properties: VpcId: !Ref VPC ServiceName: !Sub "com.amazonaws.${Region}.s3" VpcEndpointType: Gateway RouteTableIds: - !Ref PublicRouteTable - !Ref PrivateRouteTable SubnetPublic1: Condition: One Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [0, !Cidr [!Ref VpcCidr, 6, 8]] AvailabilityZone: !Select [0, !GetAZs ''] MapPublicIpOnLaunch: true Tags: - Key: Name Value: !Sub "${Name}-Public-Subnet-1" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' - Key: 'kubernetes.io/role/elb' Value: '1' SubnetPrivate1: Condition: One Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [1, !Cidr [!Ref VpcCidr, 6, 8]] AvailabilityZone: !Select [0, !GetAZs ''] MapPublicIpOnLaunch: false Tags: - Key: Name Value: !Sub "${Name}-Private-Subnet-1" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' - Key: 'kubernetes.io/role/internal-elb' Value: '1' SubnetPublic2: Condition: Two Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [2, !Cidr [!Ref VpcCidr, 6, 8]] AvailabilityZone: !Select [1, !GetAZs ''] MapPublicIpOnLaunch: true Tags: - Key: Name Value: !Sub "${Name}-Public-Subnet-2" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' - Key: 'kubernetes.io/role/elb' Value: '1' SubnetPrivate2: Condition: Two Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [3, !Cidr [!Ref VpcCidr, 6, 8]] AvailabilityZone: !Select [1, !GetAZs ''] MapPublicIpOnLaunch: false Tags: - Key: Name Value: !Sub "${Name}-Private-Subnet-2" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' - Key: 'kubernetes.io/role/internal-elb' Value: '1' SubnetPublic3: Condition: HasAZ3 Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [4, !Cidr [!Ref VpcCidr, 6, 8]] AvailabilityZone: !Select [2, !GetAZs ''] MapPublicIpOnLaunch: true Tags: - Key: Name Value: !Sub "${Name}-Public-Subnet-3" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' - Key: 'kubernetes.io/role/elb' Value: '1' SubnetPrivate3: Condition: HasAZ3 Type: AWS::EC2::Subnet Properties: VpcId: !Ref VPC CidrBlock: !Select [5, !Cidr [!Ref VpcCidr, 6, 8]] AvailabilityZone: !Select [2, !GetAZs ''] MapPublicIpOnLaunch: false Tags: - Key: Name Value: !Sub "${Name}-Private-Subnet-3" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' - Key: 'kubernetes.io/role/internal-elb' Value: '1' InternetGateway: Type: AWS::EC2::InternetGateway Properties: Tags: - Key: Name Value: !Ref Name - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' AttachGateway: Type: AWS::EC2::VPCGatewayAttachment Properties: VpcId: !Ref VPC InternetGatewayId: !Ref InternetGateway ElasticIP1: Type: AWS::EC2::EIP Properties: Domain: vpc Tags: - Key: Name Value: !Ref Name - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' ElasticIP2: Type: AWS::EC2::EIP Properties: Domain: vpc Tags: - Key: Name Value: !Ref Name - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' ElasticIP3: Condition: HasAZ3 Type: AWS::EC2::EIP Properties: Domain: vpc Tags: - Key: Name Value: !Ref Name - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' NATGateway1: Condition: One Type: 'AWS::EC2::NatGateway' Properties: AllocationId: !GetAtt ElasticIP1.AllocationId SubnetId: !Ref SubnetPublic1 Tags: - Key: Name Value: !Sub "${Name}-NAT-1" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' NATGateway2: Condition: Two Type: 'AWS::EC2::NatGateway' Properties: AllocationId: !GetAtt ElasticIP2.AllocationId SubnetId: !Ref SubnetPublic2 Tags: - Key: Name Value: !Sub "${Name}-NAT-2" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' NATGateway3: Condition: HasAZ3 Type: 'AWS::EC2::NatGateway' Properties: AllocationId: !GetAtt ElasticIP3.AllocationId SubnetId: !Ref SubnetPublic3 Tags: - Key: Name Value: !Sub "${Name}-NAT-3" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' PublicRouteTable: Type: AWS::EC2::RouteTable Properties: VpcId: !Ref VPC Tags: - Key: Name Value: !Ref Name - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' PublicRoute: Type: AWS::EC2::Route DependsOn: AttachGateway Properties: RouteTableId: !Ref PublicRouteTable DestinationCidrBlock: 0.0.0.0/0 GatewayId: !Ref InternetGateway PrivateRouteTable: Type: AWS::EC2::RouteTable Properties: VpcId: !Ref VPC Tags: - Key: Name Value: !Sub "${Name}-Private-Route-Table" - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' - Key: 'service' Value: 'ROSA' PrivateRoute: Type: AWS::EC2::Route Properties: RouteTableId: !Ref PrivateRouteTable DestinationCidrBlock: 0.0.0.0/0 NatGatewayId: !If - One - !Ref NATGateway1 - !If - Two - !Ref NATGateway2 - !If - HasAZ3 - !Ref NATGateway3 - !Ref "AWS::NoValue" PublicSubnetRouteTableAssociation1: Condition: One Type: AWS::EC2::SubnetRouteTableAssociation Properties: SubnetId: !Ref SubnetPublic1 RouteTableId: !Ref PublicRouteTable PublicSubnetRouteTableAssociation2: Condition: Two Type: AWS::EC2::SubnetRouteTableAssociation Properties: SubnetId: !Ref SubnetPublic2 RouteTableId: !Ref PublicRouteTable PublicSubnetRouteTableAssociation3: Condition: HasAZ3 Type: AWS::EC2::SubnetRouteTableAssociation Properties: SubnetId: !Ref SubnetPublic3 RouteTableId: !Ref PublicRouteTable PrivateSubnetRouteTableAssociation1: Condition: One Type: AWS::EC2::SubnetRouteTableAssociation Properties: SubnetId: !Ref SubnetPrivate1 RouteTableId: !Ref PrivateRouteTable PrivateSubnetRouteTableAssociation2: Condition: Two Type: AWS::EC2::SubnetRouteTableAssociation Properties: SubnetId: !Ref SubnetPrivate2 RouteTableId: !Ref PrivateRouteTable PrivateSubnetRouteTableAssociation3: Condition: HasAZ3 Type: AWS::EC2::SubnetRouteTableAssociation Properties: SubnetId: !Ref SubnetPrivate3 RouteTableId: !Ref PrivateRouteTable SecurityGroup: Type: AWS::EC2::SecurityGroup Properties: GroupDescription: "Authorize inbound VPC traffic" VpcId: !Ref VPC SecurityGroupIngress: - IpProtocol: -1 FromPort: 0 ToPort: 0 CidrIp: "10.0.0.0/16" SecurityGroupEgress: - IpProtocol: -1 FromPort: 0 ToPort: 0 CidrIp: 0.0.0.0/0 Tags: - Key: Name Value: !Ref Name - Key: 'service' Value: 'ROSA' - Key: 'rosa_managed_policies' Value: 'true' - Key: 'rosa_hcp_policies' Value: 'true' EC2VPCEndpoint: Type: AWS::EC2::VPCEndpoint Properties: VpcId: !Ref VPC ServiceName: !Sub "com.amazonaws.${Region}.ec2" PrivateDnsEnabled: true VpcEndpointType: Interface SubnetIds: - !If [One, !Ref SubnetPrivate1, !Ref "AWS::NoValue"] - !If [Two, !Ref SubnetPrivate2, !Ref "AWS::NoValue"] - !If [HasAZ3, !Ref SubnetPrivate3, !Ref "AWS::NoValue"] SecurityGroupIds: - !Ref SecurityGroup KMSVPCEndpoint: Type: AWS::EC2::VPCEndpoint Properties: VpcId: !Ref VPC ServiceName: !Sub "com.amazonaws.${Region}.kms" PrivateDnsEnabled: true VpcEndpointType: Interface SubnetIds: - !If [One, !Ref SubnetPrivate1, !Ref "AWS::NoValue"] - !If [Two, !Ref SubnetPrivate2, !Ref "AWS::NoValue"] - !If [HasAZ3, !Ref SubnetPrivate3, !Ref "AWS::NoValue"] SecurityGroupIds: - !Ref SecurityGroup STSVPCEndpoint: Type: AWS::EC2::VPCEndpoint Properties: VpcId: !Ref VPC ServiceName: !Sub "com.amazonaws.${Region}.sts" PrivateDnsEnabled: true VpcEndpointType: Interface SubnetIds: - !If [One, !Ref SubnetPrivate1, !Ref "AWS::NoValue"] - !If [Two, !Ref SubnetPrivate2, !Ref "AWS::NoValue"] - !If [HasAZ3, !Ref SubnetPrivate3, !Ref "AWS::NoValue"] SecurityGroupIds: - !Ref SecurityGroup EcrApiVPCEndpoint: Type: AWS::EC2::VPCEndpoint Properties: VpcId: !Ref VPC ServiceName: !Sub "com.amazonaws.${Region}.ecr.api" PrivateDnsEnabled: true VpcEndpointType: Interface SubnetIds: - !If [One, !Ref SubnetPrivate1, !Ref "AWS::NoValue"] - !If [Two, !Ref SubnetPrivate2, !Ref "AWS::NoValue"] - !If [HasAZ3, !Ref SubnetPrivate3, !Ref "AWS::NoValue"] SecurityGroupIds: - !Ref SecurityGroup EcrDkrVPCEndpoint: Type: AWS::EC2::VPCEndpoint Properties: VpcId: !Ref VPC ServiceName: !Sub "com.amazonaws.${Region}.ecr.dkr" PrivateDnsEnabled: true VpcEndpointType: Interface SubnetIds: - !If [One, !Ref SubnetPrivate1, !Ref "AWS::NoValue"] - !If [Two, !Ref SubnetPrivate2, !Ref "AWS::NoValue"] - !If [HasAZ3, !Ref SubnetPrivate3, !Ref "AWS::NoValue"] SecurityGroupIds: - !Ref SecurityGroup Outputs: VPCId: Description: "VPC Id" Value: !Ref VPC Export: Name: !Sub "${Name}-VPCId" VPCEndpointId: Description: The ID of the VPC Endpoint Value: !Ref S3VPCEndpoint Export: Name: !Sub "${Name}-VPCEndpointId" PublicSubnets: Description: "Public Subnet Ids" Value: !Join [",", [!If [One, !Ref SubnetPublic1, !Ref "AWS::NoValue"], !If [Two, !Ref SubnetPublic2, !Ref "AWS::NoValue"], !If [HasAZ3, !Ref SubnetPublic3, !Ref "AWS::NoValue"]]] Export: Name: !Sub "${Name}-PublicSubnets" PrivateSubnets: Description: "Private Subnet Ids" Value: !Join [",", [!If [One, !Ref SubnetPrivate1, !Ref "AWS::NoValue"], !If [Two, !Ref SubnetPrivate2, !Ref "AWS::NoValue"], !If [HasAZ3, !Ref SubnetPrivate3, !Ref "AWS::NoValue"]]] Export: Name: !Sub "${Name}-PrivateSubnets" EIP1AllocationId: Description: Allocation ID for ElasticIP1 Value: !GetAtt ElasticIP1.AllocationId Export: Name: !Sub "${Name}-EIP1-AllocationId" EIP2AllocationId: Description: Allocation ID for ElasticIP2 Value: !GetAtt ElasticIP2.AllocationId Export: Name: !Sub "${Name}-EIP2-AllocationId" EIP3AllocationId: Condition: HasAZ3 Description: Allocation ID for ElasticIP3 Value: !GetAtt ElasticIP3.AllocationId Export: Name: !Sub "${Name}-EIP3-AllocationId" NatGatewayId: Description: The NAT Gateway IDs Value: !Join [",", [!If [One, !Ref NATGateway1, !Ref "AWS::NoValue"], !If [Two, !Ref NATGateway2, !Ref "AWS::NoValue"], !If [HasAZ3, !Ref NATGateway3, !Ref "AWS::NoValue"]]] Export: Name: !Sub "${Name}-NatGatewayId" InternetGatewayId: Description: The ID of the Internet Gateway Value: !Ref InternetGateway Export: Name: !Sub "${Name}-InternetGatewayId" PublicRouteTableId: Description: The ID of the public route table Value: !Ref PublicRouteTable Export: Name: !Sub "${Name}-PublicRouteTableId" PrivateRouteTableId: Description: The ID of the private route table Value: !Ref PrivateRouteTable Export: Name: !Sub "${Name}-PrivateRouteTableId" EC2VPCEndpointId: Description: The ID of the EC2 VPC Endpoint Value: !Ref EC2VPCEndpoint Export: Name: !Sub "${Name}-EC2VPCEndpointId" KMSVPCEndpointId: Description: The ID of the KMS VPC Endpoint Value: !Ref KMSVPCEndpoint Export: Name: !Sub "${Name}-KMSVPCEndpointId" STSVPCEndpointId: Description: The ID of the STS VPC Endpoint Value: !Ref STSVPCEndpoint Export: Name: !Sub "${Name}-STSVPCEndpointId" EcrApiVPCEndpointId: Description: The ID of the ECR API VPC Endpoint Value: !Ref EcrApiVPCEndpoint Export: Name: !Sub "${Name}-EcrApiVPCEndpointId" EcrDkrVPCEndpointId: Description: The ID of the ECR DKR VPC Endpoint Value: !Ref EcrDkrVPCEndpoint Export: Name: !Sub "${Name}-EcrDkrVPCEndpointId"
オプション | 定義 |
---|---|
--template-dir |
テンプレートディレクトリーへのパスを指定できます。 |
--param Name | ネットワークの名前を定義します。カスタムテンプレートファイルを使用する場合は必須パラメーターです。 |
--param Region | ネットワークのリージョンを定義します。カスタムテンプレートファイルを使用する場合は必須パラメーターです。 |
--param <various> |
使用可能なパラメーターはテンプレートによって異なります。使用可能なパラメーターを見つけるには、テンプレートディレクトリー内で |
--mode=manual | ネットワークスタックを作成するための AWS コマンドを提供します。 |
例
通常の引数とフラグを使用して基本的なネットワークを作成します。
$ rosa create network rosa-quickstart-default-vpc --param Tags=key1=value1,key2=value2 --param Name=example-stack --param Region=us-west-2
8.2.3.11. 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 ロールとポリシー参照 を参照してください。
8.2.3.12. 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 アカウントの関連付けについて を参照してください。
8.2.4. 関連情報
- サポートされているインスタンスタイプのリストは、AWS インスタンスタイプ を参照してください。
- クラスターの作成に必要な IAM ロールのリストは、アカウント全体の IAM ロールとポリシー参照 を参照してください。
- OCM ロールとユーザーロールの詳細は、AWS アカウントの関連付けについて を参照してください。
- セキュリティーグループの要件は、追加のカスタムセキュリティーグループ を参照してください。
8.2.5. オブジェクトの編集
このセクションでは、クラスターおよびリソースの edit
コマンドを説明します。
8.2.5.1. edit cluster
既存のクラスターの編集を許可します。
構文
$ rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--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 プロファイル (文字列) を指定します。 |
例
クラスター mycluster
を編集して、プライベートにします。
$ rosa edit cluster --cluster=mycluster --private
クラスター mycluster
ですべてのクラスターオプションをインタラクティブに編集します。
$ rosa edit cluster --cluster=mycluster --interactive
8.2.5.2. edit ingress
クラスターのデフォルトのアプリケーションルーターを編集します。
デフォルト以外のアプリケーションルーターの編集は、関連情報 を参照してください。
構文
$ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: Ingress が追加されるクラスターの名前または ID (文字列)。 |
--cluster-routes-hostname | OAuth、コンソール、ダウンロードのコンポーネントルートのホスト名。 |
--cluster-routes-tls-secret-ref | OAuth、コンソール、ダウンロードのコンポーネントルートの TLS シークレット参照。 |
--excluded-namespaces |
Ingress の除外対象の namespace。形式はコンマ区切りリスト |
--label-match | Ingress のラベル一致 (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。ラベルが指定されていない場合は、すべてのルートが両方のルーターで公開されます。 |
--lb-type |
ロードバランサーのタイプ。オプションは |
--namespace-ownership-policy |
Ingress の namespace 所有権ポリシー。オプションは |
--private | アプリケーションルートを直接かつプライベートの接続に制限します。 |
--route-selector | Ingress のルートセレクター。形式は key=value のコンマ区切りリストです。ラベルが指定されていない場合は、すべてのルートが両方のルーターで公開されます。従来の Ingress サポートの場合、このラベルは包含ラベルです。それ以外の場合は、除外ラベルとして扱われます。 |
--wildcard-policy |
Ingress のワイルドカードポリシー。オプションは |
オプション | 定義 |
---|---|
--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
apps2
Ingress のロードバランサータイプを更新します。
$ rosa edit ingress --lb-type=nlb --cluster=mycluster apps2
8.2.5.3. edit kubeletconfig
マシンプール内のカスタム KubeletConfig
オブジェクトを編集します。
構文
$ rosa edit kubeletconfig --cluster=<cluster_name|cluster_id> --name=<kubeletconfig_name> --pod-pids-limit=<number> [flags]
オプション | 定義 |
---|---|
-c, --cluster <cluster_name>|<cluster_id> |
必須。 |
-i, --interactive | 対話モードを有効にします。 |
--pod-pids-limit <number> |
必須。 |
--name |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) で必要です。クラスターには |
-h、--help | このコマンドのヘルプを表示します。 |
クラスターの PID 制限の設定の詳細は、PID 制限の設定 を参照してください。
8.2.5.4. edit machinepool
クラスターのマシンプールへの編集を許可します。
構文
$ rosa edit machinepool --cluster=<cluster_name_or_id> <machinepool_name> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: 追加のマシンプールが編集されるクラスターの名前または ID (文字列)。 |
--enable-autoscaling |
コンピュートノードの自動スケーリングを有効または無効にします。自動スケーリングを有効にするには、 |
--labels | マシンプールのラベル (文字列)。形式は、キーと値のペアのコンマ区切りリストにする必要があります。この値の編集は、ノード番号を増やして作成されたマシンプールの新しく作成されたノードにのみ影響し、既存のノードには影響しません。このリストは、継続的にノードラベルに加えられるすべての変更を上書きします。 |
--kubelet-configs <kubeletconfig_name> |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、マシンプール内のノードに適用する |
--max-replicas | 自動スケーリングを有効にする際のコンピュートノードの最大数を指定します。 |
--min-replicas | 自動スケーリングを有効にする際のコンピュートノードの最小数を指定します。 |
--max-surge |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、
デフォルト値は |
--max-unavailable |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) の場合、
デフォルト値は |
--node-drain-grace-period | マシンプールをアップグレードまたは置き換えるときのノードドレイン猶予期間を指定します。(これは ROSA with HCP クラスターのみ対象です。) |
--replicas | 自動スケーリングが設定されていない場合に必要です。このマシンプールのマシンの数 (整数)。 |
--taints |
マシンプールのテイント。この文字列値は、 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--interactive | 対話モードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
クラスター mycluster
で、マシンプール mp1
に 4 つのレプリカを設定します。
$ rosa edit machinepool --cluster=mycluster --replicas=4 mp1
クラスター mycluster
で、マシンプール mp1
の自動スケーリングを有効にします。
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 mp1
クラスター mycluster
で、マシンプール mp1
の自動スケーリングを無効にします。
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling=false --replicas=3 mp1
クラスター mycluster
で、マシンプール mp1
の自動スケーリング範囲を変更します。
$ rosa edit machinepool --max-replicas=9 --cluster=mycluster mp1
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) で、mp1
マシンプールを編集して、アップグレード中に次の動作を追加します。
- アップグレード中に最大 2 つの余分なノードをプロビジョニングできるようにします。
- アップグレード中に使用できないノードが 3 つ以下であることを確認します。
$ rosa edit machinepool --cluster=mycluster mp1 --max-surge=2 --max-unavailable=3
KubeletConfig
オブジェクトを、ROSA with HCP クラスター上の既存の high-pid-pool
マシンプールに関連付けます。
$ rosa edit machinepool -c mycluster --kubelet-configs=set-high-pids high-pid-pool
8.2.6. 関連情報
- デフォルト以外のアプリケーションルーターの編集は、Ingress Controller の設定 を参照してください。
8.2.7. オブジェクトの削除
このセクションでは、クラスターおよびリソースの delete
コマンドを説明します。
8.2.7.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
8.2.7.2. delete cluster
クラスターを削除します。
構文
$ rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: 削除するクラスターの名前または ID (文字列)。 |
--watch | クラスターのアンインストールログを監視します。 |
--best-effort |
クラスター削除プロセスの失敗の原因となることが判明しているクラスター破棄チェーンのステップをスキップします。このオプションは慎重に使用してください。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--interactive | 対話モードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
--yes |
操作を確認するために、自動的に |
例
クラスター mycluster
を削除します。
$ rosa delete cluster --cluster=mycluster
8.2.7.3. delete external-auth-provider
クラスターから外部認証プロバイダーを削除します。
構文
$ rosa delete external-auth-provider <name_of_external_auth_provider> --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須。外部認証プロバイダーが削除されるクラスターの名前または ID 文字列。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--interactive | 対話モードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル文字列を指定します。 |
--yes |
操作を確認するために、自動的に |
例
クラスター mycluster
から exauth-1
という名前のアイデンティティープロバイダーを削除します。
$ rosa delete external-auth-provider exauth-1 --cluster=mycluster
8.2.7.4. 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
8.2.7.5. 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
8.2.7.6. delete kubeletconfig
クラスターからカスタム KubeletConfig
オブジェクトを削除します。
構文
$ rosa delete kubeletconfig --cluster=<cluster_name|cluster_id> [flags]
オプション | 定義 |
---|---|
-c, --cluster <cluster_name>|<cluster_id> |
必須。 |
-h、--help | このコマンドのヘルプを表示します。 |
--name |
Hosted Control Plane (HCP) クラスターを備えた Red Hat OpenShift Service on AWS (ROSA) で必要です。クラスターには |
-y, --yes |
操作を確認するために、自動的に |
8.2.7.7. 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
8.2.8. アドオンのインストールおよびアンインストール
このセクションでは、クラスターに Red Hat マネージドサービスアドオンをインストールおよびアンインストールする方法を説明します。
8.2.8.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
8.2.8.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
8.2.9. オブジェクトのリスト表示および説明
このセクションでは、クラスターおよびリソースの list
コマンドおよび describe
コマンドを説明します。
8.2.9.1. list addon
マネージドサービスアドオンインストールをリスト表示します。
構文
$ rosa list addons --cluster=<cluster_name> | <cluster_id>
オプション | 定義 |
---|---|
--cluster | 必須: アドオンをリスト表示するクラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
8.2.9.2. break glass 認証情報をリスト表示する
クラスターのすべての Break Glass 認証情報をリスト表示します。
構文
$ rosa list break-glass-credential [arguments]
オプション | 定義 |
---|---|
--cluster <cluster_name>|<cluster_id> | 必須。break glass 認証情報が追加されたクラスターの名前または ID。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster
という名前のクラスターのすべての Break Glass 認証情報をリスト表示します。
$ rosa list break-glass-credential --cluster=mycluster
8.2.9.3. list clusters
すべてのクラスターをリスト表示します。
構文
$ rosa list clusters [arguments]
オプション | 定義 |
---|---|
--count |
表示するクラスターの数 (整数)。デフォルトは、 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
8.2.9.4. list external-auth-provider
クラスターの外部認証プロバイダーをリスト表示します。
構文
$ rosa list external-auth-provider --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: 外部認証プロバイダーがリストされるクラスターの名前または ID 文字列。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル文字列を指定します。 |
例
mycluster
という名前のクラスターの外部認証プロバイダーをリスト表示します。
$ rosa list external-auth-provider --cluster=mycluster
8.2.9.5. 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
8.2.9.6. 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
8.2.9.7. list instance-types
ROSA で使用できるすべてのインスタンスタイプをリストします。可用性は、アカウントの AWS クォータに基づいています。
構文
$ rosa list instance-types [arguments]
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--output |
出力フォーマット。許可される形式は |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
すべてのインスタンスタイプを一覧表示します。
$ rosa list instance-types
8.2.9.8. list kubeletconfigs
クラスターに設定されている KubeletConfig
オブジェクトをリストします。
構文
$ rosa list kubeletconfigs --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: マシンプールをリスト表示するクラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
例
mycluster
という名前のクラスター上のすべての KubeletConfig
オブジェクトをリストします。
$ rosa list kubeletconfigs --cluster=mycluster
8.2.9.9. list machinepools
クラスターに設定されたマシンプールをリスト表示します。
構文
$ rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: マシンプールをリスト表示するクラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster
という名前のクラスター上のすべてのマシンプールを一覧表示します。
$ rosa list machinepools --cluster=mycluster
8.2.9.10. list regions
現在の AWS アカウントで利用可能なリージョンのリストを表示します。
構文
$ rosa list regions [arguments]
オプション | 定義 |
---|---|
--multi-az | 複数のアベイラビリティーゾーンのサポートを提供するリージョンをリスト表示します。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
利用可能なすべてのリージョンを一覧表示します。
$ rosa list regions
8.2.9.11. list upgrades
利用可能かつスケジュールされたクラスターバージョンのアップグレードをすべてリスト表示します。
構文
$ rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: 利用可能なアップグレードをリスト表示するクラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster
という名前のクラスターで利用可能なすべてのアップグレードを一覧表示します。
$ rosa list upgrades --cluster=mycluster
8.2.9.12. list users
指定されたクラスターのクラスター管理者および専用の管理者のユーザーをリスト表示します。
構文
$ rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: クラスター管理者をリスト表示するクラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster
という名前のクラスターのすべてのクラスター管理者と専用管理者を一覧表示します。
$ rosa list users --cluster=mycluster
8.2.9.13. list versions
クラスターの作成に利用可能な OpenShift バージョンリストを表示します。
構文
$ rosa list versions [arguments]
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
OpenShift Container Platform のすべてのバージョンを一覧表示します。
$ rosa list versions
8.2.9.14. 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
8.2.9.15. describe addon
マネージドサービスアドオンの詳細を表示します。
構文
$ rosa describe addon <addon_id> | <addon_name> [arguments]
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
dbaas-operator
という名前のアドオンを記述します。
$ rosa describe addon dbaas-operator
8.2.9.16. describe break glass credential
特定のクラスターの Break Glass 認証情報の詳細を表示します。
構文
$ rosa describe break-glass-credential --id=<break_glass_credential_id> --cluster=<cluster_name>| <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: クラスターの名前または ID (文字列)。 |
--id | 必須: break glass 認証情報の ID (文字列)。 |
--kubeconfig | オプション: Break Glass 認証情報から kubeconfig を取得します。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
8.2.9.17. describe cluster
クラスターの詳細を表示します。
構文
$ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: クラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
--get-role-policy-bindings | クラスターに割り当てられた STS ロールにアタッチされているポリシーをリスト表示します。 |
例
mycluster
という名前のクラスターを記述します。
$ rosa describe cluster --cluster=mycluster
8.2.9.18. describe kubeletconfig
カスタム KubeletConfig
オブジェクトの詳細を表示します。
構文
$ rosa describe kubeletconfig --cluster=<cluster_name|cluster_id> [flags]
オプション | 定義 |
---|---|
-c, --cluster <cluster_name>|<cluster_id> |
必須。 |
-h、--help | このコマンドのヘルプを表示します。 |
--name |
オプション: 記述する |
-o、--output string | -o、--output string |
8.2.9.19. describe machinepool
クラスター上に設定された特定のマシンプールを記述します。
構文
$ rosa describe machinepool --cluster=[<cluster_name>|<cluster_id>] --machinepool=<machinepool_name> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: クラスターの名前または ID (文字列)。 |
--machinepool | 必須: マシンプールの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster
という名前のクラスター上の、mymachinepool
という名前のマシンプールを記述します。
$ rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool
8.2.10. オブジェクトの取り消し
このセクションでは、クラスターとリソースの revoke
コマンドを説明します。
8.2.10.1. revoke-break-glass-credential
外部認証が有効になっている指定された Hosted Control Plane クラスターからすべての Break Glass 認証情報を取り消します。
構文
$ rosa revoke break-glass-credential --cluster=<cluster_name> | <cluster_id>
オプション | 定義 |
---|---|
--cluster | 必須: break glass 認証情報が削除されるクラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
--yes |
操作を確認するために、自動的に |
例
mycluster
という名前のクラスターから Break Glass 認証情報を取り消します。
$ rosa revoke break-glass-credential --cluster=mycluster
8.2.11. オブジェクトのアップグレードおよびアップグレードの削除
このセクションでは、オブジェクトの upgrade
コマンドの使用を説明します。
8.2.11.1. upgrade cluster
クラスターのアップグレードをスケジュールします。
構文
$ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
オプション | 定義 |
---|---|
--cluster | 必須: アップグレードがスケジュールされるクラスターの名前または ID (文字列)。 |
--interactive | 対話モードを有効にします。 |
--version | クラスターをアップグレードする OpenShift Container Platform のバージョン (文字列) です。 |
--schedule-date |
協定世界時 (UTC) で指定された時刻にアップグレードが実行される次の日付 (文字列)。形式は、 |
--schedule-time |
次回のアップグレードは、協定世界時 (UTC) で指定された日付に実行されます。形式は、 |
--node-drain-grace-period [1] |
アップグレード時に、Pod の Disruption Budget (停止状態の予算) で保護されるワークロードが尊重される期間の猶予期間 (文字列) を設定します。この猶予期間後に、ノードから正常にドレイン (解放) されていない Pod の Disruption Budget (停止状態の予算) で保護されるワークロードは、強制的にエビクトされます。デフォルトは、 |
--control-plane [2] | クラスターの Hosted Control Plane をアップグレードします。 |
- 従来のクラスターのみ
- ROSA with HCP クラスターのみ
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
例
mycluster
という名前のクラスターでアップグレードをインタラクティブにスケジュールします。
$ rosa upgrade cluster --cluster=mycluster --interactive
mycluster
という名前のクラスターで、1 時間以内にクラスターアップグレードをスケジュールします。
$ rosa upgrade cluster --cluster=mycluster --version 4.5.20
8.2.11.2. クラスターのアップグレードの削除
スケジュールされたクラスターアップグレードをキャンセルします。
構文
$ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
オプション | 定義 |
---|---|
--cluster | 必須: アップグレードがキャンセルされるクラスターの名前または ID (文字列) です。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--yes |
操作を確認するために、自動的に |
8.2.11.3. upgrade machinepool
ROSA with HCP クラスターで設定された特定のマシンプールをアップグレードします。
マシンプールの アップグレード
コマンドは、ROSA with HCP クラスターにのみ適用されます。
構文
$ rosa upgrade machinepool --cluster=<cluster_name> <machinepool_name>
オプション | 定義 |
---|---|
--cluster | 必須: クラスターの名前または ID (文字列)。 |
--schedule-date |
協定世界時 (UTC) で指定された時刻にアップグレードが実行される次の日付 (文字列)。形式は、 |
--schedule-time |
次回のアップグレードは、協定世界時 (UTC) で指定された日付に実行されます。形式は、 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster
という名前のクラスター上のマシンプールをアップグレードします。
$ rosa upgrade machinepool --cluster=mycluster
8.2.11.4. マシンプールアップグレードの削除
スケジュールされたマシンプールアップグレードをキャンセルします。
構文
$ rosa delete upgrade --cluster=<cluster_name> <machinepool_name>
オプション | 定義 |
---|---|
--cluster | 必須: クラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
8.2.11.5. ロールのアップグレード
クラスターに設定されたロールをアップグレードします。
構文
$ rosa upgrade roles --cluster=<cluster_id>
オプション | 定義 |
---|---|
--cluster | 必須: クラスターの名前または ID (文字列)。 |
オプション | 定義 |
---|---|
--help | このコマンドのヘルプを表示します。 |
--debug | デバッグモードを有効にします。 |
--profile | 認証情報ファイルから AWS プロファイル (文字列) を指定します。 |
例
mycluster
という名前のクラスターでロールをアップグレードします。
$ rosa upgrade roles --cluster=mycluster