Skip to content

Commit dc08965

Browse files
authored
Merge pull request #96549 from openshift-cherrypick-robot/cherry-pick-96122-to-enterprise-4.19
[enterprise-4.19] OSDOCS-14482: Update CLI tools with HCP review feedback
2 parents c21a2b9 + 10c693e commit dc08965

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

cli_reference/rosa_cli/rosa-get-started-cli.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ include::modules/rosa-configure.adoc[leveloffset=+1]
1616
1717
* xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[Getting started with the OpenShift CLI]
1818
19+
ifdef::openshift-rosa[]
1920
include::modules/rosa-initialize.adoc[leveloffset=+1]
21+
endif::openshift-rosa[]
2022
include::modules/rosa-using-bash-script.adoc[leveloffset=+1]
2123
include::modules/rosa-updating-rosa-cli.adoc[leveloffset=+1]

modules/rosa-create-objects.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
[id="rosa-create-objects_{context}"]
77
= Create objects
88

9+
[NOTE]
10+
====
11+
To create a Hosted Control Plane cluster, include the '--hosted-cp' flag where necessary.
12+
====
13+
914
This section describes the `create` commands for clusters and resources.
1015

1116
[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
255260
|--min-replicas <number_of_nodes>
256261
|Specifies the minimum number of compute nodes when enabling autoscaling. Default: `2`
257262

263+
ifdef::openshift-rosa[]
264+
//this is being deprecated and will eventually be removed entirely.
258265
|--multi-az
259266
|Deploys to multiple data centers.
267+
endif::openshift-rosa[]
260268

261269
|--no-cni
262270
|Creates a cluster without a Container Network Interface (CNI) plugin. Customers can then bring their own CNI plugin and install it after cluster creation.
@@ -274,9 +282,15 @@ OVN-Kubernetes, the default network provider in ROSA 4.11 and later, uses the `1
274282

275283
|--private
276284
|Restricts primary API endpoint and application routes to direct, private connectivity.
285+
//To be added when available for HCP only.
286+
//ifdef::openshift-rosa-hcp[]
287+
//To allow public subnets on a private API cluster, you can use both the `--private` and `--private-ingress=false` arguments.
288+
//endif::openshift-rosa-hcp[]
277289

290+
ifdef::openshift-rosa[]
278291
|--private-link
279292
|Specifies to use AWS PrivateLink to provide private connectivity between VPCs and services. The `--subnet-ids` argument is required when using `--private-link`.
293+
endif::openshift-rosa[]
280294

281295
|--region <region_name>
282296
|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 +309,32 @@ a|Block of IP addresses (ipNet) for services, for example, `172.30.0.0/16`.
295309
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.
296310
====
297311

312+
ifdef::openshift-rosa[]
298313
a|--sts \| --non-sts
299314
|Specifies whether to use AWS Security Token Service (STS) or IAM credentials (non-STS) to deploy your cluster.
315+
endif::openshift-rosa[]
300316

317+
ifdef::openshift-rosa-hcp[]
318+
|--sts
319+
|Specifies the use of AWS Security Token Service (STS) credentials to deploy your cluster.
320+
endif::openshift-rosa-hcp[]
321+
322+
ifdef::openshift-rosa[]
301323
|--subnet-ids <aws_subnet_id>
302324
|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.
303325

304326
When using `--private-link`, the `--subnet-ids` argument is required and only one private subnet is allowed per zone.
327+
endif::openshift-rosa[]
328+
329+
ifdef::openshift-rosa-hcp[]
330+
|--subnet-ids <aws_subnet_id>
331+
|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.
332+
333+
When using `--private` for "private API", the `--subnet-ids` argument is required and only one private subnet is allowed per zone.
334+
335+
//To be added when available
336+
//To allow public subnets on a private API cluster, you can use both the `--private` and `--private-ingress=false` arguments.
337+
endif::openshift-rosa-hcp[]
305338

306339
|--support-role-arn string
307340
|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 +757,13 @@ For more information about setting the PID limit for the cluster, see _Configuri
724757

725758
Add a machine pool to an existing cluster.
726759

760+
ifdef::openshift-rosa-hcp[]
761+
[TIP]
762+
====
763+
Machine pool is also referred to as node pool on hosted control plane clusters.
764+
====
765+
endif::openshift-rosa-hcp[]
766+
727767
.Syntax
728768
[source,terminal]
729769
----

modules/rosa-list-objects.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -389,8 +389,10 @@ $ rosa list regions [arguments]
389389
|===
390390
|Option |Definition
391391

392+
ifdef::openshift-rosa[]
392393
|--multi-az
393394
|Lists regions that provide support for multiple availability zones.
395+
endif::openshift-rosa[]
394396
|===
395397

396398
.Optional arguments inherited from parent commands

0 commit comments

Comments
 (0)