From 651ed815c10897827e912cfbf58cc3e5653a7250 Mon Sep 17 00:00:00 2001 From: Ben Hardesty Date: Mon, 10 Nov 2025 17:39:19 -0500 Subject: [PATCH] Replace manual ROSA CLI command ref with autogenerated version --- _topic_maps/_topic_map_rosa.yml | 8 +- _topic_maps/_topic_map_rosa_hcp.yml | 8 +- .../rosa-available-services.adoc | 2 +- .../rosa-checking-acct-version-cli.adoc | 12 - .../rosa_cli/rosa-checking-logs-cli.adoc | 12 - cli_reference/rosa_cli/rosa-cli-commands.adoc | 16 + .../rosa_cli/rosa-manage-objects-cli.adoc | 47 - modules/rosa-by-example-content.adoc | 1509 +++++++++++++++++ ...-checking-account-version-cli-version.adoc | 36 - ...a-checking-account-version-cli-whoami.adoc | 36 - modules/rosa-common-commands.adoc | 90 - modules/rosa-create-objects.adoc | 1271 -------------- modules/rosa-delete-objects.adoc | 593 ------- modules/rosa-edit-objects.adoc | 410 ----- modules/rosa-install-uninstall-addon.adoc | 102 -- modules/rosa-list-objects.adoc | 1124 ------------ modules/rosa-logs-install.adoc | 60 - modules/rosa-logs-uninstall.adoc | 52 - modules/rosa-parent-commands.adoc | 66 - modules/rosa-revoke-objects.adoc | 55 - modules/rosa-upgrade-cluster-cli.adoc | 238 --- .../rosa-hcp-life-cycle.adoc | 2 +- .../rosa-life-cycle.adoc | 2 +- .../rosa-managing-worker-nodes.adoc | 2 +- .../rosa-nodes-about-autoscaling-nodes.adoc | 5 +- ...a-hcp-sts-creating-a-cluster-ext-auth.adoc | 4 +- ...reating-a-cluster-with-customizations.adoc | 2 +- .../rosa-sts-deleting-cluster.adoc | 2 +- ...osa-troubleshooting-installations-hcp.adoc | 2 +- upgrading/rosa-hcp-upgrading.adoc | 2 +- 30 files changed, 1540 insertions(+), 4230 deletions(-) delete mode 100644 cli_reference/rosa_cli/rosa-checking-acct-version-cli.adoc delete mode 100644 cli_reference/rosa_cli/rosa-checking-logs-cli.adoc create mode 100644 cli_reference/rosa_cli/rosa-cli-commands.adoc delete mode 100644 cli_reference/rosa_cli/rosa-manage-objects-cli.adoc create mode 100644 modules/rosa-by-example-content.adoc delete mode 100644 modules/rosa-checking-account-version-cli-version.adoc delete mode 100644 modules/rosa-checking-account-version-cli-whoami.adoc delete mode 100644 modules/rosa-common-commands.adoc delete mode 100644 modules/rosa-create-objects.adoc delete mode 100644 modules/rosa-delete-objects.adoc delete mode 100644 modules/rosa-edit-objects.adoc delete mode 100644 modules/rosa-install-uninstall-addon.adoc delete mode 100644 modules/rosa-list-objects.adoc delete mode 100644 modules/rosa-logs-install.adoc delete mode 100644 modules/rosa-logs-uninstall.adoc delete mode 100644 modules/rosa-parent-commands.adoc delete mode 100644 modules/rosa-revoke-objects.adoc delete mode 100644 modules/rosa-upgrade-cluster-cli.adoc diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index f9e3202057..f8ef7cdc07 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -512,12 +512,8 @@ Topics: # File: rosa-cli-openshift-console - Name: Getting started with the ROSA CLI File: rosa-get-started-cli - - Name: Managing objects with the ROSA CLI - File: rosa-manage-objects-cli - - Name: Checking account and version information with the ROSA CLI - File: rosa-checking-acct-version-cli - - Name: Checking logs with the ROSA CLI - File: rosa-checking-logs-cli + - Name: ROSA CLI command reference + File: rosa-cli-commands - Name: Least privilege permissions for ROSA CLI commands File: rosa-cli-permission-examples diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index 351075c7b2..7411f932f7 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -314,12 +314,8 @@ Topics: # File: rosa-cli-openshift-console - Name: Getting started with the ROSA CLI File: rosa-get-started-cli - - Name: Managing objects with the ROSA CLI - File: rosa-manage-objects-cli - - Name: Checking account and version information with the ROSA CLI - File: rosa-checking-acct-version-cli - - Name: Checking logs with the ROSA CLI - File: rosa-checking-logs-cli + - Name: ROSA CLI command reference + File: rosa-cli-commands - Name: Least privilege permissions for ROSA CLI commands File: rosa-cli-permission-examples - Name: Managing AWS billing accounts with the ROSA CLI diff --git a/adding_service_cluster/rosa-available-services.adoc b/adding_service_cluster/rosa-available-services.adoc index b8e1c94471..7b7e90dac2 100644 --- a/adding_service_cluster/rosa-available-services.adoc +++ b/adding_service_cluster/rosa-available-services.adoc @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] You can add services to your existing {product-title} (ROSA) cluster using the xref:../adding_service_cluster/adding-service.adoc#adding-service[{cluster-manager-first} console]. -These services can also be installed xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[using the `rosa` CLI]. +These services can also be installed xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-install-addon[using the `rosa install addon` command]. include::modules/aws-cloudwatch.adoc[leveloffset=+1] diff --git a/cli_reference/rosa_cli/rosa-checking-acct-version-cli.adoc b/cli_reference/rosa_cli/rosa-checking-acct-version-cli.adoc deleted file mode 100644 index ee95a6d774..0000000000 --- a/cli_reference/rosa_cli/rosa-checking-acct-version-cli.adoc +++ /dev/null @@ -1,12 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/attributes-openshift-dedicated.adoc[] -[id="rosa-acct-version-cli"] -= Checking account and version information with the ROSA CLI -:context: rosa-checking-acct-version-cli - -toc::[] - -Use the following commands to check your account and version information. - -include::modules/rosa-checking-account-version-cli-whoami.adoc[leveloffset=+1] -include::modules/rosa-checking-account-version-cli-version.adoc[leveloffset=+1] diff --git a/cli_reference/rosa_cli/rosa-checking-logs-cli.adoc b/cli_reference/rosa_cli/rosa-checking-logs-cli.adoc deleted file mode 100644 index efcefdbf90..0000000000 --- a/cli_reference/rosa_cli/rosa-checking-logs-cli.adoc +++ /dev/null @@ -1,12 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/attributes-openshift-dedicated.adoc[] -[id="rosa-checking-logs-cli"] -= Checking logs with the ROSA CLI -:context: rosa-checking-logs-cli - -toc::[] - -Use the following commands to check your install and uninstall logs. - -include::modules/rosa-logs-install.adoc[leveloffset=+1] -include::modules/rosa-logs-uninstall.adoc[leveloffset=+1] \ No newline at end of file diff --git a/cli_reference/rosa_cli/rosa-cli-commands.adoc b/cli_reference/rosa_cli/rosa-cli-commands.adoc new file mode 100644 index 0000000000..b1766c6ecf --- /dev/null +++ b/cli_reference/rosa_cli/rosa-cli-commands.adoc @@ -0,0 +1,16 @@ +:_mod-docs-content-type: ASSEMBLY +[id="rosa-cli-commands"] += ROSA CLI command reference +include::_attributes/attributes-openshift-dedicated.adoc[] +:context: rosa-cli-commands + +toc::[] + +[role="_abstract"] +This reference provides descriptions and example commands for ROSA CLI (`rosa`) commands. + +Run `rosa -h` to list all commands or run `rosa --help` to get additional details for a specific command. + +// The following file is auto-generated from the openshift/rosa repository +// ROSA CLI commands +include::modules/rosa-by-example-content.adoc[leveloffset=+1] diff --git a/cli_reference/rosa_cli/rosa-manage-objects-cli.adoc b/cli_reference/rosa_cli/rosa-manage-objects-cli.adoc deleted file mode 100644 index 44ba42ab65..0000000000 --- a/cli_reference/rosa_cli/rosa-manage-objects-cli.adoc +++ /dev/null @@ -1,47 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/attributes-openshift-dedicated.adoc[] -[id="rosa-managing-objects-cli"] -= Managing objects with the ROSA CLI - -:context: rosa-managing-objects-cli - -toc::[] - -Managing objects with the {rosa-cli-first}, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades. - -[NOTE] -==== -To access a cluster that is accessible only over an HTTP proxy server, you can set the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` variables. These environment variables are respected by the `rosa` CLI so that all communication with the cluster goes through the HTTP proxy. -==== - -include::modules/rosa-common-commands.adoc[leveloffset=+1] -include::modules/rosa-parent-commands.adoc[leveloffset=+1] -include::modules/rosa-create-objects.adoc[leveloffset=+1] - -ifdef::openshift-rosa[] -[role="_additional-resources"] -== Additional resources - -* See xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-aws-instance-types_rosa-service-definition[AWS Instance types] for a list of supported instance types. -* See xref:../../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies_rosa-sts-about-iam-resources[Account-wide IAM role and policy reference] for a list of IAM roles needed for cluster creation. -* See xref:../../rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc#rosa-sts-understanding-aws-account-association_rosa-sts-creating-a-cluster-with-customizations[Understanding AWS account association] for more information about the OCM role and user role. -* See xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#rosa-security-groups_prerequisites[Additional custom security groups] for information about security group requirements. -endif::openshift-rosa[] - -include::modules/rosa-edit-objects.adoc[leveloffset=+1] - -[role="_additional-resources_1"] -== Additional resources -ifdef::openshift-rosa[] -* See xref:../../networking/networking_operators/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller] for information regarding editing non-default application routers. -endif::openshift-rosa[] -//Classic to HCP breakout. Remove ROSA-specific conditionals when networking is added to HCP. - -include::modules/rosa-delete-objects.adoc[leveloffset=+1] -include::modules/rosa-install-uninstall-addon.adoc[leveloffset=+1] -include::modules/rosa-list-objects.adoc[leveloffset=+1] -ifdef::openshift-rosa-hcp[] -include::modules/rosa-revoke-objects.adoc[leveloffset=+1] -endif::openshift-rosa-hcp[] -include::modules/rosa-upgrade-cluster-cli.adoc[leveloffset=+1] - diff --git a/modules/rosa-by-example-content.adoc b/modules/rosa-by-example-content.adoc new file mode 100644 index 0000000000..f5c0946656 --- /dev/null +++ b/modules/rosa-by-example-content.adoc @@ -0,0 +1,1509 @@ +// 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 --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 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 --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 --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 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 +---- + + + +== 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 + rosa describe 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 -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 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 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 +---- + + + +== 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 --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 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 +---- + + + +== 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 +---- + + diff --git a/modules/rosa-checking-account-version-cli-version.adoc b/modules/rosa-checking-account-version-cli-version.adoc deleted file mode 100644 index f7685ad706..0000000000 --- a/modules/rosa-checking-account-version-cli-version.adoc +++ /dev/null @@ -1,36 +0,0 @@ -// Module included in the following assemblies: -// -// * rosa_cli/rosa-checking-acct-version-cli.adoc - -:_mod-docs-content-type: REFERENCE -[id="rosa-version_{context}"] -= version - -Display the version of your `rosa` CLI by using the following command syntax: - -.Syntax -[source,terminal] ----- -$ rosa version [arguments] ----- - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -[source,terminal] ----- -$ rosa version ----- \ No newline at end of file diff --git a/modules/rosa-checking-account-version-cli-whoami.adoc b/modules/rosa-checking-account-version-cli-whoami.adoc deleted file mode 100644 index 4e6d5cf1d1..0000000000 --- a/modules/rosa-checking-account-version-cli-whoami.adoc +++ /dev/null @@ -1,36 +0,0 @@ -// Module included in the following assemblies: -// -// * rosa_cli/rosa-checking-acct-version-cli.adoc - -:_mod-docs-content-type: REFERENCE -[id="rosa-whoami_{context}"] -= whoami - -Display information about your AWS and Red{nbsp}Hat accounts by using the following command syntax: - -.Syntax -[source,terminal] ----- -$ rosa whoami [arguments] ----- - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -[source,terminal] ----- -$ rosa whoami ----- \ No newline at end of file diff --git a/modules/rosa-common-commands.adoc b/modules/rosa-common-commands.adoc deleted file mode 100644 index e96466c640..0000000000 --- a/modules/rosa-common-commands.adoc +++ /dev/null @@ -1,90 +0,0 @@ - -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc -:_mod-docs-content-type: REFERENCE -[id="rosa-common-commands_{context}"] -= Common commands and arguments - -These common commands and arguments are available for the {rosa-cli-first}. - -[id="rosa-debug_{context}"] -== debug - -Enables debug mode for the parent command to help with troubleshooting. - -.Example -[source,terminal] ----- -$ rosa create cluster --cluster-name= --debug ----- - -[id="rosa-download_{context}"] -== download - -Downloads the latest compatible version of the specified software to the current directory in an archive file. Extract the contents of the archive and add the contents to your path to use the software. To download the latest ROSA CLI, specify `rosa`. To download the latest OpenShift CLI, specify `oc`. - -.Example -[source,terminal] ----- -$ rosa download ----- - -[id="rosa-help_{context}"] -== help - -Displays general help information for the ROSA CLI (`rosa`) and a list of available commands. This option can also be used as an argument to display help information for a parent command, such as `version` or `create`. - -.Examples -Displays general help for the ROSA CLI. -[source,terminal] ----- -$ rosa --help ----- - -Displays general help for `version`. -[source,terminal] ----- -$ rosa version --help ----- - -[id="rosa-interactive_{context}"] -== interactive - -Enables interactive mode. - -.Example -[source,terminal] ----- -$ rosa create cluster --cluster-name= --interactive ----- - -[id="rosa-profile-string_{context}"] -== profile - -Specifies an AWS profile from your credential file. - -.Example -[source,terminal] ----- -$ rosa create cluster --cluster-name= --profile=myAWSprofile ----- - -[id="rosa-version_{context}"] -== version - -Displays the `rosa` version and checks whether a newer version is available. - -.Example -[source,terminal] ----- -$ rosa version [arguments] ----- - -.Example output -Displayed when a newer version of the ROSA CLI is available. -[source,terminal] ----- -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/ ----- diff --git a/modules/rosa-create-objects.adoc b/modules/rosa-create-objects.adoc deleted file mode 100644 index 21110c1b24..0000000000 --- a/modules/rosa-create-objects.adoc +++ /dev/null @@ -1,1271 +0,0 @@ - -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc -:_mod-docs-content-type: REFERENCE -[id="rosa-create-objects_{context}"] -= Create objects -//Adding the following condition fpr pruning purposes. Once pruning complete, note should be removed from HCP docs and flag can be manually added to each create command (where applicable). -ifdef::openshift-rosa-hcp[] -[NOTE] -==== -To create a {product-title} cluster, include the '--hosted-cp' flag where necessary. -==== -endif::openshift-rosa-hcp[] -This section describes the `create` commands for clusters and resources. - -[id="rosa-create-account-roles_{context}"] -== create account-roles - -Create the required account-wide role and policy resources for your cluster. - -.Syntax -[source,terminal] ----- -$ rosa create account-roles [flags] ----- - -.Flags -[cols="30,70"] -|=== -|Option |Definition - -|--debug -|Enable debug mode. - -|-i, --interactive -|Enable interactive mode. - -|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be automatically applied using the current AWS account. -`manual`:: Commands necessary to modify AWS resources will be output to be run manually. - -|--path string -|The Amazon Resource Name (ARN) path for the account-wide roles and policies, including the Operator policies. - -|--permissions-boundary string -|The ARN of the policy that is used to set the permissions boundary for the account roles. - -|--prefix string -|User-defined prefix for all generated AWS resources. The default is `ManagedOpenShift`. - -|--profile string -|Use a specific AWS profile from your credential file. - -|-y, --yes -|Automatically answer yes to confirm operations. - -|=== - -[id="rosa-create-admin_{context}"] -== create admin - -Create a cluster administrator with an automatically generated password that can log in to a cluster. - -.Syntax -[source,terminal] ----- -$ rosa create admin --cluster=| ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|--cluster \| -|Required. The name or ID (string) of the cluster to add to the identity provider (IDP). -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile string -|Specifies an AWS profile from your credentials file. -|=== - -.Example -Create a cluster administrator that can log in to a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa create admin --cluster=mycluster ----- -ifdef::openshift-rosa-hcp[] -[id="rosa-create-break-glass-credential_{context}"] -== create break glass credential - -Create a break glass credential for a {product-title} cluster with external authentication enabled. - -.Syntax -[source,terminal] ----- -$ rosa create break-glass-credential --cluster= [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster \| -|Required. The name or ID of the cluster to which the break glass credential will be added. - -|--expiration -|Optional: How long a break glass credential can be used before expiring. The expiration duration must be a minimum of 10 minutes and a maximum of 24 hours. If you do not enter a value, the expiration duration defaults to 24 hours. - -|--username -|Optional. The username for the break glass credential. If you do not enter a value, a random username is generated for you. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|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. - -|--region -|Specifies an AWS region, overriding the `AWS_REGION` environment variable. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== - -.Examples -Add a break glass credential to a cluster named `mycluster`. - -.Syntax -[source,terminal] ----- -$ rosa create break-glass-credential --cluster=mycluster ----- - -Add a break glass credential to a cluster named `mycluster` using the interactive mode. - -.Syntax -[source,terminal] ----- -$ rosa create break-glass-credential --cluster=mycluster -i ----- -endif::openshift-rosa-hcp[] -[id="rosa-create-cluster-command_{context}"] -== create cluster - -Create a new cluster. - -.Syntax -[source,terminal] ----- -$ rosa create cluster --cluster-name= [arguments] ----- -//Note to writers: The create cluster command specifically uses --cluster-name because a cluster ID does not exist yet. All other commands use --cluster because either the name or the ID can be used. - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--additional-compute-security-group-ids -|The identifier of one or more additional security groups to use along with the default security groups that are used with the standard machine pool created alongside the cluster. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_. - -|--additional-infra-security-group-ids -|The identifier of one or more additional security groups to use along with the default security groups that are used with the infra nodes created alongside the cluster. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_. - -|--additional-control-plane-security-group-ids -|The identifier of one or more additional security groups to use along with the default security groups that are used with the control plane nodes created alongside the cluster. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_. -ifdef::openshift-rosa-hcp[] -|--additional-allowed-principals -|A comma-separated list of additional allowed principal ARNs to be added to the hosted control plane's VPC endpoint service to enable additional VPC endpoint connection requests to be automatically accepted. -endif::openshift-rosa-hcp[] -a|--cluster-name -|Required. The name of the cluster. When used with the `create cluster` command, this argument is used to set the cluster name and can hold up to 54 characters. The value for this argument must be unique within your organization. - -|--compute-machine-type -|The instance type for compute nodes in the cluster. This determines the amount of memory and vCPU that is allocated to each compute node. For more information on valid instance types, see _AWS Instance types_ in _ROSA service definition_. - -|--controlplane-iam-role -|The ARN of the IAM role to attach to control plane instances. - -|--create-cluster-admin -|Optional. As part of cluster creation, create a local administrator user (`cluster-admin`) for your cluster. This automatically configures an htpasswd identity provider for the `cluster-admin` user. Optionally, use the `--cluster-admin-user` and `--cluster-admin-password` options to specify the username and password for the administrator user. Omitting these options automatically generates the credentials and displays their values as terminal output. - -|--cluster-admin-user -|Optional. Specifies the user name of the cluster administrator user created when used in conjunction with the `--create-cluster-admin` option. - -|--cluster-admin-password -|Optional. Specifies the password of the cluster administrator user created when used in conjunction with the `--create-cluster-admin` option. - -|--disable-scp-checks -|Indicates whether cloud permission checks are disabled when attempting to install a cluster. - -|--dry-run -|Simulates creating the cluster. - -|--domain-prefix -|Optional: When used with the `create cluster` command, this argument sets the subdomain for your cluster on `*.openshiftapps.com`. The value for this argument must be unique within your organization, cannot be longer than 15 characters, and cannot be changed after cluster creation. -If the argument is not supplied, an autogenerated value is created that depends on the length of the cluster name. If the cluster name is fewer than or equal to 15 characters, that name is used for the domain prefix. If the cluster name is longer than 15 characters, the domain prefix is randomly generated to a 15 character string. - -|--ec2-metadata-http-tokens string -|Configures the use of IMDSv2 for EC2 instances. Valid values are `optional` (default) or `required`. - -|--enable-autoscaling -|Enables autoscaling of compute nodes. By default, autoscaling is set to `2` nodes. To set non-default node limits, use this argument with the `--min-replicas` and `--max-replicas` arguments. - -|--etcd-encryption -|Enables encryption of ETCD key-values on Red Hat OpenShift Service on AWS (classical architecture) clusters. - -|--etcd-encryption-kms-arn -|Enables encryption of ETCD storage using the customer-managed key managed in AWS Key Management Service. - -|--external-id -|An optional unique identifier that might be required when you assume a role in another account. - -|--host-prefix -|The subnet prefix length to assign to each individual node, as an integer. For example, if host prefix is set to `23`, then each node is assigned a `/23` subnet out of the given CIDR. - -|--machine-cidr -a|Block of IP addresses (ipNet) used by {product-title} while installing the cluster, for example, `10.0.0.0/16`. - -[IMPORTANT] -==== -OVN-Kubernetes, the default network provider in {product-title} 4.11 and later, uses the `100.64.0.0/16` IP address range internally. If your cluster uses OVN-Kubernetes, do not include the `100.64.0.0/16` IP address range in any other CIDR definitions in your cluster. -==== - -|--max-replicas -|Specifies the maximum number of compute nodes when enabling autoscaling. Default: `2` - -|--min-replicas -|Specifies the minimum number of compute nodes when enabling autoscaling. Default: `2` - -ifdef::openshift-rosa[] -//this is being deprecated and will eventually be removed entirely. -|--multi-az -|Deploys to multiple data centers. -endif::openshift-rosa[] - -|--no-cni -|Creates a cluster without a Container Network Interface (CNI) plugin. Customers can then bring their own CNI plugin and install it after cluster creation. - -|--operator-roles-prefix -|Prefix that are used for all IAM roles used by the operators needed in the OpenShift installer. A prefix is generated automatically if you do not specify one. - -|--pod-cidr -a|Block of IP addresses (ipNet) from which pod IP addresses are allocated, for example, `10.128.0.0/14`. - -[IMPORTANT] -==== -OVN-Kubernetes, the default network provider in {product-title} 4.11 and later, uses the `100.64.0.0/16` IP address range internally. If your cluster uses OVN-Kubernetes, do not include the `100.64.0.0/16` IP address range in any other CIDR definitions in your cluster. -==== - -|--private -|Restricts primary API endpoint and application routes to direct, private connectivity. -//To be added when available for HCP only. -//ifdef::openshift-rosa-hcp[] -//To allow public subnets on a private API cluster, you can use both the `--private` and `--private-ingress=false` arguments. -//endif::openshift-rosa-hcp[] - -ifdef::openshift-rosa[] -|--private-link -|Specifies to use AWS PrivateLink to provide private connectivity between VPCs and services. The `--subnet-ids` argument is required when using `--private-link`. -endif::openshift-rosa[] - -|--region -|The name of the AWS region where your worker pool will be located, for example, `us-east-1`. This argument overrides the `AWS_REGION` environment variable. - -|--replicas n -|The number of worker nodes to provision per availability zone. Single-zone clusters require at least 2 nodes. Multi-zone clusters require at least 3 nodes. Default: `2` for single-zone clusters; `3` for multi-zone clusters. - -|--role-arn -|The ARN of the installer role that {cluster-manager} uses to create the cluster. This is required if you have not already created account roles. - -|--service-cidr -a|Block of IP addresses (ipNet) for services, for example, `172.30.0.0/16`. - -[IMPORTANT] -==== -OVN-Kubernetes, the default network provider in ROSA 4.11 and later, uses the `100.64.0.0/16` IP address range internally. If your cluster uses OVN-Kubernetes, do not include the `100.64.0.0/16` IP address range in any other CIDR definitions in your cluster. -==== - -ifdef::openshift-rosa[] -a|--sts \| --non-sts -|Specifies whether to use AWS Security Token Service (STS) or IAM credentials (non-STS) to deploy your cluster. -endif::openshift-rosa[] - -ifdef::openshift-rosa-hcp[] -|--sts -|Specifies the use of AWS Security Token Service (STS) credentials to deploy your cluster. -endif::openshift-rosa-hcp[] - -ifdef::openshift-rosa[] -|--subnet-ids -|The AWS subnet IDs that are used when installing the cluster, for example, `subnet-01abc234d5678ef9a`. Subnet IDs must be in pairs with one private subnet ID and one public subnet ID per availability zone. Subnets are comma-delimited, for example, `--subnet-ids=subnet-1,subnet-2`. Leave the value empty for installer-provisioned subnet IDs. - -When using `--private-link`, the `--subnet-ids` argument is required and only one private subnet is allowed per zone. -endif::openshift-rosa[] - -ifdef::openshift-rosa-hcp[] -|--subnet-ids -|The AWS subnet IDs that are used when installing the cluster, for example, `subnet-01abc234d5678ef9a`. Subnet IDs must be in pairs with one private subnet ID and one public subnet ID per availability zone. Subnets are comma-delimited, for example, `--subnet-ids=subnet-1,subnet-2`. Leave the value empty for installer-provisioned subnet IDs. - -When using `--private` for "private API", the `--subnet-ids` argument is required and only one private subnet is allowed per zone. - -//To be added when available -//To allow public subnets on a private API cluster, you can use both the `--private` and `--private-ingress=false` arguments. -endif::openshift-rosa-hcp[] - -|--support-role-arn string -|The ARN of the role used by Red Hat Site Reliability Engineers (SREs) to enable access to the cluster account to provide support. - -|--tags -a|Tags that are used on resources created by {product-title} in AWS. Tags can help you manage, identify, organize, search for, and filter resources within AWS. Tags are comma separated, for example: "key value, foo bar". -[IMPORTANT] -==== -{product-title} only supports custom tags to Red{nbsp}Hat OpenShift resources during cluster creation. Once added, the tags cannot be removed or edited. -Tags that are added by Red{nbsp}Hat are required for clusters to stay in compliance with Red{nbsp}Hat production service level agreements (SLAs). These tags must not be removed. - -{product-title} does not support adding additional tags outside of {product-title} cluster-managed resources. These tags can be lost when AWS resources are managed by the ROSA cluster. In these cases, you might need custom solutions or tools to reconcile the tags and keep them intact. -==== - -|--version string -|The version of {product-title} that will be used to install the cluster or cluster resources. For `cluster` use an `X.Y.Z` format, for example, `4.20.0`. For `account-role` use an `X.Y` format, for example, `4.20`. - -|--worker-iam-role string -|The ARN of the IAM role that will be attached to compute instances. - -|--channel-group -|Allows users to assign their cluster to a specific channel group. Options include `stable` and `eus`. For more information about channel groups, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/updating_clusters/understanding-openshift-updates-1#understanding-update-channels-releases[Understanding update channels and releases]. - -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Examples -Create a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa create cluster --cluster-name=mycluster ----- -//Note to writers: The create cluster command specifically uses --cluster-name because a cluster ID does not exist yet. All other commands use --cluster because either the name or the ID can be used. - -Create a cluster with a specific AWS region. - -[source,terminal] ----- -$ rosa create cluster --cluster-name=mycluster --region=us-east-2 ----- - -Create a cluster with autoscaling enabled on the default worker machine pool. - -[source,terminal] ----- -$ rosa create cluster --cluster-name=mycluster -region=us-east-1 --enable-autoscaling --min-replicas=2 --max-replicas=5 ----- -ifdef::openshift-rosa-hcp[] -[id="rosa-create-external-auth-provider_{context}"] -== create external-auth-provider - -Add an external identity provider instead of the {OCP-short} OAuth2 server. - - -.Syntax -[source,terminal] ----- -$ rosa create external-auth-provider --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--claim-mapping-groups-claim -|Required. Describes rules on how to transform information from an ID token into a cluster identity. - -|--claim-validation-rule -|Rules that are applied to validate token claims to authenticate users. The input will be in a `:` format. To have multiple claim validation rules, you can separate the values by `,`. For example, `:,:`. - -|--claim-mapping-username-claim -|The name of the claim that should be used to construct user names for the cluster identity. - -a|--cluster \| -|Required. The name or ID of the cluster to which the IDP will be added. - -|--console-client-id -|The identifier of the OIDC client from the OIDC provider for the {cluster-manager-url} web console. - -|--console-client-secret -|The secret that is associated with the console application registration. - -|--issuer-audiences -|An array of audiences to check the incoming tokens against. Valid tokens must include at least one of these values in their audience claim. - -|--issuer-ca-file -|The path to the PEM-encoded certificate file to use when making requests to the server. - -|--issuer-url -|The serving URL of the token issuer. - -|--name -|A name that is used to refer to the external authentication provider. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile string from your credentials file. -|=== - -.Examples -Add a Microsoft Entra ID identity provider to a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa create external-auth-provider --cluster=mycluster --name --issuer-audiences --issuer-url --claim-mapping-username-claim email --claim-mapping-groups-claim groups ----- -endif::openshift-rosa-hcp[] -[id="rosa-create-idp_{context}"] -== create idp - -Add an identity provider (IDP) to define how users log in to a cluster. - -.Syntax -[source,terminal] ----- -$ rosa create idp --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|--cluster \| -|Required. The name or ID of the cluster to which the IDP will be added. - -|--ca -|The path to the PEM-encoded certificate file to use when making requests to the server, for example, `/usr/share/cert.pem`. - -|--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: `claim` - -|--name -|The name (string) for the identity provider. - -|--type -|The type (string) of identity provider. Options: `github`, `gitlab`, `google`, `ldap`, `openid` -|=== - -.GitHub arguments -[cols="30,70"] -|=== -|Option |Definition - -|--hostname -|The optional domain (string) that are used 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 `/`. -|=== - -.GitLab arguments -[cols="30,70"] -|=== -|Option |Definition - -|--host-url -|The host URL (string) of a GitLab provider. Default: `https://gitlab.com` -|=== - -.Google arguments -[cols="30,70"] -|=== -|Option |Definition - -|--hosted-domain -|Restricts users to a Google Apps domain (string). -|=== - -.LDAP arguments -[cols="30,70"] -|=== -|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: `dn` - -|--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: `cn` - -|--url -|An RFC 2255 URL (string) which specifies the LDAP search parameters that are used. - -|--username-attributes -|The list (string) of attributes whose values should be used as the preferred username. Default: `uid` -|=== - -.OpenID arguments -[cols="30,70"] -|=== -|Option |Definition - -|--email-claims -|The list (string) of claims that are used as the email address. - -|--extra-scopes -|The list (string) of scopes to request, in addition to the `openid` scope, during the authorization token request. - -|--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 that are used as the display name. - -|--username-claims -|The list (string) of claims that are used as the preferred username when provisioning a user. - -|--groups-claims -|The list (string) of claims that are used as the groups names. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Examples -Add a GitHub identity provider to a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa create idp --type=github --cluster=mycluster ----- - -Add an identity provider following interactive prompts. - -[source,terminal] ----- -$ rosa create idp --cluster=mycluster --interactive ----- -ifdef::openshift-rosa-hcp[] -[id="rosa-create-idms_{context}"] -== create image mirror configurations - -[IMPORTANT] -==== -The image mirror configuration feature operates exclusively with image references by digest, meaning that image mirroring will only activate when an image is pulled using its unique and immutable ID. Any image references using a mutable tag is currently not supported by this functionality. - -{product-title} clusters must be in the **Ready** state in order to create an image mirror configuration. -==== -Creates an image mirror configuration for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa create image-mirror [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|--cluster -|Required: The name or ID of the cluster the mirror configuration will be applied to. - -|--source -|Required: The source registry that will be mirrored. - -|--mirrors -|Required: List of mirror registries. Mirror registries must be comma-separated. - -|--type=digest -|Optional: Type of image mirror. The `digest` type is set by default and the only available `type` option. - -|--profile -|Optional: Specifies an AWS profile (string) from your credentials file. - -|--region -|Optional:Specifies an AWS region, overriding the AWS_REGION environment variable. - -|=== - -.Examples -Adds an image mirror configuration to a cluster named `mycluster`. - -[IMPORTANT] -==== -The source registry cannot be modified after creation. You must delete and recreate the image mirror to change the source. -==== - -[source,terminal] ----- -$ rosa create image-mirror --cluster=mycluster \ - --source=registry.example.com/team \ - --mirrors=mirror.corp.com/team,backup.corp.com/team ----- - -Adds an image mirror configuration with a specific type to a cluster. - -[source,terminal] ----- -$ rosa create image-mirror --cluster=mycluster \ - --type=digest --source=docker.io/library \ - --mirrors=internal-registry.company.com/dockerhub ----- - -Adds multiple mirror image configurations to a cluster. - -[source,terminal] ----- -$ rosa create image-mirror --cluster=mycluster \ - --source=quay.io/openshift \ - --mirrors=mirror1.company.com/openshift,mirror2.company.com/openshift,mirror3.company.com/openshift ----- - -endif::openshift-rosa-hcp[] - -[id="rosa-create-ingress_{context}"] -== create ingress - -Add an ingress endpoint to enable API access to the cluster. - -.Syntax -[source,terminal] ----- -$ rosa create ingress --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|--cluster \| -|Required: The name or ID of the cluster to which the ingress will be added. - -|--label-match -|The label match (string) for ingress. The format must be a comma-delimited list of key=value pairs. If no label is specified, all routes are exposed on both routers. - -|--private -|Restricts application route to direct, private connectivity. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Examples -Add an internal ingress to a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa create ingress --private --cluster=mycluster ----- - -Add a public ingress to a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa create ingress --cluster=mycluster ----- - -Add an ingress with a route selector label match. - -[source,terminal] ----- -$ rosa create ingress --cluster=mycluster --label-match=foo=bar,bar=baz ----- - -[id="rosa-create-kubeletconfig_{context}"] -== create kubeletconfig - -Create a custom `KubeletConfig` object to allow custom configuration of nodes in a -ifdef::openshift-rosa[] -cluster. -endif::openshift-rosa[] -ifdef::openshift-rosa-hcp[] -machine pool. -endif::openshift-rosa-hcp[] - -.Syntax -[source,terminal] ----- -$ rosa create kubeletconfig --cluster= --name= --pod-pids-limit= [flags] ----- - -.Flags -[cols="30,70"] -|=== -|Option |Definition - -|--pod-pids-limit -a|Required. The maximum number of PIDs for each node in the -ifdef::temp-ifdef[] -cluster. -endif::[] -ifdef::temp-ifdef[] -machine pool associated with the `KubeletConfig` object. -endif::[] - -a|-c, --cluster \| -|Required. The name or ID of the cluster in which to create the `KubeletConfig` object. - -|--name -a| -ifdef::temp-ifdef[] -Optional. -endif::[] -ifdef::temp-ifdef[] -Required. -endif::[] -Specifies a name for the `KubeletConfig` object. - -|-i, --interactive -|Enable interactive mode. - -|-h, --help -|Shows help for this command. -|=== - -For more information about setting the PID limit for the cluster, see _Configuring PID limits_. - -[id="rosa-create-machinepool_{context}"] -== create machinepool - -Add a machine pool to an existing cluster. - -ifdef::openshift-rosa-hcp[] -[TIP] -==== -Machine pool is also referred to as node pool on {product-title} clusters. -==== -endif::openshift-rosa-hcp[] - -.Syntax -[source,terminal] ----- -$ rosa create machinepool --cluster= | --replicas= --name= [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -// Note for writers: This command works the same way as rosa create --additional-compute-security-group-ids but all subsequent machinepools are compute only so we don't specify compute here yet; consistency across commands to come in OCM-3111. -|--additional-security-group-ids -|The identifier of one or more additional security groups to use along with the default security groups for this machine pool. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_. - -ifdef::openshift-rosa-hcp[] -|--capacity-reservation-id -|The ID of a pre-purchased AWS Capacity Reservation. -endif::openshift-rosa-hcp[] - -a|--cluster \| -|Required: The name or ID of the cluster to which the machine pool will be added. - -|--disk-size -|Set the disk volume size for the machine pool, in Gib or TiB. The default is 300 GiB. -ifdef::openshift-rosa[] -For {product-title} clusters version 4.13 or earlier, the minimum disk size is 128 GiB, and the maximum is 1 TiB. For cluster version 4.14 and later, the minimum is 128 GiB, and the maximum is 16 TiB. -endif::openshift-rosa[] -ifdef::openshift-rosa-hcp[] -For {product-title} clusters, the minimum disk size is 75 GiB, and the maximum is 16,384 GiB. -endif::openshift-rosa-hcp[] -|--enable-autoscaling -|Enable or disable autoscaling of compute nodes. To enable autoscaling, use this argument with the `--min-replicas` and `--max-replicas` arguments. To disable autoscaling, use `--enable-autoscaling=false` with the `--replicas` argument. - -|--instance-type -|The instance type (string) that should be used. Default: `m5.xlarge` - - -ifdef::openshift-rosa-hcp[] -a|--kubelet-configs -|The names of any `KubeletConfig` objects to apply to nodes in a machine pool. -endif::openshift-rosa-hcp[] - -|--labels -|The labels (string) for the machine pool. The format must be a comma-delimited list of key=value pairs. This list overwrites any modifications made to node labels on an ongoing basis. - -|--max-replicas -|Specifies the maximum number of compute nodes when enabling autoscaling. - -|--min-replicas -|Specifies the minimum number of compute nodes when enabling autoscaling. - -ifdef::openshift-rosa-hcp[] -|--max-surge -a| The `max-surge` parameter defines the number of new nodes that can be provisioned in excess of the desired number of replicas for the machine pool, as configured using the `--replicas` parameter, or as determined by the autoscaler when autoscaling is enabled. This can be an absolute number (for example, `2`) or a percentage of the machine pool size (for example, `20%`), but must use the same unit as the `max-unavailable` parameter. - -The default value is `1`, meaning that the maximum number of nodes in the machine pool during an upgrade is 1 plus the desired number of replicas for the machine pool. In this situation, one excess node can be provisioned before existing nodes need to be made unavailable. The number of nodes that can be provisioned simultaneously during an upgrade is `max-surge` plus `max-unavailable`. - -|--max-unavailable -a|The `max-unavailable` parameter defines the number of nodes that can be made unavailable in a machine pool during an upgrade, before new nodes are provisioned. This can be an absolute number (for example, `2`) or a percentage of the current replica count in the machine pool (for example, `20%`), but must use the same unit as the `max-surge` parameter. - -The default value is `0`, meaning that no outdated nodes are removed before new nodes are provisioned. The valid range for this value is from `0` to the current machine pool size, or from `0%` to `100%`. The total number of nodes that can be upgraded simultaneously during an upgrade is `max-surge` plus `max-unavailable`. - -endif::openshift-rosa-hcp[] - -|--name -|Required: The name (string) for the machine pool. - -|--replicas -|Required when autoscaling is not configured. The number (integer) of machines for this machine pool. - -|--tags -|Apply user defined tags to all resources created by {product-title} in AWS. Tags are comma separated, for example: `'key value, foo bar'`. - -|--taints -|Taints for the machine pool. This string value should be formatted as a comma-separated list of `key=value:ScheduleType`. This list will overwrite any modifications made to Node taints on an ongoing basis. - -|--autorepair -|AutoRepair setting for the machine pool represented as the boolean `true` or `false`. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Examples -Interactively add a machine pool to a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa create machinepool --cluster=mycluster --interactive ----- - -Add a machine pool that is named `mp-1` to a cluster with autoscaling enabled. - -[source,terminal] ----- -$ 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. - -[source,terminal] ----- -$ rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1 ----- - -Add a machine pool (`mp-1`) to a {product-title} cluster, configuring 6 replicas and the following upgrade behavior: - -* Allow up to 2 excess nodes to be provisioned during an upgrade. -* Ensure that no more than 3 nodes are unavailable during an upgrade. - -[source,terminal] ----- -$ rosa create machinepool --cluster=mycluster --replicas=6 --name=mp-1 --max-surge=2 --max-unavailable=3 ----- - -Add a machine pool with labels to a cluster. - -[source,terminal] ----- -$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --labels=foo=bar,bar=baz --name=mp-1 ----- - -Add a machine pool with tags to a cluster. - -[source,terminal] ----- -$ rosa create machinepool --cluster=mycluster --replicas=2 --instance-type=r5.2xlarge --tags='foo bar,bar baz' --name=mp-1 ----- -ifdef::openshift-rosa-hcp[] -[id="rosa-create-network_{context}"] -== create network - -Create a network that creates any necessary AWS resources through AWS CloudFormation templates. This helper command is intended to help create and configure a VPC for use with {product-title}. This command also supports {egress-zero} clusters. - -[IMPORTANT] -==== -Running this command creates resources within your AWS account. -==== - -[NOTE] -==== -For custom or advanced configurations, it is highly recommended to use the AWS CLI directly using the `aws cloudformation` command or create a new custom template with the required configurations. If you use a custom CloudFormation template with the ROSA CLI, the minimum required version is 1.2.47 or later. -==== - -.Syntax -[source,terminal] ----- -$ rosa create network [flags] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -| -|Allows you to use a custom template. Templates must be in the template folder, structured as `templates//cloudformation.yaml`. If no template name is provided, the command uses the default template. For binary builds, this template directory must be referenced manually after it is downloaded. - -|=== - -.Default CloudFormation template -[source,yaml] ----- -include::https://raw.githubusercontent.com/openshift/rosa/refs/heads/master/cmd/create/network/templates/rosa-quickstart-default-vpc/cloudformation.yaml[] ----- - -.Flags -[cols="30,70"] -|=== -|Option |Definition - -|--template-dir -|Allows you to specify the path to the template directory. Overrides the `OCM_TEMPLATE_DIR` environment variable. Required if not running the command inside the template directory. - -|--param Name -|Define the name of your network. A required parameter when using a custom template file. - -|--param Region -|Define the region of your network. A required parameter when using a custom template file. - -|--param -|Available parameters depend on the template. Use `--help` when in the template directory to find available parameters. -// TODO OSDOCS-11830 Suggest adding more parameters here, at least some related to setting up multiple AZs - -|--mode=manual -|Provides AWS commands to create the network stack. - -|=== - -.Example -Create a basic network with regular arguments and flags. - -[source,terminal] ----- -$ rosa create network rosa-quickstart-default-vpc --param Tags=key1=value1,key2=value2 --param Name=example-stack --param Region=us-west-2 ----- - -* The full list of parameters is available in the default template. -+ -.Example template -+ -[source,yaml] ----- -Parameters: - AvailabilityZoneCount: - Type: Number - Description: "Number of Availability Zones to use" - Default: 1 - MinValue: 1 - MaxValue: 3 - Region: - Type: String - Description: "AWS Region" - Default: "us-west-2" - Name: - Type: String - Description: "Name prefix for resources" - VpcCidr: - Type: String - Description: CIDR block for the VPC - Default: '10.0.0.0/16' ----- -endif::openshift-rosa-hcp[] -[id="rosa-create-ocm-role_{context}"] -== create ocm-role - -Create the required ocm-role resources for your cluster. - -.Syntax -[source,terminal] ----- -$ rosa create ocm-role [flags] ----- - -.Flags -[cols="30,70"] -|=== -|Option |Definition - -|--admin -|Enable admin capabilities for the role. - -|--debug -|Enable debug mode. - -|-i, --interactive -|Enable interactive mode. - -|-m, --mode string -a|How to perform the operation. Valid options are: - -* `auto`: Resource changes will be automatically applied using the current AWS account -* `manual`: Commands necessary to modify AWS resources will be output to be run manually - -|--path string -|The ARN path for the OCM role and policies. - -|--permissions-boundary string -|The ARN of the policy that is used to set the permissions boundary for the OCM role. - -|--prefix string -|User-defined prefix for all generated AWS resources. The default is `ManagedOpenShift`. - -|--profile string -|Use a specific AWS profile from your credential file. - -|-y, --yes -|Automatically answer yes to confirm operation. - -|=== - -For more information about the OCM role created with the `rosa create ocm-role` command, see _Account-wide IAM role and policy reference_. - -[id="rosa-create-user-role_{context}"] -== create user-role - -Create the required user-role resources for your cluster. - -.Syntax -[source,terminal] ----- -$ rosa create user-role [flags] ----- - -.Flags -[cols="30,70"] -|=== -|Option |Definition - -|--debug -|Enable debug mode. - -|-i, --interactive -|Enable interactive mode. - -|-m, --mode string -a|How to perform the operation. Valid options are: - -* `auto`: Resource changes will be automatically applied using the current AWS account -* `manual`: Commands necessary to modify AWS resources will be output to be run manually - -|--path string -|The ARN path for the user role and policies. - -|--permissions-boundary string -|The ARN of the policy that is used to set the permissions boundary for the user role. - -|--prefix string -|User-defined prefix for all generated AWS resources The default is `ManagedOpenShift`. - -|--profile string -|Use a specific AWS profile from your credential file. - -|-y, --yes -|Automatically answer yes to confirm operation. - -|=== - -For more information about the user role created with the `rosa create user-role` command, see _Understanding AWS account association_. - -[id="rosa-create-iamserviceaccount_{context}"] -== create iamserviceaccount - -Create an AWS Identity and Access Management (IAM) role that can be assumed by a {product-title} service account using OpenID Connect (OIDC) identity federation. - -.Syntax -[source,terminal] ----- -$ rosa create iamserviceaccount --cluster= | --name= [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|--cluster \| -|Required. The name or ID of the cluster for which to create the IAM service account role. - -|--name -|Required. The name of the {product-title} service account. This flag can be used multiple times to create a role for multiple service accounts. - -|--namespace -|The {product-title} namespace for the service account. Default: `default` - -|--role-name -|The name of the IAM role to create. If not specified, a name will be auto-generated using the pattern `{cluster-name}-{namespace}-{service-account-name}-role`. - -|--attach-policy-arn -|The ARN of an IAM policy to attach to the role. This flag can be used multiple times to attach multiple policies. - -|--inline-policy -|An inline policy document in JSON format or a file path prefixed with `file://` (for example, `file://policy.json`). - -|--permissions-boundary -|The ARN of an IAM policy to use as a permissions boundary for the role. - -|--path -|The IAM path for the role. Default: `/` - -a|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be automatically applied using the current AWS account. -`manual`:: Commands necessary to modify AWS resources will be output to be run manually. - -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile string -|Specifies an AWS profile from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. - -|=== - -.Examples -Create an IAM role for a service account named `my-app` in the `default` namespace with S3 read-only access. - -[source,terminal] ----- -$ rosa create iamserviceaccount --cluster=mycluster --name=my-app --attach-policy-arn=arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess ----- - -Create an IAM role with a custom name and multiple policies. - -[source,terminal] ----- -$ rosa create iamserviceaccount --cluster=mycluster --name=my-app --namespace=production --role-name=my-custom-role --attach-policy-arn=arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess --attach-policy-arn=arn:aws:iam::aws:policy/AmazonEC2ReadOnlyAccess ----- - -Create an IAM role with an inline policy from a file. - -[source,terminal] ----- -$ rosa create iamserviceaccount --cluster=mycluster --name=my-app --inline-policy=file://my-policy.json ----- diff --git a/modules/rosa-delete-objects.adoc b/modules/rosa-delete-objects.adoc deleted file mode 100644 index 4afc76636c..0000000000 --- a/modules/rosa-delete-objects.adoc +++ /dev/null @@ -1,593 +0,0 @@ -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc - -:_mod-docs-content-type: REFERENCE -[id="rosa-delete-objects_{context}"] -= Delete objects - -This section describes the `delete` commands for clusters and resources. - -[id="rosa-delete-account-roles_{context}"] -== delete account-roles - -Cleans up account roles from the current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa delete account-roles ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--classic -|Deletes classic account roles - -|--delete-hcp-shared-vpc-policies -|Deletes the Hosted Control Plane shared vpc policies - -|--hosted-cp -|Deletes Hosted Control Plane roles - -a|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be applied automatically using the current AWS account. -`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. - -|--prefix -|Prefix of the account roles to be deleted. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes all AWS account roles with the prefix of `mycluster`. - -[source,terminal] ----- -$ rosa delete account-roles -p mycluster ----- - -[id="rosa-delete-admin_{context}"] -== delete admin - -Deletes a cluster administrator from a specified cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete admin --cluster= | ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that contains the identity provider (IDP) you want to delete. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes a cluster administrator from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete admin --cluster=mycluster ----- - -ifdef::openshift-rosa[] -[id="rosa-delete-autoscaler_{context}"] -== delete autoscaler - -Deletes autoscaler configuration for a given cluster. - -[NOTE] -==== -This action is only supported on {product-title} clusters with a self-hosted control plane. Clusters with hosted control planes do not support autoscaler. -==== - -.Syntax -[source,terminal] ----- -$ rosa delete autoscaler --cluster= ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that has an autoscaler you want to delete. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes the autoscaler on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete autoscaler --cluster=mycluster ----- -endif::openshift-rosa[] - -[id="rosa-delete-cluster_{context}"] -== delete cluster - -Deletes a cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete cluster --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster to delete. - -|--watch -|Watches the cluster uninstallation logs. - -|--best-effort -|Skips steps in the cluster destruction chain that are known to cause the cluster deletion process to fail. You should use this option with care and it is recommended that you manually check your AWS account for any resources that might be left over after using `--best-effort`. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Deletes a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete cluster --cluster=mycluster ----- - -[id="rosa-delete-external-auth-provider_{context}"] -== delete external-auth-provider - -Deletes an external authentication provider from a cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete external-auth-provider --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required. The name or ID string of the cluster the external auth provider will be deleted from. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes an identity provider named `exauth-1` from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete external-auth-provider exauth-1 --cluster=mycluster ----- - -[id="rosa-delete-idp_{context}"] -== delete idp - -Deletes a specific identity provider (IDP) from a cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete idp --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster from which the IDP will be deleted. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes an identity provider named `github` from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete idp github --cluster=mycluster ----- - -[id="rosa-delete-ingress_{context}"] -== delete ingress - -Deletes a non-default application router (ingress) from a cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete ingress --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster from which the ingress will be deleted. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Deletes an ingress with the ID `a1b2` from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete ingress --cluster=mycluster a1b2 ----- - -Deletes a secondary ingress with the subdomain name `apps2` from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete ingress --cluster=mycluster apps2 ----- - -[id="rosa-delete-kubeletconfig_{context}"] -== delete kubeletconfig - -Deletes a custom `KubeletConfig` object from a cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete kubeletconfig --cluster= [flags] ----- - -.Flags -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster for which you want to delete the `KubeletConfig` object. - -|--name -a| -ifdef::temp-ifdef[] -Optional. -endif::[] -ifdef::temp-ifdef[] -Required. -endif::[] -Specifies a name for the `KubeletConfig` object. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-delete-machinepool_{context}"] -== delete machinepool - -Deletes a machine pool from a cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete machinepool --cluster= | ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the machine pool will be deleted from. - -|--machinepool string -|Machine pool of the cluster to target. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes the machine pool with the ID `mp-1` from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete machinepool --cluster=mycluster mp-1 ----- - -[id="rosa-delete-ocm-role_{context}"] -== delete ocm-role - -Deletes OCM role from the current AWS organization. - -.Syntax -[source,terminal] ----- -$ rosa delete ocm-role --role-arn ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be applied automatically using the current AWS account. -`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. - -|--role-arn string -|Required: The role ARN to delete from the user role from the AWS account - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Deletes an ocm-role with `arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778` arn. - -[source,terminal] ----- -$ rosa delete ocm-role --role-arn arn:aws:iam::123456789012:role/xxx-OCM-Role-1223456778 ----- - -[id="rosa-delete-oidc-config_{context}"] -== delete oidc-config - -Deletes the OIDC config based on the registered OIDC Config ID. - -.Syntax -[source,terminal] ----- -$ rosa delete oidc-config --oidc-config-id ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be applied automatically using the current AWS account. -`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. - -|--oidc-config-id string -|Required: Registered ID for identification of OIDC config. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes an OIDC config with an ID of `A1B2C3D4`. - -[source,terminal] ----- -$ rosa delete oidc-config --oidc-config-id A1B2C3D4 ----- - -[id="rosa-delete-oidc-provider_{context}"] -== delete oidc-provider - -Deletes the OIDC provider of a deleted STS cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete oidc-provider --cluster= | --oidc-config-id ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-c, --cluster string -|Name or ID of the cluster. - -a|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be applied automatically using the current AWS account. -`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. - -|--oidc-config-id string -|Required: Registered OIDC configuration ID to retrieve its issuer URL. Not to be used alongside `--cluster` flag. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -* Deletes the OIDC provider using the OIDC config ID of `A1B2C3D4`. -+ -[source,terminal] ----- -$ rosa delete oidc-provider --oidc-config-id A1B2C3D4 ----- - -* Deletes the OIDC provider using the cluster name of `mycluster`. -+ -[source,terminal] ----- -$ rosa delete oidc-provider --cluster=mycluster ----- - -[id="rosa-delete-operator-roles_{context}"] -== delete operator-roles - -Deletes the Operator roles of a deleted STS cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete oidc-provider --cluster= | --oidc-config-id ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-c, --cluster string -|Name or ID of the cluster. - -ifdef::openshift-rosa-hcp[] -|--delete-hcp-shared-vpc-policies -|Deletes the hosted control plane shared VPC policies. -endif::openshift-rosa-hcp[] - -a|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be applied automatically using the current AWS account. -`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. - -|--prefix string -|Operator role prefix. You must use this flag in case of reusable OIDC Config. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example - -Deletes the operator-roles on the cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete operator-roles --cluster=mycluster ----- - -[id="rosa-delete-tuning-configs_{context}"] -== delete tuning-configs - -Deletes a specified tuning configuration that is on a specified cluster. - -.Syntax -[source,terminal] ----- -$ rosa delete tuning-config --cluster= ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-c, --cluster string -|Name or ID of the cluster. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example - -Deletes the tuning config named `tuned1` from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa delete tuning-config --cluster=mycluster tuned1 ----- - -[id="rosa-delete-upgrade_{context}"] -== delete upgrade - -Cancels a scheduled cluster upgrade. - -.Syntax -[source,terminal] ----- -$ rosa delete upgrade ----- - -.Arguments -[cols="30,70"] -|=== -|Option -|Definition - -|-c, --cluster string -|Name or ID of the cluster. - -|--machinepool string -|Machine pool of the cluster to target. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes the user role that has a prefix of `rh-user` and a user-role name of `Auditor`. - -[source,terminal] ----- -$ rosa delete user-role --role-arn rh-user-User-Auditor-Role ----- - -[id="rosa-delete-user-role_{context}"] -== delete user-role - -Deletes user role from the current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa delete user-role ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-m, --mode string -a|How to perform the operation. Valid options are: - -`auto`:: Resource changes will be applied automatically using the current AWS account. -`manual`:: Outputs the necessary commands to modify AWS resources will be output to be run manually. - -|--role-arn string -|Required: The ARN of the user-role that you want to delete from the AWS account. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Deletes the user role that has a prefix of `rh-user` and a user-role name of `Auditor`. - -[source,terminal] ----- -$ rosa delete user-role --role-arn rh-user-User-Auditor-Role ----- \ No newline at end of file diff --git a/modules/rosa-edit-objects.adoc b/modules/rosa-edit-objects.adoc deleted file mode 100644 index d073db3a31..0000000000 --- a/modules/rosa-edit-objects.adoc +++ /dev/null @@ -1,410 +0,0 @@ - -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc - -:_mod-docs-content-type: REFERENCE -[id="rosa-edit-objects_{context}"] -= Edit objects - - -This section describes the `edit` commands for clusters and resources. - -[id="rosa-edit-cluster_{context}"] -== edit cluster - -Allows edits to an existing cluster. - -.Syntax -[source,terminal] ----- -$ rosa edit cluster --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition -ifdef::openshift-rosa-hcp[] -|--additional-allowed-principals -|A comma-separated list of additional allowed principal ARNs to be added to the Hosted Control Plane's VPC endpoint service to enable additional VPC endpoint connection requests to be automatically accepted. -endif::openshift-rosa-hcp[] -|--cluster -|Required: The name or ID (string) of the cluster to edit. - -|--private -|Restricts a primary API endpoint to direct, private connectivity. - -|--enable-delete-protection=true -|Enables the delete protection feature. - -|--enable-delete-protection=false -|Disables the delete protection feature. -ifdef::openshift-rosa-hcp[] -|--billing-account-string -|Specifies the account used for billing subscriptions purchased from the AWS marketplace. -endif::openshift-rosa-hcp[] - -|--channel-group -|Allows users to assign their cluster to a specific channel group. Options include `stable` and `eus`. For more information about channel groups, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/updating_clusters/understanding-openshift-updates-1#understanding-update-channels-releases[Understanding update channels and releases]. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Examples -Edit a cluster named `mycluster` to make it private. - -[source,terminal] ----- -$ rosa edit cluster --cluster=mycluster --private ----- - -Edit all cluster options interactively on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa edit cluster --cluster=mycluster --interactive ----- - -[id="rosa-edit-ingress_{context}"] -== edit ingress - -Edits the default application router for a cluster. - -[NOTE] -==== -For information about editing non-default application routers, see _Additional resources_. -==== -.Syntax -[source,terminal] ----- -$ rosa edit ingress --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster to which the ingress will be added. - -|--cluster-routes-hostname -|Components route hostname for OAuth, console, and download. - -|--cluster-routes-tls-secret-ref -|Components route TLS secret reference for OAuth, console, and download. - -|--excluded-namespaces -|Excluded namespaces for ingress. Format is a comma-separated list `value1, value2...`. If no values are specified, all namespaces will be exposed. - -|--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. - -|--lb-type -|Type of Load Balancer. Options are `classic`, `nlb`. - -|--namespace-ownership-policy -|Namespace Ownership Policy for ingress. Options are `Strict` and `InterNamespaceAllowed`. Default is `Strict`. - -|--private -|Restricts the application route to direct, private connectivity. - -|--route-selector -|Route Selector for ingress. Format is a comma-separated list of key=value. If no label is specified, all routes will be exposed on both routers. For legacy ingress support these are inclusion labels, otherwise they are treated as exclusion label. - -|--wildcard-policy -|Wildcard Policy for ingress. Options are `WildcardsDisallowed` and `WildcardsAllowed`. Default is `WildcardsDisallowed`. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Examples - -Make an additional ingress with the ID `a1b2` as a private connection on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa edit ingress --private --cluster=mycluster a1b2 ----- - -Update the router selectors for the additional ingress with the ID `a1b2` on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa edit ingress --label-match=foo=bar --cluster=mycluster a1b2 ----- - -Update the default ingress using the sub-domain identifier `apps` on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa edit ingress --private=false --cluster=mycluster apps ----- - -Update the load balancer type of the `apps2` ingress. - -[source,terminal] ----- -$ rosa edit ingress --lb-type=nlb --cluster=mycluster apps2 ----- - -[id="rosa-edit-kubeletconfig_{context}"] -== edit kubeletconfig - -Edit a custom `KubeletConfig` object in a -ifdef::temp-ifdef[] -cluster. -endif::[] -ifdef::temp-ifdef[] -machine pool. -endif::[] - -.Syntax -[source,terminal] ----- -$ rosa edit kubeletconfig --cluster= --name= --pod-pids-limit= [flags] ----- - -.Flags -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster for which the `KubeletConfig` object will be edited. - -|-i, --interactive -|Enable interactive mode. - -|--pod-pids-limit -a|Required. The maximum number of PIDs for each node in the -ifdef::temp-ifdef[] -cluster. -endif::[] -ifdef::temp-ifdef[] -machine pool associated with the `KubeletConfig` object. -endif::[] - -|--name -a| -ifdef::temp-ifdef[] -Optional. -endif::[] -ifdef::temp-ifdef[] -Required. -endif::[] -Specifies a name for the `KubeletConfig` object. - -|-h, --help -|Shows help for this command. -|=== - -For more information about setting the PID limit for the cluster, see _Configuring PID limits_. - -[id="rosa-edit-machinepool_{context}"] -== edit machinepool - -Allows edits to the machine pool in a cluster. - -.Syntax -[source,terminal] ----- -$ rosa edit machinepool --cluster= [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|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 `--min-replicas` and `--max-replicas` arguments. To disable autoscaling, use `--enable-autoscaling=false` with the `--replicas` argument. - -|--labels -|The labels (string) for the machine pool. The format must be a comma-delimited list of key=value pairs. Editing this value only affects newly created nodes of the machine pool, which are created by increasing the node number, and does not affect the existing nodes. This list overwrites any modifications made to node labels on an ongoing basis. - -ifdef::openshift-rosa-hcp[] -a|--kubelet-configs -| The names of any `KubeletConfig` objects to apply to nodes in a machine pool. -endif::openshift-rosa-hcp[] - -|--max-replicas -|Specifies the maximum number of compute nodes when enabling autoscaling. - -|--min-replicas -|Specifies the minimum number of compute nodes when enabling autoscaling. - -ifdef::openshift-rosa-hcp[] -|--max-surge -a| The `max-surge` parameter defines the number of new nodes that can be provisioned in excess of the desired number of replicas for the machine pool, as configured using the `--replicas` parameter, or as determined by the autoscaler when autoscaling is enabled. This can be an absolute number (for example, `2`) or a percentage of the machine pool size (for example, `20%`), but must use the same unit as the `max-unavailable` parameter. - -The default value is `1`, meaning that the maximum number of nodes in the machine pool during an upgrade is 1 plus the desired number of replicas for the machine pool. In this situation, one excess node can be provisioned before existing nodes need to be made unavailable. The number of nodes that can be provisioned simultaneously during an upgrade is `max-surge` plus `max-unavailable`. - -|--max-unavailable -a|The `max-unavailable` parameter defines the number of nodes that can be made unavailable in a machine pool during an upgrade, before new nodes are provisioned. This can be an absolute number (for example, `2`) or a percentage of the current replica count in the machine pool (for example, `20%`), but must use the same unit as the `max-surge` parameter. - -The default value is `0`, meaning that no outdated nodes are removed before new nodes are provisioned. The valid range for this value is from `0` to the current machine pool size, or from `0%` to `100%`. The total number of nodes that can be upgraded simultaneously during an upgrade is `max-surge` plus `max-unavailable`. - - -|--node-drain-grace-period -|Specifies the node drain grace period when upgrading or replacing the machine pool. -endif::openshift-rosa-hcp[] -|--replicas -|Required when autoscaling is not configured. The number (integer) of machines for this machine pool. - -|--taints -|Taints for the machine pool. This string value should be formatted as a comma-separated list of `key=value:ScheduleType`. Editing this value only affect newly created nodes of the machine pool, which are created by increasing the node number, and does not affect the existing nodes. This list overwrites any modifications made to Node taints on an ongoing basis. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--interactive -|Enables interactive mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Examples - -Set 4 replicas on a machine pool named `mp1` on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa edit machinepool --cluster=mycluster --replicas=4 mp1 ----- - -Enable autoscaling on a machine pool named `mp1` on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa edit machinepool --cluster=mycluster --enable-autoscaling --min-replicas=3 --max-replicas=5 mp1 ----- - -Disable autoscaling on a machine pool named `mp1` on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa edit machinepool --cluster=mycluster --enable-autoscaling=false --replicas=3 mp1 ----- - -Modify the autoscaling range on a machine pool named `mp1` on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa edit machinepool --max-replicas=9 --cluster=mycluster mp1 ----- -ifdef::openshift-rosa-hcp[] -On {product-title} clusters, edit the `mp1` machine pool to add the following behavior during upgrades: -* Allow up to 2 excess nodes to be provisioned during an upgrade. -* Ensure that no more than 3 nodes are unavailable during an upgrade. - -[source,terminal] ----- -$ rosa edit machinepool --cluster=mycluster mp1 --max-surge=2 --max-unavailable=3 ----- - -Associate a `KubeletConfig` object with an existing `high-pid-pool` machine pool on a {product-title} cluster. - -[source,terminal] ----- -$ rosa edit machinepool -c mycluster --kubelet-configs=set-high-pids high-pid-pool ----- - -[id="rosa-edit-mirror-set_{context}"] -== edit mirror image configurations -Edits the mirror lists in an existing mirror image configuration. -[NOTE] -==== -When editing image mirrors, the new mirrors list completely replaces the existing mirrors list. -==== - -.Syntax -[source,terminal] ----- -$ rosa edit image-mirror [arguments] ----- -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster to which the ingress will be added. - -|--mirrors -|Required: New list of mirror registries that replaces current mirror registries. Mirror registries must be comma-separated. - -|--id -|Required: ID of the image mirror configuration to edit. - -|--profile -|Optional: Use a specific AWS profile from your credential file. - -|--region -|Optional: Use a specific AWS region, overriding the AWS_REGION environment variable. -|=== - -.Examples - -Replaces all mirrors. - -[source,terminal] ----- -$ rosa edit image-mirror --cluster=mycluster --id=abc123def456 \ - --mirrors=new-primary.company.com/team,new-secondary.company.com/team ----- - -Replaces a single mirror. -[source,terminal] ----- -$ rosa edit image-mirror --cluster=mycluster --id=abc123def456 \ - --mirrors=single-mirror.company.com/team ----- - -endif::openshift-rosa-hcp[] \ No newline at end of file diff --git a/modules/rosa-install-uninstall-addon.adoc b/modules/rosa-install-uninstall-addon.adoc deleted file mode 100644 index 0c1e147e87..0000000000 --- a/modules/rosa-install-uninstall-addon.adoc +++ /dev/null @@ -1,102 +0,0 @@ -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc - -:_mod-docs-content-type: REFERENCE -[id="rosa-install-uninstall-addon_{context}"] -= Install and uninstall add-ons - - -This section describes how to install and uninstall Red{nbsp}Hat managed service add-ons to a cluster. - -[id="rosa-install-addon_{context}"] -== install addon - -Installs a managed service add-on on a cluster. - -.Syntax -[source,terminal] ----- -$ rosa install addon --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster where the add-on will be installed. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Uses a specific AWS profile (string) from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== - -.Example -Add the `dbaas-operator` add-on installation to a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa install addon --cluster=mycluster dbaas-operator ----- - -[id="rosa-uninstall-addon_{context}"] -== uninstall addon - -Uninstalls a managed service add-on from a cluster. - -.Syntax -[source,terminal] ----- -$ rosa uninstall addon --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the add-on will be uninstalled from. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Uses a specific AWS profile (string) from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== - -.Example -Remove the `dbaas-operator` add-on installation from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa uninstall addon --cluster=mycluster dbaas-operator ----- diff --git a/modules/rosa-list-objects.adoc b/modules/rosa-list-objects.adoc deleted file mode 100644 index 55b20b3388..0000000000 --- a/modules/rosa-list-objects.adoc +++ /dev/null @@ -1,1124 +0,0 @@ -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc -:_mod-docs-content-type: REFERENCE -[id="rosa-list-objects_{context}"] -= List and describe objects - -This section describes the `list` and `describe` commands for clusters and resources. - -[id="rosa-describe-access-request_{context}"] -== describe access-request - -Shows detailed information about access requests. - -.Syntax -[source,terminal] ----- -$ rosa describe describe access-request --id ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -| --id string -| Required. The ID of your access request. -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Shows the details of the access request with an ID of `A1B2C3D4` and produces the results in a .yaml output. - -[source,terminal] ----- -$ rosa describe describe access-request --id A1B2C3D4 -output yaml ----- - -[id="rosa-list-access-request_{context}"] -== list access-request - -Lists all access requests in either `Pending` or `Approved` status. If you use the '--cluster' flag, the CLI lists all access requests in any status for the specified cluster. - -.Syntax -[source,terminal] ----- -$ rosa list access-request [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-c, --cluster string -|Required: The name or ID (string) of the cluster that the machine pools will be listed for. -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all Access Requests for cluster `foo`. - -[source,terminal] ----- -$ rosa list access-request --cluster foo ----- - -[id="rosa-list-account-roles_{context}"] -== list account-roles - -Lists all account roles and policies for the current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa list account-roles [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-c, --cluster string -|Required: The name or ID (string) of the cluster that the machine pools will be listed for. -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all AWS account roles associated with your account. - -[source,terminal] ----- -$ rosa list account-roles ----- - -[id="rosa-describe-addon-installation_{context}"] -== describe addon-installation - -Shows detailed information about an add-on installation. - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-c, --cluster string -|Required: The name or ID (string) of the cluster that the machine pools will be listed for. -| --addon string -|Required: Name or ID of the add-on installation. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Describes the `bar` add-on installation on cluster `foo`. - -[source,terminal] ----- -$ rosa describe addon-installation --cluster foo --addon bar ----- - -[id="rosa-describe-admin_{context}"] -== describe admin - -Shows the details of a specified `cluster-admin` user and a command to log in to the cluster. - -.Syntax -[source,terminal] ----- -$ rosa describe admin --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster to which the cluster-admin belongs. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Describes the `cluster-admin` user for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa describe admin --cluster=mycluster ----- - -[id="rosa-describe-addon_{context}"] -== describe addon - -Shows the details of a managed service add-on. - -.Syntax -[source,terminal] ----- -$ rosa describe addon | [arguments] ----- - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Describes an add-on named `dbaas-operator`. - -[source,terminal] ----- -$ rosa describe addon dbaas-operator ----- - -[id="rosa-list-oaddon_{context}"] -== list addon - -Lists the managed service add-on installations. - -.Syntax -[source,terminal] ----- -$ rosa list addons [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster to list the add-ons for. -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all add-on installations on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list addons --cluster=mycluster ----- - -ifdef::openshift-rosa[] -[id="rosa-describe-autoscaler_{context}"] -== describe autoscaler - -Shows detailed information about the configuration for a specified cluster's autoscaler. - -[NOTE] -==== -Cluster autoscalers are only supported on {product-title} clusters that use self-hosted control planes. -==== - -.Syntax -[source,terminal] ----- -$ rosa describe autoscaler [flag] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Describes the autoscaler for cluster `foo`. - -[source,terminal] ----- -$ rosa describe autoscaler --cluster foo ----- -endif::openshift-rosa[] - -[id="rosa-describe-break-glass-credential_{context}"] -== describe break-glass-credential - -Shows the details for a break glass credential for a specific cluster. - -.Syntax -[source,terminal] ----- -$ rosa describe break-glass-credential --id= --cluster=| [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. -|--id -|Required: The ID (string) of the break glass credential. -|--kubeconfig -|Optional: Retrieves the kubeconfig from the break glass credential. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-list-break-glass-credential_{context}"] -== List break-glass-credential - -Lists all of the break glass credentials for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list break-glass-credential [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster \| -|Required. The name or ID of the cluster to which the break glass credentials have been added. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example - -Lists all of the break glass credentials for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list break-glass-credential --cluster=mycluster ----- - -[id="rosa-describe-cluster_{context}"] -== describe cluster - -Shows the details for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa describe cluster [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. - -|--external-id -|An optional, unique identifier that might be required when you assume a role in another account. - -|--get-role-policy-bindings -|Lists the policies that are attached to the STS roles assigned to the cluster. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Describes a cluster named `mycluster`. -[source,terminal] ----- -$ rosa describe cluster --cluster=mycluster ----- - -[id="rosa-list-clusters_{context}"] -== list clusters - -Lists all of your clusters. - -.Syntax -[source,terminal] ----- -$ rosa list clusters [flag] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition -|-a, --all -|Lists all clusters across different AWS accounts under the same Red Hat organization - -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|--get-role-policy-bindings -|Lists the policies that are attached to the STS roles assigned to the cluster. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-list-dns-domain_{context}"] -== list dns-domain - -Lists all DNS domains. - -.Syntax -[source,terminal] ----- -$ rosa list dns-domain [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-a, --all -|Lists all DNS domains. The default options lists just user defined domains. - -| --hosted-cp -|Filters the list to only DNS Domains used for hosted control plane clusters. - -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all DNS Domains tied to your organization ID. - -[source,terminal] ----- -$ rosa list dns-domain ----- - -[id="rosa-describe-external-auth-provider_{context}"] -== describe external-auth-provider - -Shows detailed information about an external authentication provider on a cluster. - -.Syntax -[source,terminal] ----- -$ rosa describe external-auth-provider [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. - -|--name string -|The name for the external authentication provider of the cluster to target. - -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Shows details of an external authentication provider named `exauth` on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa describe external-auth-provider exauth --cluster=mycluster ----- - -[id="rosa-list-external-auth-provider_{context}"] -== list external-auth-provider - -Lists any external authentication providers for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list external-auth-provider --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID string of the cluster that the external authentication provider will be listed for. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists any external authentication providers for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list external-auth-provider --cluster=mycluster ----- - -[id="rosa-list-gates_{context}"] -== list gates - -Lists all available OCP Gates for a specific OCP release or by cluster upgrade version. - -.Syntax -[source,terminal] ----- -$ rosa list gates [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. - -|--gate string -|Gate type. Options are `sts` and `ocp`. - -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|--version string -|Specified OpenShift version. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example - -* Lists all OCP gates for an OCP version. -+ -[source,terminal] ----- -$ rosa list gates --version 4.19 ----- - -* Lists all STS gates for an OCP version. -+ -[source,terminal] ----- -$ rosa list gates --gate sts --version 4.19 ----- - -* Lists all OCP gates for an OCP version. -+ -[source,terminal] ----- -$ rosa list gates --gate ocp --version 4.19 ----- - -* Lists available gates for a cluster upgrade version. -+ -[source,terminal] ----- -$ rosa list gates -c mycluster --version 4.19.7 ----- - -[id="rosa-list-idps_{context}"] -== list idps - -Lists all of the identity providers (IDPs) for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list idps [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the IDPs will be listed for. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all identity providers (IDPs) for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list idps --cluster=mycluster ----- - -[id="rosa-describe-ingress_{context}"] -== describe ingress - -Shows detailed information about the specified ingress within cluster. - -.Syntax -[source,terminal] ----- -$ rosa describe ingress [ingress] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. - -| --ingress string -|Specify the ingress of the cluster to target - -|-o, --output string -|Specify your output format. You may use either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Shows the details of an ingress named `a1b2c3d4` on cluster named `mycluster`. - -[source,terminal] ----- -$ rosa describe ingress a1b2c3d4 -c mycluster ----- - -[id="rosa-list-ingresses_{context}"] -== list ingresses - -Lists all of the API and ingress endpoints for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list ingresses [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the IDPs will be listed for. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all API and ingress endpoints for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list ingresses --cluster=mycluster ----- - -[id="rosa-list-instance-types_{context}"] -== list instance-types - -Lists all of the available instance types for use with {product-title}. Availability is based on the account's AWS quota. - -.Syntax -[source,terminal] ----- -$ rosa list instance-types [arguments] ----- - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all instance types. - -[source,terminal] ----- -$ rosa list instance-types ----- - -[id="rosa-describe-kubeletconfig_{context}"] -== describe kubeletconfig - -Shows the details of a custom `KubeletConfig` object. - -.Syntax -[source,terminal] ----- -$ rosa describe kubeletconfig --cluster= [arguments] ----- - -.Flags -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster for which you want to view the `KubeletConfig` object. - -|-h, --help -|Shows help for this command. - -|--name -a| -ifdef::openshift-rosa[] -Optional. -endif::openshift-rosa[] -ifdef::openshift-rosa-hcp[] -Required. -endif::openshift-rosa-hcp[] -Specifies the name of the `KubeletConfig` object to describe. - -|-o, --output string -|The output format. You can specify either `json` or `yaml`. - -|=== - -[id="rosa-list-kubeletconfigs_{context}"] -== list kubeletconfigs - -Lists the `KubeletConfig` objects configured on a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list kubeletconfigs --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster that the machine pools will be listed for. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all of the `KubeletConfig` objects on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list kubeletconfigs --cluster=mycluster ----- - -[id="rosa-describe-machinepool_{context}"] -== describe machinepool - -Describes a specific machine pool configured on a cluster. - -.Syntax -[source,terminal] ----- -$ rosa describe machinepool --cluster=[|] --machinepool= [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. - -|--machinepool -|Required: The name or ID (string) of the machinepool. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Describes a machine pool named `mymachinepool` on a cluster named `mycluster`. -[source,terminal] ----- -$ rosa describe machinepool --cluster=mycluster --machinepool=mymachinepool ----- - -[id="rosa-list-machinepools_{context}"] -== list machinepools - -Lists the machine pools configured on a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list machinepools --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the machine pools will be listed for. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all of the machine pools on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list machinepools --cluster=mycluster ----- - -[id="rosa-list-ocm-roles_{context}"] -== list ocm-roles - -Lists all OCM roles for the current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa list ocm-roles [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-o, --output string -|The output format. You can specify either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-list-oidc-config_{context}"] -== list oidc-config - -Lists the OIDC Configuration resources associated with your AWS account. - -.Syntax -[source,terminal] ----- -$ rosa list oidc-config ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-o, --output string -|The output format. You can specify either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-list-oidc-providers_{context}"] -== list oidc-providers - -Lists all of the OIDC providers for the current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa list oidc-providers [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster that the OIDC providers will be listed for. - -|--oidc-config-id string -|This argument filters OIDC providers by OIDC config ID. It returns one provider linked to the config ID. - -|-o, --output string -|The output format. You can specify either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-list-operator-roles_{context}"] -== list operator-roles - -Lists all Operator roles and policies for the current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa list operator-roles [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster. -|-o, --output string -|The output format. You can specify either `json` or `yaml`. -|--prefix string -|List only Operator roles that are associated with the given prefix. The prefix must match up to `openshift|kube-system`. -|--version string -|List only Operator roles that are associated with the given version. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-list-regions_{context}"] -== list regions - -Lists all of the available regions for the current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa list regions [arguments] ----- - -ifdef::openshift-rosa[] -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--multi-az -|Lists regions that provide support for multiple availability zones. -|=== -endif::openshift-rosa[] - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all of the available regions. - -[source,terminal] ----- -$ rosa list regions ----- - -[id="rosa-describe-tuning-configs_{context}"] -== describe tuning-configs - -Shows detailed information about a tuning config for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa describe tuning-config --cluster ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster. -|-o, --output string -|The output format. You can specify either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Examples -Describes the `tuned1` tuned config on cluster `foo`. - -[source,terminal] ----- -$ rosa describe tuning-config --cluster foo tuned1 ----- - -[id="rosa-list-tuning-configs_{context}"] -== list tuning-configs - -Lists tuning configuration resources for a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list tuning-configs --cluster ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster. -|-o, --output string -|The output format. You can specify either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all tuning configuration for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list tuning-configs -c mycluster ----- - -[id="rosa-describe-upgrade_{context}"] -== describe upgrade - -Shows detailed information about an upgrade. - -.Syntax -[source,terminal] ----- -$ rosa describe upgrade [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -a|-c, --cluster \| -|Required. The name or ID of the cluster. -| --machinepool string -|The name of the machine pool of the cluster to target. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-list-upgrades_{context}"] -== list upgrades - -Lists all available and scheduled cluster version upgrades. - -.Syntax -[source,terminal] ----- -$ rosa list upgrades --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the available upgrades will be listed for. -| --machinepool string -|The name of the machine pool of the cluster to target. -|-o, --output string -|The output format. You can specify either `json` or `yaml`. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all of the available upgrades for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list upgrades --cluster=mycluster ----- - -[id="rosa-list-user-roles_{context}"] -== list user-roles - -Lists all user roles for current AWS account. - -.Syntax -[source,terminal] ----- -$ rosa list user-roles ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|-o, --output string -|The output format. You can specify either `json` or `yaml`. - -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -[id="rosa-list-users_{context}"] -== list users -Lists the cluster administrator and dedicated administrator users for a specified cluster. - -.Syntax -[source,terminal] ----- -$ rosa list users --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the cluster administrators will be listed for. -|=== - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all of the cluster administrators and dedicated administrators for a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa list users --cluster=mycluster ----- - -[id="rosa-list-versions_{context}"] -== list versions - -Lists all of the OpenShift versions that are available for creating a cluster. - -.Syntax -[source,terminal] ----- -$ rosa list versions [arguments] ----- - -include::snippets/rosa-cli-default-flags.adoc[] - -.Example -Lists all of the {product-title} versions. - -[source,terminal] ----- -$ rosa list versions ----- \ No newline at end of file diff --git a/modules/rosa-logs-install.adoc b/modules/rosa-logs-install.adoc deleted file mode 100644 index 9ba4edd0ad..0000000000 --- a/modules/rosa-logs-install.adoc +++ /dev/null @@ -1,60 +0,0 @@ -// Module included in the following assemblies: -// -// * * rosa_cli/rosa-checking-logs-cli.adoc - -:_mod-docs-content-type: REFERENCE -[id="rosa-logs-install_{context}"] -= logs install - -Show the cluster install logs by using the following command syntax: - -.Syntax -[source,terminal] ----- -$ rosa logs install --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster to get logs for. - -|--tail -|The number (integer) of lines to get from the end of the log. Default: `2000` - -|--watch -|Watches for changes after getting the logs. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Examples -Show the last 100 install log lines for a cluster named `mycluster`: - -[source,terminal] ----- -$ rosa logs install mycluster --tail=100 ----- - -Show the install logs for a cluster named `mycluster`: - -[source,terminal] ----- -$ rosa logs install --cluster=mycluster ----- \ No newline at end of file diff --git a/modules/rosa-logs-uninstall.adoc b/modules/rosa-logs-uninstall.adoc deleted file mode 100644 index 796ca95db7..0000000000 --- a/modules/rosa-logs-uninstall.adoc +++ /dev/null @@ -1,52 +0,0 @@ -// Module included in the following assemblies: -// -// * * rosa_cli/rosa-checking-logs-cli.adoc - -:_mod-docs-content-type: REFERENCE -[id="rosa-logs-uninstall_{context}"] -= logs uninstall - -Show the cluster uninstall logs by using the following command syntax: - -.Syntax -[source,terminal] ----- -$ rosa logs uninstall --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|The name or ID (string) of the cluster to get logs for. - -|--tail -|The number (integer) of lines to get from the end of the log. Default: `2000` - -|--watch -|Watches for changes after getting the logs. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -Show the last 100 uninstall logs for a cluster named `mycluster`: -[source,terminal] ----- -$ rosa logs uninstall --cluster=mycluster --tail=100 ----- \ No newline at end of file diff --git a/modules/rosa-parent-commands.adoc b/modules/rosa-parent-commands.adoc deleted file mode 100644 index c6e39666a3..0000000000 --- a/modules/rosa-parent-commands.adoc +++ /dev/null @@ -1,66 +0,0 @@ - -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc - -:_mod-docs-content-type: REFERENCE -[id="rosa-parent-commands_{context}"] -= Parent commands - - -The {rosa-cli-first} 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. - -[id="rosa-create_{context}"] -== create - -Creates an object or resource when paired with a child command. - -.Example -[source,terminal] ----- -$ rosa create cluster --cluster-name=mycluster ----- - -[id="rosa-edit_{context}"] -== edit - -Edits options for an object, such as making a cluster private. - -.Example -[source,terminal] ----- -$ rosa edit cluster --cluster=mycluster --private ----- - -[id="rosa-delete_{context}"] -== delete - -Deletes an object or resource when paired with a child command. - -.Example -[source,terminal] ----- -$ rosa delete ingress --cluster=mycluster ----- - -[id="rosa-list_{context}"] -== list - -Lists clusters or resources for a specific cluster. - -.Example -[source,terminal] ----- -$ rosa list users --cluster=mycluster ----- - -[id="rosa-describe_{context}"] -== describe - -Shows the details for a cluster. - -.Example -[source,terminal] ----- -$ rosa describe cluster --cluster=mycluster ----- diff --git a/modules/rosa-revoke-objects.adoc b/modules/rosa-revoke-objects.adoc deleted file mode 100644 index 043f582b4c..0000000000 --- a/modules/rosa-revoke-objects.adoc +++ /dev/null @@ -1,55 +0,0 @@ -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc - -:_mod-docs-content-type: PROCEDURE -[id="rosa-revoke-objects_{context}"] -= Revoke objects - -This section describes the `revoke` commands for clusters and resources. - -[id="rosa-revoke-break-glass-credential_{context}"] -== revoke-break-glass-credential - -Revokes all break glass credentials from a specified {product-title} cluster with external authentication enabled. - -.Syntax -[source,terminal] ----- -$ rosa revoke break-glass-credential --cluster= | ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster from which the break glass credentials will be deleted. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== - -.Example -Revoke the break glass credentials from a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa revoke break-glass-credential --cluster=mycluster ----- diff --git a/modules/rosa-upgrade-cluster-cli.adoc b/modules/rosa-upgrade-cluster-cli.adoc deleted file mode 100644 index 93f9d729d8..0000000000 --- a/modules/rosa-upgrade-cluster-cli.adoc +++ /dev/null @@ -1,238 +0,0 @@ - -// Module included in the following assemblies: -// -// * rosa_cli/rosa-manage-objects-cli.adoc -:_mod-docs-content-type: REFERENCE -[id="rosa-upgrading-cluster_{context}"] -= Upgrade and delete upgrade for objects - -This section describes the `upgrade` command usage for objects. - -[id="rosa-upgrade-cluster_{context}"] -== upgrade cluster - -Schedule a cluster upgrade. - -.Syntax -[source,terminal] ----- -$ rosa upgrade cluster --cluster= | [arguments] ----- - -.Arguments -[cols="30,70"] -|=== -|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 in Coordinated Universal Time (UTC). Format: `yyyy-mm-dd` - -|--schedule-time -|The next time the upgrade will run on the specified date in Coordinated Universal Time (UTC). Format: `HH:mm` -ifdef::openshift-rosa[] -|--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: `1 hour` -endif::openshift-rosa[] -ifdef::openshift-rosa-hcp[] -|--control-plane -|Upgrades the cluster's hosted control plane. -endif::openshift-rosa-hcp[] -|=== - - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. -|=== - -.Examples -Interactively schedule an upgrade on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa upgrade cluster --cluster=mycluster --interactive ----- - -Schedule a cluster upgrade within the hour on a cluster named `mycluster`. - -[source,terminal] ----- -$ rosa upgrade cluster --cluster=mycluster --version 4.5.20 ----- - -[id="rosa-delete-upgrade-cluster_{context}"] -== delete cluster upgrade - -Cancel a scheduled cluster upgrade. - -.Syntax -[source,terminal] ----- -$ rosa delete upgrade --cluster= | ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster that the upgrade will be cancelled for. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--yes -|Automatically answers `yes` to confirm the operation. -|=== -ifdef::openshift-rosa-hcp[] -[id="rosa-upgrade-machinepool_{context}"] -== upgrade machinepool - -Upgrades a specific machine pool configured on a {product-title} cluster. - -.Syntax -[source,terminal] ----- -$ rosa upgrade machinepool --cluster= ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. - -|--schedule-date -|The next date (string) when the upgrade will run at the specified time in Coordinated Universal Time (UTC). Format: `yyyy-mm-dd` - -|--schedule-time -|The next time the upgrade will run on the specified date in Coordinated Universal Time (UTC). Format: `HH:mm` - -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -Upgrade a machine pool on a cluster named `mycluster`. -[source,terminal] ----- -$ rosa upgrade machinepool --cluster=mycluster ----- - -[id="rosa-delete-upgrade-machinepool_{context}"] -== delete machinepool upgrade - -Cancel a scheduled machinepool upgrade. - -.Syntax -[source,terminal] ----- -$ rosa delete upgrade --cluster= ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== -endif::openshift-rosa-hcp[] -//Per wgordon, rosa upgrade roles is not needed for HCP clusters -ifndef::openshift-rosa-hcp[] -[id="rosa-upgrade-roles_{context}"] -== upgrade roles -Upgrades roles configured on a cluster. - - -.Syntax -[source,terminal] ----- -$ rosa upgrade roles --cluster= ----- - -.Arguments -[cols="30,70"] -|=== -|Option |Definition - -|--cluster -|Required: The name or ID (string) of the cluster. -|=== - -.Optional arguments inherited from parent commands -[cols="30,70"] -|=== -|Option |Definition - -|--help -|Shows help for this command. - -|--debug -|Enables debug mode. - -|--profile -|Specifies an AWS profile (string) from your credentials file. -|=== - -.Example -Upgrade roles on a cluster named `mycluster`. -[source,terminal] ----- -$ rosa upgrade roles --cluster=mycluster ----- -endif::openshift-rosa-hcp[] diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc index c9d172afc6..704c95768a 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc @@ -33,5 +33,5 @@ include::modules/life-cycle-mandatory-upgrades.adoc[leveloffset=+1] include::modules/life-cycle-dates.adoc[leveloffset=+1] .Additional resources -* xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-edit-cluster_rosa-managing-objects-cli[edit cluster] +* xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-cli-commands[ROSA CLI command reference] * xref:../../upgrading/rosa-hcp-upgrading.adoc#rosa-upgrade-options_rosa-hcp-upgrading[Upgrade options for {product-title} clusters] \ No newline at end of file diff --git a/rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc b/rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc index 1e31d97696..c38b1d4878 100644 --- a/rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc +++ b/rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc @@ -31,4 +31,4 @@ include::modules/life-cycle-mandatory-upgrades.adoc[leveloffset=+1] include::modules/life-cycle-dates.adoc[leveloffset=+1] .Additional resources -* xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-edit-cluster_rosa-managing-objects-cli[edit cluster] \ No newline at end of file +* xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-cli-commands[ROSA CLI command reference] \ No newline at end of file diff --git a/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc b/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc index 626e555ca5..84acaace02 100644 --- a/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc +++ b/rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc @@ -58,7 +58,7 @@ include::modules/configuring-machine-pool-disk-volume-cli.adoc[leveloffset=+2] ifndef::openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources -* For a detailed list of the arguments that are available for the `rosa create machinepool` subcommand, see xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[Managing objects with the {rosa-cli}]. +* The xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-create-machinepool[`rosa create machinepool` command] in the _ROSA CLI command reference_. endif::openshift-rosa-hcp[] include::modules/deleting-machine-pools.adoc[leveloffset=+1] diff --git a/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc b/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc index 526e115da7..10e0627311 100644 --- a/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc +++ b/rosa_cluster_admin/rosa_nodes/rosa-nodes-about-autoscaling-nodes.adoc @@ -91,8 +91,5 @@ endif::[] * xref:../../rosa_cluster_admin/rosa_nodes/rosa-nodes-machinepools-about.adoc#rosa-nodes-machinepools-about[About machinepools] ifdef::openshift-rosa,openshift-rosa-hcp[] * xref:../../rosa_cluster_admin/rosa_nodes/rosa-managing-worker-nodes.adoc#rosa-managing-worker-nodes[Managing compute nodes] -// This xref can be included in ROSA HCP when all of the files are added. -ifndef::openshift-rosa-hcp[] -* xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[Managing objects with the ROSA CLI] -endif::openshift-rosa-hcp[] +* xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-cli-commands[ROSA CLI command reference] endif::[] diff --git a/rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc b/rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc index f2d08f3d52..5b08505315 100644 --- a/rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc +++ b/rosa_hcp/rosa-hcp-sts-creating-a-cluster-ext-auth.adoc @@ -47,8 +47,8 @@ include::modules/rosa-hcp-sts-example-external-auth-provider.adoc[leveloffset=+2 * link:https://learn.microsoft.com/en-us/entra/fundamentals/whatis[What is Microsoft Entra ID?] (Microsoft documentation) * xref:../cloud_experts_tutorials/cloud-experts-entra-id-idp.adoc#cloud-experts-entra-id-idp[Configuring Microsoft Entra ID (formerly Azure Active Directory) as an identity provider] * link:https://www.keycloak.org/guides[Keycloak documentaton] -* For information about the similar `idps` tool in the ROSA CLI, see xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-idp_rosa-managing-objects-cli[`create idp`]. -* For more information about options in the ROSA CLI, see xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-external-auth-provider_rosa-managing-objects-cli[`create external-auth-provider`], xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-list-external-auth-provider_rosa-managing-objects-cli[`list external-auth-provider`], and xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-delete-external-auth-provider_rosa-managing-objects-cli[`delete external-auth-provider`]. +* For information about the similar `idps` tool in the ROSA CLI, see xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-create-idp[`rosa create idp`]. +* For more information about managing external authentication providers using the {rosa-cli}, see xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-create-external-auth-provider[`rosa create external-auth-provider`], xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-list-external-auth-providers[`rosa list external-auth-providers`], and xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-delete-external-auth-provider[`rosa delete external-auth-provider`] in the _ROSA CLI command reference_. // Step 3: Create, list, and revoke a break glass credential include::modules/rosa-hcp-sts-creating-a-break-glass-cred-cli.adoc[leveloffset=+1] diff --git a/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc b/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc index 5af56d65e0..440a79867c 100644 --- a/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc +++ b/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-with-customizations.adoc @@ -54,7 +54,7 @@ include::modules/rosa-sts-creating-a-cluster-using-customizations.adoc[leveloffs include::modules/rosa-sts-creating-a-cluster-with-customizations-ocm.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-create-cluster-command_rosa-managing-objects-cli[create cluster] in _Managing objects with the ROSA CLI_ +* xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-create-cluster[`rosa create cluster`] in the _ROSA CLI command reference_ * xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-account-wide-roles-and-policies-creation-methods_rosa-sts-about-iam-resources[Methods of account-wide role creation] include::modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc[leveloffset=+2] diff --git a/rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc b/rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc index 54ca0e5ab0..5a2534f773 100644 --- a/rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc +++ b/rosa_install_access_delete_clusters/rosa-sts-deleting-cluster.adoc @@ -40,6 +40,6 @@ include::modules/rosa-unlinking-and-deleting-ocm-and-user-iam-roles.adoc[levelof [id="additional-resources_rosa-sts-deleting-cluster"] == Additional resources -* For information about the cluster delete protection feature, see xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-edit-objects_rosa-managing-objects-cli[Edit objects]. +* For information about the cluster delete protection feature, see the xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-cli-commands[ROSA CLI command reference]. * For information about the AWS IAM resources for ROSA clusters that use STS, see xref:../rosa_architecture/rosa-sts-about-iam-resources.adoc#rosa-sts-about-iam-resources[About IAM resources]. * For information on cluster errors that are due to missing IAM roles, see xref:../support/troubleshooting/rosa-troubleshooting-deployments.adoc#rosa-troubleshooting-cluster-deletion_rosa-troubleshooting-cluster-deployments[Repairing a cluster that cannot be deleted]. diff --git a/support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc b/support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc index aaab787721..d46635969f 100644 --- a/support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc +++ b/support/troubleshooting/rosa-troubleshooting-installations-hcp.adoc @@ -36,7 +36,7 @@ include::modules/rosa-hcp-ready-no-console-access.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* For more information about the `rosa describe machinepool` command, see xref:../../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-list-objects[List and describe objects]. +* For more information about the `rosa describe machinepool` command, see xref:../../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-describe-machinepool[`rosa describe machinepool`] in the _ROSA CLI command reference_. include::modules/rosa-hcp-private-ready-no-console-access.adoc[leveloffset=+1] diff --git a/upgrading/rosa-hcp-upgrading.adoc b/upgrading/rosa-hcp-upgrading.adoc index 7f5eeb97f0..91fb00f222 100644 --- a/upgrading/rosa-hcp-upgrading.adoc +++ b/upgrading/rosa-hcp-upgrading.adoc @@ -9,7 +9,7 @@ toc::[] include::modules/rosa-hcp-upgrade-options.adoc[leveloffset=+1] .Additional resources -* xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-edit-machinepool_rosa-managing-objects-cli[ROSA CLI reference: `rosa edit machinepool`] +* xref:../cli_reference/rosa_cli/rosa-cli-commands.adoc#rosa-edit-machinepool[ROSA CLI reference: `rosa edit machinepool`] * xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-service-definition.adoc#rosa-sdpolicy-node-lifecycle_rosa-service-definition[Node lifecycle] //This cannot be a module if we want to use the xrefs