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

Documentation feedback: Inconsistent network name capitalization

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • rhos-18.0.15
    • documentation
    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • ?
    • rhos-conplat-core-operators
    • None
    • Moderate

      Link: https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/deploying_red_hat_openstack_services_on_openshift/assembly_preparing-rhoso-networks_preparing#proc_creating-the-data-plane-network_preparing_networks

      Step 3 of the procedure shows a netconfig example. That example capitalizes some of the letters in the network names (CtlPlane, InternalApi, External, Storage, Tenant). This is inconsistent with the rest of this documentation page. Everywhere else these networks are mentioned, they're lower case.

      This also causes issues with telemetry, that result in customer cases (I've seen at least 2 already). I assume customers copy and use the example with the capitalized network names and then don't realize they need to change the network name in telemetry as well (telemetry by default expects lowercase network names).

      What's more our dev environments and CI as far as I've seen use lowercase everywhere as well, so the lowercase values is what we test with.

      So please change the names in the example to lowercase to match what is in the rest of the documentation, to match what telemetry expects by default and to match what's being tested.

              igallagh@redhat.com Irina Gallagher
              rh-ee-jwysogla Jaromir Wysoglad
              rhos-conplat-core-operators
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: