Skip to content

Commit 3667cd8

Browse files
authored
Merge pull request #73350 from mletalie/OSDOCS-9995
[OSDOCS-9995]: Add AWS CLI requirement to "Getting started with the ROSA CLI" topic in ROSA docs
2 parents 5d7e5b6 + b773eea commit 3667cd8

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Specify your `aws_access_key_id`, `aws_secret_access_key`, and `region` in the `
4444
+
4545
[NOTE]
4646
====
47-
You can alternatively use the `AWS_DEFAULT_REGION` environment variable to set the default AWS region.
47+
You can optionally use the `AWS_DEFAULT_REGION` environment variable to set the default AWS region.
4848
====
4949
.. Query the AWS API to verify if the AWS CLI is installed and configured correctly:
5050
+

modules/rosa-setting-up-cli.adoc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,28 @@ Use the following steps to install and configure the ROSA CLI (`rosa`) on your i
1212

1313
.Procedure
1414

15+
. Install and configure the latest AWS CLI (`aws`).
16+
.. Follow the link:https://aws.amazon.com/cli/[AWS Command Line Interface] documentation to install and configure the AWS CLI for your operating system.
17+
+
18+
Specify your `aws_access_key_id`, `aws_secret_access_key`, and `region` in the `.aws/credentials` file. See link:https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html[AWS Configuration basics] in the AWS documentation.
19+
+
20+
[NOTE]
21+
====
22+
You can optionally use the `AWS_DEFAULT_REGION` environment variable to set the default AWS region.
23+
====
24+
.. Query the AWS API to verify if the AWS CLI is installed and configured correctly:
25+
+
26+
[source,terminal]
27+
----
28+
$ aws sts get-caller-identity --output text
29+
----
30+
+
31+
.Example output
32+
[source,terminal]
33+
----
34+
<aws_account_id> arn:aws:iam::<aws_account_id>:user/<username> <aws_user_id>
35+
----
36+
1537
. 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}.
1638

1739
. Extract the `rosa` binary file from the downloaded archive. The following example extracts the binary from a Linux tar archive:

0 commit comments

Comments
 (0)