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

[Doc][RFE] Add better examples and explanation of namespace and resource names in CLI installation

XMLWordPrintable

    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • False
    • Install
    • None

      Description of problem:

      In the documentation for installation of ACM using the CLI, only placeholders used for the resource names for the commands and yaml files.
      An arbitrary administrator might struggle to use proper names and should rather provided with more explanation of resource names to choose. Examples should be provided with default names, e.g. from console based installation.

      Version-Release number of selected component (if applicable):

      4.20

      How reproducible: always

      Steps to Reproduce:

      1. https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html-single/install/index#installing-from-the-cli
      2. check the provided code snippets: those provide place holders like <namespace>
      3. look for proper explanations of good choices for the names

      Actual results:

      There no explanations of which namespaces, operator group names, etc. one should choose and what a dependency or issue might be upon choices. 

      Expected results:

      Better examples or explanations of which namespaces, operator group names, etc. one should choose should be given. In addition, it would help to understand if certain choices would be suggested and what a dependency or issue might be upon different choices.

      Additional info:

      This section is named "1.4.4. Installing from the OpenShift Container Platform CLI " in ACM 2.14 is found under "Installing while connected online" section.

              Unassigned Unassigned
              matthiasmuench Matthias Muench
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: