From 48a4be43462c43ea8a97aee5e9cc67a670a08247 Mon Sep 17 00:00:00 2001 From: mletalie Date: Tue, 9 Sep 2025 16:53:32 -0400 Subject: [PATCH] CLI tools update --- cli_reference/index.adoc | 33 +-- cli_reference/kn-cli-tools.adoc | 2 +- .../openshift_cli/managing-cli-profiles.adoc | 7 +- .../openshift_cli/usage-oc-kubectl.adoc | 60 +---- .../rosa-cli-permission-examples.adoc | 10 +- .../rosa_cli/rosa-manage-objects-cli.adoc | 8 +- .../rosa-updating-billing-account-cli.adoc | 4 +- modules/about-cli-profiles-switch.adoc | 25 +- modules/cli-extending-plugins-installing.adoc | 8 +- modules/cli-extending-plugins-writing.adoc | 16 +- modules/cli-getting-help.adoc | 8 +- modules/cli-installing-cli-rpm.adoc | 6 +- modules/cli-installing-cli-web-console.adoc | 21 +- modules/cli-logging-in.adoc | 26 +- modules/olm-installing-opm.adoc | 8 +- modules/op-installing-tkn-on-linux.adoc | 8 +- modules/op-installing-tkn-on-macos.adoc | 8 +- modules/op-installing-tkn-on-windows.adoc | 8 +- modules/opm-cli-ref-index.adoc | 6 +- modules/rosa-about.adoc | 3 +- modules/rosa-cli-classic-examples.adoc | 251 ++++++++++++++++- modules/rosa-cli-hcp-examples.adoc | 252 +++++++++++++++++- modules/rosa-common-commands.adoc | 2 +- modules/rosa-configure.adoc | 12 +- modules/rosa-create-objects.adoc | 82 +++--- modules/rosa-edit-objects.adoc | 34 ++- modules/rosa-initialize.adoc | 6 +- modules/rosa-list-objects.adoc | 4 +- modules/rosa-parent-commands.adoc | 2 +- modules/rosa-revoke-objects.adoc | 2 +- modules/rosa-update-billing-cli.adoc | 2 +- modules/rosa-updating-rosa-cli.adoc | 2 +- modules/rosa-upgrade-cluster-cli.adoc | 36 +-- modules/rosa-using-bash-script.adoc | 6 +- 34 files changed, 654 insertions(+), 314 deletions(-) diff --git a/cli_reference/index.adoc b/cli_reference/index.adoc index 787c69ea6ff6..84273ac72679 100644 --- a/cli_reference/index.adoc +++ b/cli_reference/index.adoc @@ -6,36 +6,20 @@ include::_attributes/common-attributes.adoc[] toc::[] -A user performs a range of operations while working on {product-title} -ifdef::openshift-rosa[] -(ROSA) -endif::openshift-rosa[] -such as the following: +A user performs a range of operations while working on {product-title} such as the following: * Managing clusters * Building, deploying, and managing applications * Managing deployment processes * Creating and maintaining Operator catalogs -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -offers a set of command-line interface (CLI) tools that simplify these tasks by enabling users to perform various administration and development operations from the terminal. +{product-title} offers a set of command-line interface (CLI) tools that simplify these tasks by enabling users to perform various administration and development operations from the terminal. These tools expose simple commands to manage the applications, as well as interact with each component of the system. [id="cli-tools-list"] == List of CLI tools -The following set of CLI tools are available in -ifndef::openshift-rosa[] -{product-title}: -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA: -endif::openshift-rosa[] +The following set of CLI tools are available in {product-title}: * xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (`oc`)]: ifndef::openshift-rosa[] @@ -44,14 +28,7 @@ endif::openshift-rosa[] ifdef::openshift-rosa[] This is one of the more commonly used developer CLI tools. endif::openshift-rosa[] -It helps both cluster administrators and developers to perform end-to-end operations across -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts. +It helps both cluster administrators and developers to perform end-to-end operations across {product-title} using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts. * xref:../cli_reference/kn-cli-tools.adoc#kn-cli-tools[Knative CLI (kn)]: The Knative (`kn`) CLI tool provides simple and intuitive terminal commands that can be used to interact with OpenShift Serverless components, such as Knative Serving and Eventing. @@ -60,5 +37,5 @@ using the terminal. Unlike the web console, it allows the user to work directly * xref:../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[opm CLI]: The `opm` CLI tool helps the Operator developers and cluster administrators to create and maintain the catalogs of Operators from the terminal. ifdef::openshift-rosa,openshift-rosa-hcp[] -* xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI (`rosa`)]: Use the `rosa` CLI to create, update, manage, and delete ROSA clusters and resources. +* xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI (`rosa`)]: Use the `rosa` CLI to create, update, manage, and delete {product-title} clusters and resources. endif::openshift-rosa,openshift-rosa-hcp[] diff --git a/cli_reference/kn-cli-tools.adoc b/cli_reference/kn-cli-tools.adoc index cd42febc0678..6ce647354d2d 100644 --- a/cli_reference/kn-cli-tools.adoc +++ b/cli_reference/kn-cli-tools.adoc @@ -25,4 +25,4 @@ Key features of the Knative CLI include: [id="kn-cli-tools-installing-kn"] == Installing the Knative CLI -See link:https://docs.openshift.com/serverless/1.28/install/installing-kn.html#installing-kn[Installing the Knative CLI]. +See link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.28/html/installing_serverless/installing-kn#installing-kn[Installing the Knative CLI]. diff --git a/cli_reference/openshift_cli/managing-cli-profiles.adoc b/cli_reference/openshift_cli/managing-cli-profiles.adoc index 0979f1b6157c..ab122c7ebccc 100644 --- a/cli_reference/openshift_cli/managing-cli-profiles.adoc +++ b/cli_reference/openshift_cli/managing-cli-profiles.adoc @@ -13,12 +13,7 @@ endif::microshift,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::microshift[] user authentication endif::[] -ifndef::openshift-rosa,openshift-rosa-hcp[] -an {product-title} -endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-rosa-hcp[] -the {product-title} (ROSA) -endif::openshift-rosa,openshift-rosa-hcp[] +a {product-title} server information associated with a _nickname_. include::modules/about-cli-profiles-switch.adoc[leveloffset=+1] diff --git a/cli_reference/openshift_cli/usage-oc-kubectl.adoc b/cli_reference/openshift_cli/usage-oc-kubectl.adoc index c165ba727b49..78a0613f0091 100644 --- a/cli_reference/openshift_cli/usage-oc-kubectl.adoc +++ b/cli_reference/openshift_cli/usage-oc-kubectl.adoc @@ -4,46 +4,18 @@ include::_attributes/common-attributes.adoc[] :context: usage-oc-kubectl -The Kubernetes command-line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because {product-title} -ifdef::openshift-rosa,openshift-rosa-hcp[] -(ROSA) -endif::openshift-rosa,openshift-rosa-hcp[] -is a certified Kubernetes distribution, you can use the supported `kubectl` binaries that ship with -ifndef::openshift-rosa,openshift-rosa-hcp[] -{product-title} -endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-rosa-hcp[] -ROSA -endif::openshift-rosa,openshift-rosa-hcp[] -, or you can gain extended functionality by using the `oc` binary. +The Kubernetes command-line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because {product-title} is a certified Kubernetes distribution, you can use the supported `kubectl` binaries that ship with +{product-title}, or you can gain extended functionality by using the `oc` binary. == The oc binary The `oc` binary offers the same capabilities as the `kubectl` binary, but it extends to natively support additional -ifndef::openshift-rosa,openshift-rosa-hcp[] -{product-title} -endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-rosa-hcp[] -ROSA -endif::openshift-rosa,openshift-rosa-hcp[] -features, including: +{product-title} features, including: -* **Full support for -ifndef::openshift-rosa,openshift-rosa-hcp[] -{product-title} -endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-rosa-hcp[] -ROSA -endif::openshift-rosa,openshift-rosa-hcp[] -resources** +* **Full support for {product-title} resources** + Resources such as `DeploymentConfig`, `BuildConfig`, `Route`, `ImageStream`, and `ImageStreamTag` objects are specific to -ifndef::openshift-rosa,openshift-rosa-hcp[] {product-title} -endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-rosa-hcp[] -ROSA -endif::openshift-rosa,openshift-rosa-hcp[] distributions, and build upon standard Kubernetes primitives. + * **Authentication** @@ -68,16 +40,9 @@ ifndef::openshift-rosa,openshift-rosa-hcp[] {product-title} {product-version} endif::openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-rosa-hcp[] -ROSA -endif::openshift-rosa,openshift-rosa-hcp[] -. If you want the latest features, you must download and install the latest version of the `oc` binary corresponding to your -ifndef::openshift-rosa,openshift-rosa-hcp[] {product-title} endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-rosa-hcp[] -ROSA -endif::openshift-rosa,openshift-rosa-hcp[] -server version. +. If you want the latest features, you must download and install the latest version of the `oc` binary corresponding to your {product-title} server version. ==== Non-security API changes will involve, at minimum, two minor releases (4.1 to 4.2 to 4.3, for example) to allow older `oc` binaries to update. Using new capabilities might require newer `oc` binaries. A 4.3 server might have additional capabilities that a 4.2 `oc` binary cannot use and a 4.3 `oc` binary might have additional capabilities that are unsupported by a 4.2 server. @@ -109,20 +74,7 @@ image:redcircle-3.png[] `oc` client might provide options and features that migh == The kubectl binary The `kubectl` binary is provided as a means to support existing workflows and scripts for new -ifndef::openshift-rosa,openshift-rosa-hcp[] -{product-title} -endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-rosa-hcp[] -ROSA -endif::openshift-rosa,openshift-rosa-hcp[] -users coming from a standard Kubernetes environment, or for those who prefer to use the `kubectl` CLI. Existing users of `kubectl` can continue to use the binary to interact with Kubernetes primitives, with no changes required to the -ifndef::openshift-rosa,openshift-rosa-hcp[] -{product-title} -endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-rosa,openshift-rosa-hcp[] -ROSA -endif::openshift-rosa,openshift-rosa-hcp[] -cluster. +{product-title} users coming from a standard Kubernetes environment, or for those who prefer to use the `kubectl` CLI. Existing users of `kubectl` can continue to use the binary to interact with Kubernetes primitives, with no changes required to the {product-title} cluster. You can install the supported `kubectl` binary by following the steps to xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-installing-cli_cli-developer-commands[Install the OpenShift CLI]. The `kubectl` binary is included in the archive if you download the binary, or is installed when you install the CLI by using an RPM. diff --git a/cli_reference/rosa_cli/rosa-cli-permission-examples.adoc b/cli_reference/rosa_cli/rosa-cli-permission-examples.adoc index 7134b566fab2..cff927556c47 100644 --- a/cli_reference/rosa_cli/rosa-cli-permission-examples.adoc +++ b/cli_reference/rosa_cli/rosa-cli-permission-examples.adoc @@ -5,7 +5,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-cli-permission-examples toc::[] -You can create roles with permissions that adhere to the principal of least privilege, in which the users assigned the roles have no other permissions assigned to them outside the scope of the specific action they need to perform. These policies contain only the minimum required permissions needed to perform specific actions by using the {product-title} (ROSA) command-line interface (CLI). +You can create roles with permissions that adhere to the principal of least privilege, in which the users assigned the roles have no other permissions assigned to them outside the scope of the specific action they need to perform. These policies contain only the minimum required permissions needed to perform specific actions by using the {rosa-cli-first}. [IMPORTANT] ==== @@ -20,11 +20,13 @@ Although the policies and commands presented in this topic will work in conjunct For more information about configuring permissions, policies, and roles in the AWS console, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html[AWS Identity and Access Management] in the AWS documentation. -include::modules/rosa-cli-hcp-classic-examples.adoc[leveloffset=+1] - +// include::modules/rosa-cli-hcp-classic-examples.adoc[leveloffset=+1] +ifdef::openshift-rosa-hcp[] include::modules/rosa-cli-hcp-examples.adoc[leveloffset=+1] +endif::openshift-rosa-hcp[] +ifdef::openshift-rosa[] include::modules/rosa-cli-classic-examples.adoc[leveloffset=+1] - +endif::openshift-rosa[] include::modules/rosa-cli-no-permissions-required.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/cli_reference/rosa_cli/rosa-manage-objects-cli.adoc b/cli_reference/rosa_cli/rosa-manage-objects-cli.adoc index 9ccb901bedcd..44ba42ab651a 100644 --- a/cli_reference/rosa_cli/rosa-manage-objects-cli.adoc +++ b/cli_reference/rosa_cli/rosa-manage-objects-cli.adoc @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] -Managing objects with the {product-title} (ROSA) CLI, `rosa`, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades. +Managing objects with the {rosa-cli-first}, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades. [NOTE] ==== @@ -35,11 +35,13 @@ include::modules/rosa-edit-objects.adoc[leveloffset=+1] ifdef::openshift-rosa[] * See xref:../../networking/networking_operators/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller] for information regarding editing non-default application routers. endif::openshift-rosa[] -//Classic to HCP breakout. Remove ROSA-specific conditionals when networking is added to HCP. - +//Classic to HCP breakout. Remove ROSA-specific conditionals when networking is added to HCP. + include::modules/rosa-delete-objects.adoc[leveloffset=+1] include::modules/rosa-install-uninstall-addon.adoc[leveloffset=+1] include::modules/rosa-list-objects.adoc[leveloffset=+1] +ifdef::openshift-rosa-hcp[] include::modules/rosa-revoke-objects.adoc[leveloffset=+1] +endif::openshift-rosa-hcp[] include::modules/rosa-upgrade-cluster-cli.adoc[leveloffset=+1] diff --git a/cli_reference/rosa_cli/rosa-updating-billing-account-cli.adoc b/cli_reference/rosa_cli/rosa-updating-billing-account-cli.adoc index 88bb5f7b1821..d301ce881d82 100644 --- a/cli_reference/rosa_cli/rosa-updating-billing-account-cli.adoc +++ b/cli_reference/rosa_cli/rosa-updating-billing-account-cli.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/attributes-openshift-dedicated.adoc[] [id="rosa-updating-account-cli"] -= Managing billing accounts for ROSA with HCP clusters += Managing billing accounts for {product-title} clusters :context: rosa-updating-account-cli toc::[] @@ -12,7 +12,7 @@ This can be useful if you have accidentally linked to the wrong AWS billing acco [NOTE] ==== -You also have the option to update your billing account through the {cluster-manager}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html-single/managing_clusters/index#proc_updating-billing-accts-rosa-hcp_assembly-managing-clusters[Updating billing accounts for OpenShift Service on AWS Hosted Control Planes clusters.] +You also have the option to update your billing account through the {cluster-manager}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html-single/managing_clusters/index#proc_updating-billing-accts-rosa-hcp_assembly-managing-clusters[Updating billing accounts for {product-title} clusters.] ==== diff --git a/modules/about-cli-profiles-switch.adoc b/modules/about-cli-profiles-switch.adoc index 8c8d014ced6b..9d71c914edff 100644 --- a/modules/about-cli-profiles-switch.adoc +++ b/modules/about-cli-profiles-switch.adoc @@ -6,22 +6,9 @@ [id="about-switches-between-cli-profiles_{context}"] = About switches between CLI profiles -Contexts allow you to easily switch between multiple users across multiple -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -servers, or clusters, when using CLI operations. Nicknames make managing CLI configurations easier by providing short-hand references to contexts, user credentials, and cluster details. +Contexts allow you to easily switch between multiple users across multiple {product-title} servers, or clusters, when using CLI operations. Nicknames make managing CLI configurations easier by providing short-hand references to contexts, user credentials, and cluster details. After a user logs in with the `oc` CLI for the first time, -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -creates a `~/.kube/config` file if one does not already exist. As more authentication and connection details are provided to the CLI, either automatically during an `oc login` operation or by manually configuring CLI profiles, the updated information is stored in the configuration file: +{product-title} creates a `~/.kube/config` file if one does not already exist. As more authentication and connection details are provided to the CLI, either automatically during an `oc login` operation or by manually configuring CLI profiles, the updated information is stored in the configuration file: .CLI config file @@ -58,13 +45,7 @@ users: <4> ---- <1> The `clusters` section defines connection details for -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -clusters, including the address for their master server. In this example, one cluster is nicknamed `openshift1.example.com:8443` and another is nicknamed `openshift2.example.com:8443`. +{product-title} clusters, including the address for their master server. In this example, one cluster is nicknamed `openshift1.example.com:8443` and another is nicknamed `openshift2.example.com:8443`. <2> This `contexts` section defines two contexts: one nicknamed `alice-project/openshift1.example.com:8443/alice`, using the `alice-project` project, `openshift1.example.com:8443` cluster, and `alice` user, and another nicknamed `joe-project/openshift1.example.com:8443/alice`, using the `joe-project` project, `openshift1.example.com:8443` cluster and `alice` user. <3> The `current-context` parameter shows that the `joe-project/openshift1.example.com:8443/alice` context is currently in use, allowing the `alice` user to work in the `joe-project` project on the `openshift1.example.com:8443` cluster. <4> The `users` section defines user credentials. In this example, the user nickname `alice/openshift1.example.com:8443` uses an access token. diff --git a/modules/cli-extending-plugins-installing.adoc b/modules/cli-extending-plugins-installing.adoc index 8f5f06d43734..cc31faadcf29 100644 --- a/modules/cli-extending-plugins-installing.adoc +++ b/modules/cli-extending-plugins-installing.adoc @@ -7,12 +7,12 @@ = Installing and using CLI plugins After you write a custom plugin for the -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] {product-title} -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] OpenShift -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] CLI, you must install the plugin before use. diff --git a/modules/cli-extending-plugins-writing.adoc b/modules/cli-extending-plugins-writing.adoc index e143ed4552ab..628ae774fc4c 100644 --- a/modules/cli-extending-plugins-writing.adoc +++ b/modules/cli-extending-plugins-writing.adoc @@ -7,12 +7,12 @@ = Writing CLI plugins You can write a plugin for the -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] {product-title} -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] OpenShift -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] CLI in any programming language or script that allows you to write command-line commands. Note that you can not use a plugin to overwrite an existing `oc` command. @@ -58,12 +58,12 @@ echo "I am a plugin named kubectl-foo" ---- After you install this plugin for the -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] {product-title} -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp[] OpenShift -endif::openshift-rosa[] +endif::openshift-rosa,openshift-rosa-hcp[] CLI, it can be invoked using the `oc foo` command. diff --git a/modules/cli-getting-help.adoc b/modules/cli-getting-help.adoc index 8b352e7e4a2c..5cc62e472d74 100644 --- a/modules/cli-getting-help.adoc +++ b/modules/cli-getting-help.adoc @@ -5,13 +5,7 @@ [id="cli-getting-help_{context}"] = Getting help -You can get help with CLI commands and -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] +You can get help with CLI commands and {product-title} resources in the following ways: * Use `oc help` to get a list and description of all available CLI commands: diff --git a/modules/cli-installing-cli-rpm.adoc b/modules/cli-installing-cli-rpm.adoc index df0a57f90c6c..e9956c6184d4 100644 --- a/modules/cli-installing-cli-rpm.adoc +++ b/modules/cli-installing-cli-rpm.adoc @@ -7,11 +7,7 @@ [id="cli-installing-cli-rpm_{context}"] = Installing the OpenShift CLI by using an RPM -For {op-system-base-full}, you can install the {oc-first} as an RPM if you have an active {product-title} -ifdef::openshift-rosa[] -(ROSA) -endif::openshift-rosa[] -subscription on your Red Hat account. +For {op-system-base-full}, you can install the {oc-first} as an RPM if you have an active {product-title} subscription on your Red Hat account. [IMPORTANT] ==== diff --git a/modules/cli-installing-cli-web-console.adoc b/modules/cli-installing-cli-web-console.adoc index ce881a2871f8..e972b7903f87 100644 --- a/modules/cli-installing-cli-web-console.adoc +++ b/modules/cli-installing-cli-web-console.adoc @@ -5,25 +5,18 @@ endif::[] [id="cli-installing-cli-web-console_{context}"] = Installing the OpenShift CLI by using the web console -You can install the {oc-first} to interact with {product-title} -ifdef::openshift-rosa[] -(ROSA) -endif::openshift-rosa[] -ifdef::openshift-dedicated[] -clusters -endif::openshift-dedicated[] -from a web console. You can install `oc` on Linux, Windows, or macOS. +You can install the {oc-first} to interact with {product-title} clusters from a web console. You can install `oc` on Linux, Windows, or macOS. [IMPORTANT] ==== If you installed an earlier version of `oc`, you cannot use it to complete all -of the commands in -ifndef::openshift-rosa[] +of the commands in +ifndef::openshift-rosa,openshift-rosa-hcp[] {product-title} {product-version}. -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA. -endif::openshift-rosa[] +endif::openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-rosa,openshift-rosa-hcp[] +{product-title}. +endif::openshift-rosa,openshift-rosa-hcp[] Download and install the new version of `oc`. ifdef::restricted[] diff --git a/modules/cli-logging-in.adoc b/modules/cli-logging-in.adoc index 7c506ee04dd7..1b5976c4ff38 100644 --- a/modules/cli-logging-in.adoc +++ b/modules/cli-logging-in.adoc @@ -10,14 +10,7 @@ You can log in to the OpenShift CLI (`oc`) to access and manage your cluster. .Prerequisites -* You must have access to -ifndef::openshift-rosa[] -an {product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -a ROSA -endif::openshift-rosa[] -cluster. +* You must have access to a {product-title} cluster. * The {oc-first} is installed. [NOTE] @@ -58,27 +51,14 @@ You don't have any projects. You can try to create a new project, by running Welcome! See 'oc help' to get started. ---- -<1> Enter the -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -server URL. +<1> Enter the {product-title} server URL. <2> Enter whether to use insecure connections. <3> Enter the user's password. [NOTE] ==== If you are logged in to the web console, you can generate an `oc login` command that includes your token and server information. You can use the command to log in to the -ifndef::openshift-rosa[] -{product-title} -endif::openshift-rosa[] -ifdef::openshift-rosa[] -OpenShift -endif::openshift-rosa[] -CLI without the interactive prompts. To generate the command, select *Copy login command* from the username drop-down menu at the top right of the web console. +OpenShift CLI (`oc`) without the interactive prompts. To generate the command, select *Copy login command* from the username drop-down menu at the top right of the web console. ==== You can now create a project or issue other commands for managing your cluster. diff --git a/modules/olm-installing-opm.adoc b/modules/olm-installing-opm.adoc index 9f516f6e1b6c..317a055ced2c 100644 --- a/modules/olm-installing-opm.adoc +++ b/modules/olm-installing-opm.adoc @@ -16,13 +16,13 @@ You can install the `opm` CLI tool on your Linux, macOS, or Windows workstation. .Procedure -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Navigate to the link:https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/latest-{product-version}/[OpenShift mirror site] and download the latest version of the tarball that matches your operating system. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Navigate to the link:https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/[OpenShift mirror site] and download the latest version of the tarball that matches your operating system. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Unpack the archive. diff --git a/modules/op-installing-tkn-on-linux.adoc b/modules/op-installing-tkn-on-linux.adoc index 128e48321ad9..2fe34427ac63 100644 --- a/modules/op-installing-tkn-on-linux.adoc +++ b/modules/op-installing-tkn-on-linux.adoc @@ -33,13 +33,13 @@ For Linux distributions, you can download the CLI as a `tar.gz` archive. ---- $ tar xvzf ---- -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Add the location of your `tkn`, `tkn-pac`, and `opc` files to your `PATH` environment variable. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Add the location of your `tkn` and `tkn-pac` files to your `PATH` environment variable. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . To check your `PATH`, run the following command: + diff --git a/modules/op-installing-tkn-on-macos.adoc b/modules/op-installing-tkn-on-macos.adoc index cdba9dc6ef3b..5dbc7f586e8c 100644 --- a/modules/op-installing-tkn-on-macos.adoc +++ b/modules/op-installing-tkn-on-macos.adoc @@ -20,13 +20,13 @@ For macOS, you can download the CLI as a `tar.gz` archive. . Unpack and extract the archive. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Add the location of your `tkn`, `tkn-pac`, and `opc` files to your `PATH` environment variable. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Add the location of your `tkn` and `tkn-pac` and files to your `PATH` environment variable. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . To check your `PATH`, run the following command: + diff --git a/modules/op-installing-tkn-on-windows.adoc b/modules/op-installing-tkn-on-windows.adoc index e982026f584c..a5b0bacd1bb2 100644 --- a/modules/op-installing-tkn-on-windows.adoc +++ b/modules/op-installing-tkn-on-windows.adoc @@ -15,12 +15,12 @@ For Windows, you can download the CLI as a `zip` archive. . Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/pipelines/{pipelines-version-number}.0/tkn-windows-amd64.zip[CLI tool]. . Extract the archive with a ZIP program. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Add the location of your `tkn`, `tkn-pac`, and `opc` files to your `PATH` environment variable. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Add the location of your `tkn` and `tkn-pac` files to your `PATH` environment variable. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . To check your `PATH`, run the following command: + diff --git a/modules/opm-cli-ref-index.adoc b/modules/opm-cli-ref-index.adoc index f4b0cf6402ff..3be9fbee1688 100644 --- a/modules/opm-cli-ref-index.adoc +++ b/modules/opm-cli-ref-index.adoc @@ -13,11 +13,11 @@ As of {product-title} 4.11, the default Red Hat-provided Operator catalog releas The `opm` subcommands, flags, and functionality related to the SQLite database format are also deprecated and will be removed in a future release. The features are still supported and must be used for catalogs that use the deprecated SQLite database format. -Many of the `opm` subcommands and flags for working with the SQLite database format, such as `opm index prune`, do not work with the file-based catalog format. +Many of the `opm` subcommands and flags for working with the SQLite database format, such as `opm index prune`, do not work with the file-based catalog format. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] For more information about working with file-based catalogs, see "Additional resources". -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ==== .Command syntax diff --git a/modules/rosa-about.adoc b/modules/rosa-about.adoc index d14a859b3b54..e4ef1d09e7f2 100644 --- a/modules/rosa-about.adoc +++ b/modules/rosa-about.adoc @@ -8,5 +8,4 @@ [id="rosa-about_{context}"] = About the ROSA CLI - -Use the {product-title} (ROSA) command-line interface (CLI), the `rosa` command, to create, update, manage, and delete ROSA clusters and resources. +Use the {rosa-cli-first} to create, update, manage, and delete {product-title} clusters and resources. diff --git a/modules/rosa-cli-classic-examples.adoc b/modules/rosa-cli-classic-examples.adoc index eff5ac3d6d35..1fa0097a75f2 100644 --- a/modules/rosa-cli-classic-examples.adoc +++ b/modules/rosa-cli-classic-examples.adoc @@ -4,14 +4,259 @@ :_mod-docs-content-type: REFERENCE [id="rosa-cli-classic-examples_{context}"] -= Least privilege permissions for common ROSA Classic CLI commands += Least privilege permissions for common {rosa-cli} commands -The following examples show the least privilege permissions needed for the most common ROSA CLI commands when building ROSA Classic clusters. +The following examples show the least privilege permissions needed for the most common ROSA CLI commands when building {product-title} clusters. + +[id="rosa-create-OIDC-providers-hcp-classic_{context}"] +== Create a managed OpenID Connect (OIDC) provider +Run the following command with the specified permissions to create your managed OIDC provider by using `auto` mode. + +.Input +[source,terminal] +---- +$ rosa create oidc-config --mode auto +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "CreateOidcConfig", + "Effect": "Allow", + "Action": [ + "iam:TagOpenIDConnectProvider", + "iam:CreateOpenIDConnectProvider" + ], + "Resource": "*" + } + ] +} +---- +[id="rosa-create-unmanaged-OIDC-providers-hcp-classic_{context}"] +== Create an unmanaged OpenID Connect provider +Run the following command with the specified permissions to create your unmanaged OIDC provider by using `auto` mode. + +.Input +[source,terminal] +---- +$ rosa create oidc-config --mode auto --managed=false +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "VisualEditor0", + "Effect": "Allow", + "Action": [ + "iam:GetRole", + "iam:TagOpenIDConnectProvider", + "iam:ListRoleTags", + "iam:ListRoles", + "iam:CreateOpenIDConnectProvider", + "s3:CreateBucket", + "s3:PutObject", + "s3:PutBucketTagging", + "s3:PutBucketPolicy", + "s3:PutObjectTagging", + "s3:PutBucketPublicAccessBlock", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-list-account-roles-hcp-classic_{context}"] +== List your account roles +Run the following command with the specified permissions to list your account roles. + +.Input +[source,terminal] +---- +$ rosa list account-roles +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "ListAccountRoles", + "Effect": "Allow", + "Action": [ + "iam:ListRoleTags", + "iam:ListRoles" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-list-operator-roles-hcp-classic_{context}"] +== List your Operator roles +Run the following command with the specified permissions to list your Operator roles. + +.Input +[source,terminal] +---- +$ rosa list operator-roles +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "ListOperatorRoles", + "Effect": "Allow", + "Action": [ + "iam:ListRoleTags", + "iam:ListAttachedRolePolicies", + "iam:ListRoles", + "iam:ListPolicyTags" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-list-OIDC-providers-hcp-classic_{context}"] +== List your OIDC providers + +Run the following command with the specified permissions to list your OIDC providers. + +.Input +[source,terminal] +---- +$ rosa list oidc-providers +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "ListOidcProviders", + "Effect": "Allow", + "Action": [ + "iam:ListOpenIDConnectProviders", + "iam:ListOpenIDConnectProviderTags" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-verify-quota-hcp-classic_{context}"] +== Verify your quota + +Run the following command with the specified permissions to verify your quota. + +.Input +[source,terminal] +---- +$ rosa verify quota +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "VerifyQuota", + "Effect": "Allow", + "Action": [ + "elasticloadbalancing:DescribeAccountLimits", + "servicequotas:ListServiceQuotas" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-delete-oidc-config-hcp-classic_{context}"] +== Delete your managed OIDC configuration + +Run the following command with the specified permissions to delete your managed OIDC configuration by using `auto` mode. + +.Input +[source,terminal] +---- +$ rosa delete oidc-config -–mode auto +---- +.Policy +[source,json] +---- + +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "DeleteOidcConfig", + "Effect": "Allow", + "Action": [ + "iam:ListOpenIDConnectProviders", + "iam:DeleteOpenIDConnectProvider" + ], + "Resource": "*" + } + ] +} + +---- +[id="rosa-delete-unmanaged-oidc-config-hcp-classic_{context}"] +== Delete your unmanaged OIDC configuration + +Run the following command with the specified permissions to delete your unmanaged OIDC configuration by using `auto` mode. + +.Input +[source,terminal] +---- +$ rosa delete oidc-config -–mode auto +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "VisualEditor0", + "Effect": "Allow", + "Action": [ + "iam:ListOpenIDConnectProviders", + "iam:DeleteOpenIDConnectProvider", + "secretsmanager:DeleteSecret", + "s3:ListBucket", + "s3:DeleteObject", + "s3:DeleteBucket" + ], + "Resource": "*" + } + ] +} +---- [id="rosa-min-permissions-required-classic_{context}"] == Create a cluster -Run the following command with the specified permissions to create a ROSA Classic cluster with least privilege permissions. +Run the following command with the specified permissions to create a {product-title} cluster with least privilege permissions. .Input [source,terminal] diff --git a/modules/rosa-cli-hcp-examples.adoc b/modules/rosa-cli-hcp-examples.adoc index 8c5ba7f00b7f..f3b4dd07609f 100644 --- a/modules/rosa-cli-hcp-examples.adoc +++ b/modules/rosa-cli-hcp-examples.adoc @@ -4,14 +4,260 @@ :_mod-docs-content-type: REFERENCE [id="rosa-cli-hcp-examples_{context}"] -= Least privilege permissions for common ROSA with HCP CLI commands += Least privilege permissions for common {product-title} CLI commands + +The following examples show the least privilege permissions needed for the most common ROSA CLI commands when building {product-title} clusters. + +[id="rosa-create-OIDC-providers-hcp-classic_{context}"] +== Create a managed OpenID Connect (OIDC) provider +Run the following command with the specified permissions to create your managed OIDC provider by using `auto` mode. + +.Input +[source,terminal] +---- +$ rosa create oidc-config --mode auto +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "CreateOidcConfig", + "Effect": "Allow", + "Action": [ + "iam:TagOpenIDConnectProvider", + "iam:CreateOpenIDConnectProvider" + ], + "Resource": "*" + } + ] +} +---- +[id="rosa-create-unmanaged-OIDC-providers-hcp-classic_{context}"] +== Create an unmanaged OpenID Connect provider +Run the following command with the specified permissions to create your unmanaged OIDC provider by using `auto` mode. + +.Input +[source,terminal] +---- +$ rosa create oidc-config --mode auto --managed=false +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "VisualEditor0", + "Effect": "Allow", + "Action": [ + "iam:GetRole", + "iam:TagOpenIDConnectProvider", + "iam:ListRoleTags", + "iam:ListRoles", + "iam:CreateOpenIDConnectProvider", + "s3:CreateBucket", + "s3:PutObject", + "s3:PutBucketTagging", + "s3:PutBucketPolicy", + "s3:PutObjectTagging", + "s3:PutBucketPublicAccessBlock", + "secretsmanager:CreateSecret", + "secretsmanager:TagResource" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-list-account-roles-hcp-classic_{context}"] +== List your account roles +Run the following command with the specified permissions to list your account roles. + +.Input +[source,terminal] +---- +$ rosa list account-roles +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "ListAccountRoles", + "Effect": "Allow", + "Action": [ + "iam:ListRoleTags", + "iam:ListRoles" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-list-operator-roles-hcp-classic_{context}"] +== List your Operator roles +Run the following command with the specified permissions to list your Operator roles. + +.Input +[source,terminal] +---- +$ rosa list operator-roles +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "ListOperatorRoles", + "Effect": "Allow", + "Action": [ + "iam:ListRoleTags", + "iam:ListAttachedRolePolicies", + "iam:ListRoles", + "iam:ListPolicyTags" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-list-OIDC-providers-hcp-classic_{context}"] +== List your OIDC providers + +Run the following command with the specified permissions to list your OIDC providers. + +.Input +[source,terminal] +---- +$ rosa list oidc-providers +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "ListOidcProviders", + "Effect": "Allow", + "Action": [ + "iam:ListOpenIDConnectProviders", + "iam:ListOpenIDConnectProviderTags" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-verify-quota-hcp-classic_{context}"] +== Verify your quota + +Run the following command with the specified permissions to verify your quota. + +.Input +[source,terminal] +---- +$ rosa verify quota +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "VerifyQuota", + "Effect": "Allow", + "Action": [ + "elasticloadbalancing:DescribeAccountLimits", + "servicequotas:ListServiceQuotas" + ], + "Resource": "*" + } + ] +} +---- + +[id="rosa-delete-oidc-config-hcp-classic_{context}"] +== Delete your managed OIDC configuration + +Run the following command with the specified permissions to delete your managed OIDC configuration by using `auto` mode. + +.Input +[source,terminal] +---- +$ rosa delete oidc-config -–mode auto +---- +.Policy +[source,json] +---- + +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "DeleteOidcConfig", + "Effect": "Allow", + "Action": [ + "iam:ListOpenIDConnectProviders", + "iam:DeleteOpenIDConnectProvider" + ], + "Resource": "*" + } + ] +} + +---- +[id="rosa-delete-unmanaged-oidc-config-hcp-classic_{context}"] +== Delete your unmanaged OIDC configuration + +Run the following command with the specified permissions to delete your unmanaged OIDC configuration by using `auto` mode. + +.Input +[source,terminal] +---- +$ rosa delete oidc-config -–mode auto +---- +.Policy +[source,json] +---- +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "VisualEditor0", + "Effect": "Allow", + "Action": [ + "iam:ListOpenIDConnectProviders", + "iam:DeleteOpenIDConnectProvider", + "secretsmanager:DeleteSecret", + "s3:ListBucket", + "s3:DeleteObject", + "s3:DeleteBucket" + ], + "Resource": "*" + } + ] +} +---- -The following examples show the least privilege permissions needed for the most common ROSA CLI commands when building ROSA with hosted control plane (HCP) clusters. [id="rosa-create-hcp-cluster_{context}"] == Create a cluster -Run the following command with the specified permissions to create ROSA with HCP clusters. +Run the following command with the specified permissions to create {product-title} clusters. .Input [source,terminal] diff --git a/modules/rosa-common-commands.adoc b/modules/rosa-common-commands.adoc index 7dc863904ee7..e96466c64062 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 {product-title} (ROSA) CLI, `rosa`. +These common commands and arguments are available for the {rosa-cli-first}. [id="rosa-debug_{context}"] == debug diff --git a/modules/rosa-configure.adoc b/modules/rosa-configure.adoc index 2a2017f5558a..fc701968000d 100644 --- a/modules/rosa-configure.adoc +++ b/modules/rosa-configure.adoc @@ -6,11 +6,11 @@ [id="rosa-configure_{context}"] = Configuring the ROSA CLI -Use the following commands to configure the {product-title} (ROSA) CLI, `rosa`. +Use the following commands to configure the {rosa-cli-first}. [id="rosa-login_{context}"] == login -There are several methods you can use to log into your Red{nbsp}Hat account using the {product-title} (ROSA) CLI (`rosa`). These methods are described in detail below. +There are several methods you can use to log in to your Red{nbsp}Hat account using the {rosa-cli-first}. These methods are described in detail below. [id="rosa-login-sso_{context}"] === Authenticating the ROSA CLI with Red Hat single sign-on @@ -23,14 +23,14 @@ Alternatively, authenticating with the Red{nbsp}Hat single sign-on method automa [IMPORTANT] ==== -The method of authenticating using Red Hat single sign-on does not break any existing automations that rely on offline tokens. Red{nbsp}Hat recommends using link:https://console.redhat.com/iam/service-accounts[services accounts] for automation purposes. If you still need to use offline tokens for automation or other purposes, you can download the OpenShift Cluster Manager API token from the link:https://console.redhat.com/openshift/token[OpenShift Cluster Manager API Token] page. +The method of authenticating using Red{nbsp}Hat single sign-on does not break any existing automations that rely on offline tokens. Red{nbsp}Hat recommends using link:https://console.redhat.com/iam/service-accounts[services accounts] for automation purposes. If you still need to use offline tokens for automation or other purposes, you can download the OpenShift Cluster Manager API token from the link:https://console.redhat.com/openshift/token[OpenShift Cluster Manager API Token] page. ==== Use one of the following methods of authentication: * If your system has a web browser, see the "Authenticating the ROSA CLI with a single sign-on authorization code" section to authenticate with Red Hat single sign-on. -* If you are working with containers, remote hosts, or other environments without a web browser, see the "Authenticating the ROSA CLI with a single sign-on device code" section to authenticate with Red Hat single sign-on. +* If you are working with containers, remote hosts, or other environments without a web browser, see the "Authenticating the ROSA CLI with a single sign-on device code" section to authenticate with Red{nbsp}Hat single sign-on. * To authenticate the ROSA CLI using an offline token, see the "Authenticating the ROSA CLI with an offline token" section. @@ -85,7 +85,7 @@ Single sign-on authorization is supported with ROSA CLI (`rosa`) version 1.2.36 $ rosa login --use-device-code ---- + -Running this command will redirect you to the Red Hat SSO login and provide a log in code. +Running this command will redirect you to the Red{nbsp}Hat SSO login and provide a log in code. + .Optional arguments inherited from parent commands [cols="30,70"] @@ -195,7 +195,7 @@ $ rosa logout [arguments] [id="rosa-verify-permissions_{context}"] == verify permissions -Verify that the AWS permissions required to create a ROSA cluster are configured correctly: +Verify that the AWS permissions required to create a {product-title} cluster are configured correctly: .Syntax [source,terminal] diff --git a/modules/rosa-create-objects.adoc b/modules/rosa-create-objects.adoc index c392256f6c63..7c1fd939bc33 100644 --- a/modules/rosa-create-objects.adoc +++ b/modules/rosa-create-objects.adoc @@ -5,12 +5,13 @@ :_mod-docs-content-type: REFERENCE [id="rosa-create-objects_{context}"] = Create objects - +//Adding the following condition fpr pruning purposes. Once pruning complete, note should be removed from HCP docs and flag can be manually added to each create command (where applicable). +ifdef::openshift-rosa-hcp[] [NOTE] ==== -To create a Hosted Control Plane cluster, include the '--hosted-cp' flag where necessary. +To create a {product-title} cluster, include the '--hosted-cp' flag where necessary. ==== - +endif::openshift-rosa-hcp[] This section describes the `create` commands for clusters and resources. [id="rosa-create-account-roles_{context}"] @@ -103,11 +104,11 @@ Create a cluster administrator that can log in to a cluster named `mycluster`. ---- $ rosa create admin --cluster=mycluster ---- - +ifdef::openshift-rosa-hcp[] [id="rosa-create-break-glass-credential_{context}"] == create break glass credential -Create a break glass credential for a hosted control plane cluster with external authentication enabled. +Create a break glass credential for a {product-title} cluster with external authentication enabled. .Syntax [source,terminal] @@ -170,7 +171,7 @@ Add a break glass credential to a cluster named `mycluster` using the interactiv ---- $ rosa create break-glass-credential --cluster=mycluster -i ---- - +endif::openshift-rosa-hcp[] [id="rosa-create-cluster-command_{context}"] == create cluster @@ -196,10 +197,10 @@ $ rosa create cluster --cluster-name= [arguments] |--additional-control-plane-security-group-ids |The identifier of one or more additional security groups to use along with the default security groups that are used with the control plane nodes created alongside the cluster. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_. - +ifdef::openshift-rosa-hcp[] |--additional-allowed-principals |A comma-separated list of additional allowed principal ARNs to be added to the hosted control plane's VPC endpoint service to enable additional VPC endpoint connection requests to be automatically accepted. - +endif::openshift-rosa-hcp[] a|--cluster-name |Required. The name of the cluster. When used with the `create cluster` command, this argument is used to set the cluster name and can hold up to 54 characters. The value for this argument must be unique within your organization. @@ -247,11 +248,11 @@ If the argument is not supplied, an autogenerated value is created that depends |The subnet prefix length to assign to each individual node, as an integer. For example, if host prefix is set to `23`, then each node is assigned a `/23` subnet out of the given CIDR. |--machine-cidr -a|Block of IP addresses (ipNet) used by ROSA while installing the cluster, for example, `10.0.0.0/16`. +a|Block of IP addresses (ipNet) used by {product-title} while installing the cluster, for example, `10.0.0.0/16`. [IMPORTANT] ==== -OVN-Kubernetes, the default network provider in ROSA 4.11 and later, uses the `100.64.0.0/16` IP address range internally. If your cluster uses OVN-Kubernetes, do not include the `100.64.0.0/16` IP address range in any other CIDR definitions in your cluster. +OVN-Kubernetes, the default network provider in {product-title} 4.11 and later, uses the `100.64.0.0/16` IP address range internally. If your cluster uses OVN-Kubernetes, do not include the `100.64.0.0/16` IP address range in any other CIDR definitions in your cluster. ==== |--max-replicas @@ -277,14 +278,14 @@ a|Block of IP addresses (ipNet) from which pod IP addresses are allocated, for e [IMPORTANT] ==== -OVN-Kubernetes, the default network provider in ROSA 4.11 and later, uses the `100.64.0.0/16` IP address range internally. If your cluster uses OVN-Kubernetes, do not include the `100.64.0.0/16` IP address range in any other CIDR definitions in your cluster. +OVN-Kubernetes, the default network provider in {product-title} 4.11 and later, uses the `100.64.0.0/16` IP address range internally. If your cluster uses OVN-Kubernetes, do not include the `100.64.0.0/16` IP address range in any other CIDR definitions in your cluster. ==== |--private |Restricts primary API endpoint and application routes to direct, private connectivity. //To be added when available for HCP only. //ifdef::openshift-rosa-hcp[] -//To allow public subnets on a private API cluster, you can use both the `--private` and `--private-ingress=false` arguments. +//To allow public subnets on a private API cluster, you can use both the `--private` and `--private-ingress=false` arguments. //endif::openshift-rosa-hcp[] ifdef::openshift-rosa[] @@ -315,7 +316,7 @@ a|--sts \| --non-sts endif::openshift-rosa[] ifdef::openshift-rosa-hcp[] -|--sts +|--sts |Specifies the use of AWS Security Token Service (STS) credentials to deploy your cluster. endif::openshift-rosa-hcp[] @@ -333,7 +334,7 @@ ifdef::openshift-rosa-hcp[] When using `--private` for "private API", the `--subnet-ids` argument is required and only one private subnet is allowed per zone. //To be added when available -//To allow public subnets on a private API cluster, you can use both the `--private` and `--private-ingress=false` arguments. +//To allow public subnets on a private API cluster, you can use both the `--private` and `--private-ingress=false` arguments. endif::openshift-rosa-hcp[] |--support-role-arn string @@ -346,11 +347,11 @@ a|Tags that are used on resources created by {product-title} in AWS. Tags can he {product-title} only supports custom tags to Red{nbsp}Hat OpenShift resources during cluster creation. Once added, the tags cannot be removed or edited. Tags that are added by Red{nbsp}Hat are required for clusters to stay in compliance with Red{nbsp}Hat production service level agreements (SLAs). These tags must not be removed. -{product-title} does not support adding additional tags outside of ROSA cluster-managed resources. These tags can be lost when AWS resources are managed by the ROSA cluster. In these cases, you might need custom solutions or tools to reconcile the tags and keep them intact. +{product-title} does not support adding additional tags outside of {product-title} cluster-managed resources. These tags can be lost when AWS resources are managed by the ROSA cluster. In these cases, you might need custom solutions or tools to reconcile the tags and keep them intact. ==== |--version string -|The version of ROSA that will be used to install the cluster or cluster resources. For `cluster` use an `X.Y.Z` format, for example, `4.19.0`. For `account-role` use an `X.Y` format, for example, `4.19`. +|The version of {product-title} that will be used to install the cluster or cluster resources. For `cluster` use an `X.Y.Z` format, for example, `4.19.0`. For `account-role` use an `X.Y` format, for example, `4.19`. |--worker-iam-role string |The ARN of the IAM role that will be attached to compute instances. @@ -396,16 +397,12 @@ Create a cluster with autoscaling enabled on the default worker machine pool. ---- $ rosa create cluster --cluster-name=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=5 ---- - +ifdef::openshift-rosa-hcp[] [id="rosa-create-external-auth-provider_{context}"] == create external-auth-provider Add an external identity provider instead of the {OCP-short} OAuth2 server. -[IMPORTANT] -==== -You can only use external authentication providers on {hcp-title} clusters. -==== .Syntax [source,terminal] @@ -474,7 +471,7 @@ Add a Microsoft Entra ID identity provider to a cluster named `mycluster`. ---- $ rosa create external-auth-provider --cluster=mycluster --name --issuer-audiences --issuer-url --claim-mapping-username-claim email --claim-mapping-groups-claim groups ---- - +endif::openshift-rosa-hcp[] [id="rosa-create-idp_{context}"] == create idp @@ -760,7 +757,7 @@ Add a machine pool to an existing cluster. ifdef::openshift-rosa-hcp[] [TIP] ==== -Machine pool is also referred to as node pool on hosted control plane clusters. +Machine pool is also referred to as node pool on {product-title} clusters. ==== endif::openshift-rosa-hcp[] @@ -784,22 +781,23 @@ a|--cluster \| |--disk-size |Set the disk volume size for the machine pool, in Gib or TiB. The default is 300 GiB. - -For {rosa-classic} clusters version 4.13 or earlier, the minimum disk size is 128 GiB, and the maximum is 1 TiB. For cluster version 4.14 and later, the minimum is 128 GiB, and the maximum is 16 TiB. - -For {hcp-title} clusters, the minimum disk size is 75 GiB, and the maximum is 16,384 GiB. - +ifdef::openshift-rosa[] +For {product-title} clusters version 4.13 or earlier, the minimum disk size is 128 GiB, and the maximum is 1 TiB. For cluster version 4.14 and later, the minimum is 128 GiB, and the maximum is 16 TiB. +endif::openshift-rosa[] +ifdef::openshift-rosa-hcp[] +For {product-title} clusters, the minimum disk size is 75 GiB, and the maximum is 16,384 GiB. +endif::openshift-rosa-hcp[] |--enable-autoscaling |Enable or disable autoscaling of compute nodes. To enable autoscaling, use this argument with the `--min-replicas` and `--max-replicas` arguments. To disable autoscaling, use `--enable-autoscaling=false` with the `--replicas` argument. |--instance-type |The instance type (string) that should be used. Default: `m5.xlarge` -//TODO OSDOCS-10439: Add conditions back when HCP and Classic are published separately -//ifdef::temp-ifdef[] + +ifdef::openshift-rosa-hcp[] a|--kubelet-configs -| For {hcp-title-first} clusters, the names of any `KubeletConfig` objects to apply to nodes in a machine pool. -//endif::[] +|The names of any `KubeletConfig` objects to apply to nodes in a machine pool. +endif::openshift-rosa-hcp[] |--labels |The labels (string) for the machine pool. The format must be a comma-delimited list of key=value pairs. This list overwrites any modifications made to node labels on an ongoing basis. @@ -810,20 +808,18 @@ a|--kubelet-configs |--min-replicas |Specifies the minimum number of compute nodes when enabling autoscaling. -//OSDOCS-11160: HCP only, but need to wait on separate HCP publishing -//ifdef::temp-ifdef[] +ifdef::openshift-rosa-hcp[] |--max-surge -a| For {hcp-title-first} clusters, the `max-surge` parameter defines the number of new nodes that can be provisioned in excess of the desired number of replicas for the machine pool, as configured using the `--replicas` parameter, or as determined by the autoscaler when autoscaling is enabled. This can be an absolute number (for example, `2`) or a percentage of the machine pool size (for example, `20%`), but must use the same unit as the `max-unavailable` parameter. +a| The `max-surge` parameter defines the number of new nodes that can be provisioned in excess of the desired number of replicas for the machine pool, as configured using the `--replicas` parameter, or as determined by the autoscaler when autoscaling is enabled. This can be an absolute number (for example, `2`) or a percentage of the machine pool size (for example, `20%`), but must use the same unit as the `max-unavailable` parameter. The default value is `1`, meaning that the maximum number of nodes in the machine pool during an upgrade is 1 plus the desired number of replicas for the machine pool. In this situation, one excess node can be provisioned before existing nodes need to be made unavailable. The number of nodes that can be provisioned simultaneously during an upgrade is `max-surge` plus `max-unavailable`. |--max-unavailable -a|For {hcp-title-first} clusters, the `max-unavailable` parameter defines the number of nodes that can be made unavailable in a machine pool during an upgrade, before new nodes are provisioned. This can be an absolute number (for example, `2`) or a percentage of the current replica count in the machine pool (for example, `20%`), but must use the same unit as the `max-surge` parameter. +a|The `max-unavailable` parameter defines the number of nodes that can be made unavailable in a machine pool during an upgrade, before new nodes are provisioned. This can be an absolute number (for example, `2`) or a percentage of the current replica count in the machine pool (for example, `20%`), but must use the same unit as the `max-surge` parameter. The default value is `0`, meaning that no outdated nodes are removed before new nodes are provisioned. The valid range for this value is from `0` to the current machine pool size, or from `0%` to `100%`. The total number of nodes that can be upgraded simultaneously during an upgrade is `max-surge` plus `max-unavailable`. -//endif::[] -// end OSDOCS-11160: HCP only, when separate docs are available +endif::openshift-rosa-hcp[] |--name |Required: The name (string) for the machine pool. @@ -832,7 +828,7 @@ The default value is `0`, meaning that no outdated nodes are removed before new |Required when autoscaling is not configured. The number (integer) of machines for this machine pool. |--tags -|Apply user defined tags to all resources created by ROSA in AWS. Tags are comma separated, for example: `'key value, foo bar'`. +|Apply user defined tags to all resources created by {product-title} in AWS. Tags are comma separated, for example: `'key value, foo bar'`. |--taints |Taints for the machine pool. This string value should be formatted as a comma-separated list of `key=value:ScheduleType`. This list will overwrite any modifications made to Node taints on an ongoing basis. @@ -881,7 +877,7 @@ Add a machine pool that is named `mp-1` with 3 replicas of `m5.xlarge` to a clus $ rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1 ---- -Add a machine pool (`mp-1`) to a {hcp-title-first} cluster, configuring 6 replicas and the following upgrade behavior: +Add a machine pool (`mp-1`) to a {product-title} cluster, configuring 6 replicas and the following upgrade behavior: * Allow up to 2 excess nodes to be provisioned during an upgrade. * Ensure that no more than 3 nodes are unavailable during an upgrade. @@ -904,11 +900,11 @@ Add a machine pool with tags to a cluster. ---- $ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --tags='foo bar,bar baz' --name=mp-1 ---- - +ifdef::openshift-rosa-hcp[] [id="rosa-create-network_{context}"] == create network -Create a network that creates any necessary AWS resources through AWS CloudFormation templates. This helper command is intended to help create and configure a VPC for use with {hcp-title}. This command also supports {egress-zero} clusters. +Create a network that creates any necessary AWS resources through AWS CloudFormation templates. This helper command is intended to help create and configure a VPC for use with {product-title}. This command also supports {egress-zero} clusters. [IMPORTANT] ==== @@ -998,7 +994,7 @@ Parameters: Description: CIDR block for the VPC Default: '10.0.0.0/16' ---- - +endif::openshift-rosa-hcp[] [id="rosa-create-ocm-role_{context}"] == create ocm-role diff --git a/modules/rosa-edit-objects.adoc b/modules/rosa-edit-objects.adoc index 6232ae68ed4d..852eaa8fe632 100644 --- a/modules/rosa-edit-objects.adoc +++ b/modules/rosa-edit-objects.adoc @@ -24,10 +24,10 @@ $ rosa edit cluster --cluster= | [arguments] [cols="30,70"] |=== |Option |Definition - +ifdef::openshift-rosa-hcp[] |--additional-allowed-principals |A comma-separated list of additional allowed principal ARNs to be added to the Hosted Control Plane's VPC endpoint service to enable additional VPC endpoint connection requests to be automatically accepted. - +endif::openshift-rosa-hcp[] |--cluster |Required: The name or ID (string) of the cluster to edit. @@ -256,11 +256,10 @@ $ rosa edit machinepool --cluster= [argum |--labels |The labels (string) for the machine pool. The format must be a comma-delimited list of key=value pairs. Editing this value only affects newly created nodes of the machine pool, which are created by increasing the node number, and does not affect the existing nodes. This list overwrites any modifications made to node labels on an ongoing basis. -//TODO OSDOCS-10439: Add conditions back when HCP and Classic are published separately -//ifdef::temp-ifdef[] +ifdef::openshift-rosa-hcp[] a|--kubelet-configs -| For {hcp-title-first} clusters, the names of any `KubeletConfig` objects to apply to nodes in a machine pool. -//endif::[] +| The names of any `KubeletConfig` objects to apply to nodes in a machine pool. +endif::openshift-rosa-hcp[] |--max-replicas |Specifies the maximum number of compute nodes when enabling autoscaling. @@ -268,23 +267,21 @@ a|--kubelet-configs |--min-replicas |Specifies the minimum number of compute nodes when enabling autoscaling. -//OSDOCS-11160: HCP only, but need to wait on separate HCP publishing -//ifdef::temp-ifdef[] +ifdef::openshift-rosa-hcp[] |--max-surge -a| For {hcp-title-first} clusters, the `max-surge` parameter defines the number of new nodes that can be provisioned in excess of the desired number of replicas for the machine pool, as configured using the `--replicas` parameter, or as determined by the autoscaler when autoscaling is enabled. This can be an absolute number (for example, `2`) or a percentage of the machine pool size (for example, `20%`), but must use the same unit as the `max-unavailable` parameter. +a| The `max-surge` parameter defines the number of new nodes that can be provisioned in excess of the desired number of replicas for the machine pool, as configured using the `--replicas` parameter, or as determined by the autoscaler when autoscaling is enabled. This can be an absolute number (for example, `2`) or a percentage of the machine pool size (for example, `20%`), but must use the same unit as the `max-unavailable` parameter. The default value is `1`, meaning that the maximum number of nodes in the machine pool during an upgrade is 1 plus the desired number of replicas for the machine pool. In this situation, one excess node can be provisioned before existing nodes need to be made unavailable. The number of nodes that can be provisioned simultaneously during an upgrade is `max-surge` plus `max-unavailable`. |--max-unavailable -a|For {hcp-title-first} clusters, the `max-unavailable` parameter defines the number of nodes that can be made unavailable in a machine pool during an upgrade, before new nodes are provisioned. This can be an absolute number (for example, `2`) or a percentage of the current replica count in the machine pool (for example, `20%`), but must use the same unit as the `max-surge` parameter. +a|The `max-unavailable` parameter defines the number of nodes that can be made unavailable in a machine pool during an upgrade, before new nodes are provisioned. This can be an absolute number (for example, `2`) or a percentage of the current replica count in the machine pool (for example, `20%`), but must use the same unit as the `max-surge` parameter. The default value is `0`, meaning that no outdated nodes are removed before new nodes are provisioned. The valid range for this value is from `0` to the current machine pool size, or from `0%` to `100%`. The total number of nodes that can be upgraded simultaneously during an upgrade is `max-surge` plus `max-unavailable`. -//endif::[] -// end OSDOCS-11160: HCP only, when separate docs are available -|--node-drain-grace-period -|Specifies the node drain grace period when upgrading or replacing the machine pool. (This is for {hcp-title} clusters only.) +|--node-drain-grace-period +|Specifies the node drain grace period when upgrading or replacing the machine pool. +endif::openshift-rosa-hcp[] |--replicas |Required when autoscaling is not configured. The number (integer) of machines for this machine pool. @@ -339,8 +336,8 @@ Modify the autoscaling range on a machine pool named `mp1` on a cluster named `m ---- $ rosa edit machinepool --max-replicas=9 --cluster=mycluster mp1 ---- - -On {hcp-title-first} clusters, edit the `mp1` machine pool to add the following behavior during upgrades: +ifdef::openshift-rosa-hcp[] +On {product-title} clusters, edit the `mp1` machine pool to add the following behavior during upgrades: * Allow up to 2 excess nodes to be provisioned during an upgrade. * Ensure that no more than 3 nodes are unavailable during an upgrade. @@ -350,9 +347,10 @@ On {hcp-title-first} clusters, edit the `mp1` machine pool to add the following $ rosa edit machinepool --cluster=mycluster mp1 --max-surge=2 --max-unavailable=3 ---- -Associate a `KubeletConfig` object with an existing `high-pid-pool` machine pool on a {hcp-title} cluster. +Associate a `KubeletConfig` object with an existing `high-pid-pool` machine pool on a {product-title} cluster. [source,terminal] ---- $ rosa edit machinepool -c mycluster --kubelet-configs=set-high-pids high-pid-pool ----- \ No newline at end of file +---- +endif::openshift-rosa-hcp[] \ No newline at end of file diff --git a/modules/rosa-initialize.adoc b/modules/rosa-initialize.adoc index 2275e01dd9c3..cedbe85b93b0 100644 --- a/modules/rosa-initialize.adoc +++ b/modules/rosa-initialize.adoc @@ -4,14 +4,14 @@ // * rosa_cli/rosa-get-started-cli.adoc [id="rosa-initialize_{context}"] -= Initializing ROSA += Initializing {product-title} -Use the `init` command to initialize {product-title} (ROSA) only if you are using non-STS. +Use the `init` command to initialize {product-title} only if you are using non-STS. [id="rosa-init_{context}"] == init -Perform a series of checks to verify that you are ready to deploy a ROSA cluster. +Perform a series of checks to verify that you are ready to deploy a {product-title} cluster. The list of checks includes the following: diff --git a/modules/rosa-list-objects.adoc b/modules/rosa-list-objects.adoc index e52fb9d3a1e4..a3c2938ff398 100644 --- a/modules/rosa-list-objects.adoc +++ b/modules/rosa-list-objects.adoc @@ -382,7 +382,7 @@ $ rosa list ingresses --cluster=mycluster == list instance-types -List all of the available instance types for use with ROSA. Availability is based on the account's AWS quota. +List all of the available instance types for use with {product-title}. Availability is based on the account's AWS quota. .Syntax [source,terminal] @@ -853,7 +853,7 @@ a|-c, --cluster \| |Shows help for this command. |--name -a| +a| ifdef::openshift-rosa[] Optional. endif::openshift-rosa[] diff --git a/modules/rosa-parent-commands.adoc b/modules/rosa-parent-commands.adoc index 242e3aadcfba..98dabadd9582 100644 --- a/modules/rosa-parent-commands.adoc +++ b/modules/rosa-parent-commands.adoc @@ -7,7 +7,7 @@ = Parent 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. +The {rosa-cli-first} 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-revoke-objects.adoc b/modules/rosa-revoke-objects.adoc index 50148fdf3586..043f582b4c9b 100644 --- a/modules/rosa-revoke-objects.adoc +++ b/modules/rosa-revoke-objects.adoc @@ -11,7 +11,7 @@ This section describes the `revoke` commands for clusters and resources. [id="rosa-revoke-break-glass-credential_{context}"] == revoke-break-glass-credential -Revokes all break glass credentials from a specified hosted control plane cluster with external authentication enabled. +Revokes all break glass credentials from a specified {product-title} cluster with external authentication enabled. .Syntax [source,terminal] diff --git a/modules/rosa-update-billing-cli.adoc b/modules/rosa-update-billing-cli.adoc index 80eb121d19c5..189105385620 100644 --- a/modules/rosa-update-billing-cli.adoc +++ b/modules/rosa-update-billing-cli.adoc @@ -3,7 +3,7 @@ // * * rosa_cli/rosa-updating-billing-account-cli.adoc :_mod-docs-content-type: PROCEDURE [id="rosa-update-billing_{context}"] -= Update billing accounts for ROSA with HCP clusters += Update billing accounts for {product-title} clusters .Prerequisites diff --git a/modules/rosa-updating-rosa-cli.adoc b/modules/rosa-updating-rosa-cli.adoc index 1b96db5c8f19..3f9b795c6bbd 100644 --- a/modules/rosa-updating-rosa-cli.adoc +++ b/modules/rosa-updating-rosa-cli.adoc @@ -48,7 +48,7 @@ $ sudo mv rosa /usr/local/bin/rosa ---- .Verification -* Verify that the new version of ROSA is installed. +* Verify that the new version of the {rosa-cli} is installed. + [source,terminal] ---- diff --git a/modules/rosa-upgrade-cluster-cli.adoc b/modules/rosa-upgrade-cluster-cli.adoc index 11f2a0f66329..93f9d729d8b5 100644 --- a/modules/rosa-upgrade-cluster-cli.adoc +++ b/modules/rosa-upgrade-cluster-cli.adoc @@ -38,18 +38,16 @@ $ rosa upgrade cluster --cluster= | [arguments] |--schedule-time |The next time the upgrade will run on the specified date in Coordinated Universal Time (UTC). Format: `HH:mm` - -|--node-drain-grace-period ^[1]^ +ifdef::openshift-rosa[] +|--node-drain-grace-period |Sets a grace period (string) for how long the pod disruption budget-protected workloads are respected during upgrades. After this grace period, any workloads protected by pod disruption budgets that have not been successfully drained from a node will be forcibly evicted. Default: `1 hour` - -|--control-plane ^[2]^ +endif::openshift-rosa[] +ifdef::openshift-rosa-hcp[] +|--control-plane |Upgrades the cluster's hosted control plane. +endif::openshift-rosa-hcp[] |=== -[.small] --- -1. Classic clusters only -2. {hcp-title} clusters only --- + .Optional arguments inherited from parent commands [cols="30,70"] @@ -109,16 +107,11 @@ $ rosa delete upgrade --cluster= | |--yes |Automatically answers `yes` to confirm the operation. |=== - +ifdef::openshift-rosa-hcp[] [id="rosa-upgrade-machinepool_{context}"] == upgrade machinepool -Upgrades a specific machine pool configured on a {hcp-title} cluster. - -[NOTE] -==== -The `upgrade` command for machinepools applies to {hcp-title} clusters only. -==== +Upgrades a specific machine pool configured on a {product-title} cluster. .Syntax [source,terminal] @@ -198,7 +191,7 @@ $ rosa delete upgrade --cluster= |--profile |Specifies an AWS profile (string) from your credentials file. |=== - +endif::openshift-rosa-hcp[] //Per wgordon, rosa upgrade roles is not needed for HCP clusters ifndef::openshift-rosa-hcp[] [id="rosa-upgrade-roles_{context}"] @@ -243,12 +236,3 @@ Upgrade roles on a cluster named `mycluster`. $ rosa upgrade roles --cluster=mycluster ---- endif::openshift-rosa-hcp[] - - - -// .Example -// Delete a machine pool named `mymachinepool` on a cluster named `mycluster`. -// [source,terminal] -// ---- -// $ rosa upgrade machinepool --cluster=mycluster --machinepool=mymachinepool -// ---- \ No newline at end of file diff --git a/modules/rosa-using-bash-script.adoc b/modules/rosa-using-bash-script.adoc index 8dbe9e1326fd..8d5e491f6343 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 {product-title} (ROSA) CLI, `rosa`. +This is an example workflow of how to use a Bash script with the {rosa-cli-first}. .Prerequisites Make sure that AWS credentials are available as one of the following options: @@ -18,14 +18,14 @@ Make sure that AWS credentials are available as one of the following options: .Procedure -. Initialize `rosa` using an {cluster-manager-first} offline token link:https://console.redhat.com/openshift/token/rosa[from Red{nbsp}Hat]: +. Initialize `rosa` using a {cluster-manager-first} offline token link:https://console.redhat.com/openshift/token/rosa[from Red{nbsp}Hat]: + [source,terminal] ---- $ rosa init --token= ---- -. Create the ROSA cluster: +. Create the {product-title} cluster: + [source,terminal] ----