Red Hat SummitROSA CLI
Learning how to use the command-line tools for Red Hat OpenShift Service on AWS
Abstract
Chapter 1. Getting started with the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa
Setup and basic usage of the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa.
1.1. About the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa
Use the rosa command-line utility for Red Hat OpenShift Service on AWS (ROSA) to create, update, manage, and delete Red Hat OpenShift Service on AWS clusters and resources.
1.2. Setting up the ROSA CLI
Use the following steps to install and configure the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa, on your installation host.
Procedure
-
Download the latest version of the ROSA CLI (
rosa) for your operating system from the Downloads page on OpenShift Cluster Manager. Extract the
rosabinary file from the downloaded archive. The following example extracts the binary from a Linux tar archive:tar xvf rosa-linux.tar.gz
$ tar xvf rosa-linux.tar.gzCopy to Clipboard Copied! Toggle word wrap Toggle overflow Add
rosato your path. In the following example, the/usr/local/bindirectory is included in the path of the user:sudo mv rosa /usr/local/bin/rosa
$ sudo mv rosa /usr/local/bin/rosaCopy to Clipboard Copied! Toggle word wrap Toggle overflow Verify if the ROSA CLI is installed correctly by querying the
rosaversion:rosa version
$ rosa versionCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
1.2.15 Your ROSA CLI is up to date.
1.2.15 Your ROSA CLI is up to date.Copy to Clipboard Copied! Toggle word wrap Toggle overflow Optional: Enable tab completion for the ROSA CLI. With tab completion enabled, you can press the
Tabkey twice to automatically complete subcommands and receive command suggestions:To enable persistent tab completion for Bash on a Linux host:
Generate a
rosatab completion configuration file for Bash and save it to your/etc/bash_completion.d/directory:rosa completion bash > /etc/bash_completion.d/rosa
# rosa completion bash > /etc/bash_completion.d/rosaCopy to Clipboard Copied! Toggle word wrap Toggle overflow - Open a new terminal to activate the configuration.
To enable persistent tab completion for Bash on a macOS host:
Generate a
rosatab 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
$ rosa completion bash > /usr/local/etc/bash_completion.d/rosaCopy to Clipboard Copied! Toggle word wrap Toggle overflow - Open a new terminal to activate the configuration.
To enable persistent tab completion for Zsh:
If tab completion is not enabled for your Zsh environment, enable it by running the following command:
echo "autoload -U compinit; compinit" >> ~/.zshrc
$ echo "autoload -U compinit; compinit" >> ~/.zshrcCopy to Clipboard Copied! Toggle word wrap Toggle overflow Generate a
rosatab completion configuration file for Zsh and save it to the first directory in your functions path:rosa completion zsh > "${fpath[1]}/_rosa"$ rosa completion zsh > "${fpath[1]}/_rosa"Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Open a new terminal to activate the configuration.
To enable persistent tab completion for fish:
Generate a
rosatab completion configuration file for fish and save it to your~/.config/fish/completions/directory:rosa completion fish > ~/.config/fish/completions/rosa.fish
$ rosa completion fish > ~/.config/fish/completions/rosa.fishCopy to Clipboard Copied! Toggle word wrap Toggle overflow - Open a new terminal to activate the configuration.
To enable persistent tab completion for PowerShell:
Generate a
rosatab completion configuration file for PowerShell and save it to a file namedrosa.ps1:PS> rosa completion powershell | Out-String | Invoke-Expression
PS> rosa completion powershell | Out-String | Invoke-ExpressionCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
Source the
rosa.ps1file from your PowerShell profile.
NoteFor more information about configuring
rosatab completion, see the help menu by running therosa completion --helpcommand.
1.3. Configuring the ROSA CLI
Use the following commands to configure the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa.
1.3.1. login
Log in to your Red Hat account, saving the credentials to the rosa configuration file. You must provide a token when logging in. You can copy your token from the Red Hat OpenShift Service on AWS token page.
The ROSA CLI (rosa) looks for a token in the following priority order:
- Command-line arguments
-
The
ROSA_TOKENenvironment variable -
The
rosaconfiguration file - Interactively from a command-line prompt
Syntax
rosa login [arguments]
$ rosa login [arguments]| Option | Definition |
|---|---|
| --client-id |
The OpenID client identifier (string). Default: |
| --client-secret | The OpenID client secret (string). |
| --insecure | Enables insecure communication with the server. This disables verification of TLS certificates and host names. |
| --scope |
The OpenID scope (string). If this option is used, it replaces the default scopes. This can be repeated multiple times to specify multiple scopes. Default: |
| --token | Accesses or refreshes the token (string). |
| --token-url |
The OpenID token URL (string). Default: |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
1.3.2. logout
Log out of rosa. Logging out also removes the rosa configuration file.
Syntax
rosa logout [arguments]
$ rosa logout [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
1.3.3. verify permissions
Verify that the AWS permissions required to create a ROSA cluster are configured correctly:
Syntax
rosa verify permissions [arguments]
$ rosa verify permissions [arguments]This command verifies permissions only for clusters that do not use the AWS Security Token Service (STS).
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --region |
The AWS region (string) in which to run the command. This value overrides the |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Verify that the AWS permissions are configured correctly:
rosa verify permissions
$ rosa verify permissionsVerify that the AWS permissions are configured correctly in a specific region:
rosa verify permissions --region=us-west-2
$ rosa verify permissions --region=us-west-21.3.4. verify quota
Verifies that AWS quotas are configured correctly for your default region.
Syntax
rosa verify quota [arguments]
$ rosa verify quota [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --region |
The AWS region (string) in which to run the command. This value overrides the |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Verify that the AWS quotas are configured correctly for the default region:
rosa verify quota
$ rosa verify quotaVerify that the AWS quotas are configured correctly in a specific region:
rosa verify quota --region=us-west-2
$ rosa verify quota --region=us-west-21.3.5. download rosa
Download the latest compatible version of the ROSA CLI.
After you download rosa, extract the contents of the archive and add it to your path. See Setting up the ROSA CLI for more details.
Syntax
rosa download rosa [arguments]
$ rosa download rosa [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
1.3.6. download oc
Download the latest compatible version of the OpenShift Container Platform CLI (oc).
After you download oc, you must extract the contents of the archive and add it to your path.
Syntax
rosa download oc [arguments]
$ rosa download oc [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
Example
Download oc client tools:
rosa download oc
$ rosa download oc1.3.7. verify oc
Verifies that the OpenShift Container Platform CLI (oc) is installed correctly.
Syntax
rosa verify oc [arguments]
$ rosa verify oc [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
Example
Verify oc client tools:
rosa verify oc
$ rosa verify oc1.4. Initializing Red Hat OpenShift Service on AWS
Use the init command to initialize Red Hat OpenShift Service on AWS (ROSA) only if you are using non-STS.
1.4.1. init
Perform a series of checks to verify that you are ready to deploy an Red Hat OpenShift Service on AWS cluster.
The list of checks includes the following:
-
Checks to see that you have logged in (see
login) - Checks that your AWS credentials are valid
-
Checks that your AWS permissions are valid (see
verify permissions) -
Checks that your AWS quota levels are high enough (see
verify quota) - Runs a cluster simulation to ensure cluster creation will perform as expected
-
Checks that the
osdCcsAdminuser has been created in your AWS account - Checks that the OpenShift Container Platform command-line tool is available on your system
Syntax
rosa init [arguments]
$ rosa init [arguments]| Option | Definition |
|---|---|
| --region |
The AWS region (string) in which to verify quota and permissions. This value overrides the |
| --delete |
Deletes the stack template that is applied to your AWS account during the |
| --client-id |
The OpenID client identifier (string). Default: |
| --client-secret | The OpenID client secret (string). |
| --insecure | Enables insecure communication with the server. This disables verification of TLS certificates and host names. |
| --scope |
The OpenID scope (string). If this option is used, it completely replaces the default scopes. This can be repeated multiple times to specify multiple scopes. Default: |
| --token | Accesses or refreshes the token (string). |
| --token-url |
The OpenID token URL (string). Default: |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Configure your AWS account to allow ROSA clusters:
rosa init
$ rosa initConfigure a new AWS account using pre-existing OpenShift Cluster Manager credentials:
rosa init --token=$OFFLINE_ACCESS_TOKEN
$ rosa init --token=$OFFLINE_ACCESS_TOKEN1.5. Using a Bash script
This is an example workflow of how to use a Bash script with the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa.
Prerequisites
Make sure that AWS credentials are available as one of the following options:
- AWS profile
-
Environment variables (
AWS_ACCESS_KEY_ID,AWS_SECRET_ACCESS_KEY)
Procedure
Initialize
rosausing an Red Hat OpenShift Cluster Manager offline token from Red Hat:rosa init --token=<token>
$ rosa init --token=<token>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the Red Hat OpenShift Service on AWS (ROSA) cluster:
rosa create cluster --cluster-name=<cluster_name>
$ rosa create cluster --cluster-name=<cluster_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add an identity provider (IDP):
rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]
$ rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add a
dedicated-adminuser:rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>
$ rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.6. Updating the ROSA CLI
Update to the latest compatible version of the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa.
Procedure
Confirm that a new version of the ROSA CLI (
rosa) is available:rosa version
$ rosa versionCopy to Clipboard Copied! Toggle word wrap Toggle overflow 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/
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/Copy to Clipboard Copied! Toggle word wrap Toggle overflow Download the latest compatible version of the ROSA CLI:
rosa download rosa
$ rosa download rosaCopy to Clipboard Copied! Toggle word wrap Toggle overflow This command downloads an archive called
rosa-*.tar.gzinto the current directory. The exact name of the file depends on your operating system and system architecture.Extract the contents of the archive:
tar -xzf rosa-linux.tar.gz
$ tar -xzf rosa-linux.tar.gzCopy to Clipboard Copied! Toggle word wrap Toggle overflow Install the new version of the ROSA CLI by moving the extracted file into your path. In the following example, the
/usr/local/bindirectory is included in the path of the user:sudo mv rosa /usr/local/bin/rosa
$ sudo mv rosa /usr/local/bin/rosaCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Verify that the new version of ROSA is installed.
rosa version
$ rosa versionCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
1.2.15 Your ROSA CLI is up to date.
1.2.15 Your ROSA CLI is up to date.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 2. Managing objects with the ROSA CLI
Managing objects with the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa, such as adding dedicated-admin users, managing clusters, and scheduling cluster upgrades.
2.1. Common commands and arguments
These common commands and arguments are available for the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa.
2.1.1. debug
Enables debug mode for the parent command to help with troubleshooting.
Example
rosa create cluster --cluster-name=<cluster_name> --debug
$ rosa create cluster --cluster-name=<cluster_name> --debug2.1.2. 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 Red Hat OpenShift Service on AWS CLI, specify rosa. To download the latest OpenShift CLI, specify oc.
Example
rosa download <software>
$ rosa download <software>2.1.3. help
Displays general help information for the ROSA CLI (rosa) and a list of available commands. This option can also be used as an argument to display help information for a parent command, such as version or create.
Examples
Displays general help for the ROSA CLI.
rosa --help
$ rosa --help
Displays general help for version.
rosa version --help
$ rosa version --help2.1.4. interactive
Enables interactive mode.
Example
rosa create cluster --cluster-name=<cluster_name> --interactive
$ rosa create cluster --cluster-name=<cluster_name> --interactive2.1.5. profile
Specifies an AWS profile from your credential file.
Example
rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile
$ rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile2.1.6. version
Displays the rosa version and checks whether a newer version is available.
Example
rosa version [arguments]
$ rosa version [arguments]Example output
Displayed when a newer version of the ROSA CLI is available.
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/
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.2. Parent commands
The Red Hat OpenShift Service on AWS (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.
2.2.1. create
Creates an object or resource when paired with a child command.
Example
rosa create cluster --cluster-name=mycluster
$ rosa create cluster --cluster-name=mycluster2.2.2. edit
Edits options for an object, such as making a cluster private.
Example
rosa edit cluster --cluster=mycluster --private
$ rosa edit cluster --cluster=mycluster --private2.2.3. delete
Deletes an object or resource when paired with a child command.
Example
rosa delete ingress --cluster=mycluster
$ rosa delete ingress --cluster=mycluster2.2.4. list
Lists clusters or resources for a specific cluster.
Example
rosa list users --cluster=mycluster
$ rosa list users --cluster=mycluster2.2.5. describe
Shows the details for a cluster.
Example
rosa describe cluster --cluster=mycluster
$ rosa describe cluster --cluster=mycluster2.3. Create objects
This section describes the create commands for clusters and resources.
2.3.1. create account-roles
Create the required account-wide role and policy resources for your cluster.
Syntax
rosa create account-roles [flags]
$ rosa create account-roles [flags]| Option | Definition |
|---|---|
| --debug | Enable debug mode. |
| -i, --interactive | Enable interactive mode. |
| -m, --mode string | How to perform the operation. Valid options are:
|
| --path string | The ARN path for the account-wide roles and policies, including the Operator policies. |
| --permissions-boundary string | The ARN of the policy that is used to set the permissions boundary for the account roles. |
| --prefix string |
User-defined prefix for all generated AWS resources. The default is |
| --profile string | Use a specific AWS profile from your credential file. |
| -y, --yes | Automatically answer yes to confirm operations. |
2.3.2. create admin
Create a cluster administrator with an automatically generated password that can log in to a cluster.
Syntax
rosa create admin --cluster=<cluster_name>|<cluster_id>
$ rosa create admin --cluster=<cluster_name>|<cluster_id>| Option | Definition |
|---|---|
| --cluster <cluster_name>|<cluster_id> | Required. The name or ID (string) of the cluster to add to the identity provider (IDP). |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile string | Specifies an AWS profile from your credentials file. |
Example
Create a cluster administrator that can log in to a cluster named mycluster.
rosa create admin --cluster=mycluster
$ rosa create admin --cluster=mycluster2.3.3. create cluster
Create a new cluster.
Syntax
rosa create cluster --cluster-name=<cluster_name> [arguments]
$ rosa create cluster --cluster-name=<cluster_name> [arguments]| Option | Definition |
|---|---|
| --cluster-name <cluster_name> |
Required. The name of the cluster. When used with the |
| --compute-machine-type <instance_type> | The instance type for compute nodes in the cluster. This determines the amount of memory and vCPU that is allocated to each compute node. For more information on valid instance types, see AWS Instance types in Red Hat OpenShift Service on AWS service definition. |
| --compute-nodes n |
The number of worker nodes to provision per availability zone. Single-zone clusters require at least 2 nodes. Multi-zone clusters require at least 3 nodes. Default: |
| --controlplane-iam-role <arn> | The Amazon Resource Name (ARN) of the IAM role to attach to control plane instances. |
| --disable-scp-checks | Indicates whether cloud permission checks are disabled when attempting to install a cluster. |
| --dry-run | Simulates creating the cluster. |
| --enable-autoscaling |
Enables autoscaling of compute nodes. By default, autoscaling is set to |
| --host-prefix <subnet> |
The subnet prefix length to assign to each individual node, as an integer. For example, if host prefix is set to |
| --machine-cidr <address_block> |
Block of IP addresses (ipNet) used by Red Hat OpenShift Service on AWS while installing the cluster, for example, Important
OVN-Kubernetes, the default network provider in Red Hat OpenShift Service on AWS 4.11 and later, uses the |
| --max-replicas <number_of_nodes> |
Specifies the maximum number of compute nodes when enabling autoscaling. Default: |
| --min-replicas <number_of_nodes> |
Specifies the minimum number of compute nodes when enabling autoscaling. Default: |
| --multi-az | Deploys to multiple data centers. |
| --operator-roles-prefix <string> | Prefix to use for all IAM roles used by the operators needed in the OpenShift installer. A prefix is generated automatically if you do not specify one. |
| --pod-cidr <address_block> |
Block of IP addresses (ipNet) from which pod IP addresses are allocated, for example, Important
OVN-Kubernetes, the default network provider in Red Hat OpenShift Service on AWS 4.11 and later, uses the |
| --private | Restricts primary API endpoint and application routes to direct, private connectivity. |
| --private-link |
Specifies to use AWS PrivateLink to provide private connectivity between VPCs and services. The |
| --region <region_name> |
The name of the AWS region where your worker pool will be located, for example, |
| --role-arn <arn> | The Amazon Resource Name (ARN) of the installer role that OpenShift Cluster Manager uses to create the cluster. This is required if you have not already created account roles. |
| --service-cidr <address_block> |
Block of IP addresses (ipNet) for services, for example, Important
OVN-Kubernetes, the default network provider in Red Hat OpenShift Service on AWS 4.11 and later, uses the |
| --sts | --non-sts | Specifies whether to use AWS Security Token Service (STS) or IAM credentials (non-STS) to deploy your cluster. |
| --subnet-ids <aws_subnet_id> |
The AWS subnet IDs to use when installing the cluster, for example,
When using |
| --support-role-arn string | The Amazon Resource Name (ARN) of the role used by Red Hat Site Reliabilty Engineers (SREs) to enable access to the cluster account to provide support. |
| --version string |
The version of Red Hat OpenShift Service on AWS that will be used to install the cluster or cluster resources. For |
| --worker-iam-role string | The Amazon Resource Name (ARN) of the IAM role that will be attached to compute instances. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Create a cluster named mycluster.
rosa create cluster --cluster-name=mycluster
$ rosa create cluster --cluster-name=myclusterCreate a cluster with a specific AWS region.
rosa create cluster --cluster-name=mycluster --region=us-east-2
$ rosa create cluster --cluster-name=mycluster --region=us-east-2Create 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
$ rosa create cluster --cluster-name=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=52.3.4. create idp
Add an identity provider (IDP) to define how users log in to a cluster.
Syntax
rosa create idp --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa create idp --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster <cluster_name>|<cluster_id> | Required. The name or ID of the cluster to which the IDP will be added. |
| --ca <path_to_file> |
The path to the PEM-encoded certificate file to use when making requests to the server, for example, |
| --client-id | The client ID (string) from the registered application. |
| --client-secret | The client secret (string) from the registered application. |
| --mapping-method |
Specifies how new identities (string) are mapped to users when they log in. Default: |
| --name | The name (string) for the identity provider. |
| --type |
The type (string) of identity provider. Options: |
| Option | Definition |
|---|---|
| --hostname | The optional domain (string) to use with a hosted instance of GitHub Enterprise. |
| --organizations | Specifies the organizations for login access. Only users that are members of at least one of the listed organizations (string) are allowed to log in. |
| --teams |
Specifies the teams for login access. Only users that are members of at least one of the listed teams (string) are allowed to log in. The format is |
| Option | Definition |
|---|---|
| --host-url |
The host URL (string) of a GitLab provider. Default: |
| Option | Definition |
|---|---|
| --hosted-domain | Restricts users to a Google Apps domain (string). |
| Option | Definition |
|---|---|
| --bind-dn | The domain name (string) to bind with during the search phase. |
| --bind-password | The password (string) to bind with during the search phase. |
| --email-attributes | The list (string) of attributes whose values should be used as the email address. |
| --id-attributes |
The list (string) of attributes whose values should be used as the user ID. Default: |
| --insecure | Does not make TLS connections to the server. |
| --name-attributes |
The list (string) of attributes whose values should be used as the display name. Default: |
| --url | An RFC 2255 URL (string) which specifies the LDAP search parameters to use. |
| --username-attributes |
The list (string) of attributes whose values should be used as the preferred username. Default: |
| Option | Definition |
|---|---|
| --email-claims | The list (string) of claims to use as the email address. |
| --extra-scopes |
The list (string) of scopes to request, in addition to the |
| --issuer-url | The URL (string) that the OpenID provider asserts as the issuer identifier. It must use the HTTPS scheme with no URL query parameters or fragment. |
| --name-claims | The list (string) of claims to use as the display name. |
| --username-claims | The list (string) of claims to use as the preferred username when provisioning a user. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Add a GitHub identity provider to a cluster named mycluster.
rosa create idp --type=github --cluster=mycluster
$ rosa create idp --type=github --cluster=myclusterAdd an identity provider following interactive prompts.
rosa create idp --cluster=mycluster --interactive
$ rosa create idp --cluster=mycluster --interactive2.3.5. create ingress
Add an ingress endpoint to enable API access to the cluster.
Syntax
rosa create ingress --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa create ingress --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster <cluster_name>|<cluster_id> | Required: The name or ID of the cluster to which the ingress will be added. |
| --label-match | The label match (string) for ingress. The format must be a comma-delimited list of key=value pairs. If no label is specified, all routes are exposed on both routers. |
| --private | Restricts application route to direct, private connectivity. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Add an internal ingress to a cluster named mycluster.
rosa create ingress --private --cluster=mycluster
$ rosa create ingress --private --cluster=mycluster
Add a public ingress to a cluster named mycluster.
rosa create ingress --cluster=mycluster
$ rosa create ingress --cluster=myclusterAdd an ingress with a route selector label match.
rosa create ingress --cluster=mycluster --label-match=foo=bar,bar=baz
$ rosa create ingress --cluster=mycluster --label-match=foo=bar,bar=baz2.3.6. create machinepool
Add a machine pool to an existing cluster.
Syntax
rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<number> --name=<machinepool_name> [arguments]
$ rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<number> --name=<machinepool_name> [arguments]| Option | Definition |
|---|---|
| --cluster <cluster_name>|<cluster_id> | Required: The name or ID of the cluster to which the machine pool will be added. |
| --enable-autoscaling |
Enable or disable autoscaling of compute nodes. To enable autoscaling, use this argument with the |
| --instance-type |
The instance type (string) that should be used. Default: |
| --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. |
| --max-replicas | Specifies the maximum number of compute nodes when enabling autoscaling. |
| --min-replicas | Specifies the minimum number of compute nodes when enabling autoscaling. |
| --name | Required: The name (string) for the machine pool. |
| --replicas | Required when autoscaling is not configured. The number (integer) of machines for this machine pool. |
| --taints |
Taints for the machine pool. This string value should be formatted as a comma-separated list of |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Interactively add a machine pool to a cluster named mycluster.
rosa create machinepool --cluster=mycluster --interactive
$ rosa create machinepool --cluster=mycluster --interactive
Add a machine pool that is named mp-1 to a cluster with autoscaling enabled.
rosa create machinepool --cluster=mycluster --enable-autoscaling --min-replicas=2 --max-replicas=5 --name=mp-1
$ rosa create machinepool --cluster=mycluster --enable-autoscaling --min-replicas=2 --max-replicas=5 --name=mp-1
Add a machine pool that is named mp-1 with 3 replicas of m5.xlarge to a cluster.
rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1
$ rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1Add a machine pool with labels to a cluster.
rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-1
$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-12.3.7. create ocm-role
Create the required ocm-role resources for your cluster.
Syntax
rosa create ocm-role [flags]
$ rosa create ocm-role [flags]| Option | Definition |
|---|---|
| --admin | Enable admin capabilities for the role. |
| --debug | Enable debug mode. |
| -i, --interactive | Enable interactive mode. |
| -m, --mode string | How to perform the operation. Valid options are:
|
| --path string | The ARN path for the OCM role and policies. |
| --permissions-boundary string | The ARN of the policy that is used to set the permissions boundary for the OCM role. |
| --prefix string |
User-defined prefix for all generated AWS resources. The default is |
| --profile string | Use a specific AWS profile from your credential file. |
| -y, --yes | Automatically answer yes to confirm operation. |
For more information about the OCM role created with the rosa create ocm-role command, see Account-wide IAM role and policy reference.
2.3.8. create user-role
Create the required user-role resources for your cluster.
Syntax
rosa create user-role [flags]
$ rosa create user-role [flags]| Option | Definition |
|---|---|
| --debug | Enable debug mode. |
| -i, --interactive | Enable interactive mode. |
| -m, --mode string | How to perform the operation. Valid options are:
|
| --path string | The ARN path for the user role and policies. |
| --permissions-boundary string | The ARN of the policy that is used to set the permissions boundary for the user role. |
| --prefix string |
User-defined prefix for all generated AWS resources The default is |
| --profile string | Use a specific AWS profile from your credential file. |
| -y, --yes | Automatically answer yes to confirm operation. |
For more information about the user role created with the rosa create user-role command, see Understanding AWS account association.
2.5. Edit objects
This section describes the edit commands for clusters and resources.
2.5.1. edit cluster
Allows edits to an existing cluster.
Syntax
rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa edit cluster --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster to edit. |
| --private | Restricts a primary API endpoint to direct, private connectivity. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Edit a cluster named mycluster to make it private.
rosa edit cluster --cluster=mycluster --private
$ rosa edit cluster --cluster=mycluster --private
Edit all cluster options interactively on a cluster named mycluster.
rosa edit cluster --cluster=mycluster --interactive
$ rosa edit cluster --cluster=mycluster --interactive2.5.2. edit ingress
Edits the additional non-default application router for a cluster.
Syntax
rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa edit ingress --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster to which the ingress will be added. |
| --label-match | The label match (string) for ingress. The format must be a comma-delimited list of key=value pairs. If no label is specified, all routes are exposed on both routers. |
| --private | Restricts the application route to direct, private connectivity. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Make an additional ingress with the ID a1b2 as a private connection on a cluster named mycluster.
rosa edit ingress --private --cluster=mycluster a1b2
$ rosa edit ingress --private --cluster=mycluster a1b2
Update the router selectors for the additional ingress with the ID a1b2 on a cluster named mycluster.
rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2
$ rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2
Update the default ingress using the sub-domain identifier apps on a cluster named mycluster.
rosa edit ingress --private=false --cluster=mycluster apps
$ rosa edit ingress --private=false --cluster=mycluster apps2.5.3. edit machinepool
Allows edits to the machine pool in a cluster.
Syntax
rosa edit machinepool --cluster=<cluster_name> | <cluster_id> <machinepool_ID> [arguments]
$ rosa edit machinepool --cluster=<cluster_name> | <cluster_id> <machinepool_ID> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster to edit on which the additional machine pool will be edited. |
| --enable-autoscaling |
Enable or disable autoscaling of compute nodes. To enable autoscaling, use this argument with the |
| --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. |
| --max-replicas | Specifies the maximum number of compute nodes when enabling autoscaling. |
| --min-replicas | Specifies the minimum number of compute nodes when enabling autoscaling. |
| --replicas | Required when autoscaling is not configured. The number (integer) of machines for this machine pool. |
| --taints |
Taints for the machine pool. This string value should be formatted as a comma-separated list of |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Set 4 replicas on a machine pool named mp1 on a cluster named mycluster.
rosa edit machinepool --cluster=mycluster --replicas=4 --name=mp1
$ rosa edit machinepool --cluster=mycluster --replicas=4 --name=mp1
Enable autoscaling on a machine pool named mp1 on a cluster named mycluster.
rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 --name=mp1
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 --name=mp1
Disable autoscaling on a machine pool named mp1 on a cluster named mycluster.
rosa edit machinepool --cluster=mycluster --enable-autoscaling=false --replicas=3 --name=mp1
$ rosa edit machinepool --cluster=mycluster --enable-autoscaling=false --replicas=3 --name=mp1
Modify the autoscaling range on a machine pool named mp1 on a cluster named mycluster.
rosa edit machinepool --max-replicas=9 --cluster=mycluster --name=mp1
$ rosa edit machinepool --max-replicas=9 --cluster=mycluster --name=mp12.6. Delete objects
This section describes the delete commands for clusters and resources.
2.6.1. delete admin
Deletes a cluster administrator from a specified cluster.
Syntax
rosa delete admin --cluster=<cluster_name> | <cluster_id>
$ rosa delete admin --cluster=<cluster_name> | <cluster_id>| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster to add to the identity provider (IDP). |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
Delete a cluster administrator from a cluster named mycluster.
rosa delete admin --cluster=mycluster
$ rosa delete admin --cluster=mycluster2.6.2. delete cluster
Deletes a cluster.
Syntax
rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa delete cluster --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster to delete. |
| --watch | Watches the cluster uninstallation logs. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
| --yes |
Automatically answers |
Examples
Delete a cluster named mycluster.
rosa delete cluster --cluster=mycluster
$ rosa delete cluster --cluster=mycluster2.6.3. delete idp
Deletes a specific identity provider (IDP) from a cluster.
Syntax
rosa delete idp --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa delete idp --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster from which the IDP will be deleted. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
| --yes |
Automatically answers |
Example
Delete an identity provider named github from a cluster named mycluster.
rosa delete idp github --cluster=mycluster
$ rosa delete idp github --cluster=mycluster2.6.4. delete ingress
Deletes a non-default application router (ingress) from a cluster.
Syntax
rosa delete ingress --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa delete ingress --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster from which the ingress will be deleted. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
| --yes |
Automatically answers |
Examples
Delete an ingress with the ID a1b2 from a cluster named mycluster.
rosa delete ingress --cluster=mycluster a1b2
$ rosa delete ingress --cluster=mycluster a1b2
Delete a secondary ingress with the subdomain name apps2 from a cluster named mycluster.
rosa delete ingress --cluster=mycluster apps2
$ rosa delete ingress --cluster=mycluster apps22.6.5. delete machinepool
Deletes a machine pool from a cluster.
Syntax
rosa delete machinepool --cluster=<cluster_name> | <cluster_id> <machine_pool_id>
$ rosa delete machinepool --cluster=<cluster_name> | <cluster_id> <machine_pool_id>| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the machine pool will be deleted from. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --interactive | Enables interactive mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
| --yes |
Automatically answers |
Example
Delete the machine pool with the ID mp-1 from a cluster named mycluster.
rosa delete machinepool --cluster=mycluster mp-1
$ rosa delete machinepool --cluster=mycluster mp-12.7. Install and uninstall add-ons
This section describes how to install and uninstall Red Hat managed service add-ons to a cluster.
2.7.1. install addon
Installs a managed service add-on on a cluster.
Syntax
rosa install addon --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa install addon --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster where the add-on will be installed. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Uses a specific AWS profile (string) from your credentials file. |
| --yes |
Automatically answers |
Example
Add the dbaas-operator add-on installation to a cluster named mycluster.
rosa install addon --cluster=mycluster dbaas-operator
$ rosa install addon --cluster=mycluster dbaas-operator2.7.2. uninstall addon
Uninstalls a managed service add-on from a cluster.
Syntax
rosa uninstall addon --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa uninstall addon --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the add-on will be uninstalled from. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Uses a specific AWS profile (string) from your credentials file. |
| --yes |
Automatically answers |
Example
Remove the dbaas-operator add-on installation from a cluster named mycluster.
rosa uninstall addon --cluster=mycluster dbaas-operator
$ rosa uninstall addon --cluster=mycluster dbaas-operator2.8. List and describe objects
This section describes the list and describe commands for clusters and resources.
2.8.1. list addon
List the managed service add-on installations.
Syntax
rosa list addons --cluster=<cluster_name> | <cluster_id>
$ rosa list addons --cluster=<cluster_name> | <cluster_id>| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster to list the add-ons for. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
2.8.2. list clusters
List all of your clusters.
Syntax
rosa list clusters [arguments]
$ rosa list clusters [arguments]| Option | Definition |
|---|---|
| --count |
The number (integer) of clusters to display. Default: |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
2.8.3. list idps
List all of the identity providers (IDPs) for a cluster.
Syntax
rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the IDPs will be listed for. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
List all identity providers (IDPs) for a cluster named mycluster.
rosa list idps --cluster=mycluster
$ rosa list idps --cluster=mycluster2.8.4. list ingresses
List all of the API and ingress endpoints for a cluster.
Syntax
rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the IDPs will be listed for. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
List all API and ingress endpoints for a cluster named mycluster.
rosa list ingresses --cluster=mycluster
$ rosa list ingresses --cluster=mycluster2.8.5. list instance-types
List all of the available instance types for use with Red Hat OpenShift Service on AWS. Availability is based on the account’s AWS quota.
Syntax
rosa list instance-types [arguments]
$ rosa list instance-types [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --output |
The output format. Allowed formats are |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
List all instance types.
rosa list instance-types
$ rosa list instance-types2.8.6. list machinepools
List the machine pools configured on a cluster.
Syntax
rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the machine pools will be listed for. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
List all of the machine pools on a cluster named mycluster.
rosa list machinepools --cluster=mycluster
$ rosa list machinepools --cluster=mycluster2.8.7. list regions
List all of the available regions for the current AWS account.
Syntax
rosa list regions [arguments]
$ rosa list regions [arguments]| Option | Definition |
|---|---|
| --multi-az | Lists regions that provide support for multiple availability zones. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
List all of the available regions.
rosa list regions
$ rosa list regions2.8.8. list upgrades
List all available and scheduled cluster version upgrades.
Syntax
rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the available upgrades will be listed for. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
List all of the available upgrades for a cluster named mycluster.
rosa list upgrades --cluster=mycluster
$ rosa list upgrades --cluster=mycluster2.8.9. list users
List the cluster administrator and dedicated administrator users for a specified cluster.
Syntax
rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the cluster administrators will be listed for. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
List all of the cluster administrators and dedicated administrators for a cluster named mycluster.
rosa list users --cluster=mycluster
$ rosa list users --cluster=mycluster2.8.10. list versions
List all of the OpenShift versions that are available for creating a cluster.
Syntax
rosa list versions [arguments]
$ rosa list versions [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
List all of the OpenShift Container Platform versions.
rosa list versions
$ rosa list versions2.8.11. describe admin
Show the details of a specified cluster-admin user and a command to log in to the cluster.
Syntax
rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster to which the cluster-admin belongs. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
Describe the cluster-admin user for a cluster named mycluster.
rosa describe admin --cluster=mycluster
$ rosa describe admin --cluster=mycluster2.8.12. describe addon
Show the details of a managed service add-on.
Syntax
rosa describe addon <addon_id> | <addon_name> [arguments]
$ rosa describe addon <addon_id> | <addon_name> [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
Describe an add-on named dbaas-operator.
rosa describe addon dbaas-operator
$ rosa describe addon dbaas-operator2.8.13. describe cluster
Shows the details for a cluster.
Syntax
rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
Describe a cluster named mycluster.
rosa describe cluster --cluster=mycluster
$ rosa describe cluster --cluster=mycluster2.9. Upgrade and delete upgrade for clusters
This section describes the upgrade command usage for clusters.
2.9.1. upgrade cluster
Schedule a cluster upgrade.
Syntax
rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the upgrade will be scheduled for. |
| --interactive | Enables interactive mode. |
| --version | The version (string) of OpenShift Container Platform that the cluster will be upgraded to. |
| --schedule-date |
The next date (string) when the upgrade will run at the specified time. Format: |
| --schedule-time |
The next time the upgrade will run on the specified date. Format: |
| --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: |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
Examples
Interactively schedule an upgrade on a cluster named mycluster.
rosa upgrade cluster --cluster=mycluster --interactive
$ rosa upgrade cluster --cluster=mycluster --interactive
Schedule a cluster upgrade within the hour on a cluster named mycluster.
rosa upgrade cluster --cluster=mycluster --version 4.5.20
$ rosa upgrade cluster --cluster=mycluster --version 4.5.202.9.2. delete upgrade
Cancel a scheduled cluster upgrade.
Syntax
rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
$ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster that the upgrade will be cancelled for. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --yes |
Automatically answers |
Chapter 3. Checking account and version information with the ROSA CLI
3.1. Checking account and version information with the ROSA CLI
Use the following commands to check your account and version information with the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa.
3.1.1. whoami
Display information about your AWS and Red Hat accounts.
Syntax
rosa whoami [arguments]
$ rosa whoami [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
rosa whoami
$ rosa whoami3.1.2. version
Display the version of your Red Hat OpenShift Service on AWS (ROSA) CLI, rosa.
Syntax
rosa version [arguments]
$ rosa version [arguments]| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
rosa version
$ rosa versionChapter 4. Checking logs with the ROSA CLI
4.1. Checking logs with the ROSA CLI
You can check logs with the Red Hat OpenShift Service on AWS (ROSA) CLI, rosa. Use the following commands to check your install and uninstall logs.
4.1.1. logs install
Show the cluster install logs.
Syntax
rosa logs install --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa logs install --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | Required: The name or ID (string) of the cluster to get logs for. |
| --tail |
The number (integer) of lines to get from the end of the log. Default: |
| --watch | Watches for changes after getting the logs. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Examples
Show the last 100 install log lines for a cluster named mycluster:
rosa logs install mycluster --tail=100
$ rosa logs install mycluster --tail=100
Show the install logs for a cluster named mycluster:
rosa logs install --cluster=mycluster
$ rosa logs install --cluster=mycluster4.1.2. logs uninstall
Show the cluster uninstall logs.
Syntax
rosa logs uninstall --cluster=<cluster_name> | <cluster_id> [arguments]
$ rosa logs uninstall --cluster=<cluster_name> | <cluster_id> [arguments]| Option | Definition |
|---|---|
| --cluster | The name or ID (string) of the cluster to get logs for. |
| --tail |
The number (integer) of lines to get from the end of the log. Default: |
| --watch | Watches for changes after getting the logs. |
| Option | Definition |
|---|---|
| --help | Shows help for this command. |
| --debug | Enables debug mode. |
| --profile | Specifies an AWS profile (string) from your credentials file. |
Example
Show the last 100 uninstall logs for a cluster named mycluster:
rosa logs uninstall --cluster=mycluster --tail=100
$ rosa logs uninstall --cluster=mycluster --tail=100
Legal Notice
Copyright © 2025 Red Hat
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}