Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-71187

POLICY_ENGINE_GRAPH_URI docs should mention 'arch' query parameter

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • 4.14, 4.15, 4.16, 4.17, 4.18, 4.19, 4.20, 4.21
    • Documentation / OTA
    • None
    • None
    • False
    • Hide

      None

      Show
      None
    • None
    • Moderate
    • No
    • Rejected
    • None
    • In Progress
    • Release Note Not Required
    • None
    • None
    • None
    • None
    • None

      Description of problem

      Current 4.14 and 4.20 docs are untouched since 2021 and suggest:

      $ while sleep 10; do HTTP_CODE="$(curl --header Accept:application/json --output /dev/stderr --write-out "%{http_code}" "${POLICY_ENGINE_GRAPH_URI}?channel=stable-4.6")"; if test "${HTTP_CODE}" -eq 200; then break; fi; echo "${HTTP_CODE}"; done
      

      That's great for the default architecture of amd64. But for folks who are not mirroring any amd64 images, and only have multi or other architectures like arm64, they'll need to set the arch query parameter.

      Version-Release number of selected component

      All supported releases are affected.

      How reproducible

      Every time.

      Steps to Reproduce

      1. Find the POLICY_ENGINE_GRAPH_URI checking docs.

      Actual results

      See a curl recommendation that doesn't set the arch query parameter.

      Expected results

      $ while sleep 10; do HTTP_CODE="$(curl --header Accept:application/json --output /dev/stderr --write-out "%{http_code}" "${POLICY_ENGINE_GRAPH_URI}?channel=${CHANNEL}&arch=${ARCHITECTURE}")"; if test "${HTTP_CODE}" -eq 200; then break; fi; echo "${HTTP_CODE}"; done
      

      with some surrounding text that talks folks through populating CHANNEL and ARCHITECTURE.

      Additional info

      This is precedent for populating an architecture variable in a command-line flow. But we can't copy it directly into this use-case, because:

      • It doesn't mention multi (maybe it should?), and
      • It uses Red-Hat-tag architecture names (e.g. x86_64), when for the policy engine results we want to use the GOARCH values (e.g. docs, like amd64) or multi.

              ocp-docs-bot OCP DocsBot
              trking W. Trevor King
              None
              None
              Jian Li Jian Li
              None
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: