Skip to content

OSDOCS-14482: Update CLI tools with HCP review feedback #96122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OSDOCS-14482: Update CLI tools with HCP review feedback #96122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions cli_reference/rosa_cli/rosa-get-started-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
31 changes: 31 additions & 0 deletions modules/rosa-create-objects.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}"]
Expand Down Expand Up @@ -255,8 +260,11 @@ OVN-Kubernetes, the default network provider in ROSA 4.11 and later, uses the `1
|--min-replicas <number_of_nodes>
|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[]
Comment on lines +264 to +267
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was told by Aaren that we should remove this flag entirely from HCP docs, since it is a no-op for HCP: https://redhat-internal.slack.com/archives/CB53T9ZHQ/p1752687583541179?thread_ts=1752674640.825629&cid=CB53T9ZHQ


|--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.
Expand All @@ -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 <region_name>
|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.
Expand All @@ -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 <aws_subnet_id>
|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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For HCP, we have new values for private clusters. --private indicates Private API (what we are using now rather than Private Link for HCP clusters). --private-ingress will set the Default Ingress Listening Method to Private

If you want public subnets on a Private API HCP cluster, you can now do --private and --private-ingress=false (or use interactive) to have both public+private subnets on an HCP cluster

This change will be in ROSA CLI 1.2.55, so while it's not in yet, these changes will be in by the end of July

endif::openshift-rosa[]

ifdef::openshift-rosa-hcp[]
|--subnet-ids <aws_subnet_id>
|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.
Expand Down Expand Up @@ -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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should specify, that machine pool is known as node pool when referring to Hosted Control Plane clusters - im not too picky on which we do here though :) This is fine if you want to keep it

====

.Syntax
[source,terminal]
----
Expand Down