Skip to content

Conversation

@jheraght
Copy link
Contributor

@jheraght jheraght commented Jan 28, 2026

Version(s):
4.20+

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

Link to docs preview:
Cluster-specific operator IAM role reference
Limits and scalability (OSD)

Peer review:

  • Peer reviewer has approved this change.

QE review:

  • QE approval is not required for this PR as no procedural changes involved.

Additional information:

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 28, 2026
@AedinC
Copy link
Contributor

AedinC commented Jan 29, 2026

This is outside scope for this PR but while you're here, would you mind fixing the conditionals that are leading to these two typos:
image

This would involve updating this section in the sd-planning-cluster-maximums.adoc module:

Consider the following tested object maximums when you plan a {product-title}
ifdef::openshift-rosa[]
(ROSA)
endif::[]
cluster installation. The table specifies the maximum limits for each tested type in a
ifdef::openshift-rosa[]
(ROSA)
endif::[]
ifdef::openshift-dedicated[]
{product-title}
endif::[]
cluster.

to:

Consider the following tested object maximums when you plan
ifdef::openshift-rosa[]
a {product-title}
endif::[]
ifdef::openshift-dedicated[]
an {product-title}
endif::[]
cluster installation. The table specifies the maximum limits for each tested type in
ifdef::openshift-rosa[]
a {product-title}
endif::[]
ifdef::openshift-dedicated[]
an {product-title}
endif::[]
cluster.

Copy link
Contributor

@AedinC AedinC left a comment

Choose a reason for hiding this comment

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

Looks great John. Just a couple of small suggestions.

| `kube-system-control-plane-operator`
| `ROSAControlPlaneOperatorPolicy`
| An IAM role required control plane management on HCP clusters.
| An IAM role required for control plane management on HCP clusters.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| An IAM role required for control plane management on HCP clusters.
| An IAM role required for control plane management on hosted control planes (HCP) clusters.

We should spell HCP out on first occurrence.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@AedinC there was an occurrence just a couple of lines before, so I did the spelled out one there (just above on line 74)

@jheraght
Copy link
Contributor Author

Looks great John. Just a couple of small suggestions.

Awesome, thanks Aedín, will make those changes.

@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 29, 2026
@jheraght
Copy link
Contributor Author

/retest

@openshift-ci
Copy link

openshift-ci bot commented Jan 29, 2026

@jheraght: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

Copy link
Contributor

@EricPonvelle EricPonvelle left a comment

Choose a reason for hiding this comment

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

Some QOL changes.


[role="_abstract"]
Consider the following tested object maximums when you plan a {product-title}
Consider the following tested object maximums when you plan an {product-title}
Copy link
Contributor

Choose a reason for hiding this comment

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

You may need more conditionals.

On Classic, {product-title} resolves to Red Hat OpenShift Service on AWS. This module is currently included in rosa_planning/rosa-limits-scalability.adoc, but that assembly is currently commented out. Since it could be missed, I would do the conditionals for "a/an"

cluster installation. The table specifies the maximum limits for each tested type in a
cluster installation. The table specifies the maximum limits for each tested type in an
ifdef::openshift-rosa[]
(ROSA)
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't use ROSA anymore, and this would also be an "a/an" situation on ROSA.

The maximum number of compute nodes on
ifdef::openshift-rosa[]
ROSA
{rosa-title}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{rosa-title}
{product-title}

When you install a {product-title}
When you install an {product-title}
ifdef::openshift-rosa[]
(ROSA)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
(ROSA)
{product-title}


[role="_abstract"]
When you install a {product-title}
When you install an {product-title}
Copy link
Contributor

Choose a reason for hiding this comment

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

Same conditional comment as before.

The maximum number of compute nodes on
ifdef::openshift-rosa[]
ROSA
{rosa-title}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{rosa-title}
{product-title}

The maximum number of compute nodes on
ifdef::openshift-rosa[]
ROSA
{rosa-title}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{rosa-title}
{product-title}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.20 branch/enterprise-4.21 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