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.

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

Conversation

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 15, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 15, 2025

@bmcelvee: This pull request references OSDOCS-14482 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set.

In response to this:

Version(s):
4.19+

Issue:
https://issues.redhat.com/browse/OSDOCS-14482

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 15, 2025
Copy link

openshift-ci bot commented Jul 15, 2025

@bmcelvee: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 15, 2025

@bmcelvee: This pull request references OSDOCS-14482 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set.

In response to this:

Version(s):
4.19+

Issue:
https://issues.redhat.com/browse/OSDOCS-14482

Link to docs preview:
https://96122--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/cli_reference/rosa_cli/rosa-get-started-cli.html
https://96122--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/cli_reference/rosa_cli/rosa-manage-objects-cli.html
https://96122--ocpdocs-pr.netlify.app/openshift-rosa/latest/cli_reference/rosa_cli/rosa-get-started-cli.html
https://96122--ocpdocs-pr.netlify.app/openshift-rosa/latest/cli_reference/rosa_cli/rosa-manage-objects-cli.html

QE review:

  • QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

Copy link

@hunterkepley hunterkepley left a comment

Choose a reason for hiding this comment

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

LGTM overall, 2 comments, one being a larger ask related to the upcoming private API + private ingress feature. Let me know if there's any questions, @willkutler would be the best person to ask specific questions about how --private + --private-ingress should function on a service level. But, I can help with any implementation/CLI questions!


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.

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

@@ -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.

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

Comment on lines +264 to +267
//this is being deprecated and will eventually be removed entirely.
|--multi-az
|Deploys to multiple data centers.
endif::openshift-rosa[]

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.19 branch/enterprise-4.20 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. SD-docs Label for all Service Delivery PRs size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants