Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-2123

Doc issues in orchestrator-software-templates Helm chart

XMLWordPrintable

    • 2
    • False
    • Hide

      None

      Show
      None
    • False
    • Release Note Not Required

      Description of problem:
      The following are issues observed when verifying the instructions for the  orchestrator-software-templates Helm chart:

      1.  In the Prerequisites section, there is no link to the setup script mentioned in point 3.

      2. In the following CLI output when running helm install:

      # Copy template and replace placeholders
      cp charts/orchestrator-software-templates/orchestrator-templates-values.yaml.template orchestrator-templates-values.yaml
      

      This assumes that the user has cloned the rhdh-chart repo. Cloning the repo should be explicitly stated in the instructions.

      3. There is a word missing in the following sentence:

      uire the following ArgoCD: 

      4. The formatting in the following is odd, possible each parameter should be on separate lines:

      ARGOCD_URL: https://argocd-server.<apps.example.com> ARGOCD_USERNAME: admin ARGOCD_PASSWORD: oc get secret -n openshift-gitops openshift-gitops-cluster -o jsonpath='{.data.admin\.password}' | base64 -d 

       5. Missing link to the setup script and/or a colon at the end of the sentence:

      The secret can be created by the setup script or manually 

      6. The following snippet is missing many of the required keys for the orchestrator-auth secret, and if used as is causes failures due to missing keys:

      oc create secret generic orchestrator-auth-secret \
        -n rhdh \
        --from-literal=BACKEND_SECRET=your-backend-secret \
        --from-literal=K8S_CLUSTER_TOKEN=your-k8s-token \
        --from-literal=K8S_CLUSTER_URL=https://your-cluster-url \
        --from-literal=GITHUB_TOKEN=your-github-token 

       

      Steps to Reproduce

      1. Deploy the Orchestrator Software templates chart with RHDH 1.7 according to the instructions.

      Actual results: See above.{}

              rh-ee-eshalev Elai Shalev
              yfirst Yona First
              RHIDP - Install
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: