openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

OSDOCS-2380 ROSA CLI version and download command enhancements Documented changes to the rosa version command output Documented the rosa download rosa command Updated related documentation for consistency and clarity

Browse Source
This commit is contained in:
Laura Bailey
2023-04-17 17:57:02 +10:00
committed by openshift-cherrypick-robot
parent b1ab321fd2
commit 9b42ea17d6
6 changed files with 114 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
modules/rosa-common-commands.adoc
View File

@@ -19,6 +19,17 @@ Enables debug mode for the parent command.
$ rosa create cluster --cluster=<cluster_name> --debug
----
[id="rosa-download_{context}"]
== download
Downloads the latest compatible version of the specified software to the current directory in an archive file. Extract the contents of the archive and add the contents to your path to use the software. To download the latest {product-title} CLI, specify `rosa`. To download the latest OpenShift CLI, specify `oc`.
.Example
[source,terminal]
----
$ rosa download <software>
----
[id="rosa-help_{context}"]
== help
@@ -73,10 +84,18 @@ $ rosa create cluster --cluster=<cluster_name> --v <level>
[id="rosa-version_{context}"]
== version
Displays the `rosa` version.
Displays the `rosa` version and checks whether a newer version is available.
.Example
[source,terminal]
----
$ rosa version [arguments]
----
.Example output
Displayed when a newer version of the `rosa` CLI is available.
[source,terminal]
----
1.2.12
There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
----

42
modules/rosa-configure.adoc
View File

@@ -195,12 +195,37 @@ Verify that the AWS quotas are configured correctly in a specific region:
$ 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`).
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]
----
$ rosa download rosa [arguments]
----
.Optional arguments inherited from parent commands
[cols="30,70"]
|===
|Option |Definition
|--help
|Shows help for this command.
|--debug
|Enables debug mode.
|===
[id="rosa-download-ocp-client_{context}"]
== download oc
Download the latest compatible version of the OpenShift Container Platform CLI (`oc`).
After downloading `oc`, you must unzip the archive and add it to your path.
After you download `oc`, you must extract the contents of the archive and add it to your path.
.Syntax
[source,terminal]
@@ -218,12 +243,6 @@ $ rosa download oc [arguments]
|--debug
|Enables debug mode.
|--profile
|Specifies an AWS profile (string) from your credentials file.
|--v <level>
|The log level for V logs.
|===
.Example
@@ -255,15 +274,6 @@ $ rosa verify oc [arguments]
|--debug
|Enables debug mode.
|--region
|The AWS region (string) in which to run the command. This value overrides the AWS_REGION environment variable.
|--profile
|Specifies an AWS profile (string) from your credentials file.
|--v <level>
|The log level for V logs.
|===
.Example

3
modules/rosa-getting-started-install-configure-cli-tools.adoc
View File

@@ -83,7 +83,8 @@ $ rosa version
.Example output
[source,terminal]
----
1.2.8
1.2.15
Your ROSA CLI is up to date.
----
ifdef::getting-started[]
+

3
modules/rosa-setting-up-cli.adoc
View File

@@ -38,7 +38,8 @@ $ rosa version
.Example output
[source,terminal]
----
1.2.6
1.2.15
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:

63
modules/rosa-updating-rosa-cli.adoc Normal file
View File

@@ -0,0 +1,63 @@
// Module included in the following assemblies:
//
// * rosa_cli/rosa-get-started-cli.adoc
:_content-type: PROCEDURE
[id="rosa-updating-the-rosa-cli_{context}"]
= Updating the ROSA CLI
Update to the latest compatible version of the {product-title} CLI.
.Procedure
. Confirm that a new version of the ROSA CLI is available:
+
[source,terminal]
----
$ rosa version
----
+
.Example output
[source,terminal]
----
1.2.12
There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
----
. Download the latest compatible version of the ROSA CLI:
+
[source,terminal]
----
$ rosa download rosa
----
+
This command downloads an archive called `rosa-*.tar.gz` into the current directory. The exact name of the file depends on your operating system and system architecture.
. Extract the contents of the archive:
+
[source,terminal]
----
$ 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:
+
[source,terminal]
----
$ sudo mv rosa /usr/local/bin/rosa
----
.Verification
* Verify that the new version of ROSA is installed.
+
[source,terminal]
----
$ rosa version
----
+
.Example output
[source,terminal]
----
1.2.15
Your ROSA CLI is up to date.
----

1
rosa_cli/rosa-get-started-cli.adoc
View File

@@ -12,3 +12,4 @@ include::modules/rosa-setting-up-cli.adoc[leveloffset=+1]
include::modules/rosa-configure.adoc[leveloffset=+1]
include::modules/rosa-initialize.adoc[leveloffset=+1]
include::modules/rosa-using-bash-script.adoc[leveloffset=+1]
include::modules/rosa-updating-rosa-cli.adoc[leveloffset=+1]