Visitar URL original
OSDOCS-19750, OSDOCS-22014, OSDOCS-22240, OSDOCS-23055: ROSA Q4 updates by michaelryanmcneill · Pull Request #123524 · openshift/openshift-docs · GitHub
Skip to content

OSDOCS-19750, OSDOCS-22014, OSDOCS-22240, OSDOCS-23055: ROSA Q4 updates - #123524

Open
michaelryanmcneill wants to merge 1 commit into
openshift:mainfrom
michaelryanmcneill:OSDOCS-19750+OSDOCS-22014+OSDOCS-22240+OSDOCS-23055
Open

michaelryanmcneill wants to merge 1 commit into
openshift:mainfrom
michaelryanmcneill:OSDOCS-19750+OSDOCS-22014+OSDOCS-22240+OSDOCS-23055

Conversation

@michaelryanmcneill

@michaelryanmcneill michaelryanmcneill commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Version(s): enterprise-5.0+

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

This PR combines and supersedes #122925 (OSDOCS-22240) and #122333 (OSDOCS-23055). Both edit the Q4 2026 release notes module and the interactive cluster creation options table, so they are combined here to avoid conflicts. It also adds documentation for cluster notification contacts and clarifies the new IMDSv2 defaults.

AWS resource tagging (from #122925, HCP only)

  • modules/rosa-adding-tags-cli.adoc: Lists the characters allowed in tag keys and values separately for each product. Classic does not allow spaces and allows empty values. HCP allows spaces and does not allow empty values. For HCP, also states that a machine pool tag takes precedence over a cluster tag with the same key.
  • modules/rosa-adding-tags.adoc, modules/rosa-hcp-cluster-terraform-file-creation.adoc, modules/rosa-sts-interactive-cluster-creation-mode-options.adoc: Add the tag precedence statement.

ROSA CLI 1.2.66 interactive changes (from #122333)

  • modules/rosa-sts-interactive-cluster-creation-mode-options.adoc: The Deploy cluster with Hosted Control Plane row now says the default is Yes, that specifying options compatible only with Classic skips the prompt, and that non-interactive mode still defaults to --hosted-cp=false. Removes the Deploy cluster using AWS STS and Configure the use of IMDSv2 rows.
  • modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc: Adds a note that Classic users must now answer No at the HCP prompt. Removes the IMDSv2 prompt from the example output.
  • rosa_release_notes/rosa-release-notes.adoc: Removes the openshift-rosa-hcp conditional around the Q4 2026 include, because Q4 now has Classic content.

Cluster notification contacts (new)

Documents openshift/rosa#3500, first released in ROSA CLI 1.2.66, and terraform-redhat/terraform-provider-rhcs#1328, first released in RHCS provider 1.7.10.

  • modules/rosa-sts-interactive-cluster-creation-mode-options.adoc: Adds a row for the Notification contact usernames or emails prompt, including how to change or clear contacts later with rosa edit cluster --notification-contacts.
  • Release note covers the --notification-contacts option for rosa create cluster and rosa edit cluster, and the rhcs_cluster_notification_contacts Terraform resource. The Terraform resource accepts only usernames and manages the complete set of contacts, so contacts added outside Terraform are removed on the next apply.

Q4 2026 release notes (modules/rosa-release-notes-q4-2026.adoc)

Entry Applies to
AWS resource tagging improvements HCP
{hcp-capital} is the default in interactive cluster creation Both
AWS STS is used by default without prompting Classic
AWS EC2 Instance Metadata Service Version 2 (IMDSv2) is now required by default Separate Classic and HCP versions
Configure cluster notification contacts by using the {rosa-cli} or Terraform Both
  • The IMDSv2 entries say the default applies to new clusters (and, on HCP, new machine pools) however they are created, not only through the CLI. The HCP entry explains that to change the setting on an existing machine pool, you replace the machine pool.
  • The HCP default compute machine type entry from OSDOCS-23055: Update ROSA interactive cluster creation for CLI 1.2.66 #122333 is not included because the Q3 2026 release notes already cover it.

Notes for reviewers

As discussed and agreed to internally, this is closing out all but one of the remaining features that were already in flight to ensure we don't have a gap in our documentation.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Oct 29, 2026
@openshift-ci-robot

openshift-ci-robot commented Oct 29, 2026 •

Copy link
Copy Markdown

@michaelryanmcneill: This pull request references OSDOCS-19750 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 epic to target the "5.1.0" version, but no target version was set.

This pull request references OSDOCS-22014 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 epic to target the "5.1.0" version, but no target version was set.

This pull request references OSDOCS-22240 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 epic to target the "5.1.0" version, but no target version was set.

This pull request references OSDOCS-23055 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 epic to target the "5.1.0" version, but no target version was set.

Details

In response to this:

Version(s): enterprise-5.0+

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

This PR combines and supersedes #122925 (OSDOCS-22240) and #122333 (OSDOCS-23055). Both edit the Q4 2026 release notes module and the interactive cluster creation options table, so they are combined here to avoid conflicts. It also adds documentation for cluster notification contacts and clarifies the new IMDSv2 defaults.

AWS resource tagging (from #122925, HCP only)

  • modules/rosa-adding-tags-cli.adoc: Lists the characters allowed in tag keys and values separately for each product. Classic does not allow spaces and allows empty values. HCP allows spaces and does not allow empty values. For HCP, also states that a machine pool tag takes precedence over a cluster tag with the same key.
  • modules/rosa-adding-tags.adoc, modules/rosa-hcp-cluster-terraform-file-creation.adoc, modules/rosa-sts-interactive-cluster-creation-mode-options.adoc: Add the tag precedence statement.

ROSA CLI 1.2.66 interactive changes (from #122333)

  • modules/rosa-sts-interactive-cluster-creation-mode-options.adoc: The Deploy cluster with Hosted Control Plane row now says the default is Yes, that specifying options compatible only with Classic skips the prompt, and that non-interactive mode still defaults to --hosted-cp=false. Removes the Deploy cluster using AWS STS and Configure the use of IMDSv2 rows.
  • modules/rosa-sts-creating-a-cluster-with-customizations-cli.adoc: Adds a note that Classic users must now answer No at the HCP prompt. Removes the IMDSv2 prompt from the example output.
  • rosa_release_notes/rosa-release-notes.adoc: Removes the openshift-rosa-hcp conditional around the Q4 2026 include, because Q4 now has Classic content.

Cluster notification contacts (new)

Documents openshift/rosa#3500, first released in ROSA CLI 1.2.66, and terraform-redhat/terraform-provider-rhcs#1328, first released in RHCS provider 1.7.10.

  • modules/rosa-sts-interactive-cluster-creation-mode-options.adoc: Adds a row for the Notification contact usernames or emails prompt, including how to change or clear contacts later with rosa edit cluster --notification-contacts.
  • Release note covers the --notification-contacts option for rosa create cluster and rosa edit cluster, and the rhcs_cluster_notification_contacts Terraform resource. The Terraform resource accepts only usernames and manages the complete set of contacts, so contacts added outside Terraform are removed on the next apply.

Q4 2026 release notes (modules/rosa-release-notes-q4-2026.adoc)

Entry Applies to
AWS resource tagging improvements HCP
{hcp-capital} is the default in interactive cluster creation Both
AWS STS is used by default without prompting Classic
AWS EC2 Instance Metadata Service Version 2 (IMDSv2) is now required by default Separate Classic and HCP versions
Configure cluster notification contacts by using the {rosa-cli} or Terraform Both
  • The IMDSv2 entries say the default applies to new clusters (and, on HCP, new machine pools) however they are created, not only through the CLI. The HCP entry explains that to change the setting on an existing machine pool, you replace the machine pool.
  • The HCP default compute machine type entry from OSDOCS-23055: Update ROSA interactive cluster creation for CLI 1.2.66 #122333 is not included because the Q3 2026 release notes already cover it.

Notes for reviewers

As discussed and agreed to internally, this is closing out all but one of the remaining features that were already in flight to ensure we don't have a gap in our documentation.

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/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 29, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Oct 29, 2026 •

Copy link
Copy Markdown

🤖 Thu Oct 29 01:58:23 - Prow CI generated the docs preview:
https://123524--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

Document AWS tag changes, ROSA CLI 1.2.66 interactive behavior, IMDSv2
defaults, and notification contacts so the Q4 2026 release notes and
reference content reflect the current service and CLI behavior.

- Document spaces in AWS tags and machine pool tag precedence over
  cluster tags for ROSA with HCP
- Document Hosted Control Plane as the default interactive answer and
  remove the AWS STS and IMDSv2 prompts from the interactive reference
- Clarify that IMDSv2 is required by default for new clusters and, on
  HCP, new machine pools regardless of how they are created, and
  describe how to replace a machine pool to change the setting
- Add the notification contacts interactive prompt and a release note
  covering the --notification-contacts option and the
  rhcs_cluster_notification_contacts Terraform resource
- Include the Q4 2026 release notes in both ROSA Classic and HCP docs

Signed-off-by: michaelryanmcneill <michael@michaelryanmcneill.com>
@michaelryanmcneill
michaelryanmcneill force-pushed the OSDOCS-19750+OSDOCS-22014+OSDOCS-22240+OSDOCS-23055 branch from 884317a to a291a47 Compare October 29, 2026 01:45
@openshift-ci

openshift-ci Bot commented Oct 29, 2026

Copy link
Copy Markdown

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

= Add tags to a machine pool by using the {rosa-cli}

[role="_abstract"]
You cannot not edit the tags after after you create the machine pool.

@jheraght jheraght Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
You cannot edit the tags after you create the machine pool.

(I know this one is just before the actual updates, but we should fix this typo.)

[IMPORTANT]
====
You must ensure that your tag keys are not `aws`, `red-hat-managed`, `red-hat-clustertype`, or `Name`. In addition, you must not set a tag key that begins with `kubernetes.io/cluster/`. Your tag's key cannot be longer than 128 characters, while your tag's value cannot be longer than 256 characters. Red{nbsp}Hat reserves the right to add additional reserved tags in the future.
You must ensure that your tag keys are not `aws`, `red-hat-managed`, `red-hat-clustertype`, or `Name`. In addition, you must not set a tag key that begins with `kubernetes.io/cluster/`. Red{nbsp}Hat reserves the right to add additional reserved tags in the future. Your tag's key cannot be longer than 128 characters, while your tag's value cannot be longer than 256 characters.

@jheraght jheraght Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
You must ensure that your tag keys are not `aws`, `red-hat-managed`, `red-hat-clustertype`, or `Name`. In addition, you must not set a tag key that begins with `kubernetes.io/cluster/`. Red{nbsp}Hat reserves the right to add additional reserved tags in the future. Your tag's key cannot be longer than 128 characters, while your tag's value cannot be longer than 256 characters.
You must ensure that your tag keys are not `aws`, `red-hat-managed`, `red-hat-clustertype`, or `Name`, which are existing reserved tags. Red{nbsp}Hat reserves the right to add additional reserved tags in the future. In addition, you must not set a tag key that begins with `kubernetes.io/cluster/`.
Your tag's key cannot be longer than 128 characters, while your tag's value cannot be longer than 256 characters.

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

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants