Este conteúdo não está disponível no idioma selecionado.

Chapter 7. ROSA CLI

7.1. Getting started with the ROSA CLI
Copiar o link

7.1.1. About the ROSA CLI
Copiar o link

Use the ROSA command-line interface (CLI) (rosa) to create, update, manage, and delete Red Hat OpenShift Service on AWS clusters and resources.

7.1.2. Setting up the ROSA CLI
Copiar o link

Use the following steps to install and configure the ROSA CLI (rosa) on your installation host.

Procedure

Install and configure the latest AWS CLI (aws).
1. Follow the AWS Command Line Interface documentation to install and configure the AWS CLI for your operating system.
  Specify your aws_access_key_id, aws_secret_access_key, and region in the .aws/credentials file. See AWS Configuration basics in the AWS documentation.
  Note
  You can optionally use the AWS_DEFAULT_REGION environment variable to set the default AWS region.
2. Query the AWS API to verify if the AWS CLI is installed and configured correctly:
  $ aws sts get-caller-identity --output text
  Copy to Clipboard Toggle word wrap
  Example output
  <aws_account_id> arn:aws:iam::<aws_account_id>:user/<username> <aws_user_id>
  
  Copy to Clipboard Toggle word wrap
Download the latest version of the ROSA CLI (rosa) for your operating system from the Downloads page on OpenShift Cluster Manager.
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
```
```
$ tar xvf rosa-linux.tar.gz
```
Copy to Clipboard Toggle word wrap
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
```
```
$ sudo mv rosa /usr/local/bin/rosa
```
Copy to Clipboard Toggle word wrap
Verify if the ROSA CLI is installed correctly by querying the rosa version:
```
rosa version
```
```
$ rosa version
```
Copy to Clipboard Toggle word wrap
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 Toggle word wrap
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
    
    Copy to Clipboard Toggle word wrap
  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
    
    Copy to Clipboard Toggle word wrap
  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
    
    Copy to Clipboard Toggle word wrap
  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"
    
    Copy to Clipboard Toggle word wrap
  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
    
    Copy to Clipboard Toggle word wrap
  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
    
    Copy to Clipboard Toggle word wrap
  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.

7.1.3. Configuring the ROSA CLI
Copiar o link

Use the following commands to configure the ROSA command-line interface (CLI) (rosa).

7.1.3.1. login
Copiar o link

There are several methods you can use to log in to your Red Hat account using the ROSA command-line interface (CLI) (rosa). These methods are described in detail below.

7.1.3.1.1. Authenticating the ROSA CLI with Red Hat single sign-on
Copiar o link

You can log in to the ROSA CLI (rosa) with Red Hat single sign-on. Red Hat recommends using the rosa command line tool with Red Hat single sign-on, instead of using an offline authentication token.

An offline authentication token is long-lived, stored on your operating system, and cannot be revoked. These factors increase overall security risks and the likelihood of unauthorized access to your account.

Alternatively, authenticating with the Red Hat single sign-on method automatically sends your rosa instance a refresh token that is valid for 10 hours. This unique, temporary authorization code enhances security and reduces the risk of unauthorized access.

Important

The method of authenticating using Red Hat single sign-on does not break any existing automations that rely on offline tokens. Red Hat recommends using services accounts for automation purposes. If you still need to use offline tokens for automation or other purposes, you can download the OpenShift Cluster Manager API token from the OpenShift Cluster Manager API Token page.

Use one of the following methods of authentication:

If your system has a web browser, see the "Authenticating the ROSA CLI with a single sign-on authorization code" section to authenticate with Red Hat single sign-on.
If you are working with containers, remote hosts, or other environments without a web browser, see the "Authenticating the ROSA CLI with a single sign-on device code" section to authenticate with Red Hat single sign-on.
To authenticate the ROSA CLI using an offline token, see the "Authenticating the ROSA CLI with an offline token" section.

Note

Single sign-on authorization is supported with ROSA CLI (rosa) version 1.2.36 or later.

7.1.3.1.2. Authenticating the ROSA CLI with a single sign-on authorization code
Copiar o link

To log in to the ROSA CLI (rosa) with a Red Hat single sign-on authorization code, run the following command:

Syntax

rosa login --use-auth-code

$ rosa login --use-auth-code

Copy to Clipboard

Toggle word wrap

Running this command redirects you to the Red Hat single sign-on login. Log in with your Red Hat login or email.

Expand

Table 7.1. Optional arguments inherited from parent commands
Option	Definition
--help	Shows help for this command.
--debug	Enables debug mode.

To switch accounts, logout from https://sso.redhat.com and run the rosa logout command in your terminal before attempting to login again.

7.1.3.1.3. Authenticating the ROSA CLI with a single sign-on device code
Copiar o link

If you are working with containers, remote hosts, and other environments without a web browser, you can use a Red Hat single sign-on device code for secure authentication. To do this, you must use a second device that has a web browser to approve the login.

Note

Single sign-on authorization is supported with ROSA CLI (rosa) version 1.2.36 or later.

To log in to the ROSA CLI (rosa) with a Red Hat single sign-on device code, run the following command:

Syntax

rosa login --use-device-code

$ rosa login --use-device-code

Copy to Clipboard

Toggle word wrap

Running this command will redirect you to the Red Hat SSO login and provide a log in code.

Expand

Table 7.2. Optional arguments inherited from parent commands
Option	Definition
--help	Shows help for this command.
--debug	Enables debug mode.

To switch accounts, logout from https://sso.redhat.com and run the rosa logout command in your terminal before attempting to login again.

7.1.3.1.4. Authenticating the ROSA CLI with an offline token
Copiar o link

Note

To use offline tokens for automation purposes, you can download the OpenShift Cluster Manager API token from the OpenShift Cluster Manager API Token page. To use service accounts for automation purposes, see the Service Accounts page.

Important

Red Hat recommends using service accounts for automation purposes.

To log in to ROSA CLI (rosa) with a Red Hat offline token, run the following command:

Syntax

rosa login [arguments]

$ rosa login [arguments]

Copy to Clipboard

Toggle word wrap

Expand

Table 7.3. Arguments
Option	Definition
--client-id	The OpenID client identifier (string). Default: `cloud-services`
--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: `openid`
--token	Accesses or refreshes the token (string).
--token-url	The OpenID token URL (string). Default: `https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token`

Expand

Table 7.4. Optional arguments inherited from parent commands
Option	Definition
--help	Shows help for this command.
--debug	Enables debug mode.
--profile	Specifies an AWS profile (string) from your credentials file.

7.1.3.2. logout
Copiar o link

Log out of rosa. Logging out also removes the rosa configuration file.

Syntax

rosa logout [arguments]

$ rosa logout [arguments]

Copy to Clipboard

Toggle word wrap

Expand

Table 7.5. Optional arguments inherited from parent commands
Option	Definition
--help	Shows help for this command.
--debug	Enables debug mode.
--profile	Specifies an AWS profile (string) from your credentials file.

7.1.3.3. verify permissions
Copiar o link

Verify that the AWS permissions required to create a Red Hat OpenShift Service on AWS cluster are configured correctly:

Syntax

rosa verify permissions [arguments]

$ rosa verify permissions [arguments]

Copy to Clipboard

Toggle word wrap

Note

This command verifies permissions only for clusters that do not use the AWS Security Token Service (STS).

Expand

Table 7.6. Optional arguments inherited from parent commands
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 `AWS_REGION` environment variable.
--profile	Specifies an AWS profile (string) from your credentials file.

Examples

Verify that the AWS permissions are configured correctly:

rosa verify permissions

$ rosa verify permissions

Copy to Clipboard

Toggle word wrap

Verify that the AWS permissions are configured correctly in a specific region:

rosa verify permissions --region=us-west-2

$ rosa verify permissions --region=us-west-2

Copy to Clipboard

Toggle word wrap

7.1.3.4. verify quota
Copiar o link

Verifies that AWS quotas are configured correctly for your default region.

Syntax

rosa verify quota [arguments]

$ rosa verify quota [arguments]

Copy to Clipboard

Toggle word wrap

Expand

Table 7.7. Optional arguments inherited from parent commands
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 `AWS_REGION` environment variable.
--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 quota

Copy to Clipboard

Toggle word wrap

Verify that the AWS quotas are configured correctly in a specific region:

rosa verify quota --region=us-west-2

$ rosa verify quota --region=us-west-2

Copy to Clipboard

Toggle word wrap

7.1.3.5. download rosa
Copiar o link

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.

Syntax

rosa download rosa [arguments]

$ rosa download rosa [arguments]

Copy to Clipboard

Toggle word wrap

Expand

Table 7.8. Optional arguments inherited from parent commands
Option	Definition
--help	Shows help for this command.
--debug	Enables debug mode.

7.1.3.6. download oc
Copiar o link

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]

Copy to Clipboard

Toggle word wrap

Expand

Table 7.9. Optional arguments inherited from parent commands
Option	Definition
--help	Shows help for this command.
--debug	Enables debug mode.

Example

Download oc client tools:

rosa download oc

$ rosa download oc

Copy to Clipboard

Toggle word wrap

7.1.3.7. verify oc
Copiar o link

Verifies that the OpenShift Container Platform CLI (oc) is installed correctly.

Syntax

rosa verify oc [arguments]

$ rosa verify oc [arguments]

Copy to Clipboard

Toggle word wrap

Expand

Table 7.10. Optional arguments inherited from parent commands
Option	Definition
--help	Shows help for this command.
--debug	Enables debug mode.

Example

Verify oc client tools:

rosa verify oc

$ rosa verify oc

Copy to Clipboard

Toggle word wrap

7.1.4. Updating the ROSA CLI
Copiar o link

Update to the latest compatible version of the ROSA CLI (rosa).

Procedure

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

rosa version

$ rosa version

Copy to Clipboard

Toggle word wrap

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

Toggle word wrap

Download the latest compatible version of the ROSA CLI:
```
rosa download rosa
```
```
$ rosa download rosa
```
Copy to Clipboard Toggle word wrap
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:
```
tar -xzf rosa-linux.tar.gz
```
```
$ tar -xzf rosa-linux.tar.gz
```
Copy to Clipboard Toggle word wrap
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
```
```
$ sudo mv rosa /usr/local/bin/rosa
```
Copy to Clipboard Toggle word wrap

Verification

Verify that the new version of the ROSA CLI is installed.
```
rosa version
```
```
$ rosa version
```
Copy to Clipboard Toggle word wrap
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 Toggle word wrap

7.2. ROSA CLI command reference
Copiar o link

This reference provides descriptions and example commands for ROSA CLI (rosa) commands.

Run rosa -h to list all commands or run rosa <command> --help to get additional details for a specific command.

7.2.1. ROSA CLI commands
Copiar o link

7.2.1.1. rosa create account-roles
Copiar o link

Create account-wide IAM roles before creating your cluster.

Example usage

# Create default account roles for ROSA clusters using STS
  rosa create account-roles

  # Create account roles with a specific permissions boundary
  rosa create account-roles --permissions-boundary arn:aws:iam::123456789012:policy/perm-boundary

# Create default account roles for ROSA clusters using STS
  rosa create account-roles

  # Create account roles with a specific permissions boundary
  rosa create account-roles --permissions-boundary arn:aws:iam::123456789012:policy/perm-boundary

Copy to Clipboard

Toggle word wrap

7.2.1.2. rosa create admin
Copiar o link

Creates an admin user to login to the cluster

Example usage

# Create an admin user to login to the cluster
  rosa create admin -c mycluster -p MasterKey123

# Create an admin user to login to the cluster
  rosa create admin -c mycluster -p MasterKey123

Copy to Clipboard

Toggle word wrap

7.2.1.3. rosa create autoscaler
Copiar o link

Create an autoscaler for a cluster

Example usage

# Interactively create an autoscaler to a cluster named "mycluster"
  rosa create autoscaler --cluster=mycluster --interactive

  # Create a cluster-autoscaler where it should skip nodes with local storage
  rosa create autoscaler --cluster=mycluster --skip-nodes-with-local-storage

  # Create a cluster-autoscaler with log verbosity of '3'
  rosa create autoscaler --cluster=mycluster --log-verbosity 3

  # Create a cluster-autoscaler with total CPU constraints
  rosa create autoscaler --cluster=mycluster --min-cores 10 --max-cores 100

# Interactively create an autoscaler to a cluster named "mycluster"
  rosa create autoscaler --cluster=mycluster --interactive

  # Create a cluster-autoscaler where it should skip nodes with local storage
  rosa create autoscaler --cluster=mycluster --skip-nodes-with-local-storage

  # Create a cluster-autoscaler with log verbosity of '3'
  rosa create autoscaler --cluster=mycluster --log-verbosity 3

  # Create a cluster-autoscaler with total CPU constraints
  rosa create autoscaler --cluster=mycluster --min-cores 10 --max-cores 100

Copy to Clipboard

Toggle word wrap

7.2.1.4. rosa create break-glass-credential
Copiar o link

Create a break glass credential for a cluster.

Example usage

# Interactively create a break glass credential to a cluster named "mycluster"
  rosa create break-glass-credential --cluster=mycluster --interactive

# Interactively create a break glass credential to a cluster named "mycluster"
  rosa create break-glass-credential --cluster=mycluster --interactive

Copy to Clipboard

Toggle word wrap

7.2.1.5. rosa create cluster
Copiar o link

Create cluster

Example usage

# Create a cluster named "mycluster"
  rosa create cluster --cluster-name=mycluster

  # Create a cluster in the us-east-2 region
  rosa create cluster --cluster-name=mycluster --region=us-east-2

# Create a cluster named "mycluster"
  rosa create cluster --cluster-name=mycluster

  # Create a cluster in the us-east-2 region
  rosa create cluster --cluster-name=mycluster --region=us-east-2

Copy to Clipboard

Toggle word wrap

7.2.1.6. rosa create decision
Copiar o link

Create a decision for an Access Request

Example usage

# Create a decision for an Access Request to approve it
  rosa create decision --access-request <access_request_id> --decision Approved

# Create a decision for an Access Request to approve it
  rosa create decision --access-request <access_request_id> --decision Approved

Copy to Clipboard

Toggle word wrap

7.2.1.7. rosa create dns-domain
Copiar o link

Create DNS Domain.

Example usage

# Create DNS Domain
	rosa create dns-domain

# Create DNS Domain
	rosa create dns-domain

Copy to Clipboard

Toggle word wrap

7.2.1.8. rosa create external-auth-provider
Copiar o link

Create an external authentication provider for a cluster.

Example usage

# Interactively create an external authentication provider to a cluster named "mycluster"
  rosa create external-auth-provider --cluster=mycluster --interactive

# Interactively create an external authentication provider to a cluster named "mycluster"
  rosa create external-auth-provider --cluster=mycluster --interactive

Copy to Clipboard

Toggle word wrap

7.2.1.9. rosa create iamserviceaccount
Copiar o link

Create IAM role for Kubernetes service account

Example usage

# Create an IAM role for a service account
  rosa create iamserviceaccount --cluster my-cluster --name my-app --namespace default

# Create an IAM role for a service account
  rosa create iamserviceaccount --cluster my-cluster --name my-app --namespace default

Copy to Clipboard

Toggle word wrap

7.2.1.10. rosa create idp
Copiar o link

Add IDP for cluster

Example usage

# Add a GitHub identity provider to a cluster named "mycluster"
  rosa create idp --type=github --cluster=mycluster

  # Add an identity provider following interactive prompts
  rosa create idp --cluster=mycluster --interactive

# Add a GitHub identity provider to a cluster named "mycluster"
  rosa create idp --type=github --cluster=mycluster

  # Add an identity provider following interactive prompts
  rosa create idp --cluster=mycluster --interactive

Copy to Clipboard

Toggle word wrap

7.2.1.11. rosa create image-mirror
Copiar o link

Create image mirror for a cluster

Example usage

# Create an image mirror for cluster "mycluster"
  rosa create image-mirror --cluster=mycluster \
    --source=registry.example.com/team \
    --mirrors=mirror.corp.com/team,backup.corp.com/team

  # Create with a specific type (digest is default and only supported type)
  rosa create image-mirror --cluster=mycluster \
    --type=digest --source=docker.io/library \
    --mirrors=internal-registry.company.com/dockerhub

# Create an image mirror for cluster "mycluster"
  rosa create image-mirror --cluster=mycluster \
    --source=registry.example.com/team \
    --mirrors=mirror.corp.com/team,backup.corp.com/team

  # Create with a specific type (digest is default and only supported type)
  rosa create image-mirror --cluster=mycluster \
    --type=digest --source=docker.io/library \
    --mirrors=internal-registry.company.com/dockerhub

Copy to Clipboard

Toggle word wrap

7.2.1.12. rosa create kubeletconfig
Copiar o link

Create a custom kubeletconfig for a cluster

Example usage

# Create a custom kubeletconfig with a pod-pids-limit of 5000
  rosa create kubeletconfig --cluster=mycluster --pod-pids-limit=5000

# Create a custom kubeletconfig with a pod-pids-limit of 5000
  rosa create kubeletconfig --cluster=mycluster --pod-pids-limit=5000

Copy to Clipboard

Toggle word wrap

7.2.1.13. rosa create machinepool
Copiar o link

Add machine pool to cluster

Example usage

# Interactively add a machine pool to a cluster named "mycluster"
  rosa create machinepool --cluster=mycluster --interactive
  # Add a machine pool mp-1 with 3 replicas of m5.xlarge to a cluster
  rosa create machinepool --cluster=mycluster --name=mp-1 --replicas=3 --instance-type=m5.xlarge
  # Add a machine pool mp-1 with autoscaling enabled and 3 to 6 replicas of m5.xlarge to a cluster
  rosa create machinepool --cluster=mycluster --name=mp-1 --enable-autoscaling \
	--min-replicas=3 --max-replicas=6 --instance-type=m5.xlarge
  # Add a machine pool with labels to a cluster
  rosa create machinepool -c mycluster --name=mp-1 --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz,
  # Add a machine pool with spot instances to a cluster
  rosa create machinepool -c mycluster --name=mp-1 --replicas=2 --instance-type=r5.2xlarge --use-spot-instances \
    --spot-max-price=0.5
  # Add a machine pool to a cluster and set the node drain grace period
  rosa create machinepool -c mycluster --name=mp-1 --node-drain-grace-period="90 minutes"

# Interactively add a machine pool to a cluster named "mycluster"
  rosa create machinepool --cluster=mycluster --interactive
  # Add a machine pool mp-1 with 3 replicas of m5.xlarge to a cluster
  rosa create machinepool --cluster=mycluster --name=mp-1 --replicas=3 --instance-type=m5.xlarge
  # Add a machine pool mp-1 with autoscaling enabled and 3 to 6 replicas of m5.xlarge to a cluster
  rosa create machinepool --cluster=mycluster --name=mp-1 --enable-autoscaling \
	--min-replicas=3 --max-replicas=6 --instance-type=m5.xlarge
  # Add a machine pool with labels to a cluster
  rosa create machinepool -c mycluster --name=mp-1 --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz,
  # Add a machine pool with spot instances to a cluster
  rosa create machinepool -c mycluster --name=mp-1 --replicas=2 --instance-type=r5.2xlarge --use-spot-instances \
    --spot-max-price=0.5
  # Add a machine pool to a cluster and set the node drain grace period
  rosa create machinepool -c mycluster --name=mp-1 --node-drain-grace-period="90 minutes"

Copy to Clipboard

Toggle word wrap

7.2.1.14. rosa create network
Copiar o link

Network AWS cloudformation stack

Example usage

# Create a AWS cloudformation stack
  rosa create network <template-name> --param Param1=Value1 --param Param2=Value2

  # ROSA quick start HCP VPC example with one availability zone
  rosa create network rosa-quickstart-default-vpc --param Region=us-west-2 --param Name=quickstart-stack --param AvailabilityZoneCount=1 --param VpcCidr=10.0.0.0/16

  # ROSA quick start HCP VPC example with two explicit availability zones
  rosa create network rosa-quickstart-default-vpc --param Region=us-west-2 --param Name=quickstart-stack --param AZ1=us-west-2b --param AZ2=us-west-2d --param VpcCidr=10.0.0.0/16

  # To delete the AWS cloudformation stack
  aws cloudformation delete-stack --stack-name <name> --region <region>

# TEMPLATE_NAME:
Specifies the name of the template to use. This should match the name of a directory
under the path specified by '--template-dir' or the 'OCM_TEMPLATE_DIR' environment variable.
The directory should contain a YAML file defining the custom template structure.

If no TEMPLATE_NAME is provided, or if no matching directory is found, the default
built-in template 'rosa-quickstart-default-vpc' will be used.

# Create a AWS cloudformation stack
  rosa create network <template-name> --param Param1=Value1 --param Param2=Value2

  # ROSA quick start HCP VPC example with one availability zone
  rosa create network rosa-quickstart-default-vpc --param Region=us-west-2 --param Name=quickstart-stack --param AvailabilityZoneCount=1 --param VpcCidr=10.0.0.0/16

  # ROSA quick start HCP VPC example with two explicit availability zones
  rosa create network rosa-quickstart-default-vpc --param Region=us-west-2 --param Name=quickstart-stack --param AZ1=us-west-2b --param AZ2=us-west-2d --param VpcCidr=10.0.0.0/16

  # To delete the AWS cloudformation stack
  aws cloudformation delete-stack --stack-name <name> --region <region>

# TEMPLATE_NAME:
Specifies the name of the template to use. This should match the name of a directory
under the path specified by '--template-dir' or the 'OCM_TEMPLATE_DIR' environment variable.
The directory should contain a YAML file defining the custom template structure.

If no TEMPLATE_NAME is provided, or if no matching directory is found, the default
built-in template 'rosa-quickstart-default-vpc' will be used.

Copy to Clipboard

Toggle word wrap

7.2.1.15. rosa create ocm-role
Copiar o link

Create role used by OCM

Example usage

# Create default ocm role for ROSA clusters using STS
  rosa create ocm-role

  # Create ocm role with a specific permissions boundary
  rosa create ocm-role --permissions-boundary arn:aws:iam::123456789012:policy/perm-boundary

# Create default ocm role for ROSA clusters using STS
  rosa create ocm-role

  # Create ocm role with a specific permissions boundary
  rosa create ocm-role --permissions-boundary arn:aws:iam::123456789012:policy/perm-boundary

Copy to Clipboard

Toggle word wrap

7.2.1.16. rosa create oidc-config
Copiar o link

Create OIDC config compliant with OIDC protocol.

Example usage

# Create OIDC config
	rosa create oidc-config

# Create OIDC config
	rosa create oidc-config

Copy to Clipboard

Toggle word wrap

7.2.1.17. rosa create oidc-provider
Copiar o link

Create OIDC provider for an STS cluster.

Example usage

# Create OIDC provider for cluster named "mycluster"
  rosa create oidc-provider --cluster=mycluster

# Create OIDC provider for cluster named "mycluster"
  rosa create oidc-provider --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.18. rosa create operator-roles
Copiar o link

Create operator IAM roles for a cluster.

Example usage

# Create default operator roles for cluster named "mycluster"
  rosa create operator-roles --cluster=mycluster

  # Create operator roles with a specific permissions boundary
  rosa create operator-roles -c mycluster --permissions-boundary arn:aws:iam::123456789012:policy/perm-boundary

# Create default operator roles for cluster named "mycluster"
  rosa create operator-roles --cluster=mycluster

  # Create operator roles with a specific permissions boundary
  rosa create operator-roles -c mycluster --permissions-boundary arn:aws:iam::123456789012:policy/perm-boundary

Copy to Clipboard

Toggle word wrap

7.2.1.19. rosa create tuning-configs
Copiar o link

Add tuning config

Example usage

# Add a tuning config with name "tuned1" and spec from a file "file1" to a cluster named "mycluster"
 rosa create tuning-config --name=tuned1 --spec-path=file1 --cluster=mycluster"

# Add a tuning config with name "tuned1" and spec from a file "file1" to a cluster named "mycluster"
 rosa create tuning-config --name=tuned1 --spec-path=file1 --cluster=mycluster"

Copy to Clipboard

Toggle word wrap

7.2.1.20. rosa create user-role
Copiar o link

Create user role to verify account association

Example usage

# Create user roles
  rosa create user-role

  # Create user role with a specific permissions boundary
  rosa create user-role --permissions-boundary arn:aws:iam::123456789012:policy/perm-boundary

# Create user roles
  rosa create user-role

  # Create user role with a specific permissions boundary
  rosa create user-role --permissions-boundary arn:aws:iam::123456789012:policy/perm-boundary

Copy to Clipboard

Toggle word wrap

7.2.1.21. rosa delete account-roles
Copiar o link

Delete Account Roles

Example usage

# Delete Account roles"
  rosa delete account-roles -p prefix

# Delete Account roles"
  rosa delete account-roles -p prefix

Copy to Clipboard

Toggle word wrap

7.2.1.22. rosa delete admin
Copiar o link

Deletes the admin user

Example usage

# Delete the admin user
  rosa delete admin --cluster=mycluster

# Delete the admin user
  rosa delete admin --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.23. rosa delete autoscaler
Copiar o link

Delete autoscaler for cluster

Example usage

# Delete the autoscaler config for cluster named "mycluster"
  rosa delete autoscaler --cluster=mycluster

# Delete the autoscaler config for cluster named "mycluster"
  rosa delete autoscaler --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.24. rosa delete cluster
Copiar o link

Delete cluster

Example usage

# Delete a cluster named "mycluster"
  rosa delete cluster --cluster=mycluster

# Delete a cluster named "mycluster"
  rosa delete cluster --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.25. rosa delete dns-domain
Copiar o link

Delete DNS domain

Example usage

# Delete a DNS domain with ID github-1
  rosa delete dns-domain github-1

# Delete a DNS domain with ID github-1
  rosa delete dns-domain github-1

Copy to Clipboard

Toggle word wrap

7.2.1.26. rosa delete external-auth-provider
Copiar o link

Delete external authentication provider

Example usage

# Delete an external authentication provider named exauth-1
  rosa delete external-auth-provider exauth-1  --cluster=mycluster

# Delete an external authentication provider named exauth-1
  rosa delete external-auth-provider exauth-1  --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.27. rosa delete iamserviceaccount
Copiar o link

Delete IAM role for Kubernetes service account

Example usage

# Delete IAM role for service account
  rosa delete iamserviceaccount --cluster my-cluster \
    --name my-app \
    --namespace default

# Delete IAM role for service account
  rosa delete iamserviceaccount --cluster my-cluster \
    --name my-app \
    --namespace default

Copy to Clipboard

Toggle word wrap

7.2.1.28. rosa delete idp
Copiar o link

Delete cluster IDPs

Example usage

# Delete an identity provider named github-1
  rosa delete idp github-1 --cluster=mycluster

# Delete an identity provider named github-1
  rosa delete idp github-1 --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.29. rosa delete image-mirror
Copiar o link

Delete image mirror from a cluster

Example usage

# Delete image mirror with ID "abc123" from cluster "mycluster"
  rosa delete image-mirror --cluster=mycluster abc123

  # Delete without confirmation prompt
  rosa delete image-mirror --cluster=mycluster abc123 --yes

  # Alternative: using the --id flag
  rosa delete image-mirror --cluster=mycluster --id=abc123

# Delete image mirror with ID "abc123" from cluster "mycluster"
  rosa delete image-mirror --cluster=mycluster abc123

  # Delete without confirmation prompt
  rosa delete image-mirror --cluster=mycluster abc123 --yes

  # Alternative: using the --id flag
  rosa delete image-mirror --cluster=mycluster --id=abc123

Copy to Clipboard

Toggle word wrap

7.2.1.30. rosa delete ingress
Copiar o link

Delete cluster ingress

Example usage

# Delete ingress with ID a1b2 from a cluster named 'mycluster'
  rosa delete ingress --cluster=mycluster a1b2

  # Delete secondary ingress using the sub-domain name
  rosa delete ingress --cluster=mycluster apps2

# Delete ingress with ID a1b2 from a cluster named 'mycluster'
  rosa delete ingress --cluster=mycluster a1b2

  # Delete secondary ingress using the sub-domain name
  rosa delete ingress --cluster=mycluster apps2

Copy to Clipboard

Toggle word wrap

7.2.1.31. rosa delete kubeletconfig
Copiar o link

Delete a kubeletconfig from a cluster

Example usage

# Delete the KubeletConfig for ROSA Classic cluster 'foo'
  rosa delete kubeletconfig --cluster foo
  # Delete the KubeletConfig named 'bar' from cluster 'foo'
  rosa delete kubeletconfig --cluster foo --name bar

# Delete the KubeletConfig for ROSA Classic cluster 'foo'
  rosa delete kubeletconfig --cluster foo
  # Delete the KubeletConfig named 'bar' from cluster 'foo'
  rosa delete kubeletconfig --cluster foo --name bar

Copy to Clipboard

Toggle word wrap

7.2.1.32. rosa delete machinepool
Copiar o link

Delete machine pool

Example usage

# Delete machine pool with ID mp-1 from a cluster named 'mycluster'
  rosa delete machinepool --cluster=mycluster mp-1

# Delete machine pool with ID mp-1 from a cluster named 'mycluster'
  rosa delete machinepool --cluster=mycluster mp-1

Copy to Clipboard

Toggle word wrap

7.2.1.33. rosa delete ocm-role
Copiar o link

Delete OCM role

Example usage

# Delete OCM role
rosa delete ocm-role --role-arn arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778

# Delete OCM role
rosa delete ocm-role --role-arn arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778

Copy to Clipboard

Toggle word wrap

7.2.1.34. rosa delete oidc-config
Copiar o link

Delete OIDC Config

Example usage

# Delete OIDC config based on registered OIDC Config ID that has been supplied
	rosa delete oidc-config --oidc-config-id <oidc_config_id>

# Delete OIDC config based on registered OIDC Config ID that has been supplied
	rosa delete oidc-config --oidc-config-id <oidc_config_id>

Copy to Clipboard

Toggle word wrap

7.2.1.35. rosa delete oidc-provider
Copiar o link

Delete OIDC Provider

Example usage

# Delete OIDC provider for cluster named "mycluster"
  rosa delete oidc-provider --cluster=mycluster

# Delete OIDC provider for cluster named "mycluster"
  rosa delete oidc-provider --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.36. rosa delete operator-roles
Copiar o link

Delete Operator Roles

Example usage

# Delete Operator roles for cluster named "mycluster"
  rosa delete operator-roles --cluster=mycluster

# Delete Operator roles for cluster named "mycluster"
  rosa delete operator-roles --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.37. rosa delete tuning-configs
Copiar o link

Delete tuning config

Example usage

# Delete tuning config with name tuned1 from a cluster named 'mycluster'
  rosa delete tuning-config --cluster=mycluster tuned1

# Delete tuning config with name tuned1 from a cluster named 'mycluster'
  rosa delete tuning-config --cluster=mycluster tuned1

Copy to Clipboard

Toggle word wrap

7.2.1.38. rosa delete user-role
Copiar o link

Delete user role

Example usage

# Delete user role
rosa delete user-role --role-arn {prefix}-User-{username}-Role

# Delete user role
rosa delete user-role --role-arn {prefix}-User-{username}-Role

Copy to Clipboard

Toggle word wrap

7.2.1.39. rosa describe access-request
Copiar o link

Show details of an Access Request

Example usage

# Describe an Access Request wit id <access_request_id>
  rosa describe access-request --id <access_request_id>

# Describe an Access Request wit id <access_request_id>
  rosa describe access-request --id <access_request_id>

Copy to Clipboard

Toggle word wrap

7.2.1.40. rosa describe addon
Copiar o link

Show details of an add-on

Example usage

# Describe an add-on named "codeready-workspaces"
  rosa describe addon codeready-workspaces

# Describe an add-on named "codeready-workspaces"
  rosa describe addon codeready-workspaces

Copy to Clipboard

Toggle word wrap

7.2.1.41. rosa describe addon-installation
Copiar o link

Show details of an add-on installation

Example usage

# Describe the 'bar' add-on installation on cluster 'foo'
  rosa describe addon-installation --cluster foo --addon bar

# Describe the 'bar' add-on installation on cluster 'foo'
  rosa describe addon-installation --cluster foo --addon bar

Copy to Clipboard

Toggle word wrap

7.2.1.42. rosa describe admin
Copiar o link

Show details of the cluster-admin user

Example usage

# Describe cluster-admin user of a cluster named mycluster
  rosa describe admin -c mycluster

# Describe cluster-admin user of a cluster named mycluster
  rosa describe admin -c mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.43. rosa describe autoscaler
Copiar o link

Show details of the autoscaler for a cluster

Example usage

# Describe the autoscaler for cluster 'foo'
rosa describe autoscaler --cluster foo

# Describe the autoscaler for cluster 'foo'
rosa describe autoscaler --cluster foo

Copy to Clipboard

Toggle word wrap

7.2.1.44. rosa describe break-glass-credential
Copiar o link

Show details of a break glass credential on a cluster

Example usage

# Show details of a break glass credential with ID "12345" on a cluster named "mycluster"
  rosa describe break-glass-credential 12345 --cluster=mycluster

# Show details of a break glass credential with ID "12345" on a cluster named "mycluster"
  rosa describe break-glass-credential 12345 --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.45. rosa describe cluster
Copiar o link

Show details of a cluster

Example usage

# Describe a cluster named "mycluster"
  rosa describe cluster --cluster=mycluster

# Describe a cluster named "mycluster"
  rosa describe cluster --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.46. rosa describe external-auth-provider
Copiar o link

Show details of an external authentication provider on a cluster

Example usage

# Show details of an external authentication provider named "exauth" on a cluster named "mycluster"
  rosa describe external-auth-provider exauth --cluster=mycluster

# Show details of an external authentication provider named "exauth" on a cluster named "mycluster"
  rosa describe external-auth-provider exauth --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.47. rosa describe iamserviceaccount
Copiar o link

Describe IAM role for Kubernetes service account

Example usage

# Describe IAM role for service account
  rosa describe iamserviceaccount --cluster my-cluster \
    --name my-app \
    --namespace default

# Describe IAM role for service account
  rosa describe iamserviceaccount --cluster my-cluster \
    --name my-app \
    --namespace default

Copy to Clipboard

Toggle word wrap

7.2.1.48. rosa describe ingress
Copiar o link

Show details of the specified ingress within cluster

Example usage

rosa describe ingress <ingress_id> -c mycluster

rosa describe ingress <ingress_id> -c mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.49. rosa describe kubeletconfig
Copiar o link

Show details of a kubeletconfig for a cluster

Example usage

# Describe the custom kubeletconfig for ROSA Classic cluster 'foo'
  rosa describe kubeletconfig --cluster foo
  # Describe the custom kubeletconfig named 'bar' for cluster 'foo'
  rosa describe kubeletconfig --cluster foo --name bar

# Describe the custom kubeletconfig for ROSA Classic cluster 'foo'
  rosa describe kubeletconfig --cluster foo
  # Describe the custom kubeletconfig named 'bar' for cluster 'foo'
  rosa describe kubeletconfig --cluster foo --name bar

Copy to Clipboard

Toggle word wrap

7.2.1.50. rosa describe machinepool
Copiar o link

Show details of a machine pool on a cluster

Example usage

# Show details of a machine pool named "mymachinepool" on a cluster named "mycluster"
  rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool

# Show details of a machine pool named "mymachinepool" on a cluster named "mycluster"
  rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool

Copy to Clipboard

Toggle word wrap

7.2.1.51. rosa describe tuning-configs
Copiar o link

Show details of tuning config

Example usage

# Describe the 'tuned1' tuned config on cluster 'foo'
  rosa describe tuning-config --cluster foo tuned1

# Describe the 'tuned1' tuned config on cluster 'foo'
  rosa describe tuning-config --cluster foo tuned1

Copy to Clipboard

Toggle word wrap

7.2.1.52. rosa describe upgrade
Copiar o link

Show details of an upgrade

Example usage

# Describe an upgrade-policy"
  rosa describe upgrade

# Describe an upgrade-policy"
  rosa describe upgrade

Copy to Clipboard

Toggle word wrap

7.2.1.53. rosa download openshift-client
Copiar o link

Download OpenShift client tools

Example usage

# Download oc client tools
  rosa download oc

# Download oc client tools
  rosa download oc

Copy to Clipboard

Toggle word wrap

7.2.1.54. rosa download rosa-client
Copiar o link

Download ROSA client tools

Example usage

# Download rosa client tools
  rosa download rosa

# Download rosa client tools
  rosa download rosa

Copy to Clipboard

Toggle word wrap

7.2.1.55. rosa edit addon
Copiar o link

Edit add-on installation parameters on cluster

Example usage

# Edit the parameters of the Red Hat OpenShift logging operator add-on installation
  rosa edit addon --cluster=mycluster cluster-logging-operator

# Edit the parameters of the Red Hat OpenShift logging operator add-on installation
  rosa edit addon --cluster=mycluster cluster-logging-operator

Copy to Clipboard

Toggle word wrap

7.2.1.56. rosa edit autoscaler
Copiar o link

Edit the autoscaler of a cluster

Example usage

# Interactively edit an autoscaler to a cluster named "mycluster"
  rosa edit autoscaler --cluster=mycluster --interactive

  # Edit a cluster-autoscaler to skip nodes with local storage
  rosa edit autoscaler --cluster=mycluster --skip-nodes-with-local-storage

  # Edit a cluster-autoscaler with log verbosity of '3'
  rosa edit autoscaler --cluster=mycluster --log-verbosity 3

  # Edit a cluster-autoscaler with total CPU constraints
  rosa edit autoscaler --cluster=mycluster --min-cores 10 --max-cores 100

# Interactively edit an autoscaler to a cluster named "mycluster"
  rosa edit autoscaler --cluster=mycluster --interactive

  # Edit a cluster-autoscaler to skip nodes with local storage
  rosa edit autoscaler --cluster=mycluster --skip-nodes-with-local-storage

  # Edit a cluster-autoscaler with log verbosity of '3'
  rosa edit autoscaler --cluster=mycluster --log-verbosity 3

  # Edit a cluster-autoscaler with total CPU constraints
  rosa edit autoscaler --cluster=mycluster --min-cores 10 --max-cores 100

Copy to Clipboard

Toggle word wrap

7.2.1.57. rosa edit cluster
Copiar o link

Edit cluster

Example usage

# Edit a cluster named "mycluster" to make it private
  rosa edit cluster -c mycluster --private

  # Edit a cluster named "mycluster" to enable User Workload Monitoring
  rosa edit cluster -c mycluster --disable-workload-monitoring=false

  # Edit all options interactively
  rosa edit cluster -c mycluster --interactive

# Edit a cluster named "mycluster" to make it private
  rosa edit cluster -c mycluster --private

  # Edit a cluster named "mycluster" to enable User Workload Monitoring
  rosa edit cluster -c mycluster --disable-workload-monitoring=false

  # Edit all options interactively
  rosa edit cluster -c mycluster --interactive

Copy to Clipboard

Toggle word wrap

7.2.1.58. rosa edit image-mirror
Copiar o link

Edit image mirror for a cluster

Example usage

# Update mirrors for image mirror with ID "abc123" on cluster "mycluster"
  rosa edit image-mirror --cluster=mycluster abc123 \
    --mirrors=mirror.corp.com/team,backup.corp.com/team,new-mirror.corp.com/team

  # Alternative: using the --id flag
  rosa edit image-mirror --cluster=mycluster --id=abc123 \
    --mirrors=mirror.corp.com/team,backup.corp.com/team,new-mirror.corp.com/team

# Update mirrors for image mirror with ID "abc123" on cluster "mycluster"
  rosa edit image-mirror --cluster=mycluster abc123 \
    --mirrors=mirror.corp.com/team,backup.corp.com/team,new-mirror.corp.com/team

  # Alternative: using the --id flag
  rosa edit image-mirror --cluster=mycluster --id=abc123 \
    --mirrors=mirror.corp.com/team,backup.corp.com/team,new-mirror.corp.com/team

Copy to Clipboard

Toggle word wrap

7.2.1.59. rosa edit ingress
Copiar o link

Edit a cluster ingress (load balancer)

Example usage

# Make additional ingress with ID 'a1b2' private on a cluster named 'mycluster'
  rosa edit ingress --private --cluster=mycluster a1b2

  # Update the router selectors for the additional ingress with ID 'a1b2'
  rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2

  # Update the default ingress using the sub-domain identifier
  rosa edit ingress --private=false --cluster=mycluster apps

  # Update the load balancer type of the apps2 ingress
  rosa edit ingress --lb-type=nlb --cluster=mycluster apps2

# Make additional ingress with ID 'a1b2' private on a cluster named 'mycluster'
  rosa edit ingress --private --cluster=mycluster a1b2

  # Update the router selectors for the additional ingress with ID 'a1b2'
  rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2

  # Update the default ingress using the sub-domain identifier
  rosa edit ingress --private=false --cluster=mycluster apps

  # Update the load balancer type of the apps2 ingress
  rosa edit ingress --lb-type=nlb --cluster=mycluster apps2

Copy to Clipboard

Toggle word wrap

7.2.1.60. rosa edit kubeletconfig
Copiar o link

Edit a kubeletconfig for a cluster

Example usage

# Edit a KubeletConfig to have a pod-pids-limit of 10000
  rosa edit kubeletconfig --cluster=mycluster --pod-pids-limit=10000
  # Edit a KubeletConfig named 'bar' to have a pod-pids-limit of 10000
  rosa edit kubeletconfig --cluster=mycluster --name=bar --pod-pids-limit=10000

# Edit a KubeletConfig to have a pod-pids-limit of 10000
  rosa edit kubeletconfig --cluster=mycluster --pod-pids-limit=10000
  # Edit a KubeletConfig named 'bar' to have a pod-pids-limit of 10000
  rosa edit kubeletconfig --cluster=mycluster --name=bar --pod-pids-limit=10000

Copy to Clipboard

Toggle word wrap

7.2.1.61. rosa edit machinepool
Copiar o link

Edit machine pool

Example usage

# Set 4 replicas on machine pool 'mp1' on cluster 'mycluster'
	rosa edit machinepool --replicas=4 --cluster=mycluster mp1
	# Enable autoscaling and Set 3-5 replicas on machine pool 'mp1' on cluster 'mycluster'
	rosa edit machinepool --enable-autoscaling --min-replicas=3 --max-replicas=5 --cluster=mycluster mp1
	# Set the node drain grace period to 1 hour on machine pool 'mp1' on cluster 'mycluster'
	rosa edit machinepool --node-drain-grace-period="1 hour" --cluster=mycluster mp1

# Set 4 replicas on machine pool 'mp1' on cluster 'mycluster'
	rosa edit machinepool --replicas=4 --cluster=mycluster mp1
	# Enable autoscaling and Set 3-5 replicas on machine pool 'mp1' on cluster 'mycluster'
	rosa edit machinepool --enable-autoscaling --min-replicas=3 --max-replicas=5 --cluster=mycluster mp1
	# Set the node drain grace period to 1 hour on machine pool 'mp1' on cluster 'mycluster'
	rosa edit machinepool --node-drain-grace-period="1 hour" --cluster=mycluster mp1

Copy to Clipboard

Toggle word wrap

7.2.1.62. rosa edit tuning-configs
Copiar o link

Edit tuning config

Example usage

# Update the tuning config with name 'tuning-1' with the spec defined in file1
  rosa edit tuning-config --cluster=mycluster tuning-1 --spec-path file1

# Update the tuning config with name 'tuning-1' with the spec defined in file1
  rosa edit tuning-config --cluster=mycluster tuning-1 --spec-path file1

Copy to Clipboard

Toggle word wrap

7.2.1.63. rosa grant user
Copiar o link

Grant user access to cluster

Example usage

# Add cluster-admin role to a user
  rosa grant user cluster-admin --user=myusername --cluster=mycluster

  # Grant dedicated-admins role to a user
  rosa grant user dedicated-admin --user=myusername --cluster=mycluster

# Add cluster-admin role to a user
  rosa grant user cluster-admin --user=myusername --cluster=mycluster

  # Grant dedicated-admins role to a user
  rosa grant user dedicated-admin --user=myusername --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.64. rosa init
Copiar o link

Applies templates to support Red Hat OpenShift Service on AWS

Example usage

# Configure your AWS account to allow IAM (non-STS) ROSA clusters
  rosa init

  # Configure a new AWS account using pre-existing OCM credentials
  rosa init --token=$OFFLINE_ACCESS_TOKEN

# Configure your AWS account to allow IAM (non-STS) ROSA clusters
  rosa init

  # Configure a new AWS account using pre-existing OCM credentials
  rosa init --token=$OFFLINE_ACCESS_TOKEN

Copy to Clipboard

Toggle word wrap

7.2.1.65. rosa install addon
Copiar o link

Install add-ons on cluster

Example usage

# Add the CodeReady Workspaces add-on installation to the cluster
  rosa install addon --cluster=mycluster codeready-workspaces

# Add the CodeReady Workspaces add-on installation to the cluster
  rosa install addon --cluster=mycluster codeready-workspaces

Copy to Clipboard

Toggle word wrap

7.2.1.66. rosa link ocm-role
Copiar o link

Link OCM role to specific OCM organization.

Example usage

# Link OCM role
  rosa link ocm-role --role-arn arn:aws:iam::123456789012:role/ManagedOpenshift-OCM-Role

# Link OCM role
  rosa link ocm-role --role-arn arn:aws:iam::123456789012:role/ManagedOpenshift-OCM-Role

Copy to Clipboard

Toggle word wrap

7.2.1.67. rosa link user-role
Copiar o link

Link user role to specific OCM account.

Example usage

# Link user roles
  rosa link user-role --role-arn arn:aws:iam::{accountid}:role/{prefix}-User-{username}-Role

# Link user roles
  rosa link user-role --role-arn arn:aws:iam::{accountid}:role/{prefix}-User-{username}-Role

Copy to Clipboard

Toggle word wrap

7.2.1.68. rosa list access-request
Copiar o link

List Access Requests

Example usage

# List all Access Requests for cluster 'foo'
  rosa list access-request --cluster foo

# List all Access Requests for cluster 'foo'
  rosa list access-request --cluster foo

Copy to Clipboard

Toggle word wrap

7.2.1.69. rosa list account-roles
Copiar o link

List account roles and policies

Example usage

# List all account roles
  rosa list account-roles

# List all account roles
  rosa list account-roles

Copy to Clipboard

Toggle word wrap

7.2.1.70. rosa list addons
Copiar o link

List add-on installations

Example usage

# List all add-on installations on a cluster named "mycluster"
  rosa list addons --cluster=mycluster

# List all add-on installations on a cluster named "mycluster"
  rosa list addons --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.71. rosa list break-glass-credentials
Copiar o link

List break glass credential

Example usage

# List all break glass credentials for a cluster named 'mycluster'"
  rosa list break-glass-credentials -c mycluster

# List all break glass credentials for a cluster named 'mycluster'"
  rosa list break-glass-credentials -c mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.72. rosa list clusters
Copiar o link

List clusters

Example usage

# List all clusters
  rosa list clusters

# List all clusters
  rosa list clusters

Copy to Clipboard

Toggle word wrap

7.2.1.73. rosa list dns-domain
Copiar o link

List DNS Domains

Example usage

# List all DNS Domains tied to your organization ID"
  rosa list dns-domain

# List all DNS Domains tied to your organization ID"
  rosa list dns-domain

Copy to Clipboard

Toggle word wrap

7.2.1.74. rosa list external-auth-providers
Copiar o link

List external authentication provider

Example usage

# List all external authentication providers for a cluster named 'mycluster'"
  rosa list external-auth-provider -c mycluster

# List all external authentication providers for a cluster named 'mycluster'"
  rosa list external-auth-provider -c mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.75. rosa list gates
Copiar o link

List available OCP Gates

Example usage

# List all OCP gates for OCP version
  rosa list gates --version 4.9

  # List all STS gates for OCP version
  rosa list gates --gate sts --version 4.9

  # List all OCP gates for OCP version
  rosa list gates --gate ocp --version 4.9

  # List available gates for cluster upgrade version
  rosa list gates -c <cluster_id> --version 4.9.15

# List all OCP gates for OCP version
  rosa list gates --version 4.9

  # List all STS gates for OCP version
  rosa list gates --gate sts --version 4.9

  # List all OCP gates for OCP version
  rosa list gates --gate ocp --version 4.9

  # List available gates for cluster upgrade version
  rosa list gates -c <cluster_id> --version 4.9.15

Copy to Clipboard

Toggle word wrap

7.2.1.76. rosa list iamserviceaccounts
Copiar o link

List IAM roles for Kubernetes service accounts

Example usage

# List IAM roles for service accounts
  rosa list iamserviceaccounts --cluster my-cluster

# List IAM roles for service accounts
  rosa list iamserviceaccounts --cluster my-cluster

Copy to Clipboard

Toggle word wrap

7.2.1.77. rosa list idps
Copiar o link

List cluster IDPs

Example usage

# List all identity providers on a cluster named "mycluster"
  rosa list idps --cluster=mycluster

# List all identity providers on a cluster named "mycluster"
  rosa list idps --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.78. rosa list image-mirrors
Copiar o link

List cluster image mirrors

Example usage

# List all image mirrors on a cluster named "mycluster"
  rosa list image-mirrors --cluster=mycluster

# List all image mirrors on a cluster named "mycluster"
  rosa list image-mirrors --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.79. rosa list ingresses
Copiar o link

List cluster Ingresses

Example usage

# List all routes on a cluster named "mycluster"
  rosa list ingresses --cluster=mycluster

# List all routes on a cluster named "mycluster"
  rosa list ingresses --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.80. rosa list instance-types
Copiar o link

List Instance types

Example usage

# List all instance types
	rosa list instance-types

# List all instance types
	rosa list instance-types

Copy to Clipboard

Toggle word wrap

7.2.1.81. rosa list kubeletconfigs
Copiar o link

List kubeletconfigs

Example usage

# List the kubeletconfigs for cluster 'foo'
rosa list kubeletconfig --cluster foo

# List the kubeletconfigs for cluster 'foo'
rosa list kubeletconfig --cluster foo

Copy to Clipboard

Toggle word wrap

7.2.1.82. rosa list machinepools
Copiar o link

List cluster machine pools

Example usage

# List all machine pools on a cluster named "mycluster"
  rosa list machinepools --cluster=mycluster

  # List machine pools showing all information
  rosa list machinepools --cluster=mycluster --all

# List all machine pools on a cluster named "mycluster"
  rosa list machinepools --cluster=mycluster

  # List machine pools showing all information
  rosa list machinepools --cluster=mycluster --all

Copy to Clipboard

Toggle word wrap

7.2.1.83. rosa list ocm-roles
Copiar o link

List ocm roles

Example usage

# List all ocm roles
rosa list ocm-roles

# List all ocm roles
rosa list ocm-roles

Copy to Clipboard

Toggle word wrap

7.2.1.84. rosa list oidc-config
Copiar o link

List OIDC Configuration resources

Example usage

# List all OIDC Configurations tied to your organization ID"
  rosa list oidc-config

# List all OIDC Configurations tied to your organization ID"
  rosa list oidc-config

Copy to Clipboard

Toggle word wrap

7.2.1.85. rosa list oidc-providers
Copiar o link

List OIDC providers

Example usage

# List all oidc providers
  rosa list oidc-providers

# List all oidc providers
  rosa list oidc-providers

Copy to Clipboard

Toggle word wrap

7.2.1.86. rosa list operator-roles
Copiar o link

List operator roles and policies

Example usage

# List all operator roles
  rosa list operator-roles

# List all operator roles
  rosa list operator-roles

Copy to Clipboard

Toggle word wrap

7.2.1.87. rosa list regions
Copiar o link

List available regions

Example usage

# List all available regions
  rosa list regions

# List all available regions
  rosa list regions

Copy to Clipboard

Toggle word wrap

7.2.1.88. rosa list tuning-configs
Copiar o link

List tuning configs

Example usage

# List all tuning configuration for a cluster named 'mycluster'"
  rosa list tuning-configs -c mycluster

# List all tuning configuration for a cluster named 'mycluster'"
  rosa list tuning-configs -c mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.89. rosa list user-roles
Copiar o link

List user roles

Example usage

# List all user roles
rosa list user-roles

# List all user roles
rosa list user-roles

Copy to Clipboard

Toggle word wrap

7.2.1.90. rosa list users
Copiar o link

List cluster users

Example usage

# List all users on a cluster named "mycluster"
  rosa list users --cluster=mycluster

# List all users on a cluster named "mycluster"
  rosa list users --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.91. rosa list versions
Copiar o link

List available versions

Example usage

# List all OpenShift versions
  rosa list versions

# List all OpenShift versions
  rosa list versions

Copy to Clipboard

Toggle word wrap

7.2.1.92. rosa login
Copiar o link

Example usage

# Login to the OpenShift API with an existing token generated from https://console.redhat.com/openshift/token/rosa
  rosa login --token=$OFFLINE_ACCESS_TOKEN

# Login to the OpenShift API with an existing token generated from https://console.redhat.com/openshift/token/rosa
  rosa login --token=$OFFLINE_ACCESS_TOKEN

Copy to Clipboard

Toggle word wrap

7.2.1.93. rosa logs
Copiar o link

Show installation or uninstallation logs for a cluster

Example usage

# Show install logs for a cluster named 'mycluster'
  rosa logs install --cluster=mycluster

  # Show uninstall logs for a cluster named 'mycluster'
  rosa logs uninstall --cluster=mycluster

# Show install logs for a cluster named 'mycluster'
  rosa logs install --cluster=mycluster

  # Show uninstall logs for a cluster named 'mycluster'
  rosa logs uninstall --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.94. rosa logs install
Copiar o link

Show cluster installation logs

Example usage

# Show last 100 install log lines for a cluster named "mycluster"
  rosa logs install mycluster --tail=100

  # Show install logs for a cluster using the --cluster flag
  rosa logs install --cluster=mycluster

# Show last 100 install log lines for a cluster named "mycluster"
  rosa logs install mycluster --tail=100

  # Show install logs for a cluster using the --cluster flag
  rosa logs install --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.95. rosa logs uninstall
Copiar o link

Show cluster uninstallation logs

Example usage

# Show last 100 uninstall log lines for a cluster named "mycluster"
  rosa logs uninstall mycluster --tail=100

  # Show uninstall logs for a cluster using the --cluster flag
  rosa logs uninstall --cluster=mycluster

# Show last 100 uninstall log lines for a cluster named "mycluster"
  rosa logs uninstall mycluster --tail=100

  # Show uninstall logs for a cluster using the --cluster flag
  rosa logs uninstall --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.96. rosa register oidc-config
Copiar o link

Registers unmanaged OIDC config with Openshift Clusters Manager.

Example usage

# Register OIDC config
	rosa register oidc-config

# Register OIDC config
	rosa register oidc-config

Copy to Clipboard

Toggle word wrap

7.2.1.97. rosa revoke break-glass-credentials
Copiar o link

Revoke break glass credentials

Example usage

# Revoke all break glass credentials
  rosa revoke break-glass-credentials --cluster=mycluster

# Revoke all break glass credentials
  rosa revoke break-glass-credentials --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.98. rosa revoke user
Copiar o link

Revoke role from users

Example usage

# Revoke cluster-admin role from a user
  rosa revoke user cluster-admins --user=myusername --cluster=mycluster

  # Revoke dedicated-admin role from a user
  rosa revoke user dedicated-admins --user=myusername --cluster=mycluster

# Revoke cluster-admin role from a user
  rosa revoke user cluster-admins --user=myusername --cluster=mycluster

  # Revoke dedicated-admin role from a user
  rosa revoke user dedicated-admins --user=myusername --cluster=mycluster

Copy to Clipboard

Toggle word wrap

7.2.1.99. rosa uninstall addon
Copiar o link

Uninstall add-on from cluster

Example usage

# Remove the CodeReady Workspaces add-on installation from the cluster
  rosa uninstall addon --cluster=mycluster codeready-workspaces

# Remove the CodeReady Workspaces add-on installation from the cluster
  rosa uninstall addon --cluster=mycluster codeready-workspaces

Copy to Clipboard

Toggle word wrap

7.2.1.100. rosa unlink ocm-role
Copiar o link

Unlink ocm role from a specific OCM organization

Example usage

#Unlink ocm role
rosa unlink ocm-role --role-arn arn:aws:iam::123456789012:role/ManagedOpenshift-OCM-Role

#Unlink ocm role
rosa unlink ocm-role --role-arn arn:aws:iam::123456789012:role/ManagedOpenshift-OCM-Role

Copy to Clipboard

Toggle word wrap

7.2.1.101. rosa unlink user-role
Copiar o link

Unlink user role from a specific OCM account

Example usage

# Unlink user role
rosa unlink user-role --role-arn arn:aws:iam::{accountid}:role/{prefix}-User-{username}-Role

# Unlink user role
rosa unlink user-role --role-arn arn:aws:iam::{accountid}:role/{prefix}-User-{username}-Role

Copy to Clipboard

Toggle word wrap

7.2.1.102. rosa upgrade account-roles
Copiar o link

Upgrade account-wide IAM roles to the latest version.

Example usage

# Upgrade account roles for ROSA STS clusters
  rosa upgrade account-roles

# Upgrade account roles for ROSA STS clusters
  rosa upgrade account-roles

Copy to Clipboard

Toggle word wrap

7.2.1.103. rosa upgrade cluster
Copiar o link

Upgrade cluster

Example usage

# Interactively schedule an upgrade on the cluster named "mycluster"
  rosa upgrade cluster --cluster=mycluster --interactive

  # Schedule a cluster upgrade within the hour
  rosa upgrade cluster -c mycluster --version 4.12.20

  # Check if any gates need to be acknowledged prior to attempting an upgrading
  rosa upgrade cluster -c mycluster --version 4.12.20 --dry-run

# Interactively schedule an upgrade on the cluster named "mycluster"
  rosa upgrade cluster --cluster=mycluster --interactive

  # Schedule a cluster upgrade within the hour
  rosa upgrade cluster -c mycluster --version 4.12.20

  # Check if any gates need to be acknowledged prior to attempting an upgrading
  rosa upgrade cluster -c mycluster --version 4.12.20 --dry-run

Copy to Clipboard

Toggle word wrap

7.2.1.104. rosa upgrade machinepool
Copiar o link

Upgrade machinepool

Example usage

# Interactively schedule an upgrade on the cluster named "mycluster"" for a machinepool named "np1"
  rosa upgrade machinepool np1 --cluster=mycluster --interactive

  # Schedule a machinepool upgrade within the hour
  rosa upgrade machinepool np1 -c mycluster --version 4.12.20

# Interactively schedule an upgrade on the cluster named "mycluster"" for a machinepool named "np1"
  rosa upgrade machinepool np1 --cluster=mycluster --interactive

  # Schedule a machinepool upgrade within the hour
  rosa upgrade machinepool np1 -c mycluster --version 4.12.20

Copy to Clipboard

Toggle word wrap

7.2.1.105. rosa upgrade operator-roles
Copiar o link

Upgrade operator IAM roles for a cluster.

Example usage

# Upgrade cluster-specific operator IAM roles
  rosa upgrade operators-roles

# Upgrade cluster-specific operator IAM roles
  rosa upgrade operators-roles

Copy to Clipboard

Toggle word wrap

7.2.1.106. rosa upgrade roles
Copiar o link

Upgrade cluster-specific IAM roles to the latest version.

Example usage

# Upgrade cluster roles for ROSA STS clusters
		rosa upgrade roles -c <cluster_key>

# Upgrade cluster roles for ROSA STS clusters
		rosa upgrade roles -c <cluster_key>

Copy to Clipboard

Toggle word wrap

7.2.1.107. rosa verify network
Copiar o link

Verify VPC subnets are configured correctly

Example usage

# Verify two subnets
	rosa verify network --subnet-ids subnet-03046a9b92b5014fb,subnet-03046a9c92b5014fb

# Verify two subnets
	rosa verify network --subnet-ids subnet-03046a9b92b5014fb,subnet-03046a9c92b5014fb

Copy to Clipboard

Toggle word wrap

7.2.1.108. rosa verify openshift-client
Copiar o link

Verify OpenShift client tools

Example usage

# Verify oc client tools
  rosa verify oc

# Verify oc client tools
  rosa verify oc

Copy to Clipboard

Toggle word wrap

7.2.1.109. rosa verify permissions
Copiar o link

Verify AWS permissions are ok for non-STS cluster install

Example usage

# Verify AWS permissions are configured correctly
  rosa verify permissions

  # Verify AWS permissions in a different region
  rosa verify permissions --region=us-west-2

# Verify AWS permissions are configured correctly
  rosa verify permissions

  # Verify AWS permissions in a different region
  rosa verify permissions --region=us-west-2

Copy to Clipboard

Toggle word wrap

7.2.1.110. rosa verify quota
Copiar o link

Verify AWS quota is ok for cluster install

Example usage

# Verify AWS quotas are configured correctly
  rosa verify quota

  # Verify AWS quotas in a different region
  rosa verify quota --region=us-west-2

# Verify AWS quotas are configured correctly
  rosa verify quota

  # Verify AWS quotas in a different region
  rosa verify quota --region=us-west-2

Copy to Clipboard

Toggle word wrap

7.2.1.111. rosa verify rosa-client
Copiar o link

Verify ROSA client tools

Example usage

# Verify rosa client tools
  rosa verify rosa

# Verify rosa client tools
  rosa verify rosa

Copy to Clipboard

Toggle word wrap

7.2.1.112. rosa whoami
Copiar o link

Displays user account information

Example usage

# Displays user information
  rosa whoami

# Displays user information
  rosa whoami

Copy to Clipboard

Toggle word wrap

7.3. Least privilege permissions for ROSA CLI commands
Copiar o link

You can create roles with permissions that adhere to the principal of least privilege, in which the users assigned the roles have no other permissions assigned to them outside the scope of the specific action they need to perform. These policies contain only the minimum required permissions needed to perform specific actions by using the ROSA command-line interface (CLI) (rosa).

Important

Although the policies and commands presented in this topic will work in conjunction with one another, you might have other restrictions within your AWS environment that make the policies for these commands insufficient for your specific needs. Red Hat provides these examples as a baseline, assuming no other AWS Identity and Access Management (IAM) restrictions are present.

For more information about configuring permissions, policies, and roles in the AWS console, see AWS Identity and Access Management in the AWS documentation.

7.3.1. Least privilege permissions for common Red Hat OpenShift Service on AWS CLI commands
Copiar o link

The following examples show the least privilege permissions needed for the most common ROSA CLI commands when building Red Hat OpenShift Service on AWS clusters.

7.3.1.1. Create a managed OpenID Connect (OIDC) provider
Copiar o link

Run the following command with the specified permissions to create your managed OIDC provider by using auto mode.

Input

rosa create oidc-config --mode auto

$ rosa create oidc-config --mode auto

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "CreateOidcConfig",
            "Effect": "Allow",
            "Action": [
                "iam:TagOpenIDConnectProvider",
                "iam:CreateOpenIDConnectProvider"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "CreateOidcConfig",
            "Effect": "Allow",
            "Action": [
                "iam:TagOpenIDConnectProvider",
                "iam:CreateOpenIDConnectProvider"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.2. Create an unmanaged OpenID Connect provider
Copiar o link

Run the following command with the specified permissions to create your unmanaged OIDC provider by using auto mode.

Input

rosa create oidc-config --mode auto --managed=false

$ rosa create oidc-config --mode auto --managed=false

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:TagOpenIDConnectProvider",
                "iam:ListRoleTags",
                "iam:ListRoles",
                "iam:CreateOpenIDConnectProvider",
                "s3:CreateBucket",
                "s3:PutObject",
                "s3:PutBucketTagging",
                "s3:PutBucketPolicy",
                "s3:PutObjectTagging",
                "s3:PutBucketPublicAccessBlock",
                "secretsmanager:CreateSecret",
                "secretsmanager:TagResource"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:TagOpenIDConnectProvider",
                "iam:ListRoleTags",
                "iam:ListRoles",
                "iam:CreateOpenIDConnectProvider",
                "s3:CreateBucket",
                "s3:PutObject",
                "s3:PutBucketTagging",
                "s3:PutBucketPolicy",
                "s3:PutObjectTagging",
                "s3:PutBucketPublicAccessBlock",
                "secretsmanager:CreateSecret",
                "secretsmanager:TagResource"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.3. List your account roles
Copiar o link

Run the following command with the specified permissions to list your account roles.

Input

rosa list account-roles

$ rosa list account-roles

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ListAccountRoles",
            "Effect": "Allow",
            "Action": [
                "iam:ListRoleTags",
                "iam:ListRoles"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ListAccountRoles",
            "Effect": "Allow",
            "Action": [
                "iam:ListRoleTags",
                "iam:ListRoles"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.4. List your Operator roles
Copiar o link

Run the following command with the specified permissions to list your Operator roles.

Input

rosa list operator-roles

$ rosa list operator-roles

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ListOperatorRoles",
            "Effect": "Allow",
            "Action": [
                "iam:ListRoleTags",
                "iam:ListAttachedRolePolicies",
                "iam:ListRoles",
                "iam:ListPolicyTags"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ListOperatorRoles",
            "Effect": "Allow",
            "Action": [
                "iam:ListRoleTags",
                "iam:ListAttachedRolePolicies",
                "iam:ListRoles",
                "iam:ListPolicyTags"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.5. List your OIDC providers
Copiar o link

Run the following command with the specified permissions to list your OIDC providers.

Input

rosa list oidc-providers

$ rosa list oidc-providers

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ListOidcProviders",
            "Effect": "Allow",
            "Action": [
                "iam:ListOpenIDConnectProviders",
                "iam:ListOpenIDConnectProviderTags"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ListOidcProviders",
            "Effect": "Allow",
            "Action": [
                "iam:ListOpenIDConnectProviders",
                "iam:ListOpenIDConnectProviderTags"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.6. Verify your quota
Copiar o link

Run the following command with the specified permissions to verify your quota.

Input

rosa verify quota

$ rosa verify quota

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VerifyQuota",
            "Effect": "Allow",
            "Action": [
                "elasticloadbalancing:DescribeAccountLimits",
                "servicequotas:ListServiceQuotas"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VerifyQuota",
            "Effect": "Allow",
            "Action": [
                "elasticloadbalancing:DescribeAccountLimits",
                "servicequotas:ListServiceQuotas"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.7. Delete your managed OIDC configuration
Copiar o link

Run the following command with the specified permissions to delete your managed OIDC configuration by using auto mode.

Input

rosa delete oidc-config -–mode auto

$ rosa delete oidc-config -–mode auto

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "DeleteOidcConfig",
            "Effect": "Allow",
            "Action": [
                "iam:ListOpenIDConnectProviders",
                "iam:DeleteOpenIDConnectProvider"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "DeleteOidcConfig",
            "Effect": "Allow",
            "Action": [
                "iam:ListOpenIDConnectProviders",
                "iam:DeleteOpenIDConnectProvider"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.8. Delete your unmanaged OIDC configuration
Copiar o link

Run the following command with the specified permissions to delete your unmanaged OIDC configuration by using auto mode.

Input

rosa delete oidc-config -–mode auto

$ rosa delete oidc-config -–mode auto

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "iam:ListOpenIDConnectProviders",
                "iam:DeleteOpenIDConnectProvider",
                "secretsmanager:DeleteSecret",
                "s3:ListBucket",
                "s3:DeleteObject",
                "s3:DeleteBucket"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "iam:ListOpenIDConnectProviders",
                "iam:DeleteOpenIDConnectProvider",
                "secretsmanager:DeleteSecret",
                "s3:ListBucket",
                "s3:DeleteObject",
                "s3:DeleteBucket"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.9. Create a cluster
Copiar o link

Run the following command with the specified permissions to create Red Hat OpenShift Service on AWS clusters.

Input

rosa create cluster --hosted-cp

$ rosa create cluster --hosted-cp

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "CreateCluster",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:ListRoleTags",
                "iam:ListAttachedRolePolicies",
                "iam:ListRoles",
                "ec2:DescribeSubnets",
                "ec2:DescribeRouteTables",
                "ec2:DescribeAvailabilityZones"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "CreateCluster",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:ListRoleTags",
                "iam:ListAttachedRolePolicies",
                "iam:ListRoles",
                "ec2:DescribeSubnets",
                "ec2:DescribeRouteTables",
                "ec2:DescribeAvailabilityZones"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.10. Create your account roles and Operator roles
Copiar o link

Run the following command with the specified permissions to create account and Operator roles by using auto mode.

Input

rosa create account-roles --mode auto --hosted-cp

$ rosa create account-roles --mode auto --hosted-cp

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "CreateAccountRoles",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:UpdateAssumeRolePolicy",
                "iam:ListRoleTags",
                "iam:GetPolicy",
                "iam:TagRole",
                "iam:ListRoles",
                "iam:CreateRole",
                "iam:AttachRolePolicy",
                "iam:ListPolicyTags"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "CreateAccountRoles",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:UpdateAssumeRolePolicy",
                "iam:ListRoleTags",
                "iam:GetPolicy",
                "iam:TagRole",
                "iam:ListRoles",
                "iam:CreateRole",
                "iam:AttachRolePolicy",
                "iam:ListPolicyTags"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.11. Delete your account roles
Copiar o link

Run the following command with the specified permissions to delete the account roles in auto mode.

Input

rosa delete account-roles -–mode auto

$ rosa delete account-roles -–mode auto

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "DeleteAccountRoles",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:ListInstanceProfilesForRole",
                "iam:DetachRolePolicy",
                "iam:ListAttachedRolePolicies",
                "iam:ListRoles",
                "iam:DeleteRole",
                "iam:ListRolePolicies"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "DeleteAccountRoles",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:ListInstanceProfilesForRole",
                "iam:DetachRolePolicy",
                "iam:ListAttachedRolePolicies",
                "iam:ListRoles",
                "iam:DeleteRole",
                "iam:ListRolePolicies"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.1.12. Delete your Operator roles
Copiar o link

Run the following command with the specified permissions to delete your Operator roles in auto mode.

Input

rosa delete operator-roles -–mode auto

$ rosa delete operator-roles -–mode auto

Copy to Clipboard

Toggle word wrap

Policy

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "DeleteOperatorRoles",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:DetachRolePolicy",
                "iam:ListAttachedRolePolicies",
                "iam:ListRoles",
                "iam:DeleteRole"
            ],
            "Resource": "*"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "DeleteOperatorRoles",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "iam:DetachRolePolicy",
                "iam:ListAttachedRolePolicies",
                "iam:ListRoles",
                "iam:DeleteRole"
            ],
            "Resource": "*"
        }
    ]
}

Copy to Clipboard

Toggle word wrap

7.3.2. ROSA CLI commands with no required permissions
Copiar o link

The following ROSA CLI commands do not require permissions or policies to run. Instead, they require an access key and configured secret key or an attached role.

Expand

Table 7.11. Commands
Command	Input
list cluster	`$ rosa list cluster`
list versions	`$ rosa list versions`
describe cluster	`$ rosa describe cluster -c <cluster name>`
create admin	`$ rosa create admin -c <cluster name>`
list users	`$ rosa list users -c <cluster-name>`
list upgrades	`$ rosa list upgrades`
list OIDC configuration	`$ rosa list oidc-config`
list identity providers	`$ rosa list idps -c <cluster-name>`
list ingresses	`$ rosa list ingresses -c <cluster-name>`

7.4. Managing billing accounts for Red Hat OpenShift Service on AWS clusters
Copiar o link

You can use the ROSA CLI (rosa) to link your cluster to the desired AWS billing account after the cluster has been deployed.

This can be useful if you have accidentally linked to the wrong AWS billing account during cluster deployment, or if you simply want to update the billing account.

Note

You also have the option to update your billing account through the OpenShift Cluster Manager. For more information, see Updating billing accounts for Red Hat OpenShift Service on AWS clusters.

7.4.1. Update billing accounts for Red Hat OpenShift Service on AWS clusters
Copiar o link

Prerequisites

You must have more than one AWS billing account.
The AWS billing account you want your cluster to link to must already be linked to the Red Hat organization where the cluster is deployed.

Procedure

Run the following command in your terminal window:
Syntax
```
rosa edit cluster -c <cluster_ID>
```
```
$ rosa edit cluster -c <cluster_ID> 
```
1
Copy to Clipboard Toggle word wrap
1
Replace <cluster_ID> with the ID of the cluster that you want to update the AWS billing account.
Note
To locate the IDs of your active clusters, run the $ rosa list clusters command in your terminal window.
Skip to the Billing Account parameter within the interactive mode.
Select the desired AWS billing account from the list of available options and press "Enter".
The AWS billing account for your cluster is now updated.

Voltar ao topo

Este conteúdo não está disponível no idioma selecionado.

Chapter 7. ROSA CLI

7.1. Getting started with the ROSA CLICopiar o linkLink copiado para a área de transferência!

7.1.1. About the ROSA CLICopiar o linkLink copiado para a área de transferência!

7.1.2. Setting up the ROSA CLICopiar o linkLink copiado para a área de transferência!

7.1.3. Configuring the ROSA CLICopiar o linkLink copiado para a área de transferência!

7.1.3.1. loginCopiar o linkLink copiado para a área de transferência!

7.1.3.1.1. Authenticating the ROSA CLI with Red Hat single sign-onCopiar o linkLink copiado para a área de transferência!

7.1.3.1.2. Authenticating the ROSA CLI with a single sign-on authorization codeCopiar o linkLink copiado para a área de transferência!

7.1.3.1.3. Authenticating the ROSA CLI with a single sign-on device codeCopiar o linkLink copiado para a área de transferência!

7.1.3.1.4. Authenticating the ROSA CLI with an offline tokenCopiar o linkLink copiado para a área de transferência!

7.1.3.2. logoutCopiar o linkLink copiado para a área de transferência!

7.1.3.3. verify permissionsCopiar o linkLink copiado para a área de transferência!

7.1.3.4. verify quotaCopiar o linkLink copiado para a área de transferência!

7.1.3.5. download rosaCopiar o linkLink copiado para a área de transferência!

7.1.3.6. download ocCopiar o linkLink copiado para a área de transferência!

7.1.3.7. verify ocCopiar o linkLink copiado para a área de transferência!

7.1.4. Updating the ROSA CLICopiar o linkLink copiado para a área de transferência!

7.2. ROSA CLI command referenceCopiar o linkLink copiado para a área de transferência!

7.2.1. ROSA CLI commandsCopiar o linkLink copiado para a área de transferência!

7.2.1.1. rosa create account-rolesCopiar o linkLink copiado para a área de transferência!

7.2.1.2. rosa create adminCopiar o linkLink copiado para a área de transferência!

7.2.1.3. rosa create autoscalerCopiar o linkLink copiado para a área de transferência!

7.2.1.4. rosa create break-glass-credentialCopiar o linkLink copiado para a área de transferência!

7.2.1.5. rosa create clusterCopiar o linkLink copiado para a área de transferência!

7.2.1.6. rosa create decisionCopiar o linkLink copiado para a área de transferência!

7.2.1.7. rosa create dns-domainCopiar o linkLink copiado para a área de transferência!

7.2.1.8. rosa create external-auth-providerCopiar o linkLink copiado para a área de transferência!

7.2.1.9. rosa create iamserviceaccountCopiar o linkLink copiado para a área de transferência!

7.2.1.10. rosa create idpCopiar o linkLink copiado para a área de transferência!

7.2.1.11. rosa create image-mirrorCopiar o linkLink copiado para a área de transferência!

7.2.1.12. rosa create kubeletconfigCopiar o linkLink copiado para a área de transferência!

7.2.1.13. rosa create machinepoolCopiar o linkLink copiado para a área de transferência!

7.2.1.14. rosa create networkCopiar o linkLink copiado para a área de transferência!

7.2.1.15. rosa create ocm-roleCopiar o linkLink copiado para a área de transferência!

7.2.1.16. rosa create oidc-configCopiar o linkLink copiado para a área de transferência!

7.2.1.17. rosa create oidc-providerCopiar o linkLink copiado para a área de transferência!

7.2.1.18. rosa create operator-rolesCopiar o linkLink copiado para a área de transferência!

7.2.1.19. rosa create tuning-configsCopiar o linkLink copiado para a área de transferência!

7.2.1.20. rosa create user-roleCopiar o linkLink copiado para a área de transferência!

7.2.1.21. rosa delete account-rolesCopiar o linkLink copiado para a área de transferência!

7.2.1.22. rosa delete adminCopiar o linkLink copiado para a área de transferência!

7.2.1.23. rosa delete autoscalerCopiar o linkLink copiado para a área de transferência!

7.2.1.24. rosa delete clusterCopiar o linkLink copiado para a área de transferência!

7.2.1.25. rosa delete dns-domainCopiar o linkLink copiado para a área de transferência!

7.2.1.26. rosa delete external-auth-providerCopiar o linkLink copiado para a área de transferência!

7.2.1.27. rosa delete iamserviceaccountCopiar o linkLink copiado para a área de transferência!

7.2.1.28. rosa delete idpCopiar o linkLink copiado para a área de transferência!

7.2.1.29. rosa delete image-mirrorCopiar o linkLink copiado para a área de transferência!

7.2.1.30. rosa delete ingressCopiar o linkLink copiado para a área de transferência!

7.2.1.31. rosa delete kubeletconfigCopiar o linkLink copiado para a área de transferência!

7.2.1.32. rosa delete machinepoolCopiar o linkLink copiado para a área de transferência!

7.2.1.33. rosa delete ocm-roleCopiar o linkLink copiado para a área de transferência!

7.2.1.34. rosa delete oidc-configCopiar o linkLink copiado para a área de transferência!

7.2.1.35. rosa delete oidc-providerCopiar o linkLink copiado para a área de transferência!

7.2.1.36. rosa delete operator-rolesCopiar o linkLink copiado para a área de transferência!

7.2.1.37. rosa delete tuning-configsCopiar o linkLink copiado para a área de transferência!

7.2.1.38. rosa delete user-roleCopiar o linkLink copiado para a área de transferência!

7.2.1.39. rosa describe access-requestCopiar o linkLink copiado para a área de transferência!

7.2.1.40. rosa describe addonCopiar o linkLink copiado para a área de transferência!

7.2.1.41. rosa describe addon-installationCopiar o linkLink copiado para a área de transferência!

7.2.1.42. rosa describe adminCopiar o linkLink copiado para a área de transferência!

7.2.1.43. rosa describe autoscalerCopiar o linkLink copiado para a área de transferência!

7.2.1.44. rosa describe break-glass-credentialCopiar o linkLink copiado para a área de transferência!

7.2.1.45. rosa describe clusterCopiar o linkLink copiado para a área de transferência!

7.2.1.46. rosa describe external-auth-providerCopiar o linkLink copiado para a área de transferência!

7.2.1.47. rosa describe iamserviceaccountCopiar o linkLink copiado para a área de transferência!

7.2.1.48. rosa describe ingressCopiar o linkLink copiado para a área de transferência!

7.2.1.49. rosa describe kubeletconfigCopiar o linkLink copiado para a área de transferência!

7.2.1.50. rosa describe machinepoolCopiar o linkLink copiado para a área de transferência!

7.2.1.51. rosa describe tuning-configsCopiar o linkLink copiado para a área de transferência!

7.2.1.52. rosa describe upgradeCopiar o linkLink copiado para a área de transferência!

7.2.1.53. rosa download openshift-clientCopiar o linkLink copiado para a área de transferência!

7.2.1.54. rosa download rosa-clientCopiar o linkLink copiado para a área de transferência!

7.2.1.55. rosa edit addonCopiar o linkLink copiado para a área de transferência!

7.2.1.56. rosa edit autoscalerCopiar o linkLink copiado para a área de transferência!

7.2.1.57. rosa edit clusterCopiar o linkLink copiado para a área de transferência!

7.2.1.58. rosa edit image-mirrorCopiar o linkLink copiado para a área de transferência!

7.2.1.59. rosa edit ingressCopiar o linkLink copiado para a área de transferência!

7.2.1.60. rosa edit kubeletconfigCopiar o linkLink copiado para a área de transferência!

7.1. Getting started with the ROSA CLI
Copiar o link

7.1.1. About the ROSA CLI
Copiar o link

7.1.2. Setting up the ROSA CLI
Copiar o link

7.1.3. Configuring the ROSA CLI
Copiar o link

7.1.3.1. login
Copiar o link

7.1.3.1.1. Authenticating the ROSA CLI with Red Hat single sign-on
Copiar o link

7.1.3.1.2. Authenticating the ROSA CLI with a single sign-on authorization code
Copiar o link

7.1.3.1.3. Authenticating the ROSA CLI with a single sign-on device code
Copiar o link

7.1.3.1.4. Authenticating the ROSA CLI with an offline token
Copiar o link

7.1.3.2. logout
Copiar o link

7.1.3.3. verify permissions
Copiar o link

7.1.3.4. verify quota
Copiar o link

7.1.3.5. download rosa
Copiar o link

7.1.3.6. download oc
Copiar o link

7.1.3.7. verify oc
Copiar o link

7.1.4. Updating the ROSA CLI
Copiar o link

7.2. ROSA CLI command reference
Copiar o link

7.2.1. ROSA CLI commands
Copiar o link

7.2.1.1. rosa create account-roles
Copiar o link

7.2.1.2. rosa create admin
Copiar o link

7.2.1.3. rosa create autoscaler
Copiar o link

7.2.1.4. rosa create break-glass-credential
Copiar o link

7.2.1.5. rosa create cluster
Copiar o link

7.2.1.6. rosa create decision
Copiar o link

7.2.1.7. rosa create dns-domain
Copiar o link

7.2.1.8. rosa create external-auth-provider
Copiar o link

7.2.1.9. rosa create iamserviceaccount
Copiar o link

7.2.1.10. rosa create idp
Copiar o link

7.2.1.11. rosa create image-mirror
Copiar o link

7.2.1.12. rosa create kubeletconfig
Copiar o link

7.2.1.13. rosa create machinepool
Copiar o link

7.2.1.14. rosa create network
Copiar o link

7.2.1.15. rosa create ocm-role
Copiar o link

7.2.1.16. rosa create oidc-config
Copiar o link

7.2.1.17. rosa create oidc-provider
Copiar o link

7.2.1.18. rosa create operator-roles
Copiar o link

7.2.1.19. rosa create tuning-configs
Copiar o link

7.2.1.20. rosa create user-role
Copiar o link

7.2.1.21. rosa delete account-roles
Copiar o link

7.2.1.22. rosa delete admin
Copiar o link

7.2.1.23. rosa delete autoscaler
Copiar o link

7.2.1.24. rosa delete cluster
Copiar o link

7.2.1.25. rosa delete dns-domain
Copiar o link

7.2.1.26. rosa delete external-auth-provider
Copiar o link

7.2.1.27. rosa delete iamserviceaccount
Copiar o link

7.2.1.28. rosa delete idp
Copiar o link

7.2.1.29. rosa delete image-mirror
Copiar o link

7.2.1.30. rosa delete ingress
Copiar o link

7.2.1.31. rosa delete kubeletconfig
Copiar o link

7.2.1.32. rosa delete machinepool
Copiar o link

7.2.1.33. rosa delete ocm-role
Copiar o link

7.2.1.34. rosa delete oidc-config
Copiar o link

7.2.1.35. rosa delete oidc-provider
Copiar o link

7.2.1.36. rosa delete operator-roles
Copiar o link

7.2.1.37. rosa delete tuning-configs
Copiar o link

7.2.1.38. rosa delete user-role
Copiar o link

7.2.1.39. rosa describe access-request
Copiar o link

7.2.1.40. rosa describe addon
Copiar o link

7.2.1.41. rosa describe addon-installation
Copiar o link

7.2.1.42. rosa describe admin
Copiar o link

7.2.1.43. rosa describe autoscaler
Copiar o link

7.2.1.44. rosa describe break-glass-credential
Copiar o link

7.2.1.45. rosa describe cluster
Copiar o link

7.2.1.46. rosa describe external-auth-provider
Copiar o link

7.2.1.47. rosa describe iamserviceaccount
Copiar o link

7.2.1.48. rosa describe ingress
Copiar o link

7.2.1.49. rosa describe kubeletconfig
Copiar o link

7.2.1.50. rosa describe machinepool
Copiar o link

7.2.1.51. rosa describe tuning-configs
Copiar o link

7.2.1.52. rosa describe upgrade
Copiar o link

7.2.1.53. rosa download openshift-client
Copiar o link

7.2.1.54. rosa download rosa-client
Copiar o link

7.2.1.55. rosa edit addon
Copiar o link

7.2.1.56. rosa edit autoscaler
Copiar o link

7.2.1.57. rosa edit cluster
Copiar o link

7.2.1.58. rosa edit image-mirror
Copiar o link

7.2.1.59. rosa edit ingress
Copiar o link

7.2.1.60. rosa edit kubeletconfig
Copiar o link

7.2.1.61. rosa edit machinepool
Copiar o link

7.2.1.62. rosa edit tuning-configs
Copiar o link