Chapter 1. Getting started with the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa

Procedure

1. Download the latest version of the ROSA CLI (rosa) for your operating system from the Downloads page on OpenShift Cluster Manager.

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

   $ tar xvf rosa-linux.tar.gz

3. Add rosa to your path. In the following example, the /usr/local/bin directory is included in the path of the user:

   $ sudo mv rosa /usr/local/bin/rosa

4. Verify if the ROSA CLI is installed correctly by querying the rosa version:

   $ rosa version

   Example output

   1.2.15
   Your ROSA CLI is up to date.

5. 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:

     1. Generate a rosa tab completion configuration file for Bash and save it to your /etc/bash_completion.d/ directory:

        # rosa completion bash > /etc/bash_completion.d/rosa

     2. Open a new terminal to activate the configuration.

   • To enable persistent tab completion for Bash on a macOS host:

     1. Generate a rosa tab completion configuration file for Bash and save it to your /usr/local/etc/bash_completion.d/ directory:

        $ rosa completion bash > /usr/local/etc/bash_completion.d/rosa

     2. Open a new terminal to activate the configuration.

   • To enable persistent tab completion for Zsh:

     1. If tab completion is not enabled for your Zsh environment, enable it by running the following command:

        $ echo "autoload -U compinit; compinit" >> ~/.zshrc

     2. Generate a rosa tab completion configuration file for Zsh and save it to the first directory in your functions path:

        $ rosa completion zsh > "${fpath[1]}/_rosa"

     3. Open a new terminal to activate the configuration.

   • To enable persistent tab completion for fish:

     1. Generate a rosa tab completion configuration file for fish and save it to your ~/.config/fish/completions/ directory:

        $ rosa completion fish > ~/.config/fish/completions/rosa.fish

     2. Open a new terminal to activate the configuration.

   • To enable persistent tab completion for PowerShell:

     1. Generate a rosa tab completion configuration file for PowerShell and save it to a file named rosa.ps1:

        PS> rosa completion powershell | Out-String | Invoke-Expression

     2. Source the rosa.ps1 file from your PowerShell profile.
   Note

   For more information about configuring rosa tab completion, see the help menu by running the rosa completion --help command.

Procedure

1. Initialize rosa using an Red Hat OpenShift Cluster Manager offline token from Red Hat:

   $ rosa init --token=<token>

2. Create the Red Hat OpenShift Service on AWS (ROSA) cluster:

   $ rosa create cluster --cluster-name=<cluster_name>

3. Add an identity provider (IDP):

   $ rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]

4. Add a dedicated-admin user:

   $ rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>

Procedure

1. Confirm that a new version of the ROSA CLI (rosa) is available:

   $ rosa version

   Example output

   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/

2. Download the latest compatible version of the ROSA CLI:

   $ 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.

3. Extract the contents of the archive:

   $ tar -xzf rosa-linux.tar.gz

4. 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:

   $ sudo mv rosa /usr/local/bin/rosa