From a5f00a7b1001e154385ec9182d526677c6a05474 Mon Sep 17 00:00:00 2001 From: EricPonvelle Date: Tue, 7 Oct 2025 16:36:04 -0500 Subject: [PATCH] OSDOCS-16393: Added ROSA CLI commands for deleting and listing AWS resources. --- modules/rosa-delete-objects.adoc | 579 ++++++---- modules/rosa-list-objects.adoc | 1529 ++++++++++++++------------ snippets/rosa-cli-default-flags.adoc | 19 + 3 files changed, 1210 insertions(+), 917 deletions(-) create mode 100644 snippets/rosa-cli-default-flags.adoc diff --git a/modules/rosa-delete-objects.adoc b/modules/rosa-delete-objects.adoc index ecd235d4f0..9839624468 100644 --- a/modules/rosa-delete-objects.adoc +++ b/modules/rosa-delete-objects.adoc @@ -5,9 +5,54 @@ [id="rosa-delete-objects_{context}"] = Delete objects - This section describes the `delete` commands for clusters and resources. +[id="rosa-delete-account-roles_{context}"] +== delete account-roles + +Cleans up account roles from the current AWS account. + +.Syntax +[source,terminal] +---- +$ rosa delete account-roles +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--classic +|Deletes classic account roles + +|--delete-hcp-shared-vpc-policies +|Deletes the Hosted Control Plane shared vpc policies + +|--hosted-cp +|Deletes Hosted Control Plane roles + +a|-m, --mode string +a|How to perform the operation. Valid options are: + +`auto`:: Resource changes will be applied automatically using the current AWS account. +`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. + +|--prefix +|Prefix of the account roles to be deleted. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Deletes all AWS account roles with the prefix of `mycluster`. + +[source,terminal] +---- +$ rosa delete account-roles -p mycluster +---- + [id="rosa-delete-admin_{context}"] == delete admin @@ -25,35 +70,57 @@ $ rosa delete admin --cluster= | |Option |Definition |--cluster -|Required: The name or ID (string) of the cluster to add to the identity provider (IDP). +|Required: The name or ID (string) of the cluster that contains the identity provider (IDP) you want to delete. |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -Delete a cluster administrator from a cluster named `mycluster`. +Deletes a cluster administrator from a cluster named `mycluster`. [source,terminal] ---- $ rosa delete admin --cluster=mycluster ---- +ifdef::openshift-rosa[] +[id="rosa-delete-autoscaler_{context}"] +== delete autoscaler + +Deletes autoscaler configuration for a given cluster. + +[NOTE] +==== +This action is only supported on {product-title} clusters with a self-hosted control plane. Clusters with hosted control planes do not support autoscaler. +==== + +.Syntax +[source,terminal] +---- +$ rosa delete autoscaler --cluster= +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster that has an autoscaler you want to delete. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Deletes the autoscaler on a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa delete autoscaler --cluster=mycluster +---- +endif::openshift-rosa[] + [id="rosa-delete-cluster_{context}"] == delete cluster @@ -80,29 +147,10 @@ $ rosa delete cluster --cluster= | [arguments] |Skips steps in the cluster destruction chain that are known to cause the cluster deletion process to fail. You should use this option with care and it is recommended that you manually check your AWS account for any resources that might be left over after using `--best-effort`. |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Examples -Delete a cluster named `mycluster`. +Deletes a cluster named `mycluster`. [source,terminal] ---- @@ -129,29 +177,10 @@ $ rosa delete external-auth-provider --cluster= |Required. The name or ID string of the cluster the external auth provider will be deleted from. |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile string from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -Delete an identity provider named `exauth-1` from a cluster named `mycluster`. +Deletes an identity provider named `exauth-1` from a cluster named `mycluster`. [source,terminal] ---- @@ -178,108 +207,16 @@ $ rosa delete idp --cluster= | [arguments] |Required: The name or ID (string) of the cluster from which the IDP will be deleted. |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -Delete an identity provider named `github` from a cluster named `mycluster`. +Deletes an identity provider named `github` from a cluster named `mycluster`. [source,terminal] ---- $ rosa delete idp github --cluster=mycluster ---- -[id="rosa-delete-iamserviceaccount_{context}"] -== delete iamserviceaccount - -Deletes an AWS Identity and Access Management (IAM) role that was created for a {product-title} service account. - -.Syntax -[source,terminal] ----- -$ rosa delete iamserviceaccount --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|--cluster \| -|Required. The name or ID of the cluster from which to delete the IAM service account role. - -|--name -|The name of the {product-title} service account. Required when `--role-name` is not specified. - -|--namespace -|The {product-title} namespace for the service account. Default: `default` - -|--role-name -|The name of the IAM role to delete. If not specified, the role name will be auto-detected using the service account details. - -a|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be automatically applied using the current AWS account. -`manual`:: Commands necessary to modify AWS resources will be output to be run manually. - -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. - -|=== - -.Examples -Delete an IAM role for a service account named `my-app` in the `default` namespace. - -[source,terminal] ----- -$ rosa delete iamserviceaccount --cluster=mycluster --name=my-app ----- - -Delete an IAM role by specifying the role name directly. - -[source,terminal] ----- -$ rosa delete iamserviceaccount --cluster=mycluster --role-name=my-custom-role --yes ----- - [id="rosa-delete-ingress_{context}"] == delete ingress @@ -300,36 +237,17 @@ $ rosa delete ingress --cluster= | [arguments] |Required: The name or ID (string) of the cluster from which the ingress will be deleted. |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Examples -Delete an ingress with the ID `a1b2` from a cluster named `mycluster`. +Deletes an ingress with the ID `a1b2` from a cluster named `mycluster`. [source,terminal] ---- $ rosa delete ingress --cluster=mycluster a1b2 ---- -Delete a secondary ingress with the subdomain name `apps2` from a cluster named `mycluster`. +Deletes a secondary ingress with the subdomain name `apps2` from a cluster named `mycluster`. [source,terminal] ---- @@ -339,7 +257,7 @@ $ rosa delete ingress --cluster=mycluster apps2 [id="rosa-delete-kubeletconfig_{context}"] == delete kubeletconfig -Delete a custom `KubeletConfig` object from a cluster. +Deletes a custom `KubeletConfig` object from a cluster. .Syntax [source,terminal] @@ -355,9 +273,6 @@ $ rosa delete kubeletconfig --cluster= [flags] a|-c, --cluster \| |Required. The name or ID of the cluster for which you want to delete the `KubeletConfig` object. -|-h, --help -|Shows help for this command. - |--name a| ifdef::temp-ifdef[] @@ -368,11 +283,9 @@ Required. endif::[] Specifies a name for the `KubeletConfig` object. -|-y, --yes -|Automatically answers `yes` to confirm the operation. - |=== +include::snippets/rosa-cli-default-flags.adoc[] [id="rosa-delete-machinepool_{context}"] == delete machinepool @@ -392,50 +305,31 @@ $ rosa delete machinepool --cluster= | ---- .Arguments @@ -443,31 +337,256 @@ $ rosa delete image-mirror [arguments] |=== |Option |Definition -|--cluster -|Required: The name or ID (string) of the cluster that the machine pool will be deleted from. -|--id -|Required: ID of the image mirror configuration to delete. -|`--yes`, `-y` -|Optional: Automatically answer yes to confirm deletion -|--profile -|Optional: Use a specific AWS profile from your credential file. -|--region -|Optional: Use a specific AWS region, overriding the AWS_REGION environment variable. +a|-m, --mode string +a|How to perform the operation. Valid options are: + +`auto`:: Resource changes will be applied automatically using the current AWS account. +`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. + +|--role-arn string +|Required: The role ARN to delete from the user role from the AWS account |=== + +include::snippets/rosa-cli-default-flags.adoc[] + .Examples -Deletes a mirror configuration with confirmation prompt. +Deletes an ocm-role with `arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778` arn. [source,terminal] ---- -$ rosa delete image-mirror --cluster=mycluster abc123def456 --yes +$ rosa delete ocm-role --role-arn arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778 ---- -Deletes a mirror configuration without confirmation prompt. +[id="rosa-delete-oidc-config_{context}"] +== delete oidc-config + +Deletes the OIDC config based on the registered OIDC Config ID. + +.Syntax +[source,terminal] +---- +$ rosa delete oidc-config --oidc-config-id +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +a|-m, --mode string +a|How to perform the operation. Valid options are: + +`auto`:: Resource changes will be applied automatically using the current AWS account. +`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. + +|--oidc-config-id string +|Required: Registered ID for identification of OIDC config. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Deletes an OIDC config with an ID of `A1B2C3D4`. [source,terminal] ---- -$ rosa delete image-mirror --cluster=mycluster --id=abc123def456 +$ rosa delete oidc-config --oidc-config-id A1B2C3D4 ---- -endif::openshift-rosa-hcp[] \ No newline at end of file +[id="rosa-delete-oidc-provider_{context}"] +== delete oidc-provider + +Deletes the OIDC provider of a deleted STS cluster. + +.Syntax +[source,terminal] +---- +$ rosa delete oidc-provider --cluster= | --oidc-config-id +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|-c, --cluster string +|Name or ID of the cluster. + +a|-m, --mode string +a|How to perform the operation. Valid options are: + +`auto`:: Resource changes will be applied automatically using the current AWS account. +`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. + +|--oidc-config-id string +|Required: Registered OIDC configuration ID to retrieve its issuer URL. Not to be used alongside `--cluster` flag. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Examples +* Deletes the OIDC provider using the OIDC config ID of `A1B2C3D4`. ++ +[source,terminal] +---- +$ rosa delete oidc-provider --oidc-config-id A1B2C3D4 +---- + +* Deletes the OIDC provider using the cluster name of `mycluster`. ++ +[source,terminal] +---- +$ rosa delete oidc-provider --cluster=mycluster +---- + +[id="rosa-delete-operator-roles_{context}"] +== delete operator-roles + +Deletes the Operator roles of a deleted STS cluster. + +.Syntax +[source,terminal] +---- +$ rosa delete oidc-provider --cluster= | --oidc-config-id +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|-c, --cluster string +|Name or ID of the cluster. + +ifdef::openshift-rosa-hcp[] +|--delete-hcp-shared-vpc-policies +|Deletes the hosted control plane shared VPC policies. +endif::openshift-rosa-hcp[] + +a|-m, --mode string +a|How to perform the operation. Valid options are: + +`auto`:: Resource changes will be applied automatically using the current AWS account. +`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. + +|--prefix string +|Operator role prefix. You must use this flag in case of reusable OIDC Config. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example + +Deletes the operator-roles on the cluster named `mycluster`. + +[source,terminal] +---- +$ rosa delete operator-roles --cluster=mycluster +---- + +[id="rosa-delete-tuning-configs_{context}"] +== delete tuning-configs + +Deletes a specified tuning configuration that is on a specified cluster. + +.Syntax +[source,terminal] +---- +$ rosa delete tuning-config --cluster= +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|-c, --cluster string +|Name or ID of the cluster. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example + +Deletes the tuning config named `tuned1` from a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa delete tuning-config --cluster=mycluster tuned1 +---- + +[id="rosa-delete-upgrade_{context}"] +== delete upgrade + +Cancels a scheduled cluster upgrade. + +.Syntax +[source,terminal] +---- +$ rosa delete upgrade +---- + +.Arguments +[cols="30,70"] +|=== +|Option +|Definition + +|-c, --cluster string +|Name or ID of the cluster. + +|--machinepool string +|Machine pool of the cluster to target. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Deletes the user role that has a prefix of `rh-user` and a user-role name of `Auditor`. + +[source,terminal] +---- +$ rosa delete user-role --role-arn rh-user-User-Auditor-Role +---- + +[id="rosa-delete-user-role_{context}"] +== delete user-role + +Deletes user role from the current AWS account. + +.Syntax +[source,terminal] +---- +$ rosa delete user-role +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +a|-m, --mode string +a|How to perform the operation. Valid options are: + +`auto`:: Resource changes will be applied automatically using the current AWS account. +`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. + +|--role-arn string +|Required: The ARN of the user-role that you want to delete from the AWS account. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Deletes the user role that has a prefix of `rh-user` and a user-role name of `Auditor`. + +[source,terminal] +---- +$ rosa delete user-role --role-arn rh-user-User-Auditor-Role +---- \ No newline at end of file diff --git a/modules/rosa-list-objects.adoc b/modules/rosa-list-objects.adoc index 5b18cd2252..55b20b3388 100644 --- a/modules/rosa-list-objects.adoc +++ b/modules/rosa-list-objects.adoc @@ -7,15 +7,15 @@ This section describes the `list` and `describe` commands for clusters and resources. -[id="rosa-list-oaddon_{context}"] -== list addon +[id="rosa-describe-access-request_{context}"] +== describe access-request -List the managed service add-on installations. +Shows detailed information about access requests. .Syntax [source,terminal] ---- -$ rosa list addons --cluster= | +$ rosa describe describe access-request --id ---- .Arguments @@ -23,304 +23,32 @@ $ rosa list addons --cluster= | |=== |Option |Definition -|--cluster -|Required: The name or ID (string) of the cluster to list the add-ons for. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - - -[id="rosa-list-break-glass-credential_{context}"] -== List break glass credentials - -List all of the break glass credentials for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list break-glass-credential [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster \| -|Required. The name or ID of the cluster to which the break glass credentials have been added. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example - -List all of the break glass credentials for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list break-glass-credential --cluster=mycluster ----- - -[id="rosa-list-clusters_{context}"] -== list clusters - -List all of your clusters. - -.Syntax -[source,terminal] ----- -$ rosa list clusters [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--count -|The number (integer) of clusters to display. Default: `100` -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== -ifdef::openshift-rosa-hcp[] -[id="rosa-list-configured-mirror-sets_{context}"] -== list mirror image configurations - -Lists mirrors within a mirror configuration. - -.Syntax -[source,terminal] ----- -$ rosa list image-mirrors [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: Name or ID of the cluster. -|--output -|Optional: Output format. Allowed formats are `json` and `yaml`. -|--profile -|Optional: Use a specific AWS profile from your credential file. -|--region -|Optional: Use a specific AWS region, overriding the AWS_REGION environment variable. -|=== - -.Example - -Lists image mirrors within the image mirror configuration. - -[source,terminal] ----- -$ rosa list image-mirrors --cluster=mycluster ----- - -endif::openshift-rosa-hcp[] - -[id="rosa-list-external-auth-provider_{context}"] -== list external-auth-provider - -List any external authentication providers for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list external-auth-provider --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID string of the cluster that the external authentication provider will be listed for. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile string from your credentials file. -|=== - -.Example -List any external authentication providers for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list external-auth-provider --cluster=mycluster ----- - -[id="rosa-list-idps_{context}"] -== list idps - -List all of the identity providers (IDPs) for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list idps --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the IDPs will be listed for. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -List all identity providers (IDPs) for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list idps --cluster=mycluster ----- - -[id="rosa-list-iamserviceaccounts_{context}"] -== list iamserviceaccounts - -List IAM roles that were created for OpenShift service accounts. - -.Syntax -[source,terminal] ----- -$ rosa list iamserviceaccounts [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster \| -|The name or ID of the cluster to filter service account roles by. - -|--namespace -|The OpenShift namespace to filter service account roles by. +| --id string +| Required. The ID of your access request. +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--output -|The output format. Allowed formats are `json` or `yaml`. - -|--profile -|Specifies an AWS profile from your credentials file. - -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Examples -List all IAM service account roles. +Shows the details of the access request with an ID of `A1B2C3D4` and produces the results in a .yaml output. [source,terminal] ---- -$ rosa list iamserviceaccounts +$ rosa describe describe access-request --id A1B2C3D4 -output yaml ---- -List IAM service account roles for a specific cluster. +[id="rosa-list-access-request_{context}"] +== list access-request -[source,terminal] ----- -$ rosa list iamserviceaccounts --cluster=mycluster ----- - -List IAM service account roles for a specific namespace in a cluster. - -[source,terminal] ----- -$ rosa list iamserviceaccounts --cluster=mycluster --namespace=production ----- - - - -[id="rosa-list-ingresses_{context}"] -== list ingresses - -List all of the API and ingress endpoints for a cluster. +Lists all access requests in either `Pending` or `Approved` status. If you use the '--cluster' flag, the CLI lists all access requests in any status for the specified cluster. .Syntax [source,terminal] ---- -$ rosa list ingresses --cluster= | [arguments] +$ rosa list access-request [arguments] ---- .Arguments @@ -328,121 +56,32 @@ $ rosa list ingresses --cluster= | [arguments] |=== |Option |Definition -|--cluster -|Required: The name or ID (string) of the cluster that the IDPs will be listed for. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -List all API and ingress endpoints for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list ingresses --cluster=mycluster ----- - -== list instance-types - -List all of the available instance types for use with {product-title}. Availability is based on the account's AWS quota. - -.Syntax -[source,terminal] ----- -$ rosa list instance-types [arguments] ----- - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--output -|The output format. Allowed formats are `json` or `yaml`. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -List all instance types. - -[source,terminal] ----- -$ rosa list instance-types ----- - -[id="rosa-list-kubeletconfigs_{context}"] -== list kubeletconfigs - -List the `KubeletConfig` objects configured on a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list kubeletconfigs --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster +|-c, --cluster string |Required: The name or ID (string) of the cluster that the machine pools will be listed for. +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. + |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -// |--profile -// |Specifies an AWS profile (string) from your credentials file. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -List all of the `KubeletConfig` objects on a cluster named `mycluster`. +Lists all Access Requests for cluster `foo`. [source,terminal] ---- -$ rosa list kubeletconfigs --cluster=mycluster +$ rosa list access-request --cluster foo ---- -[id="rosa-list-machinepools_{context}"] -== list machinepools +[id="rosa-list-account-roles_{context}"] +== list account-roles -List the machine pools configured on a cluster. +Lists all account roles and policies for the current AWS account. .Syntax [source,terminal] ---- -$ rosa list machinepools --cluster= | [arguments] +$ rosa list account-roles [arguments] ---- .Arguments @@ -450,201 +89,54 @@ $ rosa list machinepools --cluster= | [arguments] |=== |Option |Definition -|--cluster +|-c, --cluster string |Required: The name or ID (string) of the cluster that the machine pools will be listed for. +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. + |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -List all of the machine pools on a cluster named `mycluster`. +Lists all AWS account roles associated with your account. [source,terminal] ---- -$ rosa list machinepools --cluster=mycluster +$ rosa list account-roles ---- -[id="rosa-list-regions_{context}"] -== list regions +[id="rosa-describe-addon-installation_{context}"] +== describe addon-installation -List all of the available regions for the current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa list regions [arguments] ----- +Shows detailed information about an add-on installation. .Arguments [cols="30,70"] |=== |Option |Definition -ifdef::openshift-rosa[] -|--multi-az -|Lists regions that provide support for multiple availability zones. -endif::openshift-rosa[] +|-c, --cluster string +|Required: The name or ID (string) of the cluster that the machine pools will be listed for. +| --addon string +|Required: Name or ID of the add-on installation. + |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition +include::snippets/rosa-cli-default-flags.adoc[] -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -List all of the available regions. +.Examples +Describes the `bar` add-on installation on cluster `foo`. [source,terminal] ---- -$ rosa list regions ----- - -[id="rosa-list-upgrades_{context}"] -== list upgrades - -List all available and scheduled cluster version upgrades. - -.Syntax -[source,terminal] ----- -$ rosa list upgrades --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the available upgrades will be listed for. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -List all of the available upgrades for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list upgrades --cluster=mycluster ----- - -[id="rosa-list-users_{context}"] -== list users -List the cluster administrator and dedicated administrator users for a specified cluster. - -.Syntax -[source,terminal] ----- -$ rosa list users --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the cluster administrators will be listed for. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -List all of the cluster administrators and dedicated administrators for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list users --cluster=mycluster ----- - -[id="rosa-list-versions_{context}"] -== list versions - -List all of the OpenShift versions that are available for creating a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list versions [arguments] ----- - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -List all of the OpenShift Container Platform versions. - -[source,terminal] ----- -$ rosa list versions +$ rosa describe addon-installation --cluster foo --addon bar ---- [id="rosa-describe-admin_{context}"] == describe admin -Show the details of a specified `cluster-admin` user and a command to log in to the cluster. +Shows the details of a specified `cluster-admin` user and a command to log in to the cluster. .Syntax [source,terminal] @@ -661,23 +153,10 @@ $ rosa describe admin --cluster= | [arguments] |Required: The name or ID (string) of the cluster to which the cluster-admin belongs. |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -Describe the `cluster-admin` user for a cluster named `mycluster`. +Describes the `cluster-admin` user for a cluster named `mycluster`. [source,terminal] ---- @@ -687,7 +166,7 @@ $ rosa describe admin --cluster=mycluster [id="rosa-describe-addon_{context}"] == describe addon -Show the details of a managed service add-on. +Shows the details of a managed service add-on. .Syntax [source,terminal] @@ -695,30 +174,90 @@ Show the details of a managed service add-on. $ rosa describe addon | [arguments] ---- -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -Describe an add-on named `dbaas-operator`. +Describes an add-on named `dbaas-operator`. [source,terminal] ---- $ rosa describe addon dbaas-operator ---- + +[id="rosa-list-oaddon_{context}"] +== list addon + +Lists the managed service add-on installations. + +.Syntax +[source,terminal] +---- +$ rosa list addons [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster to list the add-ons for. +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all add-on installations on a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list addons --cluster=mycluster +---- + +ifdef::openshift-rosa[] +[id="rosa-describe-autoscaler_{context}"] +== describe autoscaler + +Shows detailed information about the configuration for a specified cluster's autoscaler. + +[NOTE] +==== +Cluster autoscalers are only supported on {product-title} clusters that use self-hosted control planes. +==== + +.Syntax +[source,terminal] +---- +$ rosa describe autoscaler [flag] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster. +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Examples +Describes the autoscaler for cluster `foo`. + +[source,terminal] +---- +$ rosa describe autoscaler --cluster foo +---- +endif::openshift-rosa[] + [id="rosa-describe-break-glass-credential_{context}"] -== describe break glass credential +== describe break-glass-credential Shows the details for a break glass credential for a specific cluster. @@ -741,21 +280,39 @@ $ rosa describe break-glass-credential --id= --cluste |Optional: Retrieves the kubeconfig from the break glass credential. |=== -.Optional arguments inherited from parent commands +include::snippets/rosa-cli-default-flags.adoc[] + +[id="rosa-list-break-glass-credential_{context}"] +== List break-glass-credential + +Lists all of the break glass credentials for a cluster. + +.Syntax +[source,terminal] +---- +$ rosa list break-glass-credential [arguments] +---- + +.Arguments [cols="30,70"] |=== |Option |Definition -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. +|--cluster \| +|Required. The name or ID of the cluster to which the break glass credentials have been added. |=== +include::snippets/rosa-cli-default-flags.adoc[] + +.Example + +Lists all of the break glass credentials for a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list break-glass-credential --cluster=mycluster +---- + [id="rosa-describe-cluster_{context}"] == describe cluster @@ -764,7 +321,7 @@ Shows the details for a cluster. .Syntax [source,terminal] ---- -$ rosa describe cluster --cluster= | [arguments] +$ rosa describe cluster [arguments] ---- .Arguments @@ -774,46 +331,59 @@ $ rosa describe cluster --cluster= | [arguments] |--cluster |Required: The name or ID (string) of the cluster. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. |--external-id -|An optional unique identifier that might be required when you assume a role in another account. - -|--profile -|Specifies an AWS profile (string) from your credentials file. +|An optional, unique identifier that might be required when you assume a role in another account. |--get-role-policy-bindings |Lists the policies that are attached to the STS roles assigned to the cluster. |=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -Describe a cluster named `mycluster`. +Describes a cluster named `mycluster`. [source,terminal] ---- $ rosa describe cluster --cluster=mycluster ---- -[id="rosa-describe-iamserviceaccount_{context}"] -== describe iamserviceaccount +[id="rosa-list-clusters_{context}"] +== list clusters -Shows detailed information about an IAM role created for an OpenShift service account. +Lists all of your clusters. .Syntax [source,terminal] ---- -$ rosa describe iamserviceaccount --cluster= | [arguments] +$ rosa list clusters [flag] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition +|-a, --all +|Lists all clusters across different AWS accounts under the same Red Hat organization + +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. + +|--get-role-policy-bindings +|Lists the policies that are attached to the STS roles assigned to the cluster. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +[id="rosa-list-dns-domain_{context}"] +== list dns-domain + +Lists all DNS domains. + +.Syntax +[source,terminal] +---- +$ rosa list dns-domain [arguments] ---- .Arguments @@ -821,64 +391,283 @@ $ rosa describe iamserviceaccount --cluster= | [argum |=== |Option |Definition -a|--cluster \| -|Required. The name or ID of the cluster. +|-a, --all +|Lists all DNS domains. The default options lists just user defined domains. -|--name -|The name of the OpenShift service account. Required when `--role-name` is not specified. +| --hosted-cp +|Filters the list to only DNS Domains used for hosted control plane clusters. -|--namespace -|The OpenShift namespace for the service account. Default: `default` - -|--role-name -|The name of the IAM role to describe. If not specified, the role name will be auto-detected using the service account details. +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition +include::snippets/rosa-cli-default-flags.adoc[] -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--output -|The output format. Allowed formats are `json` or `yaml`. - -|--profile -|Specifies an AWS profile from your credentials file. - -|=== - -.Examples -Describes an IAM role for a service account named `my-app` in the `default` namespace. +.Example +Lists all DNS Domains tied to your organization ID. [source,terminal] ---- -$ rosa describe iamserviceaccount --cluster=mycluster --name=my-app +$ rosa list dns-domain ---- -Describes an IAM role by specifying the role name directly. +[id="rosa-describe-external-auth-provider_{context}"] +== describe external-auth-provider -[source,terminal] ----- -$ rosa describe iamserviceaccount --cluster=mycluster --role-name=my-custom-role ----- - - -[id="rosa-describe-kubeletconfig_{context}"] -== describe kubeletconfig - -Show the details of a custom `KubeletConfig` object. +Shows detailed information about an external authentication provider on a cluster. .Syntax [source,terminal] ---- -$ rosa describe kubeletconfig --cluster= [flags] +$ rosa describe external-auth-provider [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster. + +|--name string +|The name for the external authentication provider of the cluster to target. + +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Examples +Shows details of an external authentication provider named `exauth` on a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa describe external-auth-provider exauth --cluster=mycluster +---- + +[id="rosa-list-external-auth-provider_{context}"] +== list external-auth-provider + +Lists any external authentication providers for a cluster. + +.Syntax +[source,terminal] +---- +$ rosa list external-auth-provider --cluster= | [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID string of the cluster that the external authentication provider will be listed for. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists any external authentication providers for a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list external-auth-provider --cluster=mycluster +---- + +[id="rosa-list-gates_{context}"] +== list gates + +Lists all available OCP Gates for a specific OCP release or by cluster upgrade version. + +.Syntax +[source,terminal] +---- +$ rosa list gates [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster. + +|--gate string +|Gate type. Options are `sts` and `ocp`. + +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. + +|--version string +|Specified OpenShift version. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example + +* Lists all OCP gates for an OCP version. ++ +[source,terminal] +---- +$ rosa list gates --version 4.19 +---- + +* Lists all STS gates for an OCP version. ++ +[source,terminal] +---- +$ rosa list gates --gate sts --version 4.19 +---- + +* Lists all OCP gates for an OCP version. ++ +[source,terminal] +---- +$ rosa list gates --gate ocp --version 4.19 +---- + +* Lists available gates for a cluster upgrade version. ++ +[source,terminal] +---- +$ rosa list gates -c mycluster --version 4.19.7 +---- + +[id="rosa-list-idps_{context}"] +== list idps + +Lists all of the identity providers (IDPs) for a cluster. + +.Syntax +[source,terminal] +---- +$ rosa list idps [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster that the IDPs will be listed for. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all identity providers (IDPs) for a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list idps --cluster=mycluster +---- + +[id="rosa-describe-ingress_{context}"] +== describe ingress + +Shows detailed information about the specified ingress within cluster. + +.Syntax +[source,terminal] +---- +$ rosa describe ingress [ingress] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster. + +| --ingress string +|Specify the ingress of the cluster to target + +|-o, --output string +|Specify your output format. You may use either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Examples +Shows the details of an ingress named `a1b2c3d4` on cluster named `mycluster`. + +[source,terminal] +---- +$ rosa describe ingress a1b2c3d4 -c mycluster +---- + +[id="rosa-list-ingresses_{context}"] +== list ingresses + +Lists all of the API and ingress endpoints for a cluster. + +.Syntax +[source,terminal] +---- +$ rosa list ingresses [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster that the IDPs will be listed for. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all API and ingress endpoints for a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list ingresses --cluster=mycluster +---- + +[id="rosa-list-instance-types_{context}"] +== list instance-types + +Lists all of the available instance types for use with {product-title}. Availability is based on the account's AWS quota. + +.Syntax +[source,terminal] +---- +$ rosa list instance-types [arguments] +---- + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all instance types. + +[source,terminal] +---- +$ rosa list instance-types +---- + +[id="rosa-describe-kubeletconfig_{context}"] +== describe kubeletconfig + +Shows the details of a custom `KubeletConfig` object. + +.Syntax +[source,terminal] +---- +$ rosa describe kubeletconfig --cluster= [arguments] ---- .Flags @@ -902,13 +691,41 @@ Required. endif::openshift-rosa-hcp[] Specifies the name of the `KubeletConfig` object to describe. -|-o, --output string - |-o, --output string |The output format. You can specify either `json` or `yaml`. |=== +[id="rosa-list-kubeletconfigs_{context}"] +== list kubeletconfigs + +Lists the `KubeletConfig` objects configured on a cluster. + +.Syntax +[source,terminal] +---- +$ rosa list kubeletconfigs --cluster= | [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +a|-c, --cluster \| +|Required. The name or ID of the cluster that the machine pools will be listed for. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all of the `KubeletConfig` objects on a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list kubeletconfigs --cluster=mycluster +---- + [id="rosa-describe-machinepool_{context}"] == describe machinepool @@ -933,37 +750,375 @@ $ rosa describe machinepool --cluster=[|] --machinepoo |=== -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== +include::snippets/rosa-cli-default-flags.adoc[] .Example -Describe a machine pool named `mymachinepool` on a cluster named `mycluster`. +Describes a machine pool named `mymachinepool` on a cluster named `mycluster`. [source,terminal] ---- $ rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool ---- -//Not currently supported in current iteration -// ifdef::openshift-rosa-hcp[] -// [id="rosa-describe-specific-mirror_set_{context}"] -// == describe specific mirror set -// Describes a specific mirror set. +[id="rosa-list-machinepools_{context}"] +== list machinepools -// .Syntax -// [source,terminal] -// ---- -// $ rosa describe idms corp-registry --cluster my-cluster -// ---- -// endif::openshift-rosa-hcp[] +Lists the machine pools configured on a cluster. + +.Syntax +[source,terminal] +---- +$ rosa list machinepools --cluster= | [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster that the machine pools will be listed for. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all of the machine pools on a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list machinepools --cluster=mycluster +---- + +[id="rosa-list-ocm-roles_{context}"] +== list ocm-roles + +Lists all OCM roles for the current AWS account. + +.Syntax +[source,terminal] +---- +$ rosa list ocm-roles [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|-o, --output string +|The output format. You can specify either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +[id="rosa-list-oidc-config_{context}"] +== list oidc-config + +Lists the OIDC Configuration resources associated with your AWS account. + +.Syntax +[source,terminal] +---- +$ rosa list oidc-config +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|-o, --output string +|The output format. You can specify either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +[id="rosa-list-oidc-providers_{context}"] +== list oidc-providers + +Lists all of the OIDC providers for the current AWS account. + +.Syntax +[source,terminal] +---- +$ rosa list oidc-providers [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +a|-c, --cluster \| +|Required. The name or ID of the cluster that the OIDC providers will be listed for. + +|--oidc-config-id string +|This argument filters OIDC providers by OIDC config ID. It returns one provider linked to the config ID. + +|-o, --output string +|The output format. You can specify either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +[id="rosa-list-operator-roles_{context}"] +== list operator-roles + +Lists all Operator roles and policies for the current AWS account. + +.Syntax +[source,terminal] +---- +$ rosa list operator-roles [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +a|-c, --cluster \| +|Required. The name or ID of the cluster. +|-o, --output string +|The output format. You can specify either `json` or `yaml`. +|--prefix string +|List only Operator roles that are associated with the given prefix. The prefix must match up to `openshift|kube-system`. +|--version string +|List only Operator roles that are associated with the given version. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +[id="rosa-list-regions_{context}"] +== list regions + +Lists all of the available regions for the current AWS account. + +.Syntax +[source,terminal] +---- +$ rosa list regions [arguments] +---- + +ifdef::openshift-rosa[] +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--multi-az +|Lists regions that provide support for multiple availability zones. +|=== +endif::openshift-rosa[] + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all of the available regions. + +[source,terminal] +---- +$ rosa list regions +---- + +[id="rosa-describe-tuning-configs_{context}"] +== describe tuning-configs + +Shows detailed information about a tuning config for a cluster. + +.Syntax +[source,terminal] +---- +$ rosa describe tuning-config --cluster +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +a|-c, --cluster \| +|Required. The name or ID of the cluster. +|-o, --output string +|The output format. You can specify either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Examples +Describes the `tuned1` tuned config on cluster `foo`. + +[source,terminal] +---- +$ rosa describe tuning-config --cluster foo tuned1 +---- + +[id="rosa-list-tuning-configs_{context}"] +== list tuning-configs + +Lists tuning configuration resources for a cluster. + +.Syntax +[source,terminal] +---- +$ rosa list tuning-configs --cluster +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +a|-c, --cluster \| +|Required. The name or ID of the cluster. +|-o, --output string +|The output format. You can specify either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all tuning configuration for a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list tuning-configs -c mycluster +---- + +[id="rosa-describe-upgrade_{context}"] +== describe upgrade + +Shows detailed information about an upgrade. + +.Syntax +[source,terminal] +---- +$ rosa describe upgrade [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +a|-c, --cluster \| +|Required. The name or ID of the cluster. +| --machinepool string +|The name of the machine pool of the cluster to target. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +[id="rosa-list-upgrades_{context}"] +== list upgrades + +Lists all available and scheduled cluster version upgrades. + +.Syntax +[source,terminal] +---- +$ rosa list upgrades --cluster= | [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster that the available upgrades will be listed for. +| --machinepool string +|The name of the machine pool of the cluster to target. +|-o, --output string +|The output format. You can specify either `json` or `yaml`. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all of the available upgrades for a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list upgrades --cluster=mycluster +---- + +[id="rosa-list-user-roles_{context}"] +== list user-roles + +Lists all user roles for current AWS account. + +.Syntax +[source,terminal] +---- +$ rosa list user-roles +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|-o, --output string +|The output format. You can specify either `json` or `yaml`. + +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +[id="rosa-list-users_{context}"] +== list users +Lists the cluster administrator and dedicated administrator users for a specified cluster. + +.Syntax +[source,terminal] +---- +$ rosa list users --cluster= | [arguments] +---- + +.Arguments +[cols="30,70"] +|=== +|Option |Definition + +|--cluster +|Required: The name or ID (string) of the cluster that the cluster administrators will be listed for. +|=== + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all of the cluster administrators and dedicated administrators for a cluster named `mycluster`. + +[source,terminal] +---- +$ rosa list users --cluster=mycluster +---- + +[id="rosa-list-versions_{context}"] +== list versions + +Lists all of the OpenShift versions that are available for creating a cluster. + +.Syntax +[source,terminal] +---- +$ rosa list versions [arguments] +---- + +include::snippets/rosa-cli-default-flags.adoc[] + +.Example +Lists all of the {product-title} versions. + +[source,terminal] +---- +$ rosa list versions +---- \ No newline at end of file diff --git a/snippets/rosa-cli-default-flags.adoc b/snippets/rosa-cli-default-flags.adoc new file mode 100644 index 0000000000..d3095be8f2 --- /dev/null +++ b/snippets/rosa-cli-default-flags.adoc @@ -0,0 +1,19 @@ +:_mod-docs-content-type: SNIPPET + +.Optional arguments inherited from parent commands +[cols="30,70] +|=== +|Option |Definition + +|--help, -h +|Shows help for this command. + +|--debug +|Enables debug mode. + +|--interactive +|Enables interactive mode. + +|--profile +|Specifies an AWS profile (string) from your credentials file. +|=== \ No newline at end of file