Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-25348

MCH: As an Installer developer, I want the MCH CR to indicate whether the MCE X.Y version exceeds the required MCE version

XMLWordPrintable

    • Installer Sprint 2025-68, Installer Sprint 2025-70
    • None

      Note: Doc team updates the current version of the documentation and the
      two previous versions (n-2), but we address *only high-priority, or
      customer-reported issues* for -2 releases in support.
      Describe the changes in the doc and link to your dev story:

      1. - [x] Mandatory: Add the required version to the Fix version/s field.

      2. - [x] Mandatory: Choose the type of documentation change or review.

      • [x] We need to update to an existing topic
      • [x] We need to add a new document to an existing section
      • [ ] We need a whole new section; this is a function not
        documented before and doesn't belong in any current section
      • [ ] We need an Operator Advisory review and approval
      • [ ] We need a z-Stream (Errata) Advisory and Release note for
        MCE and/or ACM

      3. - [x] Mandatory: Find the link to where the documentation update
      should go and add it to the recommended changes. You can either use the
      published doc or the staged repo for this step:

      I looked for a section in the docs to explain debug processes, but didn't find an immediately obvious place. It's possible that a new page / section will be required.

       

      DRAFT:

      It is technically possible to upgrade MCE while still managed by ACM. This will cause ACM to break and should not be attempted. However, should this occur, the MultiClusterHub CR yaml will indicate that MCE is currently on a mismatched version. When the version is correct, the user should see something similar to the following:


      mceVersionCompliance:
      currentVersion: 2.10.0-175
      isCompliant: true
      message: MCE version 2.10.0-175 meets channel stable-2.10 requirements
      requiredChannel: stable-2.10

       

      Note: As the feature and doc is understood, this recommendation may
      change. If this is new documentation, link to the section where you think
      it should be placed.

      Customer Portal published version

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12

      Doc staged repo within the ACM Workspace:
      https://github.com/stolostron/rhacm-docs

      4. - [ ] Mandatory for GA content:

      • [ ] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:
      • [ ] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:
      • [ ] Add verification at the end of the task, how does the user
        verify success (a command to run or a result to see?)

      5. - [ ] Mandatory for bugs: What is the diff? Clearly define what the
      problem is, what the change is, and link to the current documentation. Only
      use this for a documentation bug.

              Unassigned Unassigned
              rh-ee-ngraham Nathaniel Graham
              Matthew Smigielski Matthew Smigielski
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: