openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity
Files
3578cab0207c4a985c0790fecd13e7b520fcbef8
openshift-docs/modules/rosa-by-example-content.adoc
Ben Hardesty 4cd16c7a2b OSDOCS-17417: Generate ROSA CLI command ref
2026-01-07 08:35:20 +00:00

1556 lines
32 KiB
Plaintext
Raw Blame History

// NOTE: The contents of this file are auto-generated
:_mod-docs-content-type: REFERENCE
[id="rosa-cli-commands_{context}"]
= ROSA CLI commands
== rosa create account-roles
Create account-wide IAM roles before creating your cluster.
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa create admin
Creates an admin user to login to the cluster
.Example usage
[source,bash,options="nowrap"]
----
# Create an admin user to login to the cluster
rosa create admin -c mycluster -p MasterKey123
----
== rosa create autoscaler
Create an autoscaler for a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa create break-glass-credential
Create a break glass credential for a cluster.
.Example usage
[source,bash,options="nowrap"]
----
# Interactively create a break glass credential to a cluster named "mycluster"
rosa create break-glass-credential --cluster=mycluster --interactive
----
== rosa create cluster
Create cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa create decision
Create a decision for an Access Request
.Example usage
[source,bash,options="nowrap"]
----
# Create a decision for an Access Request to approve it
rosa create decision --access-request <access_request_id> --decision Approved
----
== rosa create dns-domain
Create DNS Domain.
.Example usage
[source,bash,options="nowrap"]
----
# Create DNS Domain
rosa create dns-domain
----
== rosa create external-auth-provider
Create an external authentication provider for a cluster.
.Example usage
[source,bash,options="nowrap"]
----
# Interactively create an external authentication provider to a cluster named "mycluster"
rosa create external-auth-provider --cluster=mycluster --interactive
----
== rosa create iamserviceaccount
Create IAM role for Kubernetes service account
.Example usage
[source,bash,options="nowrap"]
----
# Create an IAM role for a service account
rosa create iamserviceaccount --cluster my-cluster --name my-app --namespace default
----
== rosa create idp
Add IDP for cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa create image-mirror
Create image mirror for a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa create kubeletconfig
Create a custom kubeletconfig for a cluster
.Example usage
[source,bash,options="nowrap"]
----
# Create a custom kubeletconfig with a pod-pids-limit of 5000
rosa create kubeletconfig --cluster=mycluster --pod-pids-limit=5000
----
== rosa create log-forwarder
Create a log forwarder for a Hosted Control Plane cluster
.Example usage
[source,bash,options="nowrap"]
----
# Create a log forwarder using a config file
rosa create log-forwarder -c mycluster-hcp --log-fwd-config=s3.yml
# Create a log forwarder interactively
rosa create log-forwarder -c mycluster-hcp --interactive
----
== rosa create machinepool
Add machine pool to cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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"
----
== rosa create network
Network AWS cloudformation stack
.Example usage
[source,bash,options="nowrap"]
----
# 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.
----
== rosa create ocm-role
Create role used by OCM
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa create oidc-config
Create OIDC config compliant with OIDC protocol.
.Example usage
[source,bash,options="nowrap"]
----
# Create OIDC config
rosa create oidc-config
----
== rosa create oidc-provider
Create OIDC provider for an STS cluster.
.Example usage
[source,bash,options="nowrap"]
----
# Create OIDC provider for cluster named "mycluster"
rosa create oidc-provider --cluster=mycluster
----
== rosa create operator-roles
Create operator IAM roles for a cluster.
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa create tuning-configs
Add tuning config
.Example usage
[source,bash,options="nowrap"]
----
# 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"
----
== rosa create user-role
Create user role to verify account association
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa delete account-roles
Delete Account Roles
.Example usage
[source,bash,options="nowrap"]
----
# Delete Account roles"
rosa delete account-roles -p prefix
----
== rosa delete admin
Deletes the admin user
.Example usage
[source,bash,options="nowrap"]
----
# Delete the admin user
rosa delete admin --cluster=mycluster
----
== rosa delete autoscaler
Delete autoscaler for cluster
.Example usage
[source,bash,options="nowrap"]
----
# Delete the autoscaler config for cluster named "mycluster"
rosa delete autoscaler --cluster=mycluster
----
== rosa delete cluster
Delete cluster
.Example usage
[source,bash,options="nowrap"]
----
# Delete a cluster named "mycluster"
rosa delete cluster --cluster=mycluster
----
== rosa delete dns-domain
Delete DNS domain
.Example usage
[source,bash,options="nowrap"]
----
# Delete a DNS domain with ID github-1
rosa delete dns-domain github-1
----
== rosa delete external-auth-provider
Delete external authentication provider
.Example usage
[source,bash,options="nowrap"]
----
# Delete an external authentication provider named exauth-1
rosa delete external-auth-provider exauth-1 --cluster=mycluster
----
== rosa delete iamserviceaccount
Delete IAM role for Kubernetes service account
.Example usage
[source,bash,options="nowrap"]
----
# Delete IAM role for service account
rosa delete iamserviceaccount --cluster my-cluster \
--name my-app \
--namespace default
----
== rosa delete idp
Delete cluster IDPs
.Example usage
[source,bash,options="nowrap"]
----
# Delete an identity provider named github-1
rosa delete idp github-1 --cluster=mycluster
----
== rosa delete image-mirror
Delete image mirror from a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa delete ingress
Delete cluster ingress
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa delete kubeletconfig
Delete a kubeletconfig from a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa delete log-forwarder
Delete log forwarder
.Example usage
[source,bash,options="nowrap"]
----
# Delete log forwarder with ID 'example-id' from a cluster named 'mycluster-hcp'
rosa delete log-forwarder --cluster=mycluster-hcp example-id
----
== rosa delete machinepool
Delete machine pool
.Example usage
[source,bash,options="nowrap"]
----
# Delete machine pool with ID mp-1 from a cluster named 'mycluster'
rosa delete machinepool --cluster=mycluster mp-1
----
== rosa delete ocm-role
Delete OCM role
.Example usage
[source,bash,options="nowrap"]
----
# Delete OCM role
rosa delete ocm-role --role-arn arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778
----
== rosa delete oidc-config
Delete OIDC Config
.Example usage
[source,bash,options="nowrap"]
----
# Delete OIDC config based on registered OIDC Config ID that has been supplied
rosa delete oidc-config --oidc-config-id <oidc_config_id>
----
== rosa delete oidc-provider
Delete OIDC Provider
.Example usage
[source,bash,options="nowrap"]
----
# Delete OIDC provider for cluster named "mycluster"
rosa delete oidc-provider --cluster=mycluster
----
== rosa delete operator-roles
Delete Operator Roles
.Example usage
[source,bash,options="nowrap"]
----
# Delete Operator roles for cluster named "mycluster"
rosa delete operator-roles --cluster=mycluster
----
== rosa delete tuning-configs
Delete tuning config
.Example usage
[source,bash,options="nowrap"]
----
# Delete tuning config with name tuned1 from a cluster named 'mycluster'
rosa delete tuning-config --cluster=mycluster tuned1
----
== rosa delete user-role
Delete user role
.Example usage
[source,bash,options="nowrap"]
----
# Delete user role
rosa delete user-role --role-arn {prefix}-User-{username}-Role
----
== rosa describe access-request
Show details of an Access Request
.Example usage
[source,bash,options="nowrap"]
----
# Describe an Access Request wit id <access_request_id>
rosa describe access-request --id <access_request_id>
----
== rosa describe addon
Show details of an add-on
.Example usage
[source,bash,options="nowrap"]
----
# Describe an add-on named "codeready-workspaces"
rosa describe addon codeready-workspaces
----
== rosa describe addon-installation
Show details of an add-on installation
.Example usage
[source,bash,options="nowrap"]
----
# Describe the 'bar' add-on installation on cluster 'foo'
rosa describe addon-installation --cluster foo --addon bar
----
== rosa describe admin
Show details of the cluster-admin user
.Example usage
[source,bash,options="nowrap"]
----
# Describe cluster-admin user of a cluster named mycluster
rosa describe admin -c mycluster
----
== rosa describe autoscaler
Show details of the autoscaler for a cluster
.Example usage
[source,bash,options="nowrap"]
----
# Describe the autoscaler for cluster 'foo'
rosa describe autoscaler --cluster foo
----
== rosa describe break-glass-credential
Show details of a break glass credential on a cluster
.Example usage
[source,bash,options="nowrap"]
----
# Show details of a break glass credential with ID "12345" on a cluster named "mycluster"
rosa describe break-glass-credential 12345 --cluster=mycluster
----
== rosa describe cluster
Show details of a cluster
.Example usage
[source,bash,options="nowrap"]
----
# Describe a cluster named "mycluster"
rosa describe cluster --cluster=mycluster
----
== rosa describe external-auth-provider
Show details of an external authentication provider on a cluster
.Example usage
[source,bash,options="nowrap"]
----
# Show details of an external authentication provider named "exauth" on a cluster named "mycluster"
rosa describe external-auth-provider exauth --cluster=mycluster
----
== rosa describe iamserviceaccount
Describe IAM role for Kubernetes service account
.Example usage
[source,bash,options="nowrap"]
----
# Describe IAM role for service account
rosa describe iamserviceaccount --cluster my-cluster \
--name my-app \
--namespace default
----
== rosa describe ingress
Show details of the specified ingress within cluster
.Example usage
[source,bash,options="nowrap"]
----
rosa describe ingress <ingress_id> -c mycluster
----
== rosa describe kubeletconfig
Show details of a kubeletconfig for a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa describe log-forwarder
Show details of a specific log forwarder used by a cluster
.Example usage
[source,bash,options="nowrap"]
----
rosa describe log-forwarder <log_fwd_id> -c mycluster-hcp
----
== rosa describe machinepool
Show details of a machine pool on a cluster
.Example usage
[source,bash,options="nowrap"]
----
# Show details of a machine pool named "mymachinepool" on a cluster named "mycluster"
rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool
----
== rosa describe tuning-configs
Show details of tuning config
.Example usage
[source,bash,options="nowrap"]
----
# Describe the 'tuned1' tuned config on cluster 'foo'
rosa describe tuning-config --cluster foo tuned1
----
== rosa describe upgrade
Show details of an upgrade
.Example usage
[source,bash,options="nowrap"]
----
# Describe an upgrade-policy"
rosa describe upgrade
----
== rosa download openshift-client
Download OpenShift client tools
.Example usage
[source,bash,options="nowrap"]
----
# Download oc client tools
rosa download oc
----
== rosa download rosa-client
Download ROSA client tools
.Example usage
[source,bash,options="nowrap"]
----
# Download rosa client tools
rosa download rosa
----
== rosa edit addon
Edit add-on installation parameters on cluster
.Example usage
[source,bash,options="nowrap"]
----
# Edit the parameters of the Red Hat OpenShift logging operator add-on installation
rosa edit addon --cluster=mycluster cluster-logging-operator
----
== rosa edit autoscaler
Edit the autoscaler of a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa edit cluster
Edit cluster
.Example usage
[source,bash,options="nowrap"]
----
# Edit a cluster named "mycluster" to make it private
rosa edit cluster -c mycluster --private
# Edit all options interactively
rosa edit cluster -c mycluster --interactive
----
== rosa edit image-mirror
Edit image mirror for a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa edit ingress
Edit a cluster ingress (load balancer)
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa edit kubeletconfig
Edit a kubeletconfig for a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa edit machinepool
Edit machine pool
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa edit tuning-configs
Edit tuning config
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa grant user
Grant user access to cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa init
Applies templates to support Red Hat OpenShift Service on AWS
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa install addon
Install add-ons on cluster
.Example usage
[source,bash,options="nowrap"]
----
# Add the CodeReady Workspaces add-on installation to the cluster
rosa install addon --cluster=mycluster codeready-workspaces
----
== rosa link ocm-role
Link OCM role to specific OCM organization.
.Example usage
[source,bash,options="nowrap"]
----
# Link OCM role
rosa link ocm-role --role-arn arn:aws:iam::123456789012:role/ManagedOpenshift-OCM-Role
----
== rosa link user-role
Link user role to specific OCM account.
.Example usage
[source,bash,options="nowrap"]
----
# Link user roles
rosa link user-role --role-arn arn:aws:iam::{accountid}:role/{prefix}-User-{username}-Role
----
== rosa list access-request
List Access Requests
.Example usage
[source,bash,options="nowrap"]
----
# List all Access Requests for cluster 'foo'
rosa list access-request --cluster foo
----
== rosa list account-roles
List account roles and policies
.Example usage
[source,bash,options="nowrap"]
----
# List all account roles
rosa list account-roles
----
== rosa list addons
List add-on installations
.Example usage
[source,bash,options="nowrap"]
----
# List all add-on installations on a cluster named "mycluster"
rosa list addons --cluster=mycluster
----
== rosa list break-glass-credentials
List break glass credential
.Example usage
[source,bash,options="nowrap"]
----
# List all break glass credentials for a cluster named 'mycluster'"
rosa list break-glass-credentials -c mycluster
----
== rosa list clusters
List clusters
.Example usage
[source,bash,options="nowrap"]
----
# List all clusters
rosa list clusters
----
== rosa list dns-domain
List DNS Domains
.Example usage
[source,bash,options="nowrap"]
----
# List all DNS Domains tied to your organization ID"
rosa list dns-domain
----
== rosa list external-auth-providers
List external authentication provider
.Example usage
[source,bash,options="nowrap"]
----
# List all external authentication providers for a cluster named 'mycluster'"
rosa list external-auth-provider -c mycluster
----
== rosa list gates
List available OCP Gates
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa list iamserviceaccounts
List IAM roles for Kubernetes service accounts
.Example usage
[source,bash,options="nowrap"]
----
# List IAM roles for service accounts
rosa list iamserviceaccounts --cluster my-cluster
----
== rosa list idps
List cluster IDPs
.Example usage
[source,bash,options="nowrap"]
----
# List all identity providers on a cluster named "mycluster"
rosa list idps --cluster=mycluster
----
== rosa list image-mirrors
List cluster image mirrors
.Example usage
[source,bash,options="nowrap"]
----
# List all image mirrors on a cluster named "mycluster"
rosa list image-mirrors --cluster=mycluster
----
== rosa list ingresses
List cluster Ingresses
.Example usage
[source,bash,options="nowrap"]
----
# List all routes on a cluster named "mycluster"
rosa list ingresses --cluster=mycluster
----
== rosa list instance-types
List Instance types
.Example usage
[source,bash,options="nowrap"]
----
# List all instance types
rosa list instance-types
----
== rosa list kubeletconfigs
List kubeletconfigs
.Example usage
[source,bash,options="nowrap"]
----
# List the kubeletconfigs for cluster 'foo'
rosa list kubeletconfig --cluster foo
----
== rosa list log-forwarders
List cluster log forwarders
.Example usage
[source,bash,options="nowrap"]
----
# List all log forwarders on a cluster named "mycluster": rosa list log-forwarders --cluster=mycluster
----
== rosa list machinepools
List cluster machine pools
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa list ocm-roles
List ocm roles
.Example usage
[source,bash,options="nowrap"]
----
# List all ocm roles
rosa list ocm-roles
----
== rosa list oidc-config
List OIDC Configuration resources
.Example usage
[source,bash,options="nowrap"]
----
# List all OIDC Configurations tied to your organization ID"
rosa list oidc-config
----
== rosa list oidc-providers
List OIDC providers
.Example usage
[source,bash,options="nowrap"]
----
# List all oidc providers
rosa list oidc-providers
----
== rosa list operator-roles
List operator roles and policies
.Example usage
[source,bash,options="nowrap"]
----
# List all operator roles
rosa list operator-roles
----
== rosa list regions
List available regions
.Example usage
[source,bash,options="nowrap"]
----
# List all available regions
rosa list regions
----
== rosa list tuning-configs
List tuning configs
.Example usage
[source,bash,options="nowrap"]
----
# List all tuning configuration for a cluster named 'mycluster'"
rosa list tuning-configs -c mycluster
----
== rosa list user-roles
List user roles
.Example usage
[source,bash,options="nowrap"]
----
# List all user roles
rosa list user-roles
----
== rosa list users
List cluster users
.Example usage
[source,bash,options="nowrap"]
----
# List all users on a cluster named "mycluster"
rosa list users --cluster=mycluster
----
== rosa list versions
List available versions
.Example usage
[source,bash,options="nowrap"]
----
# List all OpenShift versions
rosa list versions
----
== rosa login
Log in to your Red Hat account
.Example usage
[source,bash,options="nowrap"]
----
# Login to the OpenShift API with an existing token generated from https://console.redhat.com/openshift/token/rosa
rosa login --token=$OFFLINE_ACCESS_TOKEN
----
== rosa logs
Show installation or uninstallation logs for a cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa logs install
Show cluster installation logs
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa logs uninstall
Show cluster uninstallation logs
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa register oidc-config
Registers unmanaged OIDC config with Openshift Clusters Manager.
.Example usage
[source,bash,options="nowrap"]
----
# Register OIDC config
rosa register oidc-config
----
== rosa revoke break-glass-credentials
Revoke break glass credentials
.Example usage
[source,bash,options="nowrap"]
----
# Revoke all break glass credentials
rosa revoke break-glass-credentials --cluster=mycluster
----
== rosa revoke user
Revoke role from users
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa uninstall addon
Uninstall add-on from cluster
.Example usage
[source,bash,options="nowrap"]
----
# Remove the CodeReady Workspaces add-on installation from the cluster
rosa uninstall addon --cluster=mycluster codeready-workspaces
----
== rosa unlink ocm-role
Unlink ocm role from a specific OCM organization
.Example usage
[source,bash,options="nowrap"]
----
#Unlink ocm role
rosa unlink ocm-role --role-arn arn:aws:iam::123456789012:role/ManagedOpenshift-OCM-Role
----
== rosa unlink user-role
Unlink user role from a specific OCM account
.Example usage
[source,bash,options="nowrap"]
----
# Unlink user role
rosa unlink user-role --role-arn arn:aws:iam::{accountid}:role/{prefix}-User-{username}-Role
----
== rosa upgrade account-roles
Upgrade account-wide IAM roles to the latest version.
.Example usage
[source,bash,options="nowrap"]
----
# Upgrade account roles for ROSA STS clusters
rosa upgrade account-roles
----
== rosa upgrade cluster
Upgrade cluster
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa upgrade machinepool
Upgrade machinepool
.Example usage
[source,bash,options="nowrap"]
----
# 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
----
== rosa upgrade operator-roles
Upgrade operator IAM roles for a cluster.
.Example usage
[source,bash,options="nowrap"]
----
# Upgrade cluster-specific operator IAM roles
rosa upgrade operators-roles
----
== rosa upgrade roles
Upgrade cluster-specific IAM roles to the latest version.
.Example usage
[source,bash,options="nowrap"]
----
# Upgrade cluster roles for ROSA STS clusters
rosa upgrade roles -c <cluster_key>
----
== rosa verify network
Verify VPC subnets are configured correctly
.Example usage
[source,bash,options="nowrap"]
----
# Verify two subnets
rosa verify network --subnet-ids subnet-03046a9b92b5014fb,subnet-03046a9c92b5014fb
----
== rosa verify openshift-client
Verify OpenShift client tools
.Example usage
[source,bash,options="nowrap"]
----
# Verify oc client tools
rosa verify oc
----
== rosa verify permissions
Verify AWS permissions are ok for non-STS cluster install
.Example usage
[source,bash,options="nowrap"]
----
# Verify AWS permissions are configured correctly
rosa verify permissions
# Verify AWS permissions in a different region
rosa verify permissions --region=us-west-2
----
== rosa verify quota
Verify AWS quota is ok for cluster install
.Example usage
[source,bash,options="nowrap"]
----
# Verify AWS quotas are configured correctly
rosa verify quota
# Verify AWS quotas in a different region
rosa verify quota --region=us-west-2
----
== rosa verify rosa-client
Verify ROSA client tools
.Example usage
[source,bash,options="nowrap"]
----
# Verify rosa client tools
rosa verify rosa
----
== rosa whoami
Displays user account information
.Example usage
[source,bash,options="nowrap"]
----
# Displays user information
rosa whoami
----
View Git Blame Copy Permalink