From 7dc6b3bd2d0503270c834a78ae692014599c4fb0 Mon Sep 17 00:00:00 2001 From: bmcelvee Date: Tue, 15 Jul 2025 13:09:05 -0400 Subject: [PATCH] OSDOCS-14482: Update CLI tools with HCP review feedback --- .../rosa_cli/rosa-get-started-cli.adoc | 2 ++ modules/rosa-create-objects.adoc | 31 +++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/cli_reference/rosa_cli/rosa-get-started-cli.adoc b/cli_reference/rosa_cli/rosa-get-started-cli.adoc index ff1d1a365b24..1460bd653608 100644 --- a/cli_reference/rosa_cli/rosa-get-started-cli.adoc +++ b/cli_reference/rosa_cli/rosa-get-started-cli.adoc @@ -16,6 +16,8 @@ include::modules/rosa-configure.adoc[leveloffset=+1] * xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[Getting started with the OpenShift CLI] +ifdef::openshift-rosa[] include::modules/rosa-initialize.adoc[leveloffset=+1] +endif::openshift-rosa[] include::modules/rosa-using-bash-script.adoc[leveloffset=+1] include::modules/rosa-updating-rosa-cli.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/rosa-create-objects.adoc b/modules/rosa-create-objects.adoc index 5357a54c4b5d..78a9ead4b568 100644 --- a/modules/rosa-create-objects.adoc +++ b/modules/rosa-create-objects.adoc @@ -6,6 +6,11 @@ [id="rosa-create-objects_{context}"] = Create objects +[NOTE] +==== +To create a Hosted Control Plane cluster, include the '--hosted-cp' flag where necessary. +==== + This section describes the `create` commands for clusters and resources. [id="rosa-create-account-roles_{context}"] @@ -255,8 +260,11 @@ OVN-Kubernetes, the default network provider in ROSA 4.11 and later, uses the `1 |--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. @@ -275,8 +283,10 @@ OVN-Kubernetes, the default network provider in ROSA 4.11 and later, uses the `1 |--private |Restricts primary API endpoint and application routes to direct, private connectivity. +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. @@ -295,13 +305,29 @@ a|Block of IP addresses (ipNet) for services, for example, `172.30.0.0/16`. 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`, the `--subnet-ids` argument is required and only one private subnet is allowed per zone. +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. @@ -724,6 +750,11 @@ For more information about setting the PID limit for the cluster, see _Configuri Add a machine pool to an existing cluster. +[TIP] +==== +Machine pool is also referred to as node pool. +==== + .Syntax [source,terminal] ----