diff --git a/adding_service_cluster/adding-service.adoc b/adding_service_cluster/adding-service.adoc index 90e01ca72d..bceea84dd3 100644 --- a/adding_service_cluster/adding-service.adoc +++ b/adding_service_cluster/adding-service.adoc @@ -14,7 +14,7 @@ cluster by using {cluster-manager-first}. ifdef::openshift-rosa[] == Prerequisites -* For the Amazon CloudWatch service, you must first install the `cluster-logging-operator` using the `rosa` CLI. +* For the Amazon CloudWatch service, you must first install the `cluster-logging-operator` using the ROSA CLI (`rosa`). endif::[] include::modules/adding-service-existing.adoc[leveloffset=+1] diff --git a/adding_service_cluster/rosa-available-services.adoc b/adding_service_cluster/rosa-available-services.adoc index 62f3da8f3c..bc7325278d 100644 --- a/adding_service_cluster/rosa-available-services.adoc +++ b/adding_service_cluster/rosa-available-services.adoc @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] You can add services to your existing {product-title} (ROSA) cluster using the xref:../adding_service_cluster/adding-service.adoc#adding-service[{cluster-manager-first} console]. -These services can also be installed xref:../rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[using the `rosa` CLI]. +These services can also be installed xref:../rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[using the ROSA CLI (`rosa`)]. include::modules/aws-cloudwatch.adoc[leveloffset=+1] diff --git a/modules/automatic-network-verification-bypassing.adoc b/modules/automatic-network-verification-bypassing.adoc index 2921e19377..1902455a41 100644 --- a/modules/automatic-network-verification-bypassing.adoc +++ b/modules/automatic-network-verification-bypassing.adoc @@ -24,7 +24,7 @@ endif::openshift-rosa[] When you install a cluster into an existing VPC by using {cluster-manager-first}, you can bypass the automatic verification by selecting *Bypass network verification* on the *Virtual Private Cloud (VPC) subnet settings* page. ifdef::openshift-rosa[] -.Bypassing automatic network verification by using the ROSA CLI +.Bypassing automatic network verification by using the ROSA CLI (`rosa`) When you install a cluster into an existing VPC by using the `rosa create cluster` command, you can bypass the automatic verification by including the `--bypass-network-verify --force` arguments. The following example bypasses the network verification before creating a cluster: diff --git a/modules/aws-cloudwatch.adoc b/modules/aws-cloudwatch.adoc index 2e5193e9f4..e675ca103e 100644 --- a/modules/aws-cloudwatch.adoc +++ b/modules/aws-cloudwatch.adoc @@ -6,4 +6,4 @@ = Amazon CloudWatch -Amazon CloudWatch forwards logs from {product-title} (ROSA) to the AWS console for viewing. You must first install the ROSA `cluster-logging-operator` using the `rosa` CLI before installing the Amazon CloudWatch service through {cluster-manager-first} console. +Amazon CloudWatch forwards logs from {product-title} (ROSA) to the AWS console for viewing. You must first install the ROSA `cluster-logging-operator` using the ROSA CLI (`rosa`) before installing the Amazon CloudWatch service through {cluster-manager-first} console. diff --git a/modules/configmap-removing-ca.adoc b/modules/configmap-removing-ca.adoc index a1bbe65d08..a1b93ec862 100644 --- a/modules/configmap-removing-ca.adoc +++ b/modules/configmap-removing-ca.adoc @@ -6,12 +6,12 @@ [id="configmap-removing-ca_{context}"] = Removing certificate authorities on a {product-title} cluster -You can remove certificate authorities (CA) from your cluster with the `rosa` CLI tool. +You can remove certificate authorities (CA) from your cluster with the {product-title} (ROSA) CLI, `rosa`. .Prerequisites * You must have cluster administrator privileges. -* You have installed the `rosa` CLI tool. +* You have installed the ROSA CLI (`rosa`). * Your cluster has certificate authorities added. .Procedure diff --git a/modules/creating-a-machine-pool-cli.adoc b/modules/creating-a-machine-pool-cli.adoc index 5f8172e4af..10432a15aa 100644 --- a/modules/creating-a-machine-pool-cli.adoc +++ b/modules/creating-a-machine-pool-cli.adoc @@ -10,8 +10,8 @@ You can create additional machine pools for your {product-title} (ROSA) cluster .Prerequisites -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a ROSA cluster. .Procedure diff --git a/modules/creating-a-machine-pool.adoc b/modules/creating-a-machine-pool.adoc index f52228152e..aa35f2aded 100644 --- a/modules/creating-a-machine-pool.adoc +++ b/modules/creating-a-machine-pool.adoc @@ -5,4 +5,5 @@ :_content-type: CONCEPT [id="creating_a_machine_pool_{context}"] = Creating a machine pool + A default machine pool is created when you install a {product-title} (ROSA) cluster. After installation, you can create additional machine pools for your cluster by using {cluster-manager} or the ROSA CLI (`rosa`). diff --git a/modules/nw-rosa-proxy-remove-cli.adoc b/modules/nw-rosa-proxy-remove-cli.adoc index 0c79109ab4..07a878b0a0 100644 --- a/modules/nw-rosa-proxy-remove-cli.adoc +++ b/modules/nw-rosa-proxy-remove-cli.adoc @@ -6,12 +6,12 @@ [id="nw-rosa-proxy-remove-cli_{context}"] = Removing the cluster-wide proxy using CLI -You must use the `rosa` CLI to remove the proxy's address from your cluster. +You must use the {product-title} (ROSA) CLI, `rosa`, to remove the proxy's address from your cluster. .Prerequisites * You must have cluster administrator privileges. -* You have installed the {product-title} `rosa` CLI tool. +* You have installed the ROSA CLI (`rosa`). .Procedure diff --git a/modules/rosa-about.adoc b/modules/rosa-about.adoc index 4cbbd48352..5c12bb1ef3 100644 --- a/modules/rosa-about.adoc +++ b/modules/rosa-about.adoc @@ -6,7 +6,7 @@ :_content-type: CONCEPT [id="rosa-about_{context}"] -= About the rosa CLI += About the {product-title} (ROSA) CLI, `rosa` Use the `rosa` command-line utility for {product-title} (ROSA) to create, update, manage, and delete {product-title} clusters and resources. diff --git a/modules/rosa-accessing-your-cluster.adoc b/modules/rosa-accessing-your-cluster.adoc index e557965264..d7b0f1dbd6 100644 --- a/modules/rosa-accessing-your-cluster.adoc +++ b/modules/rosa-accessing-your-cluster.adoc @@ -54,7 +54,7 @@ Any optional fields can be left empty and a default will be selected. + [NOTE] ==== -The fields in the *Register a new OAuth application* GitHub form are automatically filled with the required values through the URL that is defined by the `rosa` CLI tool. +The fields in the *Register a new OAuth application* GitHub form are automatically filled with the required values through the URL that is defined by the {product-title} (ROSA) CLI, `rosa`. ==== .. Use the information from the GitHub application you created and continue the prompts. Enter the following values: + diff --git a/modules/rosa-adding-node-labels.adoc b/modules/rosa-adding-node-labels.adoc index f948a4b0cb..4f665257a7 100644 --- a/modules/rosa-adding-node-labels.adoc +++ b/modules/rosa-adding-node-labels.adoc @@ -15,8 +15,8 @@ Labels are assigned as key-value pairs. Each key must be unique to the object it .Prerequisites ifdef::openshift-rosa[] -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a {product-title} (ROSA) cluster. endif::openshift-rosa[] ifndef::openshift-rosa[] diff --git a/modules/rosa-adding-taints.adoc b/modules/rosa-adding-taints.adoc index 332c7f03f6..fb2d714f7f 100644 --- a/modules/rosa-adding-taints.adoc +++ b/modules/rosa-adding-taints.adoc @@ -10,7 +10,7 @@ You can add taints for compute (also known as worker) nodes in a machine pool to control which pods are scheduled to them. When you apply a taint to a machine pool, the scheduler cannot place a pod on the nodes in the pool unless the pod specification includes a toleration for the taint. ifdef::openshift-rosa[] -Taints can be added to a machine pool using the OpenShift Cluster Manager or the ROSA CLI. +Taints can be added to a machine pool using the OpenShift Cluster Manager or the {product-title} (ROSA) CLI, `rosa`. endif::openshift-rosa[] [NOTE] ==== diff --git a/modules/rosa-adding-tuning.adoc b/modules/rosa-adding-tuning.adoc index 54e32fbcc4..604401a8c1 100644 --- a/modules/rosa-adding-tuning.adoc +++ b/modules/rosa-adding-tuning.adoc @@ -11,9 +11,9 @@ You can add tunings for compute (also known as worker) nodes in a machine pool t .Prerequisites ifdef::openshift-rosa[] -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the ROSA CLI. -* You created a {product-title} (ROSA) cluster. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). +* You created a ROSA cluster. endif::openshift-rosa[] ifndef::openshift-rosa[] * You created an {product-title} cluster. diff --git a/modules/rosa-aws-privatelink-create-cluster.adoc b/modules/rosa-aws-privatelink-create-cluster.adoc index a7860dc74d..1316788999 100644 --- a/modules/rosa-aws-privatelink-create-cluster.adoc +++ b/modules/rosa-aws-privatelink-create-cluster.adoc @@ -5,7 +5,7 @@ [id="rosa-aws-privatelink-create-cluster.adoc_{context}"] = Creating an AWS PrivateLink cluster -You can create an AWS PrivateLink cluster using the `rosa` CLI. +You can create an AWS PrivateLink cluster using the {product-title} (ROSA) CLI, `rosa`. [NOTE] ==== diff --git a/modules/rosa-aws-requirements.adoc b/modules/rosa-aws-requirements.adoc index a4efd463ee..9a24d57579 100644 --- a/modules/rosa-aws-requirements.adoc +++ b/modules/rosa-aws-requirements.adoc @@ -40,7 +40,7 @@ This policy only provides Red Hat with permissions and capabilities to change re ==== * Red Hat must have AWS console access to the customer-provided AWS account. This access is protected and managed by Red Hat. * The customer must not utilize the AWS account to elevate their permissions within the {product-title} cluster. -* Actions available in the `rosa` CLI utility or {cluster-manager-url} console must not be directly performed in the customer's AWS account. +* Actions available in the {product-title} (ROSA) CLI, `rosa`, or {cluster-manager-url} console must not be directly performed in the customer's AWS account. [id="rosa-support-requirements_{context}"] == Support requirements diff --git a/modules/rosa-checking-account-version-info-cli.adoc b/modules/rosa-checking-account-version-info-cli.adoc index 0c0cc9b7f3..73fc9cc37c 100644 --- a/modules/rosa-checking-account-version-info-cli.adoc +++ b/modules/rosa-checking-account-version-info-cli.adoc @@ -3,9 +3,9 @@ // * rosa_cli/rosa-checking-acct-version-cli.adoc [id="rosa-checking-account-version-information_{context}"] -= Checking account and version information with the rosa CLI += Checking account and version information with the ROSA CLI -Use the following commands to check your account and version information. +Use the following commands to check your account and version information with the {product-title} (ROSA) CLI, `rosa`. [id="rosa-whoami_{context}"] == whoami @@ -42,7 +42,7 @@ $ rosa whoami [id="rosa-version_{context}"] == version -Display the version of your `rosa` CLI. +Display the version of your {product-title} (ROSA) CLI, `rosa`. .Syntax [source,terminal] diff --git a/modules/rosa-common-commands.adoc b/modules/rosa-common-commands.adoc index 927d56a5cc..9116bf9ce7 100644 --- a/modules/rosa-common-commands.adoc +++ b/modules/rosa-common-commands.adoc @@ -6,7 +6,7 @@ [id="rosa-common-commands_{context}"] = Common commands and arguments -These common commands and arguments are available for the `rosa` CLI. +These common commands and arguments are available for the {product-title} (ROSA) CLI, `rosa`. [id="rosa-debug_{context}"] == debug @@ -33,10 +33,10 @@ $ rosa download [id="rosa-help_{context}"] == help -Displays general help information for the `rosa` CLI and a list of available commands. This option can also be used as an argument to display help information for a parent command, such as `version` or `create`. +Displays general help information for the ROSA CLI (`rosa`) and a list of available commands. This option can also be used as an argument to display help information for a parent command, such as `version` or `create`. .Examples -Displays general help for the `rosa` CLI. +Displays general help for the ROSA CLI. [source,terminal] ---- $ rosa --help @@ -82,7 +82,7 @@ $ rosa version [arguments] ---- .Example output -Displayed when a newer version of the `rosa` CLI is available. +Displayed when a newer version of the ROSA CLI is available. [source,terminal] ---- 1.2.12 diff --git a/modules/rosa-configure.adoc b/modules/rosa-configure.adoc index 9d79063533..1168d93839 100644 --- a/modules/rosa-configure.adoc +++ b/modules/rosa-configure.adoc @@ -4,16 +4,16 @@ // * rosa_cli/rosa-get-started-cli.adoc [id="rosa-configure_{context}"] -= Configuring the rosa CLI += Configuring the ROSA CLI -Use the following commands to configure the `rosa` CLI. +Use the following commands to configure the {product-title} (ROSA) CLI, `rosa`. [id="rosa-login_{context}"] == login Log in to your Red Hat account, saving the credentials to the `rosa` configuration file. You must provide a token when logging in. You can copy your token from link:https://console.redhat.com/openshift/token/rosa[the {product-title} token page]. -The `rosa` CLI looks for a token in the following priority order: +The ROSA CLI (`rosa`) looks for a token in the following priority order: . Command-line arguments . The `ROSA_TOKEN` environment variable @@ -186,9 +186,9 @@ $ rosa verify quota --region=us-west-2 [id="rosa-download-rosa-client_{context}"] == download rosa -Download the latest compatible version of the {product-title} CLI (`rosa`). +Download the latest compatible version of the ROSA CLI. -After you download `rosa`, extract the contents of the archive and add it to your path. See xref:../rosa_cli/rosa-get-started-cli.adoc#rosa-setting-up-cli_rosa-getting-started-cli[Setting up the rosa CLI] for more details. +After you download `rosa`, extract the contents of the archive and add it to your path. See xref:../rosa_cli/rosa-get-started-cli.adoc#rosa-setting-up-cli_rosa-getting-started-cli[Setting up the ROSA CLI] for more details. .Syntax [source,terminal] diff --git a/modules/rosa-configuring-aws-account.adoc b/modules/rosa-configuring-aws-account.adoc index db24aa88db..1438f3f9de 100644 --- a/modules/rosa-configuring-aws-account.adoc +++ b/modules/rosa-configuring-aws-account.adoc @@ -48,11 +48,11 @@ It is recommended to set the default AWS region by using the environment variabl + The ROSA service evaluates regions in the following priority order: + -... The region specified when running a `rosa` command with the `--region` flag. +... The region specified when running the `rosa` command with the `--region` flag. ... The region set in the `AWS_DEFAULT_REGION` environment variable. See link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html[Environment variables to configure the AWS CLI] in the AWS documentation. ... The default region set in your AWS configuration file. See link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config[Quick configuration with aws configure] in the AWS documentation. .. Optional: Configure your AWS CLI settings and credentials by using an AWS named profile. `rosa` evaluates AWS named profiles in the following priority order: -... The profile specified when running a `rosa` command with the `--profile` flag. +... The profile specified when running the `rosa` command with the `--profile` flag. ... The profile set in the `AWS_PROFILE` environment variable. See link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html[Named profiles] in the AWS documentation. .. Verify the AWS CLI is installed and configured correctly by running the following command to query the AWS API: + diff --git a/modules/rosa-creating-cluster.adoc b/modules/rosa-creating-cluster.adoc index 2d2c16c331..44a99b320b 100644 --- a/modules/rosa-creating-cluster.adoc +++ b/modules/rosa-creating-cluster.adoc @@ -6,7 +6,7 @@ [id="rosa-creating-cluster_{context}"] = Creating your cluster -You can create an {product-title} cluster using the `rosa` CLI. +You can create a {product-title} (ROSA) cluster using the ROSA CLI (`rosa`). .Prerequisites @@ -19,7 +19,7 @@ link:https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html[AWS Share .Procedure -. You can create a cluster using the default settings or by specifying custom settings using the interactive mode. To view other options when creating a cluster, enter `rosa create cluster --help`. +. You can create a cluster using the default settings or by specifying custom settings using the interactive mode. To view other options when creating a cluster, enter the `rosa create cluster --help` command. + Creating a cluster can take up to 40 minutes. + @@ -50,7 +50,7 @@ I: To determine when your cluster is Ready, run `rosa describe cluster rh-rosa-t ---- $ rosa create cluster --interactive ---- -* To configure your networking IP ranges, you can use the following default ranges. For more information when using manual mode, use `rosa create cluster --help | grep cidr`. In interactive mode, you are prompted for the settings. +* To configure your networking IP ranges, you can use the following default ranges. For more information when using manual mode, use the `rosa create cluster --help | grep cidr` command. In interactive mode, you are prompted for the settings. + ** Node CIDR: 10.0.0.0/16 ** Service CIDR: 172.30.0.0/16 diff --git a/modules/rosa-creating-node-tuning.adoc b/modules/rosa-creating-node-tuning.adoc index 5a96ea1e7e..f446f18cc4 100644 --- a/modules/rosa-creating-node-tuning.adoc +++ b/modules/rosa-creating-node-tuning.adoc @@ -6,7 +6,7 @@ [id="rosa-creating-node-tuning_{context}"] = Creating node tuning configurations on {hcp-title} -You can create tuning configurations using the ROSA CLI. +You can create tuning configurations using the {product-title} (ROSA) CLI, `rosa`. .Prerequisites diff --git a/modules/rosa-creating-operator-roles-and-oidc-manually-ocm.adoc b/modules/rosa-creating-operator-roles-and-oidc-manually-ocm.adoc index f16f3bf6e8..a6c7a6a0f2 100644 --- a/modules/rosa-creating-operator-roles-and-oidc-manually-ocm.adoc +++ b/modules/rosa-creating-operator-roles-and-oidc-manually-ocm.adoc @@ -12,6 +12,6 @@ If you use {cluster-manager-first} to install your cluster and opt to create the AWS CLI (`aws`):: With this method, you can download and extract an archive file that contains the `aws` commands and policy files required to create the IAM resources. Run the provided CLI commands from the directory that contains the policy files to create the Operator roles and the OIDC provider. -ROSA CLI (`rosa`):: You can run the commands provided by this method to create the Operator roles and the OIDC provider for your cluster using `rosa`. +The {product-title} (ROSA) CLI, `rosa`:: You can run the commands provided by this method to create the Operator roles and the OIDC provider for your cluster using `rosa`. If you use `auto` mode, {cluster-manager} creates the Operator roles and the OIDC provider automatically, using the permissions provided through the {cluster-manager} IAM role. To use this feature, you must apply admin privileges to the role. diff --git a/modules/rosa-delete-cluster-admins.adoc b/modules/rosa-delete-cluster-admins.adoc index fc6cad0aed..b3c354d3eb 100644 --- a/modules/rosa-delete-cluster-admins.adoc +++ b/modules/rosa-delete-cluster-admins.adoc @@ -6,7 +6,7 @@ :_content-type: PROCEDURE [id="rosa-delete-cluster-admins_{context}"] -= Revoking `cluster-admin` access using the `rosa` CLI += Revoking `cluster-admin` access using the ROSA CLI Only the user who created the cluster can revoke access for `cluster-admin` users. .Prerequisites diff --git a/modules/rosa-delete-dedicated-admins.adoc b/modules/rosa-delete-dedicated-admins.adoc index 4531c1f322..7423b231ce 100644 --- a/modules/rosa-delete-dedicated-admins.adoc +++ b/modules/rosa-delete-dedicated-admins.adoc @@ -6,7 +6,7 @@ :_content-type: PROCEDURE [id="rosa-delete-dedicated-admins_{context}"] -= Revoking `dedicated-admin` access using the `rosa` CLI += Revoking `dedicated-admin` access using the ROSA CLI You can revoke access for a `dedicated-admin` user if you are the user who created the cluster, the organization administrator user, or the super administrator user. .Prerequisites diff --git a/modules/rosa-deleting-cluster.adoc b/modules/rosa-deleting-cluster.adoc index daf4189886..4c010c6733 100644 --- a/modules/rosa-deleting-cluster.adoc +++ b/modules/rosa-deleting-cluster.adoc @@ -17,7 +17,7 @@ ifdef::sts[] endif::sts[] ifndef::sts[] -You can delete a {product-title} cluster using the ROSA CLI (`rosa`). +You can delete a {product-title} (ROSA) cluster using the ROSA CLI (`rosa`). endif::sts[] ifdef::sts[] diff --git a/modules/rosa-deleting-node-tuning.adoc b/modules/rosa-deleting-node-tuning.adoc index a5ba8fefc3..85a96de61a 100644 --- a/modules/rosa-deleting-node-tuning.adoc +++ b/modules/rosa-deleting-node-tuning.adoc @@ -6,7 +6,7 @@ [id="rosa-deleting-node-tuning_{context}"] = Deleting node tuning configurations on {hcp-title} -You can delete tuning configurations by using the ROSA CLI. +You can delete tuning configurations by using the {product-title} (ROSA) CLI, `rosa`. [NOTE] ==== diff --git a/modules/rosa-disabling-autoscaling-nodes.adoc b/modules/rosa-disabling-autoscaling-nodes.adoc index fa6f17260f..7e5f9e069b 100644 --- a/modules/rosa-disabling-autoscaling-nodes.adoc +++ b/modules/rosa-disabling-autoscaling-nodes.adoc @@ -6,9 +6,9 @@ :_content-type: PROCEDURE [id="rosa-disabling-autoscaling_{context}"] -= Disabling autoscaling nodes in an existing cluster using the rosa CLI += Disabling autoscaling nodes in an existing cluster using the ROSA CLI -Disable autoscaling for worker nodes in the machine pool definition. +Disable autoscaling for worker nodes in the machine pool definition using the {product-title} (ROSA) CLI, `rosa`. .Procedure diff --git a/modules/rosa-enabling-autoscaling-nodes.adoc b/modules/rosa-enabling-autoscaling-nodes.adoc index 2cb394b284..9fe463ad54 100644 --- a/modules/rosa-enabling-autoscaling-nodes.adoc +++ b/modules/rosa-enabling-autoscaling-nodes.adoc @@ -6,7 +6,7 @@ :_content-type: PROCEDURE [id="rosa-enabling-autoscaling-nodes_{context}"] -= Enabling autoscaling nodes in an existing cluster using the rosa CLI += Enabling autoscaling nodes in an existing cluster using the ROSA CLI Configure autoscaling to dynamically scale the number of worker nodes up or down based on load. diff --git a/modules/rosa-getting-started-access-cluster-web-console.adoc b/modules/rosa-getting-started-access-cluster-web-console.adoc index 701cd69e3a..311345d424 100644 --- a/modules/rosa-getting-started-access-cluster-web-console.adoc +++ b/modules/rosa-getting-started-access-cluster-web-console.adoc @@ -20,8 +20,8 @@ ifdef::getting-started[] .Prerequisites * You have an AWS account. -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a ROSA cluster. * You have created a cluster administrator user or added your user account to the configured identity provider. endif::[] diff --git a/modules/rosa-getting-started-configure-an-idp.adoc b/modules/rosa-getting-started-configure-an-idp.adoc index fd6d960eb2..79b40d2b04 100644 --- a/modules/rosa-getting-started-configure-an-idp.adoc +++ b/modules/rosa-getting-started-configure-an-idp.adoc @@ -27,8 +27,8 @@ ifdef::getting-started[] .Prerequisites * You have an AWS account. -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a ROSA cluster. * You have a GitHub user account. endif::[] @@ -68,7 +68,7 @@ Any optional fields can be left empty and a default will be selected. + [NOTE] ==== -The fields in the *Register a new OAuth application* GitHub form are automatically filled with the required values through the URL defined by the `rosa` CLI tool. +The fields in the *Register a new OAuth application* GitHub form are automatically filled with the required values through the URL defined by the ROSA CLI. ==== .. Use the information from your GitHub OAuth application page to populate the remaining `rosa create idp` interactive prompts. + diff --git a/modules/rosa-getting-started-create-cluster-admin-user.adoc b/modules/rosa-getting-started-create-cluster-admin-user.adoc index 9f13106a9a..25fc9d4a70 100644 --- a/modules/rosa-getting-started-create-cluster-admin-user.adoc +++ b/modules/rosa-getting-started-create-cluster-admin-user.adoc @@ -25,8 +25,8 @@ ifdef::getting-started[] .Prerequisites * You have an AWS account. -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a ROSA cluster. endif::[] diff --git a/modules/rosa-getting-started-deleting-a-cluster.adoc b/modules/rosa-getting-started-deleting-a-cluster.adoc index 950dad687d..c0fb3677d0 100644 --- a/modules/rosa-getting-started-deleting-a-cluster.adoc +++ b/modules/rosa-getting-started-deleting-a-cluster.adoc @@ -14,7 +14,7 @@ ifeval::["{context}" == "rosa-quickstart"] :quickstart: endif::[] -You can delete a ROSA cluster that uses the AWS Security Token Service (STS) by using the ROSA CLI (`rosa`). You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide inline and Operator policies, you can use the AWS IAM Console. +You can delete a ROSA cluster that uses the AWS Security Token Service (STS) by using the {product-title} (ROSA) CLI, `rosa`. You can also use the ROSA CLI to delete the AWS Identity and Access Management (IAM) account-wide roles, the cluster-specific Operator roles, and the OpenID Connect (OIDC) provider. To delete the account-wide inline and Operator policies, you can use the AWS IAM Console. [IMPORTANT] ==== @@ -24,8 +24,8 @@ Account-wide IAM roles and policies might be used by other ROSA clusters in the ifdef::getting-started[] .Prerequisites -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a ROSA cluster. endif::[] diff --git a/modules/rosa-getting-started-grant-admin-privileges.adoc b/modules/rosa-getting-started-grant-admin-privileges.adoc index 375d055162..a77a50c2a8 100644 --- a/modules/rosa-getting-started-grant-admin-privileges.adoc +++ b/modules/rosa-getting-started-grant-admin-privileges.adoc @@ -20,8 +20,8 @@ ifdef::getting-started[] .Prerequisites * You have an AWS account. -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a ROSA cluster. * You have configured a GitHub identity provider for your cluster and added identity provider users. endif::[] diff --git a/modules/rosa-getting-started-grant-user-access.adoc b/modules/rosa-getting-started-grant-user-access.adoc index 7f9b0deea4..6ca6108901 100644 --- a/modules/rosa-getting-started-grant-user-access.adoc +++ b/modules/rosa-getting-started-grant-user-access.adoc @@ -22,8 +22,8 @@ ifdef::getting-started[] .Prerequisites * You have an AWS account. -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a ROSA cluster. * You have a GitHub user account. * You have configured a GitHub identity provider for your cluster. diff --git a/modules/rosa-getting-started-install-configure-cli-tools.adoc b/modules/rosa-getting-started-install-configure-cli-tools.adoc index d2f27c2174..3b1acc1c69 100644 --- a/modules/rosa-getting-started-install-configure-cli-tools.adoc +++ b/modules/rosa-getting-started-install-configure-cli-tools.adoc @@ -60,7 +60,7 @@ $ aws sts get-caller-identity ---- . Install and configure the latest ROSA CLI (`rosa`). -.. Download the latest version of the `rosa` CLI for your operating system from the link:https://console.redhat.com/openshift/downloads[*Downloads*] page on the {cluster-manager-first} {hybrid-console-second}. +.. Download the latest version of the ROSA CLI for your operating system from the link:https://console.redhat.com/openshift/downloads[*Downloads*] page on the {cluster-manager-first} {hybrid-console-second}. .. Extract the `rosa` binary file from the downloaded archive. The following example extracts the binary from a Linux tar archive: + [source,terminal] @@ -73,7 +73,7 @@ $ tar xvf rosa-linux.tar.gz ---- $ sudo mv rosa /usr/local/bin/rosa ---- -.. Verify if the `rosa` CLI tool is installed correctly by querying the `rosa` version: +.. Verify if the ROSA CLI is installed correctly by querying the `rosa` version: + [source,terminal] ---- @@ -88,7 +88,7 @@ Your ROSA CLI is up to date. ---- ifdef::getting-started[] + -.. Optional: Enable tab completion for the `rosa` CLI. With tab completion enabled, you can press the `Tab` key twice to automatically complete subcommands and receive command suggestions. +.. Optional: Enable tab completion for the ROSA CLI. With tab completion enabled, you can press the `Tab` key twice to automatically complete subcommands and receive command suggestions. + `rosa` tab completion is available for different shell types. The following example enables persistent tab completion for Bash on a Linux host. The command generates a `rosa` tab completion configuration file for Bash and saves it to the `/etc/bash_completion.d/` directory: + @@ -104,7 +104,7 @@ You must open a new terminal to activate the configuration. For steps to configure `rosa` tab completion for different shell types, see the help menu by running `rosa completion --help`. ==== endif::[] -.. Log in to your Red Hat account by using the `rosa` CLI: +.. Log in to your Red Hat account by using the ROSA CLI: + [source,terminal] ---- @@ -151,7 +151,7 @@ Check that the information in the output is correct before proceeding. ifdef::getting-started[] . Install and configure the latest OpenShift CLI (`oc`). -.. Use the `rosa` CLI to download the latest version of the `oc` CLI: +.. Use the ROSA CLI to download the latest version of the `oc` CLI: + [source,terminal] ---- diff --git a/modules/rosa-getting-started-revoke-admin-privileges.adoc b/modules/rosa-getting-started-revoke-admin-privileges.adoc index a5486811ce..96a6e2f66e 100644 --- a/modules/rosa-getting-started-revoke-admin-privileges.adoc +++ b/modules/rosa-getting-started-revoke-admin-privileges.adoc @@ -19,8 +19,8 @@ Follow the steps in this section to revoke `cluster-admin` or `dedicated-admin` ifdef::getting-started[] .Prerequisites -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a ROSA cluster. * You have configured a GitHub identity provider for your cluster and added an identity provider user. * You granted `cluster-admin` or `dedicated-admin` privileges to a user. diff --git a/modules/rosa-getting-started-revoking-admin-privileges-and-user-access.adoc b/modules/rosa-getting-started-revoking-admin-privileges-and-user-access.adoc index 9327bb27de..47bb61f52f 100644 --- a/modules/rosa-getting-started-revoking-admin-privileges-and-user-access.adoc +++ b/modules/rosa-getting-started-revoking-admin-privileges-and-user-access.adoc @@ -6,7 +6,7 @@ [id="rosa-getting-started-revoking-admin-privileges-and-user-access_{context}"] = Revoking administrator privileges and user access -You can revoke `cluster-admin` or `dedicated-admin` privileges from a user by using the ROSA CLI (`rosa`). +You can revoke `cluster-admin` or `dedicated-admin` privileges from a user by using the {product-title} (ROSA) CLI, `rosa`. To revoke cluster access from a user, you must remove the user from your configured identity provider. diff --git a/modules/rosa-hcp-byo-oidc-options.adoc b/modules/rosa-hcp-byo-oidc-options.adoc index 692ea26c83..7b4f4a4a29 100644 --- a/modules/rosa-hcp-byo-oidc-options.adoc +++ b/modules/rosa-hcp-byo-oidc-options.adoc @@ -35,7 +35,7 @@ $ rosa create oidc-config --raw-files Allows you to specify the mode to create your OIDC configuration. With the `manual` option, you receive AWS commands that setup the OIDC configuration within an S3 bucket. This option stores the private key in the Secrets Manager. With the `manual` option, the OIDC Endpoint URL is the URL for the S3 bucket. You must retrieve the Secrets Manager ARN to register the OIDC configuration with OCM. -Using the `auto` option, you receive the same OIDC configuration and AWS resources as the `manual` mode. One change is that ROSA calls AWS, so you do not need to do anything else. The OIDC Endpoint URL is the URL for the S3 bucket. The CLI retrieves the Secrets Manager ARN, registers the OIDC configuration with OCM, and reports a second ROSA command that the user can run to continue with creation of STS cluster. +Using the `auto` option, you receive the same OIDC configuration and AWS resources as the `manual` mode. One change is that ROSA calls AWS, so you do not need to do anything else. The OIDC Endpoint URL is the URL for the S3 bucket. The CLI retrieves the Secrets Manager ARN, registers the OIDC configuration with OCM, and reports the second `rosa` command that the user can run to continue with the creation of the STS cluster. .Example [source,terminal] diff --git a/modules/rosa-hcp-byo-oidc.adoc b/modules/rosa-hcp-byo-oidc.adoc index 542d81a4f0..c4f0265e9f 100644 --- a/modules/rosa-hcp-byo-oidc.adoc +++ b/modules/rosa-hcp-byo-oidc.adoc @@ -24,7 +24,7 @@ endif::rosa-hcp[] ifdef::rosa-classic[] * You have completed the AWS prerequisites for {product-title}. endif::rosa-classic[] -* You have installed and configured the latest ROSA CLI (`rosa`) on your installation host. +* You have installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your installation host. .Procedure diff --git a/modules/rosa-hcp-classic-comparison.adoc b/modules/rosa-hcp-classic-comparison.adoc index 23a5d21588..962b8d1c15 100644 --- a/modules/rosa-hcp-classic-comparison.adoc +++ b/modules/rosa-hcp-classic-comparison.adoc @@ -6,7 +6,7 @@ [id="rosa-hcp-classic-comparison_{context}"] = Comparing ROSA with hosted control planes and ROSA Classic -{hcp-title-first} offers a different way to create a managed ROSA cluster. {hcp-title} offers a reduced-cost solution with focuses on reliability and efficiency. With a focus on efficiency, you can quickly create a new cluster and deploy applications in minutes. +{hcp-title-first} offers a different way to create a managed {product-title} (ROSA) cluster. {hcp-title} offers a reduced-cost solution with focuses on reliability and efficiency. With a focus on efficiency, you can quickly create a new cluster and deploy applications in minutes. {hcp-title} requires only a minimum of two nodes making it ideal for smaller projects while still being able to scale to support larger projects and enterprises. @@ -40,11 +40,11 @@ | *Deployment* | - * Deploy using ROSA CLI + * Deploy using the ROSA CLI (`rosa`) * Customers provision "Hosted Clusters" that deploy the control plane components into Red Hat's AWS account * Customers provision "Machine Pools" that deploy worker nodes into the customer's AWS account | - * Deploy using ROSA CLI or web UI + * Deploy using the ROSA CLI or the web UI * Full cluster provisioning occurs in customer's AWS account | *Upgrades* diff --git a/modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc b/modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc index ad75490db4..4c5b2b9b7f 100644 --- a/modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc +++ b/modules/rosa-hcp-creating-account-wide-sts-roles-and-policies.adoc @@ -6,7 +6,7 @@ [id="rosa-sts-creating-account-wide-sts-roles-and-policies_{context}"] = Creating the account-wide STS roles and policies -Before using the ROSA CLI to create {hcp-title-first} clusters, create the required account-wide roles and policies, including the Operator policies. +Before using the {product-title} (ROSA) CLI, `rosa`, to create {hcp-title-first} clusters, create the required account-wide roles and policies, including the Operator policies. .Prerequisites diff --git a/modules/rosa-hcp-sts-creating-a-cluster-cli.adoc b/modules/rosa-hcp-sts-creating-a-cluster-cli.adoc index f7b7a1099d..c7db56fe36 100644 --- a/modules/rosa-hcp-sts-creating-a-cluster-cli.adoc +++ b/modules/rosa-hcp-sts-creating-a-cluster-cli.adoc @@ -6,7 +6,7 @@ [id="rosa-hcp-sts-creating-a-cluster-cli_{context}"] = Creating a {hcp-title} cluster using the CLI -When using {product-title} (ROSA) CLI (`rosa`) to create a cluster, you can select the default options to create the cluster quickly. +When using the {product-title} (ROSA) CLI, `rosa`, to create a cluster, you can select the default options to create the cluster quickly. .Prerequisites diff --git a/modules/rosa-installing.adoc b/modules/rosa-installing.adoc index acf5e13b48..77117f3b63 100644 --- a/modules/rosa-installing.adoc +++ b/modules/rosa-installing.adoc @@ -8,7 +8,7 @@ [id="rosa-installing-and-configuring-the-rosa-cli_{context}"] = Installing and configuring the ROSA CLI -Install and configure the ROSA CLI (`rosa`). You can also install the OpenShift CLI (`oc`) and verify if the required AWS resource quotas are available by using the ROSA CLI. +Install and configure the {product-title} (ROSA) CLI, `rosa`. You can also install the OpenShift CLI (`oc`) and verify if the required AWS resource quotas are available by using the ROSA CLI (`rosa`). .Prerequisites @@ -19,7 +19,7 @@ Install and configure the ROSA CLI (`rosa`). You can also install the OpenShift .Procedure . Install `rosa`, the {product-title} command-line interface (CLI). -.. Download the link:https://access.redhat.com/products/red-hat-openshift-service-aws/[latest release] of the `rosa` CLI for your operating system. +.. Download the link:https://access.redhat.com/products/red-hat-openshift-service-aws/[latest release] of the ROSA CLI for your operating system. .. Optional: Rename the executable file you downloaded to `rosa`. This documentation uses `rosa` to refer to the executable file. .. Optional: Add `rosa` to your path. + @@ -76,13 +76,13 @@ Flags: Use "rosa [command] --help" for more information about a command. ---- + -.. Optional: Generate the command completion scripts for the `rosa` CLI. The following example generates the Bash completion scripts for a Linux machine: +.. Optional: Generate the command completion scripts for the ROSA CLI. The following example generates the Bash completion scripts for a Linux machine: + [source,terminal] ---- $ rosa completion bash | sudo tee /etc/bash_completion.d/rosa ---- -.. Optional: Enable `rosa` command completion from your existing terminal. The following example enables Bash completion for `rosa` in an existing terminal on a Linux machine: +.. Optional: Enable command completion for the ROSA CLI from your existing terminal. The following example enables Bash completion for `rosa` in an existing terminal on a Linux machine: + [source,terminal] ---- @@ -204,7 +204,7 @@ E: OpenShift command-line tool is not installed. Run 'rosa download oc' to download the latest version, then add it to your PATH. ---- -. Install the OpenShift CLI (`oc`) from the `rosa` CLI. +. Install the OpenShift CLI (`oc`) from the ROSA CLI. .. Enter this command to download the latest version of the `oc` CLI: + [source,terminal] diff --git a/modules/rosa-logs.adoc b/modules/rosa-logs.adoc index 7d85069e45..57cd4e932a 100644 --- a/modules/rosa-logs.adoc +++ b/modules/rosa-logs.adoc @@ -4,10 +4,9 @@ // * * rosa_cli/rosa-checking-logs-cli.adoc [id="rosa-logs_{context}"] -= Checking logs with the rosa CLI += Checking logs with the ROSA CLI - -Use the following commands to check your install and uninstall logs. +You can check logs with the {product-title} (ROSA) CLI, `rosa`. Use the following commands to check your install and uninstall logs. [id="rosa-logs-install_{context}"] == logs install diff --git a/modules/rosa-modifying-node-tuning.adoc b/modules/rosa-modifying-node-tuning.adoc index 17a51dfaa3..e650ffeb04 100644 --- a/modules/rosa-modifying-node-tuning.adoc +++ b/modules/rosa-modifying-node-tuning.adoc @@ -6,7 +6,7 @@ [id="rosa-modifying-node-tuning_{context}"] = Modifying your node tuning configurations for {hcp-title} -You can can view and update the node tuning configurations using the ROSA CLI. +You can view and update the node tuning configurations using the {product-title} (ROSA) CLI, `rosa`. .Prerequisites diff --git a/modules/rosa-nodes-machine-pools-local-zones.adoc b/modules/rosa-nodes-machine-pools-local-zones.adoc index 9ab5103237..d42b801306 100644 --- a/modules/rosa-nodes-machine-pools-local-zones.adoc +++ b/modules/rosa-nodes-machine-pools-local-zones.adoc @@ -15,7 +15,7 @@ AWS Local Zones are supported on Red Hat OpenShift Service on AWS 4.12. See the ==== .Prerequisites -* ROSA is generally available in the parent region of choice. See the link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/locations/?pg=ln&cp=bn#GA[AWS generally available locations list] to determine the Local Zone available to specific AWS regions. +* {product-title} (ROSA) is generally available in the parent region of choice. See the link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/locations/?pg=ln&cp=bn#GA[AWS generally available locations list] to determine the Local Zone available to specific AWS regions. * The ROSA cluster was initially built in an existing Amazon VPC (BYO-VPC). * The maximum transmission unit (MTU) for the ROSA cluster is set at 1200. + @@ -37,14 +37,14 @@ The network plugin could provide additional features that may also decrease the .Procedure -. Create a machine pool on the cluster by running the following ROSA CLI command. +. Create a machine pool on the cluster by running the following ROSA CLI (`rosa`) command. + [source,terminal] ---- $ rosa create machinepool -c -i ---- + -. Add the subnet and instance type for the machine pool in ROSA CLI. After several minutes, the cluster will provision the nodes. +. Add the subnet and instance type for the machine pool in the ROSA CLI. After several minutes, the cluster will provision the nodes. + [source, terminal] ---- diff --git a/modules/rosa-oidc-config-overview.adoc b/modules/rosa-oidc-config-overview.adoc index 9c5f2965b8..b812f4c482 100644 --- a/modules/rosa-oidc-config-overview.adoc +++ b/modules/rosa-oidc-config-overview.adoc @@ -6,4 +6,4 @@ [id="rosa-byo-odic-overview_{context}"] = Creating an OpenID Connect Configuration -When using a cluster hosted by Red Hat, you can create a managed or unmanaged OpenID Connect (OIDC) configuration by using the ROSA CLI. A managed OIDC configuration is stored within Red Hat's AWS account, while a generated unmanaged OIDC configuration is stored within your AWS account. The OIDC configuration is registered to be used with {cluster-manager}. When creating an unmanaged OIDC configuration, the CLI provides the private key for you. \ No newline at end of file +When using a cluster hosted by Red Hat, you can create a managed or unmanaged OpenID Connect (OIDC) configuration by using the {product-title} (ROSA) CLI, `rosa`. A managed OIDC configuration is stored within Red Hat's AWS account, while a generated unmanaged OIDC configuration is stored within your AWS account. The OIDC configuration is registered to be used with {cluster-manager}. When creating an unmanaged OIDC configuration, the CLI provides the private key for you. \ No newline at end of file diff --git a/modules/rosa-oidc-understanding.adoc b/modules/rosa-oidc-understanding.adoc index d1c39e4a44..a88d941707 100644 --- a/modules/rosa-oidc-understanding.adoc +++ b/modules/rosa-oidc-understanding.adoc @@ -19,7 +19,7 @@ You create a registered, managed OIDC configuration before you start creating yo * Registered, unmanaged OIDC configuration + -You can create a registered, unmanaged OIDC configuration before you start creating your clusters. This configuration is hosted under your AWS account. When you use this option, you are responsible for managing the private key. You can register the configuration with {cluster-manager-first} by storing the private key in an AWS secrets file by using the AWS Secrets Manager (SM) service and the issuer URL which hosts the configuration. You can use the ROSA CLI to create a registered, unmanaged OIDC configuration with the `rosa create oidc-config --managed=false` command. This command creates and hosts the configuration under your account and creates the necessary files and private secret key. This command also registers the configuration with {cluster-manager}. +You can create a registered, unmanaged OIDC configuration before you start creating your clusters. This configuration is hosted under your AWS account. When you use this option, you are responsible for managing the private key. You can register the configuration with {cluster-manager-first} by storing the private key in an AWS secrets file by using the AWS Secrets Manager (SM) service and the issuer URL which hosts the configuration. You can use the {product-title} (ROSA) CLI, `rosa`, to create a registered, unmanaged OIDC configuration with the `rosa create oidc-config --managed=false` command. This command creates and hosts the configuration under your account and creates the necessary files and private secret key. This command also registers the configuration with {cluster-manager}. The registered options can be used to create the required IAM resources before you start creating a cluster. This option results in faster install times since there is a waiting period during cluster creation where the installation pauses until you create an OIDC provider and Operator roles. diff --git a/modules/rosa-operator-config.adoc b/modules/rosa-operator-config.adoc index 5b9d0d59c0..b570549fc5 100644 --- a/modules/rosa-operator-config.adoc +++ b/modules/rosa-operator-config.adoc @@ -11,7 +11,7 @@ When using a {hcp-title} cluster, you must create the Operator IAM roles that ar .Prerequisites * You have completed the AWS prerequisites for {hcp-title}. -* You have installed and configured the latest ROSA CLI (`rosa`) on your installation host. +* You have installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your installation host. * You created the account-wide AWS roles. .Procedure diff --git a/modules/rosa-parent-commands.adoc b/modules/rosa-parent-commands.adoc index b4f280acc7..242e3aadcf 100644 --- a/modules/rosa-parent-commands.adoc +++ b/modules/rosa-parent-commands.adoc @@ -7,7 +7,7 @@ = Parent commands -The `rosa` CLI uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands. +The {product-title} (ROSA) CLI, `rosa`, uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands. [id="rosa-create_{context}"] == create diff --git a/modules/rosa-policy-shared-responsibility.adoc b/modules/rosa-policy-shared-responsibility.adoc index 5f16562bd3..b1d7b22948 100644 --- a/modules/rosa-policy-shared-responsibility.adoc +++ b/modules/rosa-policy-shared-responsibility.adoc @@ -7,7 +7,7 @@ = Tasks for shared responsibilities by area -Red Hat, AWS, and the customer all share responsibility for the monitoring, maintenance, and overall health of a {product-title} cluster. This documentation illustrates the delineation of responsibilities for each of the listed resources as shown in the tables below. +Red Hat, AWS, and the customer all share responsibility for the monitoring, maintenance, and overall health of a {product-title} (ROSA) cluster. This documentation illustrates the delineation of responsibilities for each of the listed resources as shown in the tables below. [id="rosa-policy-incident-operations-management_{context}"] == Incident and operations management @@ -141,7 +141,7 @@ manage AWS VPN connectivity with on-premises resources, Amazon VPC-to-VPC connec - Monitor and manage the deployment of Amazon EC2 control plane and infrastructure nodes on the cluster. |- Monitor and manage Amazon EC2 worker nodes by creating a -machine pool using the OpenShift Cluster Manager or ROSA CLI. +machine pool using the OpenShift Cluster Manager or the ROSA CLI (`rosa`). - Manage changes to customer-deployed applications and application data. |Cluster version diff --git a/modules/rosa-scaling-worker-nodes.adoc b/modules/rosa-scaling-worker-nodes.adoc index 2d7a4fc8c8..a741ffc0a0 100644 --- a/modules/rosa-scaling-worker-nodes.adoc +++ b/modules/rosa-scaling-worker-nodes.adoc @@ -15,8 +15,8 @@ You must scale each machine pool separately. .Prerequisites ifdef::openshift-rosa[] -* You installed and configured the latest AWS (`aws`), ROSA (`rosa`), and OpenShift (`oc`) CLIs on your workstation. -* You logged in to your Red Hat account by using the `rosa` CLI. +* You installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your workstation. +* You logged in to your Red Hat account using the ROSA CLI (`rosa`). * You created a {product-title} (ROSA) cluster. endif::openshift-rosa[] ifndef::openshift-rosa[] diff --git a/modules/rosa-sdpolicy-am-cluster-self-service.adoc b/modules/rosa-sdpolicy-am-cluster-self-service.adoc index 4d8c36628a..635e2ed8a4 100644 --- a/modules/rosa-sdpolicy-am-cluster-self-service.adoc +++ b/modules/rosa-sdpolicy-am-cluster-self-service.adoc @@ -16,4 +16,4 @@ Customers can self-service their clusters, including, but not limited to: * Add or remove machine pools and configure autoscaling * Define upgrade policies -These tasks can be self-serviced using the `rosa` CLI utility. \ No newline at end of file +You can perform these self-service tasks using the {product-title} (ROSA) CLI, `rosa`. \ No newline at end of file diff --git a/modules/rosa-sdpolicy-platform.adoc b/modules/rosa-sdpolicy-platform.adoc index d9929ff10f..e239760549 100644 --- a/modules/rosa-sdpolicy-platform.adoc +++ b/modules/rosa-sdpolicy-platform.adoc @@ -87,7 +87,7 @@ Custom node labels are created by Red Hat during node creation and cannot be cha [id="rosa-sdpolicy-upgrades_{context}"] == Upgrades -Upgrades can be scheduled using the `rosa` CLI utility or through {cluster-manager}. +Upgrades can be scheduled using the {product-title} (ROSA) CLI, `rosa`, or through {cluster-manager}. See the link:https://docs.openshift.com/rosa/rosa_policy/rosa-life-cycle.html[{product-title} Life Cycle] for more information on the upgrade policy and procedures. diff --git a/modules/rosa-sdpolicy-security.adoc b/modules/rosa-sdpolicy-security.adoc index fca659886d..1bc29e5a2c 100644 --- a/modules/rosa-sdpolicy-security.adoc +++ b/modules/rosa-sdpolicy-security.adoc @@ -9,7 +9,7 @@ This section provides information about the service definition for {product-titl [id="rosa-sdpolicy-auth-provider_{context}"] == Authentication provider -Authentication for the cluster can be configured using either {cluster-manager-url} or cluster creation process or using the `rosa` CLI. {product-title} is not an identity provider, and all access to the cluster must be managed by the customer as part of their integrated solution. The use of multiple identity providers provisioned at the same time is supported. The following identity providers are supported: +Authentication for the cluster can be configured using either {cluster-manager-url} or cluster creation process or using the {product-title} (ROSA) CLI, `rosa`. ROSA is not an identity provider, and all access to the cluster must be managed by the customer as part of their integrated solution. The use of multiple identity providers provisioned at the same time is supported. The following identity providers are supported: - GitHub or GitHub Enterprise - GitLab diff --git a/modules/rosa-setting-up-cli.adoc b/modules/rosa-setting-up-cli.adoc index aa8ca68165..640d72e617 100644 --- a/modules/rosa-setting-up-cli.adoc +++ b/modules/rosa-setting-up-cli.adoc @@ -6,13 +6,13 @@ :_content-type: PROCEDURE [id="rosa-setting-up-cli_{context}"] -= Setting up the rosa CLI += Setting up the ROSA CLI -Use the following steps to install and configure the {product-title} (ROSA) CLI (`rosa`) on your installation host. +Use the following steps to install and configure the {product-title} (ROSA) CLI, `rosa`, on your installation host. .Procedure -. Download the latest version of the `rosa` CLI for your operating system from the link:https://console.redhat.com/openshift/downloads[*Downloads*] page on {cluster-manager}. +. Download the latest version of the ROSA CLI (`rosa`) for your operating system from the link:https://console.redhat.com/openshift/downloads[*Downloads*] page on {cluster-manager}. . Extract the `rosa` binary file from the downloaded archive. The following example extracts the binary from a Linux tar archive: + @@ -28,7 +28,7 @@ $ tar xvf rosa-linux.tar.gz $ sudo mv rosa /usr/local/bin/rosa ---- -. Verify if the `rosa` CLI tool is installed correctly by querying the `rosa` version: +. Verify if the ROSA CLI is installed correctly by querying the `rosa` version: + [source,terminal] ---- @@ -42,7 +42,7 @@ $ rosa version Your ROSA CLI is up to date. ---- -. Optional: Enable tab completion for the `rosa` CLI. With tab completion enabled, you can press the `Tab` key twice to automatically complete subcommands and receive command suggestions: +. Optional: Enable tab completion for the ROSA CLI. With tab completion enabled, you can press the `Tab` key twice to automatically complete subcommands and receive command suggestions: + -- ** To enable persistent tab completion for Bash on a Linux host: @@ -101,5 +101,5 @@ PS> rosa completion powershell | Out-String | Invoke-Expression + [NOTE] ==== -For more information about configuring `rosa` tab completion, see the help menu by running `rosa completion --help`. +For more information about configuring `rosa` tab completion, see the help menu by running the `rosa completion --help` command. ==== diff --git a/modules/rosa-sts-about-ocm-role.adoc b/modules/rosa-sts-about-ocm-role.adoc index eabb1237c2..e946f8c2d9 100644 --- a/modules/rosa-sts-about-ocm-role.adoc +++ b/modules/rosa-sts-about-ocm-role.adoc @@ -5,7 +5,7 @@ [id="rosa-sts-about-ocm-role_{context}"] = About the ocm-role IAM resource -You must create the `ocm-role` IAM resource to enable a Red Hat organization of users to create ROSA clusters. Within the context of linking to AWS, a Red Hat organization is a single user within {cluster-manager}. +You must create the `ocm-role` IAM resource to enable a Red Hat organization of users to create {product-title} (ROSA) clusters. Within the context of linking to AWS, a Red Hat organization is a single user within {cluster-manager}. Some considerations for your `ocm-role` IAM resource are: @@ -20,7 +20,7 @@ If you just created a Red Hat account that is not part of an existing organizati + * See "Understanding the {cluster-manager} role" in the Additional resources of this section for a list of the AWS permissions policies for the basic and admin `ocm-role` IAM resources. -Using the `rosa` CLI, you can link your IAM resource when you create it. +Using the ROSA CLI (`rosa`), you can link your IAM resource when you create it. [NOTE] ==== diff --git a/modules/rosa-sts-account-wide-role-and-policy-commands.adoc b/modules/rosa-sts-account-wide-role-and-policy-commands.adoc index 2e3ed6cd1b..1194e4f7b4 100644 --- a/modules/rosa-sts-account-wide-role-and-policy-commands.adoc +++ b/modules/rosa-sts-account-wide-role-and-policy-commands.adoc @@ -96,7 +96,7 @@ aws iam create-policy \ [id="rosa-sts-account-wide-role-and-policy-aws-cli-auto-mode_{context}"] == Using auto mode for role creation -When you add the `--mode auto` argument, the `rosa` CLI tool creates your roles and policies. The following command starts that process: +When you add the `--mode auto` argument, the {product-title} (ROSA) CLI, `rosa`, creates your roles and policies. The following command starts that process: [source,terminal] ---- diff --git a/modules/rosa-sts-account-wide-roles-and-policies.adoc b/modules/rosa-sts-account-wide-roles-and-policies.adoc index f1727adb4f..29f4ece721 100644 --- a/modules/rosa-sts-account-wide-roles-and-policies.adoc +++ b/modules/rosa-sts-account-wide-roles-and-policies.adoc @@ -14,9 +14,9 @@ The account-wide roles and policies are specific to an OpenShift minor release v [id="rosa-sts-account-wide-roles-and-policies-creation-methods_{context}"] == Methods of account-wide role creation -You can create account-wide roles by using the `rosa` CLI tool or the {cluster-manager-url} guided installation. You can create the roles manually or by using an automatic process that uses pre-defined names for these roles and polices. +You can create account-wide roles by using the {product-title} (ROSA) CLI, `rosa`, or the {cluster-manager-url} guided installation. You can create the roles manually or by using an automatic process that uses pre-defined names for these roles and polices. -You can create account-wide roles by using the `rosa` CLI tool. You can create the roles manually or by using an automatic process that uses pre-defined names for these roles and polices. +You can create account-wide roles by using the ROSA CLI (`rosa`). You can create the roles manually or by using an automatic process that uses pre-defined names for these roles and polices. [discrete] [id="rosa-sts-account-wide-roles-and-policies-creation-methods-manual_{context}"] @@ -28,7 +28,7 @@ You can use the manual creation method if you have the necessary CLI access to c [id="rosa-sts-account-wide-roles-and-policies-creation-methods-auto_{context}"] === Automatic ocm-role resource creation -If you created an `ocm-role` resource with administrative permissions, you can use the automatic creation method from {cluster-manager}. The `rosa` CLI does not require that you have this admin `ocm-role` IAM resource to automatically create these roles and polices. Selecting this method creates the roles and policies that uses the default names. +If you created an `ocm-role` resource with administrative permissions, you can use the automatic creation method from {cluster-manager}. The ROSA CLI does not require that you have this admin `ocm-role` IAM resource to automatically create these roles and polices. Selecting this method creates the roles and policies that uses the default names. If you use the ROSA guided installation on {cluster-manager}, you must have created an `ocm-role` resource with administrative permissions in the first step of the guided cluster installation. Without this role, you cannot use the automatic Operator role and policy creation option, but you can still create the cluster and its roles and policies with the manual process. diff --git a/modules/rosa-sts-associating-your-aws-account.adoc b/modules/rosa-sts-associating-your-aws-account.adoc index 23d6898812..7afb051fb7 100644 --- a/modules/rosa-sts-associating-your-aws-account.adoc +++ b/modules/rosa-sts-associating-your-aws-account.adoc @@ -53,7 +53,7 @@ ROSA endif::rosa-hcp[] clusters, use the latest version of the ROSA CLI. ==== -* You have logged in to your Red Hat account by using the `rosa` CLI. +* You have logged in to your Red Hat account by using the ROSA CLI. * You have organization administrator privileges in your Red Hat organization. endif::[] diff --git a/modules/rosa-sts-aws-requirements-access-req.adoc b/modules/rosa-sts-aws-requirements-access-req.adoc index 79a5c5684c..85544c1025 100644 --- a/modules/rosa-sts-aws-requirements-access-req.adoc +++ b/modules/rosa-sts-aws-requirements-access-req.adoc @@ -6,6 +6,6 @@ = Access requirements * Red Hat must have AWS console access to the customer-provided AWS account. Red Hat protects and manages this access. -* You must not use the AWS account to elevate your permissions within the {product-title} cluster. -* Actions available in the `rosa` CLI utility or {cluster-manager-url} console must not be directly performed in your AWS account. +* You must not use the AWS account to elevate your permissions within the {product-title} (ROSA) cluster. +* Actions available in the ROSA CLI (`rosa`) or {cluster-manager-url} console must not be directly performed in your AWS account. * You do not need to have a preconfigured domain to deploy ROSA clusters. If you wish to use a custom domain, see the Additional resources for information. diff --git a/modules/rosa-sts-aws-requirements-account.adoc b/modules/rosa-sts-aws-requirements-account.adoc index 090677970a..7b7185ec21 100644 --- a/modules/rosa-sts-aws-requirements-account.adoc +++ b/modules/rosa-sts-aws-requirements-account.adoc @@ -4,7 +4,7 @@ :_content-type: CONCEPT [id="rosa-account_{context}"] = Account -* You must ensure that the AWS limits are sufficient to support {product-title} provisioned within your AWS account. Running `rosa verify quota` in the CLI validates that you have the required quota to run a cluster. +* You must ensure that the AWS limits are sufficient to support {product-title} provisioned within your AWS account. Running the `rosa verify quota` command in the CLI validates that you have the required quota to run a cluster. + [NOTE] ==== diff --git a/modules/rosa-sts-aws-requirements-creating-association.adoc b/modules/rosa-sts-aws-requirements-creating-association.adoc index f280d40137..b17f9b6ed5 100644 --- a/modules/rosa-sts-aws-requirements-creating-association.adoc +++ b/modules/rosa-sts-aws-requirements-creating-association.adoc @@ -7,7 +7,7 @@ [id="rosa-associating-account_{context}"] = Linking your AWS account -You can link your AWS account to existing IAM roles by using the `rosa` CLI. +You can link your AWS account to existing IAM roles by using the {product-title} (ROSA) CLI, `rosa`. .Prerequisites diff --git a/modules/rosa-sts-creating-a-cluster-quickly-cli.adoc b/modules/rosa-sts-creating-a-cluster-quickly-cli.adoc index 316d6b6740..80ba66cd79 100644 --- a/modules/rosa-sts-creating-a-cluster-quickly-cli.adoc +++ b/modules/rosa-sts-creating-a-cluster-quickly-cli.adoc @@ -13,7 +13,7 @@ ifeval::["{context}" == "rosa-quickstart"] :quickstart: endif::[] -When using the {product-title} (ROSA) CLI (`rosa`) to create a cluster that uses the AWS Security Token Service (STS), you can select the default options to create the cluster quickly. +When using the {product-title} (ROSA) CLI, `rosa`, to create a cluster that uses the AWS Security Token Service (STS), you can select the default options to create the cluster quickly. ifndef::quickstart[] .Prerequisites @@ -27,7 +27,7 @@ ifndef::quickstart[] ==== To successfully install ROSA clusters, use the latest version of the ROSA CLI. ==== -* You have logged in to your Red Hat account by using the `rosa` CLI. +* You have logged in to your Red Hat account by using the ROSA CLI. * You have verified that the AWS Elastic Load Balancing (ELB) service role exists in your AWS account. endif::[] diff --git a/modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc b/modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc index c77c7f7c9c..d9da6b6a50 100644 --- a/modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc +++ b/modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc @@ -8,7 +8,7 @@ When you create a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS), you can customize your installation interactively. -When you run `rosa create cluster --interactive` at cluster creation time, you are presented with a series of interactive prompts that enable you to customize your deployment. For more information, see _Interactive cluster creation mode reference_. +When you run the `rosa create cluster --interactive` command at cluster creation time, you are presented with a series of interactive prompts that enable you to customize your deployment. For more information, see _Interactive cluster creation mode reference_. After a cluster installation using the interactive mode completes, a single command is provided in the output that enables you to deploy further clusters using the same custom configuration. @@ -27,7 +27,7 @@ link:https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html[AWS Share * You have completed the AWS prerequisites for ROSA with STS. * You have available AWS service quotas. * You have enabled the ROSA service in the AWS Console. -* You have installed and configured the latest ROSA (`rosa`) and AWS (`aws`) CLIs on your installation host. +* You have installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your installation host. + [NOTE] ==== @@ -281,7 +281,7 @@ By enabling etcd encryption for the key values in etcd, you will incur a perform <7> The output includes a custom command that you can run to create a cluster with the same configuration in the future. -- + -As an alternative to using the `--interactive` mode, you can specify the customization options directly when you run `rosa create cluster`. Run `rosa create cluster --help` to view a list of available CLI options, or see _create cluster_ in _Managing objects with the ROSA CLI_. +As an alternative to using the `--interactive` mode, you can specify the customization options directly when you run the `rosa create cluster` command. Run the `rosa create cluster --help` command to view a list of available CLI options, or see _create cluster_ in _Managing objects with the ROSA CLI_. + [IMPORTANT] diff --git a/modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc b/modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc index 3f840439f4..d28a0cf5e7 100644 --- a/modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc +++ b/modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc @@ -92,7 +92,7 @@ I: Successfully linked role-arn 'arn:aws:iam:::role/ManagedOpenS <2> Enable the admin {cluster-manager} IAM role, which is equivalent to specifying the `--admin` argument. The admin role is required if you want to use *Auto* mode to automatically provision the cluster-specific Operator roles and the OIDC provider by using {cluster-manager}. <3> Optional: Specify a permissions boundary Amazon Resource Name (ARN) for the role. For more information, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html[Permissions boundaries for IAM entities] in the AWS documentation. <4> Specify a custom ARN path for your OCM role. The path must contain alphanumeric characters only and start and end with `/`, for example `/test/path/dev/`. For more information, see _ARN path customization for IAM roles and policies_. -<5> Select the role creation mode. You can use `auto` mode to automatically create the {cluster-manager} IAM role and link it to your Red Hat organization account. In `manual` mode, the `rosa` CLI generates the `aws` commands needed to create and link the role. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. +<5> Select the role creation mode. You can use `auto` mode to automatically create the {cluster-manager} IAM role and link it to your Red Hat organization account. In `manual` mode, the ROSA CLI generates the `aws` commands needed to create and link the role. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. <6> Link the {cluster-manager} IAM role to your Red Hat organization account. .. If you opted not to link the {cluster-manager} IAM role to your Red Hat organization account in the preceding command, copy the `rosa link` command from the {cluster-manager} *OCM role* page and run it: + @@ -130,7 +130,7 @@ I: Successfully linked role ARN 'arn:aws:iam:::role/ManagedOpenS <1> Specify the prefix to include in the user role name. The default is `ManagedOpenShift`. <2> Optional: Specify a permissions boundary Amazon Resource Name (ARN) for the role. For more information, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html[Permissions boundaries for IAM entities] in the AWS documentation. <3> Specify a custom ARN path for your user role. The path must contain alphanumeric characters only and start and end with `/`, for example `/test/path/dev/`. For more information, see _ARN path customization for IAM roles and policies_. -<4> Select the role creation mode. You can use `auto` mode to automatically create the user role and link it to your {cluster-manager} user account. In `manual` mode, the `rosa` CLI generates the `aws` commands needed to create and link the role. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. +<4> Select the role creation mode. You can use `auto` mode to automatically create the user role and link it to your {cluster-manager} user account. In `manual` mode, the ROSA CLI generates the `aws` commands needed to create and link the role. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. <5> Link the user role to your {cluster-manager} user account. .. If you opted not to link the user role to your {cluster-manager} user account in the preceding command, copy the `rosa link` command from the {cluster-manager} *User role* page and run it: + @@ -185,7 +185,7 @@ You must specify an account-wide role prefix that is unique across your AWS acco + <2> Optional: Specify a permissions boundary Amazon Resource Name (ARN) for the role. For more information, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html[Permissions boundaries for IAM entities] in the AWS documentation. <3> Specify a custom ARN path for your account-wide roles. The path must contain alphanumeric characters only and start and end with `/`, for example `/test/path/dev/`. For more information, see _ARN path customization for IAM roles and policies_. -<4> Select the role creation mode. You can use `auto` mode to automatically create the account wide roles and policies. In `manual` mode, the `rosa` CLI generates the `aws` commands needed to create the roles and policies. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. +<4> Select the role creation mode. You can use `auto` mode to automatically create the account wide roles and policies. In `manual` mode, the ROSA CLI generates the `aws` commands needed to create the roles and policies. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. <5> Creates the account-wide installer, control plane, worker and support roles and corresponding IAM policies. For more information, see _Account-wide IAM role and policy reference_. + [NOTE] @@ -339,7 +339,7 @@ CIDR configurations cannot be changed later. Confirm your selections with your n . Under the *Cluster roles and policies* page, select your preferred cluster-specific Operator IAM role and OIDC provider creation mode. + //With *Manual* mode, you can use either AWS CloudFormation, `rosa` CLI commands, or `aws` CLI commands to generate the required Operator roles and OIDC provider for your cluster. *Manual* mode enables you to review the details before using your preferred option to create the IAM resources manually and complete your cluster installation. -With *Manual* mode, you can use either `rosa` CLI commands or `aws` CLI commands to generate the required Operator roles and OIDC provider for your cluster. *Manual* mode enables you to review the details before using your preferred option to create the IAM resources manually and complete your cluster installation. +With *Manual* mode, you can use either the `rosa` CLI commands or the `aws` CLI commands to generate the required Operator roles and OIDC provider for your cluster. *Manual* mode enables you to review the details before using your preferred option to create the IAM resources manually and complete your cluster installation. + Alternatively, you can use *Auto* mode to automatically create the Operator roles and OIDC provider. To enable *Auto* mode, the {cluster-manager} IAM role must have administrator capabilities. + @@ -387,7 +387,7 @@ In the event of critical security concerns that significantly impact the securit + -- //.. In the *Action required to continue installation* dialog, select either the *AWS CloudFormation*, *AWS CLI*, or *ROSA CLI* tab and manually create the resources: -.. In the *Action required to continue installation* dialog, select either the *AWS CLI* or *ROSA CLI* tab and manually create the resources: +.. In the *Action required to continue installation* dialog, select either the *AWS CLI* or the *ROSA CLI* tab and manually create the resources: //** If you opted to use the *AWS CloudFormation* method, click the copy button next to the `aws cloudformation` commands and run them in the CLI. ** If you opted to use the *AWS CLI* method, click *Download .zip*, save the file, and then extract the AWS CLI command and policy files. Then, run the provided `aws` commands in the CLI. + diff --git a/modules/rosa-sts-creating-account-wide-sts-roles-and-policies.adoc b/modules/rosa-sts-creating-account-wide-sts-roles-and-policies.adoc index 03b74c262c..56aa298fe4 100644 --- a/modules/rosa-sts-creating-account-wide-sts-roles-and-policies.adoc +++ b/modules/rosa-sts-creating-account-wide-sts-roles-and-policies.adoc @@ -28,7 +28,7 @@ ifdef::quick-install[] ==== To successfully install ROSA clusters, use the latest version of the ROSA CLI. ==== -* You have logged in to your Red Hat account by using the `rosa` CLI. +* You have logged in to your Red Hat account by using the ROSA CLI. endif::[] .Procedure diff --git a/modules/rosa-sts-interactive-cluster-creation-mode-options.adoc b/modules/rosa-sts-interactive-cluster-creation-mode-options.adoc index 2ec26e127d..ca6b3538da 100644 --- a/modules/rosa-sts-interactive-cluster-creation-mode-options.adoc +++ b/modules/rosa-sts-interactive-cluster-creation-mode-options.adoc @@ -6,7 +6,7 @@ [id="rosa-sts-interactive-cluster-creation-mode-options_{context}"] = Interactive cluster creation mode options -You can create a {product-title} cluster with the AWS Security Token Service (STS) by using the interactive mode. You can enable the mode by specifying the `--interactive` option when you run `rosa create cluster`. +You can create a {product-title} cluster with the AWS Security Token Service (STS) by using the interactive mode. You can enable the mode by specifying the `--interactive` option when you run the `rosa create cluster` command. The following table describes the interactive cluster creation mode options: diff --git a/modules/rosa-sts-interactive-ocm-and-user-role-creation-mode-options.adoc b/modules/rosa-sts-interactive-ocm-and-user-role-creation-mode-options.adoc index eea3068d49..c4caa00ff5 100644 --- a/modules/rosa-sts-interactive-ocm-and-user-role-creation-mode-options.adoc +++ b/modules/rosa-sts-interactive-ocm-and-user-role-creation-mode-options.adoc @@ -6,7 +6,7 @@ [id="rosa-sts-interactive-ocm-and-user-role-creation-mode-options_{context}"] = Interactive OCM and user role creation mode options -Before you can use {cluster-manager-first} to create {product-title} (ROSA) clusters that use the AWS Security Token Service (STS), you must associate your AWS account with your Red Hat organization by creating and linking the OCM and user roles. You can enable interactive mode by specifying the `--interactive` option when you run `rosa create ocm-role` or `rosa create user-role`. +Before you can use {cluster-manager-first} to create {product-title} (ROSA) clusters that use the AWS Security Token Service (STS), you must associate your AWS account with your Red Hat organization by creating and linking the OCM and user roles. You can enable interactive mode by specifying the `--interactive` option when you run the `rosa create ocm-role` command or the `rosa create user-role` command. The following tables describe the interactive OCM role creation mode options: @@ -29,7 +29,7 @@ The following tables describe the interactive OCM role creation mode options: |Specify a custom ARN path for your OCM role. The path must contain alphanumeric characters only and start and end with `/`, for example `/test/path/dev/`. For more information, see _ARN path customization for IAM roles and policies_. |`Role creation mode` -|Select the role creation mode. You can use `auto` mode to automatically create the OCM role and link it to your Red Hat organization account. In `manual` mode, the `rosa` CLI generates the `aws` commands needed to create and link the role. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. +|Select the role creation mode. You can use `auto` mode to automatically create the OCM role and link it to your Red Hat organization account. In `manual` mode, the ROSA CLI (`rosa`) generates the `aws` commands needed to create and link the role. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. |`Create the '' role?` |Confirm if you want to create the OCM role. @@ -57,7 +57,7 @@ The following tables describe the interactive user role creation mode options: |Specify a custom ARN path for your user role. The path must contain alphanumeric characters only and start and end with `/`, for example `/test/path/dev/`. For more information, see _ARN path customization for IAM roles and policies_. |`Role creation mode` -|Selects the role creation mode. You can use `auto` mode to automatically create the user role and link it to your {cluster-manager} user account. In `manual` mode, the `rosa` CLI generates the `aws` commands needed to create and link the role. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. +|Selects the role creation mode. You can use `auto` mode to automatically create the user role and link it to your {cluster-manager} user account. In `manual` mode, the ROSA CLI generates the `aws` commands needed to create and link the role. In `manual` mode, the corresponding policy JSON files are also saved to the current directory. `manual` mode enables you to review the details before running the `aws` commands manually. |`Create the '' role?` |Confirm if you want to create the user role. diff --git a/modules/rosa-sts-ocm-and-user-role-troubleshooting.adoc b/modules/rosa-sts-ocm-and-user-role-troubleshooting.adoc index 951af19b82..ec029367d2 100644 --- a/modules/rosa-sts-ocm-and-user-role-troubleshooting.adoc +++ b/modules/rosa-sts-ocm-and-user-role-troubleshooting.adoc @@ -6,7 +6,7 @@ [id="rosa-sts-ocm-roles-and-permissions-troubleshooting_{context}"] = Resolving issues with ocm-roles and user-role IAM resources -You may receive an error when trying to create a cluster using the `rosa` CLI. +You may receive an error when trying to create a cluster using the {product-title} (ROSA) CLI, `rosa`. .Sample output [source,terminal] diff --git a/modules/rosa-sts-ocm-role-creation.adoc b/modules/rosa-sts-ocm-role-creation.adoc index e5933ea7c8..a8563913c3 100644 --- a/modules/rosa-sts-ocm-role-creation.adoc +++ b/modules/rosa-sts-ocm-role-creation.adoc @@ -13,7 +13,7 @@ You create your `ocm-role` IAM roles by using the command-line interface (CLI). * You have an AWS account. * You have Red Hat Organization Administrator privileges in the {cluster-manager} organization. * You have the permissions required to install AWS account-wide roles. -* You have installed and configured the latest AWS (`aws`) and ROSA (`rosa`) CLIs on your installation host. +* You have installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your installation host. .Procedure * To create an ocm-role IAM role with basic privileges, run the following command: @@ -30,7 +30,7 @@ $ rosa create ocm-role $ rosa create ocm-role --admin ---- + -This command allows you create the role by specifying specific attributes. The following example output shows the "auto mode" selected, which lets the `rosa` CLI to create your Operator roles and policies. See "Methods of account-wide role creation" in the Additional resources for more information. +This command allows you create the role by specifying specific attributes. The following example output shows the "auto mode" selected, which lets the ROSA CLI (`rosa`) create your Operator roles and policies. See "Methods of account-wide role creation" in the Additional resources for more information. .Example output [source,terminal] @@ -57,7 +57,7 @@ You do not see this prompt if you used the `--admin` option. ==== + <3> The Amazon Resource Name (ARN) of the policy to set permission boundaries. -<4> Choose the method of how to create your AWS roles. Using `auto`, the `rosa` CLI tool generates and links the roles and policies. In the `auto` mode, you receive some different prompts to create the AWS roles. +<4> Choose the method of how to create your AWS roles. Using `auto`, the ROSA CLI generates and links the roles and policies. In the `auto` mode, you receive some different prompts to create the AWS roles. <5> The auto method asks if you want to create a specific `ocm-role` using your prefix. <6> Confirm that you want to associate your IAM role with your {cluster-manager}. <7> Links the created role with your AWS organization. diff --git a/modules/rosa-sts-oidc-provider-command.adoc b/modules/rosa-sts-oidc-provider-command.adoc index c13623216c..eaa0ff6e1d 100644 --- a/modules/rosa-sts-oidc-provider-command.adoc +++ b/modules/rosa-sts-oidc-provider-command.adoc @@ -7,7 +7,7 @@ [id="rosa-sts-oidc-provider-for-operators-aws-cli_{context}"] = Creating an OIDC provider using the CLI -You can create an OIDC provider that is hosted in your AWS account with the ROSA CLI. +You can create an OIDC provider that is hosted in your AWS account with the {product-title} (ROSA) CLI, `rosa`. .Prerequisites diff --git a/modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc b/modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc index 42225818b1..ec645db5fe 100644 --- a/modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc +++ b/modules/rosa-sts-overview-of-the-default-cluster-specifications.adoc @@ -44,7 +44,7 @@ endif::rosa-standalone[] ifndef::rosa-hcp[] * Default AWS region for installations using the {cluster-manager-first} {hybrid-console-second}: us-east-1 (US East, North Virginia) endif::rosa-hcp[] -* Default AWS region for installations using the `rosa` CLI: Defined by your `aws` CLI configuration +* Default AWS region for installations using the ROSA CLI (`rosa`): Defined by your `aws` CLI configuration * Availability: Single zone for the data plane * Monitoring for user-defined projects: Enabled diff --git a/modules/rosa-sts-setting-up-environment.adoc b/modules/rosa-sts-setting-up-environment.adoc index 0f234744f1..bb1d9f9889 100644 --- a/modules/rosa-sts-setting-up-environment.adoc +++ b/modules/rosa-sts-setting-up-environment.adoc @@ -40,11 +40,11 @@ You can use the environment variable to set the default AWS region. + The ROSA service evaluates regions in the following priority order: + -... The region specified when running a `rosa` command with the `--region` flag. +... The region specified when running the `rosa` command with the `--region` flag. ... The region set in the `AWS_DEFAULT_REGION` environment variable. See link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html[Environment variables to configure the AWS CLI] in the AWS documentation. ... The default region set in your AWS configuration file. See link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html#cli-configure-quickstart-config[Quick configuration with aws configure] in the AWS documentation. .. Optional: Configure your AWS CLI settings and credentials by using an AWS named profile. `rosa` evaluates AWS named profiles in the following priority order: -... The profile specified when running a `rosa` command with the `--profile` flag. +... The profile specified when running the `rosa` command with the `--profile` flag. ... The profile set in the `AWS_PROFILE` environment variable. See link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html[Named profiles] in the AWS documentation. .. Verify the AWS CLI is installed and configured correctly by running the following command to query the AWS API: + @@ -54,7 +54,7 @@ $ aws sts get-caller-identity ---- + . Install the latest version of the ROSA CLI (`rosa`). -.. Download the link:https://access.redhat.com/products/red-hat-openshift-service-aws/[latest release] of the `rosa` CLI for your operating system. +.. Download the link:https://access.redhat.com/products/red-hat-openshift-service-aws/[latest release] of the ROSA CLI for your operating system. .. Optional: Rename the file you downloaded to `rosa` and make the file executable. This documentation uses `rosa` to refer to the executable file. + [source,terminal] @@ -115,7 +115,7 @@ Flags: Use "rosa [command] --help" for more information about a command. ---- + -.. Generate the command completion scripts for the `rosa` CLI. The following example generates the Bash completion scripts for a Linux machine: +.. Generate the command completion scripts for the ROSA CLI. The following example generates the Bash completion scripts for a Linux machine: + [source,terminal] ---- @@ -128,7 +128,7 @@ $ rosa completion bash | sudo tee /etc/bash_completion.d/rosa $ source /etc/bash_completion.d/rosa ---- -. Log in to your Red Hat account with the `rosa` CLI. +. Log in to your Red Hat account with the ROSA CLI. + .. Enter the following command. + diff --git a/modules/rosa-sts-support-considerations.adoc b/modules/rosa-sts-support-considerations.adoc index b6d6006430..8deaacabe9 100644 --- a/modules/rosa-sts-support-considerations.adoc +++ b/modules/rosa-sts-support-considerations.adoc @@ -6,11 +6,11 @@ [id="rosa-sts-support-considerations_{context}"] = Support considerations for ROSA clusters with STS -The supported way of creating a {product-title} cluster that uses the AWS Security Token Service (STS) is by using the steps described in this product documentation. +The supported way of creating a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS) is by using the steps described in this product documentation. [IMPORTANT] ==== -You can use `manual` mode with the {product-title} CLI (`rosa`) to generate the AWS Identity and Access Management (IAM) policy files and `aws` commands that are required to install the STS resources. +You can use `manual` mode with the ROSA CLI (`rosa`) to generate the AWS Identity and Access Management (IAM) policy files and `aws` commands that are required to install the STS resources. The files and `aws` commands are generated for review purposes only and must not be modified in any way. Red Hat cannot provide support for ROSA clusters that have been deployed by using modified versions of the policy files or `aws` commands. ==== diff --git a/modules/rosa-sts-user-role-creation.adoc b/modules/rosa-sts-user-role-creation.adoc index 25027782b2..bcc54ff9e6 100644 --- a/modules/rosa-sts-user-role-creation.adoc +++ b/modules/rosa-sts-user-role-creation.adoc @@ -11,7 +11,7 @@ You can create your `user-role` IAM roles by using the command-line interface (C .Prerequisites * You have an AWS account. -* You have installed and configured the latest AWS (`aws`) and ROSA (`rosa`) CLIs on your installation host. +* You have installed and configured the latest {product-title} (ROSA) CLI, `rosa`, on your installation host. .Procedure * To create a `user-role` IAM role with basic privileges, run the following command: @@ -21,7 +21,7 @@ You can create your `user-role` IAM roles by using the command-line interface (C $ rosa create user-role ---- + -This command allows you create the role by specifying specific attributes. The following example output shows the "auto mode" selected, which lets the `rosa` CLI to create your Operator roles and policies. See "Understanding the auto and manual deployment modes" in the Additional resources for more information. +This command allows you create the role by specifying specific attributes. The following example output shows the "auto mode" selected, which lets the ROSA CLI (`rosa`) to create your Operator roles and policies. See "Understanding the auto and manual deployment modes" in the Additional resources for more information. .Example output [source,terminal] @@ -40,6 +40,6 @@ I: Successfully linked role ARN 'arn:aws:iam::2066:role/ManagedOpenShift-User.os ---- <1> A prefix value for all of the created AWS resources. In this example, `ManagedOpenShift` prepends all of the AWS resources. <2> The Amazon Resource Name (ARN) of the policy to set permission boundaries. -<3> Choose the method of how to create your AWS roles. Using `auto`, the `rosa` CLI tool generates and links the role to your AWS account. In the `auto` mode, you receive some different prompts to create the AWS roles. +<3> Choose the method of how to create your AWS roles. Using `auto`, the ROSA CLI generates and links the role to your AWS account. In the `auto` mode, you receive some different prompts to create the AWS roles. <4> The auto method asks if you want to create a specific `user-role` using your prefix. <5> Links the created role with your AWS organization. diff --git a/modules/rosa-troubleshooting-expired-token.adoc b/modules/rosa-troubleshooting-expired-token.adoc index 771a69e914..d0bf91b2ac 100644 --- a/modules/rosa-troubleshooting-expired-token.adoc +++ b/modules/rosa-troubleshooting-expired-token.adoc @@ -8,7 +8,7 @@ [id="rosa-troubleshooting-expired-offline-access-tokens_{context}"] = Troubleshooting expired offline access tokens -If you use the `rosa` CLI and your api.openshift.com offline access token expires, an error message appears. This happens when sso.redhat.com invalidates the token. +If you use the {product-title} (ROSA) CLI, `rosa`, and your api.openshift.com offline access token expires, an error message appears. This happens when sso.redhat.com invalidates the token. .Example output [source,terminal] diff --git a/modules/rosa-understanding-deployment-modes.adoc b/modules/rosa-understanding-deployment-modes.adoc index fff5eb551d..ddf71c7717 100644 --- a/modules/rosa-understanding-deployment-modes.adoc +++ b/modules/rosa-understanding-deployment-modes.adoc @@ -6,9 +6,9 @@ [id="rosa-understanding-deployment-modes_{context}"] = Understanding the auto and manual deployment modes -When installing a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS), you can choose between the `auto` and `manual` ROSA CLI (`rosa`) modes to create the required AWS Identity and Access Management (IAM) resources. +When installing a {product-title} (ROSA) cluster that uses the AWS Security Token Service (STS), you can choose between the `auto` and `manual` modes to create the required AWS Identity and Access Management (IAM) resources. -`auto` mode:: With this mode, `rosa` immediately creates the required IAM roles and policies, and an OpenID Connect (OIDC) provider in your AWS account. +`auto` mode:: With this mode, the ROSA CLI (`rosa`) immediately creates the required IAM roles and policies, and an OpenID Connect (OIDC) provider in your AWS account. `manual` mode:: With this mode, `rosa` outputs the `aws` commands needed to create the IAM resources. The corresponding policy JSON files are also saved to the current directory. By using `manual` mode, you can review the generated `aws` commands before running them manually. `manual` mode also enables you to pass the commands to another administrator or group in your organization so that they can create the resources. diff --git a/modules/rosa-unlinking-and-deleting-ocm-and-user-iam-roles.adoc b/modules/rosa-unlinking-and-deleting-ocm-and-user-iam-roles.adoc index 487138a9d5..20195d43a9 100644 --- a/modules/rosa-unlinking-and-deleting-ocm-and-user-iam-roles.adoc +++ b/modules/rosa-unlinking-and-deleting-ocm-and-user-iam-roles.adoc @@ -69,7 +69,7 @@ I: Deleting OCM role ? OCM role deletion mode: auto <1> I: Successfully deleted the OCM role ---- -<1> Specifies the deletion mode. You can use `auto` mode to automatically delete the {cluster-manager} IAM role and policies. In `manual` mode, the `rosa` CLI generates the `aws` commands needed to delete the role and policies. `manual` mode enables you to review the details before running the `aws` commands manually. +<1> Specifies the deletion mode. You can use `auto` mode to automatically delete the {cluster-manager} IAM role and policies. In `manual` mode, the ROSA CLI generates the `aws` commands needed to delete the role and policies. `manual` mode enables you to review the details before running the `aws` commands manually. . Unlink the user IAM role from your Red Hat organization and delete the role: .. List the user IAM roles in your AWS account: @@ -119,4 +119,4 @@ I: Deleting user role ? User role deletion mode: auto <1> I: Successfully deleted the user role ---- -<1> Specifies the deletion mode. You can use `auto` mode to automatically delete the user IAM role. In `manual` mode, the `rosa` CLI generates the `aws` command needed to delete the role. `manual` mode enables you to review the details before running the `aws` command manually. +<1> Specifies the deletion mode. You can use `auto` mode to automatically delete the user IAM role. In `manual` mode, the ROSA CLI generates the `aws` command needed to delete the role. `manual` mode enables you to review the details before running the `aws` command manually. diff --git a/modules/rosa-update-cli-tool.adoc b/modules/rosa-update-cli-tool.adoc index f22514341d..be7a00b163 100644 --- a/modules/rosa-update-cli-tool.adoc +++ b/modules/rosa-update-cli-tool.adoc @@ -6,7 +6,7 @@ [id="updating_rosa_cli{context}"] == Updating the ROSA CLI tool -To use the latest version of the ROSA CLI tool, download the ROSA CLI tool from the Hybrid Cloud Console. If you already have this tool, the procedure is the same for updates. +To use the latest version of the {product-title} (ROSA) CLI, `rosa`, download the ROSA CLI (`rosa`) from the Hybrid Cloud Console. If you already have this tool, the procedure is the same for updates. .Procedure diff --git a/modules/rosa-updating-rosa-cli.adoc b/modules/rosa-updating-rosa-cli.adoc index e5d0665006..df94710502 100644 --- a/modules/rosa-updating-rosa-cli.adoc +++ b/modules/rosa-updating-rosa-cli.adoc @@ -6,11 +6,11 @@ [id="rosa-updating-the-rosa-cli_{context}"] = Updating the ROSA CLI -Update to the latest compatible version of the {product-title} CLI. +Update to the latest compatible version of the {product-title} (ROSA) CLI, `rosa`. .Procedure -. Confirm that a new version of the ROSA CLI is available: +. Confirm that a new version of the ROSA CLI (`rosa`) is available: + [source,terminal] ---- @@ -40,7 +40,7 @@ This command downloads an archive called `rosa-*.tar.gz` into the current direct $ tar -xzf rosa-linux.tar.gz ---- -. Install the new version of ROSA CLI by moving the extracted file into your path. In the following example, the `/usr/local/bin` directory is included in the path of the user: +. Install the new version of the ROSA CLI by moving the extracted file into your path. In the following example, the `/usr/local/bin` directory is included in the path of the user: + [source,terminal] ---- diff --git a/modules/rosa-upgrading-cli-tutorial.adoc b/modules/rosa-upgrading-cli-tutorial.adoc index 49bc526075..b91c702ede 100644 --- a/modules/rosa-upgrading-cli-tutorial.adoc +++ b/modules/rosa-upgrading-cli-tutorial.adoc @@ -13,13 +13,13 @@ endif::[] :_content-type: PROCEDURE [id="rosa-upgrading-cli_{context}"] -= Upgrading with the rosa CLI += Upgrading with the ROSA CLI -You can upgrade a {product-title} cluster +You can upgrade a {product-title} (ROSA) cluster ifdef::sts[] that uses the AWS Security Token Service (STS) endif::sts[] -manually by using the `rosa` CLI. +manually by using the ROSA CLI (`rosa`). This method schedules the cluster for an immediate upgrade, if a more recent version is available. @@ -67,7 +67,7 @@ endif::rosa-hcp[] + The cluster is scheduled for an immediate upgrade. This action can take an hour or longer, depending on your workload configuration, such as pod disruption budgets. + -You will receive an email when the upgrade is complete. You can also check the status by running `rosa describe cluster` again from the `rosa` CLI or view the status in {cluster-manager} console. +You will receive an email when the upgrade is complete. You can also check the status by running the `rosa describe cluster` command again from the ROSA CLI or view the status in {cluster-manager} console. ifeval::["{context}" == "rosa-upgrading-sts"] :!sts: endif::[] diff --git a/modules/rosa-upgrading-preparing-4-8-to-4-9.adoc b/modules/rosa-upgrading-preparing-4-8-to-4-9.adoc index 80a3abf030..3eb189da30 100644 --- a/modules/rosa-upgrading-preparing-4-8-to-4-9.adoc +++ b/modules/rosa-upgrading-preparing-4-8-to-4-9.adoc @@ -11,7 +11,7 @@ You must meet the following requirements before upgrading a {product-title} (ROS .Prerequisites * You have installed the latest AWS CLI on your installation host. -* You have installed 1.1.10 or later of the ROSA CLI on your installation host. +* You have installed 1.1.10 or later of the ROSA CLI (`rosa`) on your installation host. * You have installed version 4.9 or later of the OpenShift CLI (`oc`) on your workstation(s) as needed. * You have the permissions required to update the AWS account-wide roles and policies. * You have access to the cluster as a user with the `cluster-admin` role. diff --git a/modules/rosa-using-bash-script.adoc b/modules/rosa-using-bash-script.adoc index 2f4978e95c..c3ed86e6f3 100644 --- a/modules/rosa-using-bash-script.adoc +++ b/modules/rosa-using-bash-script.adoc @@ -8,7 +8,7 @@ = Using a Bash script -This is an example workflow of how to use a Bash script with the `rosa` CLI. +This is an example workflow of how to use a Bash script with the {product-title} (ROSA) CLI, `rosa`. .Prerequisites Make sure that AWS credentials are available as one of the following options: diff --git a/modules/running-network-verification-manually-cli.adoc b/modules/running-network-verification-manually-cli.adoc index cbfaa093f2..98fd21a291 100644 --- a/modules/running-network-verification-manually-cli.adoc +++ b/modules/running-network-verification-manually-cli.adoc @@ -36,7 +36,7 @@ I: ✓ Network verification successful + [TIP] ==== -To output the full list of verification tests, you can include the `--debug` argument when you run `rosa verify network`. +To output the full list of verification tests, you can include the `--debug` argument when you run the `rosa verify network` command. ==== + ** Verify the network configuration by specifying the VPC subnets IDs: diff --git a/networking/configuring-cluster-wide-proxy.adoc b/networking/configuring-cluster-wide-proxy.adoc index af78fb7fe5..0d407a7cdd 100644 --- a/networking/configuring-cluster-wide-proxy.adoc +++ b/networking/configuring-cluster-wide-proxy.adoc @@ -86,7 +86,7 @@ include::modules/configuring-a-proxy-after-installation-cli.adoc[leveloffset=+2] [id="removing-cluster-wide-proxy_{context}"] == Removing a cluster-wide proxy -You can remove your cluster-wide proxy by using the `rosa` CLI tool. After removing the cluster, you should also remove any trust bundles that are added to the cluster. +You can remove your cluster-wide proxy by using the ROSA CLI. After removing the cluster, you should also remove any trust bundles that are added to the cluster. include::modules/nw-rosa-proxy-remove-cli.adoc[leveloffset=+2] include::modules/configmap-removing-ca.adoc[leveloffset=+2] diff --git a/rosa_architecture/rosa-sts-about-iam-resources.adoc b/rosa_architecture/rosa-sts-about-iam-resources.adoc index 18f779ab10..b7ac0d6e0b 100644 --- a/rosa_architecture/rosa-sts-about-iam-resources.adoc +++ b/rosa_architecture/rosa-sts-about-iam-resources.adoc @@ -30,7 +30,7 @@ If you create ROSA clusters by using {cluster-manager-url}, you must have the fo [TIP] ==== -If you only use the `rosa` CLI tool, then you do not need to create these IAM roles. +If you only use the ROSA CLI (`rosa`), then you do not need to create these IAM roles. ==== These AWS IAM roles are as follows: diff --git a/rosa_architecture/rosa-understanding.adoc b/rosa_architecture/rosa-understanding.adoc index 5aef75b795..ec1f949cb5 100644 --- a/rosa_architecture/rosa-understanding.adoc +++ b/rosa_architecture/rosa-understanding.adoc @@ -31,9 +31,9 @@ There are two supported credential modes for ROSA clusters. One uses the AWS Sec AWS STS is a global web service that provides short-term credentials for IAM or federated users. ROSA with STS is the recommended credential mode for ROSA clusters. You can use AWS STS with ROSA to allocate temporary, limited-privilege credentials for component-specific IAM roles. The service enables cluster components to make AWS API calls using secure cloud resource management practices. -You can use the `rosa` CLI to create the IAM role, policy, and identity provider resources that are required for ROSA clusters that use STS. +You can use the ROSA CLI (`rosa`) to create the IAM role, policy, and identity provider resources that are required for ROSA clusters that use STS. -AWS STS aligns with principles of least privilege and secure practices in cloud service resource management. The `rosa` CLI manages the STS credentials that are assigned for unique tasks and takes action upon AWS resources as part of OpenShift functionality. One limitation of using STS is that roles must be created for each ROSA cluster. +AWS STS aligns with principles of least privilege and secure practices in cloud service resource management. The ROSA CLI manages the STS credentials that are assigned for unique tasks and takes action upon AWS resources as part of OpenShift functionality. One limitation of using STS is that roles must be created for each ROSA cluster. The STS credential mode is more secure because: diff --git a/rosa_cli/rosa-checking-acct-version-cli.adoc b/rosa_cli/rosa-checking-acct-version-cli.adoc index 7d9cad9d94..1b71668867 100644 --- a/rosa_cli/rosa-checking-acct-version-cli.adoc +++ b/rosa_cli/rosa-checking-acct-version-cli.adoc @@ -1,7 +1,7 @@ :_content-type: ASSEMBLY include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-acct-version-cli"] -= Checking account and version information with the rosa cli += Checking account and version information with the ROSA CLI :context: rosa-checking-acct-version-cli toc::[] diff --git a/rosa_cli/rosa-checking-logs-cli.adoc b/rosa_cli/rosa-checking-logs-cli.adoc index 0938f0cbfc..301ea49857 100644 --- a/rosa_cli/rosa-checking-logs-cli.adoc +++ b/rosa_cli/rosa-checking-logs-cli.adoc @@ -1,7 +1,7 @@ :_content-type: ASSEMBLY include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-checking-logs-cli"] -= Checking logs with the rosa CLI += Checking logs with the ROSA CLI :context: rosa-checking-logs-cli toc::[] diff --git a/rosa_cli/rosa-get-started-cli.adoc b/rosa_cli/rosa-get-started-cli.adoc index f2c833c41d..d7f8d4f679 100644 --- a/rosa_cli/rosa-get-started-cli.adoc +++ b/rosa_cli/rosa-get-started-cli.adoc @@ -1,11 +1,11 @@ :_content-type: ASSEMBLY include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-get-started-cli"] -= Getting started with the rosa CLI += Getting started with the {product-title} (ROSA) CLI, `rosa` :context: rosa-getting-started-cli toc::[] -Setup and basic usage of the `rosa` CLI. +Setup and basic usage of the {product-title} (ROSA) CLI, `rosa`. include::modules/rosa-about.adoc[leveloffset=+1] include::modules/rosa-setting-up-cli.adoc[leveloffset=+1] diff --git a/rosa_cli/rosa-manage-objects-cli.adoc b/rosa_cli/rosa-manage-objects-cli.adoc index 5587fdc0ba..9b0f9cf183 100644 --- a/rosa_cli/rosa-manage-objects-cli.adoc +++ b/rosa_cli/rosa-manage-objects-cli.adoc @@ -1,13 +1,13 @@ :_content-type: ASSEMBLY include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-managing-objects-cli"] -= Managing objects with the rosa CLI += Managing objects with the ROSA CLI :context: rosa-managing-objects-cli toc::[] -Managing objects with the `rosa` CLI, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades. +Managing objects with the {product-title} (ROSA) CLI, `rosa`, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades. include::modules/rosa-common-commands.adoc[leveloffset=+1] include::modules/rosa-parent-commands.adoc[leveloffset=+1] diff --git a/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc b/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc index f570f71f37..740d9cd7af 100644 --- a/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc +++ b/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc @@ -18,7 +18,7 @@ include::modules/creating-a-machine-pool-cli.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* For a detailed list of the arguments that are available for the `rosa create machinepool` subcommand, see xref:../../rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-machinepool_rosa-managing-objects-cli[Managing objects with the rosa CLI]. +* For a detailed list of the arguments that are available for the `rosa create machinepool` subcommand, see xref:../../rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-machinepool_rosa-managing-objects-cli[Managing objects with the ROSA CLI]. include::modules/deleting-machine-pools.adoc[leveloffset=+1] include::modules/deleting-machine-pools-ocm.adoc[leveloffset=+2] diff --git a/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc b/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc index 6b8b6a8aef..6b8d2b78d8 100644 --- a/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc +++ b/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc @@ -75,5 +75,5 @@ endif::[] * xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc#rosa-nodes-machinepools-about[About machinepools] ifdef::openshift-rosa[] * xref:../../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing worker nodes] -* xref:../../rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[Managing objects with the rosa CLI] +* xref:../../rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[Managing objects with the ROSA CLI] endif::[] diff --git a/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc b/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc index 0fef6baf9d..65a4a8dfbb 100644 --- a/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc +++ b/rosa_hcp/rosa-hcp-sts-creating-a-cluster-quickly.adoc @@ -11,7 +11,7 @@ toc::[] If you are looking for a quickstart guide for ROSA Classic, see xref:../rosa_getting_started/rosa-quickstart-guide-ui.adoc#rosa-quickstart-guide-ui[{product-title} quickstart guide]. ==== -{hcp-title-first} offers a more efficient and reliable architecture for creating ROSA clusters. With {hcp-title}, each cluster has a dedicated control plane that is isolated in a ROSA service account. +{hcp-title-first} offers a more efficient and reliable architecture for creating {product-title} (ROSA) clusters. With {hcp-title}, each cluster has a dedicated control plane that is isolated in a ROSA service account. :FeatureName: {hcp-title-first} include::snippets/technology-preview.adoc[] @@ -38,7 +38,7 @@ For a full list of the supported certificates, see the xref:../rosa_architecture [id="hcp-considerations_{context}"] === Considerations regarding auto creation mode -The procedures in this document use the `auto` mode in the ROSA CLI (`rosa`) to immediately create the required IAM resources using the current AWS account. The required resources include the account-wide IAM roles and policies, cluster-specific Operator roles and policies, and OpenID Connect (OIDC) identity provider. +The procedures in this document use the `auto` mode in the ROSA CLI to immediately create the required IAM resources using the current AWS account. The required resources include the account-wide IAM roles and policies, cluster-specific Operator roles and policies, and OpenID Connect (OIDC) identity provider. Alternatively, you can use `manual` mode, which outputs the `aws` commands needed to create the IAM resources instead of deploying them automatically. For steps to deploy a {hcp-title} cluster by using `manual` mode or with customizations, see xref:../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-creating-cluster-using-customizations_rosa-sts-creating-a-cluster-with-customizations[Creating a cluster using customizations]. diff --git a/rosa_install_access_delete_clusters/rosa-sts-accessing-cluster.adoc b/rosa_install_access_delete_clusters/rosa-sts-accessing-cluster.adoc index c28ab0bc24..5d182e26b6 100644 --- a/rosa_install_access_delete_clusters/rosa-sts-accessing-cluster.adoc +++ b/rosa_install_access_delete_clusters/rosa-sts-accessing-cluster.adoc @@ -8,7 +8,7 @@ toc::[] It is recommended that you access your {product-title} (ROSA) cluster using an identity provider (IDP) account. However, the cluster administrator who created the cluster can access it using the quick access procedure. -This document describes how to access a cluster and set up an IDP using the `rosa` CLI. Alternatively, you can create an IDP account using {cluster-manager} console. +This document describes how to access a cluster and set up an IDP using the ROSA CLI (`rosa`). Alternatively, you can create an IDP account using {cluster-manager} console. include::modules/rosa-accessing-your-cluster-quick.adoc[leveloffset=+1] include::modules/rosa-accessing-your-cluster.adoc[leveloffset=+1] diff --git a/rosa_install_access_delete_clusters/rosa-sts-config-identity-providers.adoc b/rosa_install_access_delete_clusters/rosa-sts-config-identity-providers.adoc index 4d85af0404..f8d1f66a88 100644 --- a/rosa_install_access_delete_clusters/rosa-sts-config-identity-providers.adoc +++ b/rosa_install_access_delete_clusters/rosa-sts-config-identity-providers.adoc @@ -8,7 +8,7 @@ toc::[] After your {product-title} (ROSA) cluster is created, you must configure identity providers to determine how users log in to access the cluster. -The following topics describe how to configure an identity provider using {cluster-manager} console. Alternatively, you can use the `rosa` CLI to configure an identity provider and access the cluster. +The following topics describe how to configure an identity provider using {cluster-manager} console. Alternatively, you can use the ROSA CLI (`rosa`) to configure an identity provider and access the cluster. include::modules/understanding-idp.adoc[leveloffset=+1] include::modules/config-github-idp.adoc[leveloffset=+1] diff --git a/rosa_install_access_delete_clusters/rosa-sts-deleting-access-cluster.adoc b/rosa_install_access_delete_clusters/rosa-sts-deleting-access-cluster.adoc index 1bb1391230..9a23b484f7 100644 --- a/rosa_install_access_delete_clusters/rosa-sts-deleting-access-cluster.adoc +++ b/rosa_install_access_delete_clusters/rosa-sts-deleting-access-cluster.adoc @@ -9,8 +9,8 @@ toc::[] An identity provider (IDP) controls access to a {product-title} (ROSA) cluster. To revoke access of a user to a cluster, you must configure that within the IDP that was set up for authentication. [id="rosa-revoke-admin-access"] -== Revoking administrator access using the `rosa` CLI -You can revoke the administrator access of users so that they can access the cluster without administrator privileges. To remove the administrator access for a user, you must revoke the `dedicated-admin` or `cluster-admin` privileges. You can revoke the administrator privileges using the `rosa` command-line utility or using {cluster-manager} console. +== Revoking administrator access using the ROSA CLI +You can revoke the administrator access of users so that they can access the cluster without administrator privileges. To remove the administrator access for a user, you must revoke the `dedicated-admin` or `cluster-admin` privileges. You can revoke the administrator privileges using the {product-title} (ROSA) CLI, `rosa`, or using {cluster-manager} console. include::modules/rosa-delete-dedicated-admins.adoc[leveloffset=+2] diff --git a/rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc b/rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc index 0b7e09c7ff..9b26dcd95f 100644 --- a/rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc +++ b/rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-installing-rosa.adoc @@ -1,12 +1,12 @@ :_content-type: ASSEMBLY [id="rosa-installing-cli"] -= Installing the ROSA CLI += Installing the {product-title} (ROSA) CLI, `rosa` include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-installing-cli toc::[] -After you configure your AWS account, install and configure the ROSA CLI (`rosa`). +After you configure your AWS account, install and configure the {product-title} (ROSA) CLI, `rosa`. include::snippets/rosa-sts.adoc[] diff --git a/rosa_planning/rosa-sts-ocm-role.adoc b/rosa_planning/rosa-sts-ocm-role.adoc index 511a822333..ff87137b56 100644 --- a/rosa_planning/rosa-sts-ocm-role.adoc +++ b/rosa_planning/rosa-sts-ocm-role.adoc @@ -6,7 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] -{product-title} (ROSA) web UI requires that you have specific permissions on your AWS account that create a trust relationship to provide the end-user experience at {cluster-manager-url} and for the `rosa` command line interface (CLI). +{product-title} (ROSA) web UI requires that you have specific permissions on your AWS account that create a trust relationship to provide the end-user experience at {cluster-manager-url} and for the `rosa` command line interface (CLI). This trust relationship is achieved through the creation and association of the `ocm-role` AWS IAM role. This role has a trust policy with the AWS installer that links your Red Hat account to your AWS account. In addition, you also need a `user-role` AWS IAM role for each web UI user, which serves to identify these users. This `user-role` AWS IAM role has no permissions. @@ -15,7 +15,7 @@ The AWS IAM roles required to use {cluster-manager} are: * `ocm-role` * `user-role` -Whether you manage your clusters using the `rosa` CLI or {cluster-manager} web UI, you must create the account-wide roles, known as `account-roles` in the `rosa` CLI, by using the `rosa` CLI. These account roles are necessary for your first cluster, and these roles can be used across multiple clusters. These required account roles are: +Whether you manage your clusters using the ROSA CLI (`rosa`) or {cluster-manager} web UI, you must create the account-wide roles, known as `account-roles` in the ROSA CLI, by using the ROSA CLI. These account roles are necessary for your first cluster, and these roles can be used across multiple clusters. These required account roles are: * `Worker-Role` * `Support-Role` @@ -29,7 +29,7 @@ Role creation does not request your AWS access or secret keys. AWS Security Toke For more information about creating these roles, see xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies[Account-wide IAM role and policy reference]. -Cluster-specific Operator roles, known as `operator-roles` in the `rosa` CLI, obtain the temporary permissions required to carry out cluster operations, such as managing back-end storage, ingress, and registry. These roles are required by the cluster that you create. These required Operator roles are: +Cluster-specific Operator roles, known as `operator-roles` in the ROSA CLI, obtain the temporary permissions required to carry out cluster operations, such as managing back-end storage, ingress, and registry. These roles are required by the cluster that you create. These required Operator roles are: * `--openshift-cluster-csi-drivers-ebs-cloud-credentials` * `--openshift-cloud-network-config-controller-credentials` diff --git a/rosa_release_notes/rosa-release-notes.adoc b/rosa_release_notes/rosa-release-notes.adoc index 24cac10781..ab73428ffa 100644 --- a/rosa_release_notes/rosa-release-notes.adoc +++ b/rosa_release_notes/rosa-release-notes.adoc @@ -31,7 +31,6 @@ include::snippets/technology-preview.adoc[leveloffset=+1] * **OIDC provider endpoint URL update:** Starting with ROSA CLI version 1.2.7, all new cluster OIDC provider endpoint URLs are no longer regional. AWS CloudFront is part of this implementation to improve access speed, reduce latency, and improve resiliency. This change is only available for new clusters created with ROSA CLI 1.2.7 or later. There are no supported migration paths for existing OIDC provider configurations. - [id="rosa-known-issues_{context}"] == Known issues * The OpenShift Cluster Manager roles (`ocm-role`) and user roles (`user-role`) that are key to the ROSA provisioning wizard might get enabled accidentally in your Red Hat organization by another user. However, this behavior does not affect the usability. diff --git a/upgrading/rosa-hcp-upgrading.adoc b/upgrading/rosa-hcp-upgrading.adoc index b38ca5d7d4..c0583c393f 100644 --- a/upgrading/rosa-hcp-upgrading.adoc +++ b/upgrading/rosa-hcp-upgrading.adoc @@ -15,7 +15,7 @@ You can manually upgrade your cluster. Red Hat Site Reliability Engineers (SREs) [id="rosa-hcp-upgrading-a-cluster"] == Upgrading a ROSA cluster -You can upgrade {hcp-title-first} clusters by using individual upgrades through the ROSA CLI. +You can upgrade {hcp-title-first} clusters by using individual upgrades through the {product-title} (ROSA) CLI, `rosa`. [NOTE] ==== diff --git a/upgrading/rosa-upgrading-sts.adoc b/upgrading/rosa-upgrading-sts.adoc index f74d78f71f..709853d707 100644 --- a/upgrading/rosa-upgrading-sts.adoc +++ b/upgrading/rosa-upgrading-sts.adoc @@ -18,7 +18,7 @@ Upgrades are manually initiated or automatically scheduled. Red Hat Site Reliabi There are two methods to upgrade {product-title} (ROSA) clusters that uses the AWS Security Token Service (STS): -* Individual upgrades through the `rosa` CLI +* Individual upgrades through the ROSA CLI (`rosa`) * Individual upgrades through the {cluster-manager} console [NOTE] diff --git a/upgrading/rosa-upgrading.adoc b/upgrading/rosa-upgrading.adoc index 7f0a89cdde..0db8d5a165 100644 --- a/upgrading/rosa-upgrading.adoc +++ b/upgrading/rosa-upgrading.adoc @@ -17,7 +17,7 @@ Upgrades are manually initiated or automatically scheduled. Red Hat Site Reliabi == Upgrading a ROSA cluster There are three methods to upgrade {product-title} (ROSA) clusters: -* Individual upgrades through the `rosa` CLI +* Individual upgrades through the ROSA CLI (`rosa`) * Individual upgrades through the {cluster-manager-url} console * Recurring upgrades through the {cluster-manager-url} console