Uploaded image for project: 'Red Hat OpenStack Services on OpenShift'
  1. Red Hat OpenStack Services on OpenShift
  2. OSPRH-9614

Documentation feedback: avoid use of yq in commands

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Minor Minor
    • rhos-18.0.1
    • rhos-18.0.0
    • documentation
    • None
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • ?
    • ?
    • ?
    • ?
    • None
    • Low

      https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/assembly_preparing-rhocp-for-rhoso#con_creating-storage-class_preparing

      (Also in `common/nfv/proc_creating-the-control-plane.adoc` which is using a duplicate set of commands vs reused content.)

      In the Procedure step 2 for creating the openstack namespace, there is a command that makes use of `yq` which is a non-standard command on RHEL and other systems. The use of `jq` is much more prevalent, and should be the preferred usage.

      Current

      $ oc get namespace openstack -o yaml | yq '.metadata.labels'
{
  "kubernetes.io/metadata.name": "openstack",
  "pod-security.kubernetes.io/enforce": "privileged",
  "security.openshift.io/scc.podSecurityLabelSync": "false"
}

      Suggest

      $ oc get namespace openstack -ojsonpath='{.metadata.labels}' | jq
{
  "kubernetes.io/metadata.name": "openstack",
  "pod-security.kubernetes.io/enforce": "privileged",
  "security.openshift.io/scc.podSecurityLabelSync": "false"
}

              igallagh@redhat.com Irina Gallagher
              lmadsen@redhat.com Leif Madsen
              rhos-dfg-ospk8s
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: