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

Document the new ability to name and rename hubs (2.14)

XMLWordPrintable

    • False
    • None
    • False
    • 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.14

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

      This may require new sections or could possibly be added to existing sections. It affects Installation but also Cluster management. In essence, the change brings in the ability to variablise the naming of a hub cluster. So customers will be able to call the name of their cluster to whatever they choose. This can be done at install time as an initial step or later on as a rename.

      • [X] We need to update to an existing topic

      Install docs. Cluster Docs. MCE. Global Hub?

      • [X] We need to add a new document to an existing section

      Ibid. 

      • [ ] We need a whole new section; this is a function not
        documented before and doesn't belong in any current section

      Let's review. Perhaps we need to create a small section on the implications of this. I do not think it falls into this category but wanted to keep the option open.

      Global hub will also use this feature so we may need reference in there. This may indicate a need to realign all these different subsections. 

      • [ ] We need an Operator Advisory review and approval
      • [ ] We need a z-Stream (Errata) Advisory and Release note
        for MCE and/or ACM

      3. - [ ] *Mandatory: *Use the following link to open the doc and find where the
      documentation update should go. Note: As the feature and doc is
      understood and developed, this placement decision may change:

      • Published doc: 

      I think we'd need updates to:

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/install/index

      And

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/index

      And

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/multicluster_engine_operator_with_red_hat_advanced_cluster_management/index

       

      • Source:

      Rather than misdirect you here can I just ibid. the above RHACM sections?

      4. - [X] Mandatory for GA content:

      • [X] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:

      TBC - but once the process is completed we need to work with engineering and UX to understand how best to share this with customers.

      • [X] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:

      Admin task. Managed hub admin task.

      • [ ] Add verification at the end of the task, how does the user
        verify success (a command to run or a result to see?)

      Their hub cluster has a custom name using the new variable engineering created.

      • [ ] Add link to dev story here:

      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.

              bswope@redhat.com Brandi Swope
              asimonel August Simonelli
              Kurtis Wang Kurtis Wang
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: