$ aws sts get-caller-identity
After you meet the AWS prerequisites, set up your environment and install Red Hat OpenShift Service on AWS (ROSA).
AWS Security Token Service (STS) is the recommended credential mode for installing and interacting with clusters on Red Hat OpenShift Service on AWS (ROSA) because it provides enhanced security.
Before you create a Red Hat OpenShift Service on AWS (ROSA) cluster that uses the AWS Security Token Service (STS), complete the following steps to set up your environment.
Review and complete the deployment prerequisites and policies.
Create a Red Hat account, if you do not already have one. Then, check your email for a verification link. You will need these credentials to install ROSA.
Log in to the Amazon Web Services (AWS) account that you want to use.
It is recommended to use a dedicated AWS account to run production clusters. If you are using AWS Organizations, you can use an AWS account within your organization or create a new one.
If you are using AWS Organizations and you need to have a service control policy (SCP) applied to the AWS account you plan to use, these policies must not be more restrictive than the roles and policies required by the cluster.
Enable the ROSA service in the AWS Management Console.
Install and configure the AWS CLI.
Specify the correct
aws_secret_access_key in the
.aws/credentials file. See AWS Configuration basics in the AWS documentation.
Set a default AWS region.
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 the
rosa command with the
The region set in the
AWS_DEFAULT_REGION environment variable. See Environment variables to configure the AWS CLI in the AWS documentation.
The default region set in your AWS configuration file. See 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 the
rosa command with the
The profile set in the
AWS_PROFILE environment variable. See 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:
$ aws sts get-caller-identity
Install the latest version of the ROSA CLI (
Download the 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.
$ chmod +x rosa
rosa to your path.
$ mv rosa /usr/local/bin/rosa
Enter the following command to verify your installation:
Command line tool for Red Hat OpenShift Service on AWS. For further documentation visit https://access.redhat.com/documentation/en-us/red_hat_openshift_service_on_aws Usage: rosa [command] Available Commands: completion Generates completion scripts create Create a resource from stdin delete Delete a specific resource describe Show details of a specific resource download Download necessary tools for using your cluster edit Edit a specific resource grant Grant role to a specific resource help Help about any command init Applies templates to support Red Hat OpenShift Service on AWS install Installs a resource into a cluster link Link a ocm/user role from stdin list List all resources of a specific type login Log in to your Red Hat account logout Log out logs Show installation or uninstallation logs for a cluster revoke Revoke role from a specific resource uninstall Uninstalls a resource from a cluster unlink UnLink a ocm/user role from stdin upgrade Upgrade a resource verify Verify resources are configured correctly for cluster install version Prints the version of the tool whoami Displays user account information Flags: --color string Surround certain characters with escape sequences to display them in color on the terminal. Allowed options are [auto never always] (default "auto") --debug Enable debug mode. -h, --help help for rosa 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:
$ rosa completion bash | sudo tee /etc/bash_completion.d/rosa
Source the scripts to enable
rosa command completion from your existing terminal. The following example sources the Bash completion scripts for
rosa on a Linux machine:
$ source /etc/bash_completion.d/rosa
Log in to your Red Hat account with the ROSA CLI.
Enter the following command.
$ rosa login
<my_offline_access_token> with your token.
To login to your Red Hat account, get an offline access token at https://console.redhat.com/openshift/token/rosa ? Copy the token and paste it here: <my-offline-access-token>
I: Logged in as '<rh-rosa-user>' on 'https://api.openshift.com'
Verify that your AWS account has the necessary quota to deploy a ROSA cluster.
$ rosa verify quota [--region=<aws_region>]
I: Validating AWS quota... I: AWS quota ok
Sometimes your AWS quota varies by region. If you receive any errors, try a different region.
If you need to increase your quota, go to the AWS Management Console and request a quota increase for the service that failed.
After the quota check succeeds, proceed to the next step.
Prepare your AWS account for cluster deployment:
Run the following command to verify your Red Hat and AWS credentials are setup correctly. Check that your AWS Account ID, Default Region and ARN match what you expect. You can safely ignore the rows beginning with OpenShift Cluster Manager for now.
$ rosa whoami
AWS Account ID: 000000000000 AWS Default Region: us-east-1 AWS ARN: arn:aws:iam::000000000000:user/hello OCM API: https://api.openshift.com OCM Account ID: 1DzGIdIhqEWyt8UUXQhSoWaaaaa OCM Account Name: Your Name OCM Account Username: email@example.com OCM Account Email: firstname.lastname@example.org OCM Organization ID: 1HopHfA2hcmhup5gCr2uH5aaaaa OCM Organization Name: Red Hat OCM Organization External ID: 0000000
Install the OpenShift CLI (
oc), version 4.7.9 or greater, from the ROSA (
Enter this command to download the latest version of the
$ rosa download openshift-client
After downloading the
oc CLI, unzip it and add it to your path.
Enter this command to verify that the
oc CLI is installed correctly:
$ rosa verify openshift-client
After completing these steps, you are ready to set up IAM and OIDC access-based roles.