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

Usability issues with Hosted control plane CLI instructions for AWS

XMLWordPrintable

    • False
    • None
    • False
    • No

      Description of problem:

      CLI instructions are not clear.

      oc hcp create cluster aws --name $CLUSTER_NAME --namespace $NAMESPACE --node-pool-replicas=3 --secret-creds $SECRET_CREDS --region $REGION

      1. What are the variables that need to be replaced?
      2. These are written as shell variables; should we be directing the user to export them instead?
      3. User has to copy the command and paste it somewhere temporary before they can even see what variables are included
      4. How is the --namespace parameter used?
      5. Is --secred-creds the name of a secret for an ACM credential (that was my guess because step 2 instructs the user to use an existing credential or create a new one). Is the namespace for this secret taken from the current context or from the --namespace argument? If the current context, can I specify it with a -n argument?
      6. Step 3 doesn't actually tell the user to run the command. And logging in using oc is part of the "Copy command" section, which doesn't really make sense.

      Additional items annotated on the screenshot.

      It might be a better experience to show the command in an editable text box that the user can copy after customizing. I am not sure if the documentation linked in step 1 will include help on this command, but it would probably be useful to include a link in step 3 that explains the command parameters.

       

              magchen@redhat.com Maggie Chen
              rh-ee-kcormier Kevin Cormier
              David Huynh David Huynh
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: