$ rosa create cluster --cluster=<cluster_name> --debug
Managing objects with the rosa
CLI, such as adding dedicated-admin
users, managing clusters, and scheduling cluster upgrades.
These common commands and arguments are available for the rosa
CLI.
Enables debug mode for the parent command.
$ rosa create cluster --cluster=<cluster_name> --debug
Displays general help information for the rosa
CLI and a list of available commands. This option can also be used as an argument to display help information for a parent command, such as version
or create
.
Displays general help for the rosa
CLI:
$ rosa --help
Displays general help for version
:
$ rosa version --help
Enables interactive mode.
$ rosa create cluster --cluster=<cluster_name> --interactive
Specifies an AWS profile from your credential file.
$ rosa create cluster --cluster=<cluster_name> --profile string=myAWSprofile
The rosa
CLI uses parent commands with child commands to manage objects. The parent commands are create
, edit
, delete
, list
, and describe
. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.
Creates an object or resource when paired with a child command.
$ rosa create cluster --cluster-name=mycluster
Edits options for an object, such as making a cluster private.
$ rosa edit cluster=mycluster --private
Deletes an object or resource when paired with a child command.
$ rosa delete ingress --cluster=mycluster
This section describes the create
commands for clusters and resources.
Create a cluster administrator with an automatically generated password that can log in to a cluster.
$ rosa create admin --cluster=<cluster_name>
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to add to the identity provider (IDP). |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Create a cluster administrator that can log in to a cluster named mycluster
:
$ rosa create admin --cluster=mycluster
Create a new cluster.
$ rosa create cluster --cluster=<cluster_name> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster. When used with the |
--channel-group |
The channel group (string) is the name of the group where this image belongs, for example |
--compute-machine-type |
The instance type (string) for the compute nodes. Determines the amount of memory and vCPU that are allocated to each compute node. |
--compute-nodes |
The number (integer) of worker nodes to provision per zone. Single-zone clusters require at least 2 nodes. Multi-zone clusters require at least 3 nodes. Default: |
--disable-scp-checks |
Indicates whether cloud permission checks are disabled when attempting to install a cluster. |
--dry-run |
Simulates creating the cluster. |
--enable-autoscaling |
Enables autoscaling of compute nodes. By default, autoscaling is set to |
--host-prefix |
The subnet prefix length (integer) to assign to each individual node. For example, if host prefix is set to |
--machine-cidr |
Block of IP addresses (ipNet) used by OpenShift Container Platform while installing the cluster. Example: |
--max-replicas |
Specifies the maximum number of compute nodes when enabling autoscaling. Default: |
--min-replicas |
Specifies the minimum number of compute nodes when enabling autoscaling. Default: |
--multi-az |
Deploys to multiple data centers. |
--pod-cidr |
Block of IP addresses (ipNet) from which pod IP addresses are allocated. Example: |
--private |
Restricts master API endpoint and application routes to direct, private connectivity. |
--region |
The AWS region (string) where your worker pool will be located. This argument overrides the |
--service-cidr |
Block of IP addresses (ipNet) for services. Example: |
--subnet-ids |
The subnet IDs (string) to use when installing the cluster. Subnet IDs must be in pairs with one private subnet ID and one public subnet ID per availability zone. Subnets are comma-delimited. Example: |
--version |
The version (string) of OpenShift Container Platform that will be used to install the cluster. Example: |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Create a cluster named mycluster
:
$ rosa create cluster --cluster=mycluster
Create a cluster with a specific AWS region:
$ rosa create cluster --cluster=mycluster --region=us-east-2
Create a cluster with autoscaling enabled on the default worker machine pool:
$ rosa create cluster --cluster=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=5
Add an identity provider (IDP) to define how users log in to a cluster.
$ rosa create idp --cluster=<cluster_name> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to which the IDP will be added. |
--ca |
The path (string) to the PEM-encoded certificate file to use when making requests to the server. |
--client-id |
The client ID (string) from the registered application. |
--client-secret |
The client secret (string) from the registered application. |
--mapping-method |
Specifies how new identities (string) are mapped to users when they log in. Default: |
--name |
The name (string) for the identity provider. |
--type |
The type (string) of identity provider. Options: |
Option | Definition |
---|---|
--hostname |
The optional domain (string) to use with a hosted instance of GitHub Enterprise. |
--organizations |
Specifies the organizations for login access. Only users that are members of at least one of the listed organizations (string) are allowed to log in. |
--teams |
Specifies the teams for login access. Only users that are members of at least one of the listed teams (string) are allowed to log in. The format is |
Option | Definition |
---|---|
--host-url |
The host URL (string) of a GitLab provider. Default: |
Option | Definition |
---|---|
--hosted-domain |
Restricts users to a Google Apps domain (string). |
Option | Definition |
---|---|
--bind-dn |
The domain name (string) to bind with during the search phase. |
--bind-password |
The password (string) to bind with during the search phase. |
--email-attributes |
The list (string) of attributes whose values should be used as the email address. |
--id-attributes |
The list (string) of attributes whose values should be used as the user ID. Default: |
--insecure |
Does not make TLS connections to the server. |
--name-attributes |
The list (string) of attributes whose values should be used as the display name. Default: |
--url |
An RFC 2255 URL (string) which specifies the LDAP search parameters to use. |
--username-attributes |
The list (string) of attributes whose values should be used as the preferred username. Default: |
Option | Definition |
---|---|
--email-claims |
The list (string) of claims to use as the email address. |
--extra-scopes |
The list (string) of scopes to request, in addition to the |
--issuer-url |
The URL (string) that the OpenID provider asserts as the issuer identifier. It must use the HTTPS scheme with no URL query parameters or fragment. |
--name-claims |
The list (string) of claims to use as the display name. |
--username-claims |
The list (string) of claims to use as the preferred username when provisioning a user. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
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 an ingress endpoint to enable API access to the cluster.
$ rosa create ingress --cluster=<cluster_name> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to which the ingress will be added. |
--label-match |
The label match (string) for ingress. The format must be a comma-delimited list of key=value pairs. If no label is specified, all routes are exposed on both routers. |
--private |
Restricts application route to direct, private connectivity. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Add an internal ingress to a cluster named mycluster
:
$ rosa create ingress --private --cluster=mycluster
Add a public ingress to a cluster named mycluster
:
$ rosa create ingress --cluster=mycluster
Add an ingress with a route selector label match:s
$ rosa create ingress --cluster=mycluster --label-match="foo=bar,bar=baz"
Add a machine pool to an existing cluster.
$ rosa create machinepool --cluster=<cluster_name> --replicas=<number> --name=<machinepool_name> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to which the machine pool will be added. |
--instance-type |
The instance type (string) that should be used. Default: |
--labels |
The labels (string) for the machine pool. The format must be a comma-delimited list of key=value pairs. This list overwrites any modifications made to node labels on an ongoing basis. |
--name |
Required: The name (string) for the machine pool. |
--replicas |
Required: The number (integer) of machines for this machine pool. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Interactively add a machine pool to a cluster named mycluster
:
$ rosa create machinepool --cluster=mycluster --interactive
Add a machine pool that is named mp-1
to a cluster with autoscaling enabled:
$ rosa create machinepool --cluster=mycluster --enable-autoscaling --min-replicas=2 --max-replicas=5 --name=mp-1
Add a machine pool that is named mp-1
with 3 replicas of m5.xlarge
to a cluster:
$ rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1
Add a machine pool with labels to a cluster:
$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels =foo=bar,bar=baz" --name=mp-1
This section describes the edit
commands for clusters and resources.
Allows edits to an existing cluster.
$ rosa edit cluster [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to edit. |
--private |
Restricts a master API endpoint to direct, private connectivity. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Edit a cluster named mycluster
to make it private.
$ rosa edit cluster --cluster=mycluster --private
Edit all cluster options interactively.
$ rosa edit cluster --cluster=mycluster --interactive
Edits the additional non-default application router for a cluster.
$ rosa edit ingress [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to which the ingress will be added. |
--label-match |
The label match (string) for ingress. The format must be a comma-delimited list of key=value pairs. If no label is specified, all routes are exposed on both routers. |
--private |
Restricts the application route to direct, private connectivity. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Make an additional ingress with ID a1b2
as private on a cluster named mycluster
.
$ rosa edit ingress --private --cluster=mycluster a1b2
Update the router selectors for the additional ingress with the ID a1b2
.
$ rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2
Update the default ingress using the sub-domain identifier apps
.
$ rosa edit ingress --private=false --cluster=mycluster apps
Allows edits to the machine pool in a cluster.
$ rosa edit machinepool --cluster=<cluster_name> <machinepool_ID> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to edit on which the additional machine pool will be edited. |
--enable-autoscaling |
Enable or disable autoscaling of compute nodes. To enable autoscaling, use this argument with the |
--max-replicas |
Specifies the maximum number of compute nodes when enabling autoscaling. |
--min-replicas |
Specifies the minimum number of compute nodes when enabling autoscaling. |
--replicas |
The number (integer) of machines for this machine pool. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Set 4 replicas on a machine pool named mp1
on a cluster named mycluster
.
$ rosa edit machinepool --cluster=mycluster --replicas=4 --name=mp1
Enable autoscaling on a machine pool named mp1
on a cluster named mycluster
.
$ rosa edit machinepool --cluster-name=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 --name=mp1
Disable autoscaling on a machine pool named mp1
on a cluster named mycluster
.
$ rosa edit machinepool --cluster-name=mycluster --enable-autoscaling=false --replicas=3 --name=mp1
Modify the autoscaling range on a machine pool named mp1
on a cluster named mycluster
.
$ rosa edit machinepool --max-replicas=9 --cluster=mycluster --name=mp1
This section describes the delete
commands for clusters and resources.
Deletes a cluster administrator from a specified cluster.
$ rosa delete admin --cluster=<cluster_name>
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to add to the identity provider (IDP). |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Delete a cluster administrator from a cluster named mycluster
.
$ rosa delete admin --cluster=mycluster
Deletes a cluster.
$ rosa delete cluster --cluster=<id> | <name> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to delete. |
--watch |
Watches the cluster uninstallation logs. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
--yes |
Automatically answers |
Delete a cluster named mycluster
.
$ rosa delete cluster --cluster=mycluster
Deletes a specific identity provider (IDP) from a cluster.
$ rosa delete idp <id> | <name> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster from which the IDP will be deleted. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
--yes |
Automatically answers |
Delete an identity provider named github
from a cluster named mycluster
.
$ rosa delete idp github --cluster=mycluster
Deletes a non-default application router (ingress) from a cluster.
$ rosa delete ingress [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster from which the ingress will be deleted. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
--yes |
Automatically answers |
Delete an ingress with ID a1b2
from a cluster named mycluster
.
$ rosa delete ingress --cluster=mycluster a1b2
Delete a secondary ingress with the subdomain name apps2
from a cluster named mycluster
.
$ rosa delete ingress --cluster=mycluster apps2
Deletes a machine pool from a cluster.
$ rosa delete machinepool --cluster=<cluster_name> <machine_pool_id>
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the machine pool will be deleted from. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--interactive |
Enables interactive mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
--yes |
Automatically answers |
Delete the machine pool with ID mp-1
from a cluster named mycluster
.
$ rosa delete machinepool --cluster=mycluster mp-1
This section describes how to install and uninstall Red Hat managed service add-ons to a cluster.
Installs a managed service add-on on a cluster.
$ rosa install addon [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster where the add-on will be installed. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Uses a specific AWS profile (string) from your credentials file. |
--v level |
Log level for V logs. |
--yes |
Automatically answers |
Add the codeready-workspaces
add-on installation to a cluster named mycluster
.
$ rosa install addon --cluster=mycluster codeready-workspaces
Uninstalls a managed service add-on from a cluster.
$ rosa uninstall addon [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the add-on will be uninstalled from. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Uses a specific AWS profile (string) from your credentials file. |
--v level |
Log level for V logs. |
--yes |
Automatically answers |
Remove the codeready-workspaces
add-on installation from a cluster named mycluster
.
$ rosa uninstall addon --cluster=mycluster codeready-workspaces
This section describes the list
and describe
commands for clusters and resources.
List the managed service add-on installations.
$ rosa list addons --cluster=<cluster_name>
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to list the add-ons for. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all of your clusters.
$ rosa list clusters [arguments]
Option | Definition |
---|---|
--count |
The number (integer) of clusters to display. Default: |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all of the identity providers (IDPs) for a cluster.
$ rosa list idps [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the IDPs will be listed for. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all identity providers (IDPs) for a cluster named mycluster
:
$ rosa list idps --cluster=mycluster
List all of the API and ingress endpoints for a cluster.
$ rosa list ingresses --cluster=mycluster [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the IDPs will be listed for. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all API and ingress endpoints for a cluster named mycluster
:
$ rosa list ingresses --cluster=mycluster
List the machine pools configured on a cluster.
$ rosa list machinepools [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the machine pools will be listed for. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all of the machine pools on a cluster named mycluster
:
$ rosa list machinepools --cluster=mycluster
List all of the available regions for the current AWS account.
$ rosa list regions [arguments]
Option | Definition |
---|---|
--multi-az |
Lists regions that provide support for multiple availability zones. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all of the available regions:
$ rosa list regions
List all available and scheduled cluster version upgrades.
$ rosa list upgrades [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the available upgrades will be listed for. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all of the available upgrades for a cluster named mycluster
:
$ rosa list upgrades --cluster=mycluster
List the cluster administrator and dedicated administrator users for a specified cluster.
$ rosa list users [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the cluster administrators will be listed for. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all of the cluster administrators and dedicated administrators for a cluster named mycluster
:
$ rosa list users --cluster=mycluster
List all of the OpenShift versions that are available for creating a cluster.
$ rosa list versions [arguments]
Option | Definition |
---|---|
--channel-group |
Lists only versions from the specified channel group (string). Default: |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
List all of the OpenShift Container Platform versions:
$ rosa list versions
Show the details of a specified cluster-admin
user and a command to log in to the cluster.
$ rosa describe admin <id> | <name> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster to which the cluster-admin belongs. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Describe the cluster-admin
user for a cluster named mycluster
:
$ rosa describe admin --cluster=mycluster
Show the details of a managed service add-on.
$ rosa describe addon <id> | <addon_name> [arguments]
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Describe an add-on named codeready-workspaces
:
$ rosa describe addon codeready-workspaces
Shows the details for a cluster.
$ rosa describe cluster <id> | <name> [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--profile |
Specifies an AWS profile (string) from your credentials file. |
--v <level> |
The log level for V logs. |
Describe a cluster named mycluster
:
$ rosa describe cluster --cluster=mycluster
This section describes the upgrade
command usage for clusters.
Schedule a cluster upgrade.
$ rosa upgrade cluster [arguments]
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the upgrade will be scheduled for. |
--interactive |
Enables interactive mode. |
--version |
The version (string) of OpenShift Container Platform that the cluster will be upgraded to. |
--schedule-date |
The next date (string) when the upgrade will run at the specified time. Format: |
--schedule-time |
The next time the upgrade will run on the specified date. Format: |
--node-drain-grace-period |
Sets a grace period (string) for how long the pod disruption budget-protected workloads are respected during upgrades. After this grace period, any workloads protected by pod disruption budgets that have not been successfully drained from a node will be forcibly evicted. Default: |
Option | Definition |
---|---|
--help |
Shows help for this command. |
Interactively schedule an upgrade on a cluster named mycluster
:
$ rosa upgrade cluster --cluster=mycluster --interactive
Schedule a cluster upgrade within the hour:
$ rosa upgrade cluster --cluster=mycluster --version 4.5.20
[id="rosa-delete-upgrade-cluster_{context}"] == delete upgrade
Cancel a scheduled cluster upgrade:
$ rosa delete upgrade --cluster=<cluster_name>
Option | Definition |
---|---|
--cluster |
Required: The name or ID (string) of the cluster that the upgrade will be cancelled for. |
Option | Definition |
---|---|
--help |
Shows help for this command. |
--debug |
Enables debug mode. |
--v level |
Log level for V logs. |
--yes |
Automatically answers |