Skip to content

📖 Documentation Update to Creating a ROSA HCP cluster directions#5920

Open
tinaafitz wants to merge 6 commits intokubernetes-sigs:mainfrom
tinaafitz:create_cluster_doc_fix
Open

📖 Documentation Update to Creating a ROSA HCP cluster directions#5920
tinaafitz wants to merge 6 commits intokubernetes-sigs:mainfrom
tinaafitz:create_cluster_doc_fix

Conversation

@tinaafitz
Copy link
Copy Markdown
Contributor

@tinaafitz tinaafitz commented Mar 31, 2026

/kind documentation

  • Simplify and reorganize the ROSA HCP "Creating a cluster" documentation
  • Add Prerequisites section with links to the Quick Start Guide and ROSA Setup guide
  • Separate Authentication and Permissions into distinct sections for clarity
  • Remove deprecated SSO offline token authentication and migration instructions
  • Minor wording fixes

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Mar 31, 2026

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

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.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Mar 31, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Mar 31, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign serngawy for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested review from faiq and serngawy March 31, 2026 17:07
@k8s-ci-robot k8s-ci-robot added needs-priority cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 31, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Mar 31, 2026

Hi @tinaafitz. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Tip

We noticed you've done this a few times! Consider joining the org to skip this step and gain /lgtm and other bot rights. We recommend asking approvers on your previous PRs to sponsor you.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@tinaafitz tinaafitz force-pushed the create_cluster_doc_fix branch 4 times, most recently from 8f82392 to 818e792 Compare March 31, 2026 18:13
@tinaafitz tinaafitz changed the title Draft Documentation - Update Creating a ROSA HCP cluster directions 📖 Draft - Documentation Update to Creating a ROSA HCP cluster directions Mar 31, 2026
serngawy
serngawy suggested changes Mar 31, 2026
View reviewed changes
@tinaafitz tinaafitz changed the title 📖 Draft - Documentation Update to Creating a ROSA HCP cluster directions 📖 Documentation Update to Creating a ROSA HCP cluster directions Mar 31, 2026
@tinaafitz tinaafitz force-pushed the create_cluster_doc_fix branch from c6eaab7 to 9afb9f1 Compare April 1, 2026 18:58
serngawy
serngawy reviewed Apr 1, 2026
View reviewed changes
docs/book/src/topics/rosa/creating-a-cluster.md Outdated

## Authentication
The CAPA controller requires service account credentials to provision ROSA HCP clusters.
If you already have a service account, you can skip these steps.
Copy link
Copy Markdown
Contributor

@serngawy serngawy Apr 1, 2026

Choose a reason for hiding this comment

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

Suggested change
If you already have a service account, you can skip these steps.
**Note:** If you already have a service account, you can skip these steps.

Copy link
Copy Markdown
Contributor Author

@tinaafitz tinaafitz Apr 2, 2026

Choose a reason for hiding this comment

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

Done.

docs/book/src/topics/rosa/creating-a-cluster.md Outdated
rosaClusterName: rosa-hcp-1
domainPrefix: rosa-hcp
rosaRoleConfigRef:
name: role-config
Copy link
Copy Markdown
Contributor

@serngawy serngawy Apr 1, 2026

Choose a reason for hiding this comment

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

Suggested change
name: role-config
name: role-config # reference to the ROSARoleConfig created above

Copy link
Copy Markdown
Contributor Author

@tinaafitz tinaafitz Apr 2, 2026

Choose a reason for hiding this comment

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

Done.

docs/book/src/topics/rosa/creating-a-cluster.md Outdated
version: "4.19.0"
region: "us-west-2"
rosaNetworkRef:
name: "rosa-vpc"
Copy link
Copy Markdown
Contributor

@serngawy serngawy Apr 1, 2026

Choose a reason for hiding this comment

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

Suggested change
name: "rosa-vpc"
name: "rosa-vpc" # reference to the ROSANetwork created above

Copy link
Copy Markdown
Contributor Author

@tinaafitz tinaafitz Apr 2, 2026

Choose a reason for hiding this comment

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

Done.

@tinaafitz
Address reviewer feedback: add resource context, machinepool example,…
4dd3520 
… and deletion steps

- Bold the service account skip note
- Add full resource headers (apiVersion, kind, metadata, spec) to ROSARoleConfig and ROSANetwork status examples
- Add inline comments to rosaRoleConfigRef and rosaNetworkRef for clarity
- Add example for creating an additional ROSAMachinePool (workers-extra)
- Add section for deleting a ROSA HCP cluster and cleaning up resources
serngawy
serngawy suggested changes Apr 2, 2026
View reviewed changes
serngawy
serngawy suggested changes Apr 7, 2026
View reviewed changes
docs/book/src/topics/rosa/specify-management-iam-role.md
1. Extract the OIDC provider from the management cluster and set your AWS account ID:

```shell
export OIDC_PROVIDER=$(kubectl get authentication.config.openshift.io cluster -ojson | jq -r .spec.serviceAccountIssuer | sed 's/https:\/\///')
Copy link
Copy Markdown
Contributor

@serngawy serngawy Apr 7, 2026

Choose a reason for hiding this comment

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

This is only for Openshift not kubernetes in general

serngawy
serngawy reviewed Apr 7, 2026
View reviewed changes
docs/book/src/topics/rosa/specify-management-iam-role.md Outdated
@@ -0,0 +1,86 @@
# Specifying the IAM Role for ROSA HCP Management Components

When using a management cluster (kind or minikube) with CAPI and CAPA installed, you can configure the CAPA controller to use IAM roles instead of storing AWS credentials. This uses OIDC federation to allow the CAPA controller service account to assume an IAM role.
Copy link
Copy Markdown
Contributor

@serngawy serngawy Apr 7, 2026

Choose a reason for hiding this comment

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

lets mentioned that a rosa-hcp is the management cluster or any cluster created using aws credential

Copy link
Copy Markdown
Contributor Author

@tinaafitz tinaafitz Apr 7, 2026

Choose a reason for hiding this comment

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

Modified.

@tinaafitz
- Restore environment variable exports section for cluster creation
338243d 
  - Add IAM Role Configuration section linking to specify-management-iam-role doc
  - Reorder prerequisites: ROSA setup first, management cluster second
  - Fix Authentication section formatting and numbering
  - Add new specify-management-iam-role doc with step-by-step IAM role setup instructions
@tinaafitz tinaafitz force-pushed the create_cluster_doc_fix branch 2 times, most recently from d911351 to cc9fec5 Compare April 8, 2026 21:51
@tinaafitz
Update ROSA HCP cluster creation and IAM role instructions:
f21d69f 
- Add ROSA and MachinePool feature gate requirements before clusterctl init
- Add note about rosa-creds-secret namespace matching resource namespace
- Add note about ROSARoleConfig prefix max length (4 characters)
- Update OpenShift version from 4.19.0 to 4.20.11 with version check hint
- Update Cluster and MachinePool API version from v1beta1 to v1beta2
@tinaafitz tinaafitz force-pushed the create_cluster_doc_fix branch from cc9fec5 to f21d69f Compare April 9, 2026 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@faiq faiq Awaiting requested review from faiq

1 more reviewer

@serngawy serngawy serngawy requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. kind/documentation Categorizes issue or PR as related to documentation. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@tinaafitz @k8s-ci-robot @serngawy