Uploaded image for project: 'Data Foundation Bugs'
  1. Data Foundation Bugs
  2. DFBUGS-290

[2316335] Yaml format issues in Multus examples

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Critical Critical
    • None
    • odf-4.16
    • Documentation
    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • ?
    • ?
    • If docs needed, set a value
    • None

      Describe the issue:

      There seems to be a YAML formatting issue with the Multus example YAMLs. I think this was my fault. There was likely a copy-paste issue when I copied things into my google doc when writing the docs.

      YAML docs should be indented with 2 spaces per hierarchy level, but the first hierarchy level is only indented 1 space.

      I can see the mistake here:

      https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.16/html/planning_your_deployment/network-requirements_rhodf#verifying_requirements_have_been_met

      And here in both example outputs (NodeNetConfPolicies and NetAttDef):

      https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.16/html/planning_your_deployment/network-requirements_rhodf#multus-examples_rhodf

      Also above, I see a typo `Interfaces` in the last NNCP section should be lower cased: `interfaces`. This was a google doc auto-capital typo.

      Describe the task you were trying to accomplish: Multus setup for 4.16

      Suggestions for improvement:

      Make sure YAML hierarchy levels are indented 2 spaces each.

      Interfaces --> interfaces

      Correct indentation example snippet:
      ```
      apiVersion: nmstate.io/v1
      kind: NodeNetworkConfigurationPolicy
      metadata:
      name: ceph-public-net-shim-compute-2 # [1]
      namespace: openshift-storage
      spec:
      nodeSelector:
      node-role.kubernetes.io/worker: ""
      kubernetes.io/hostname: compute-2 # [2]

      1. etc. etc. etc.
        ```

      Document URL: https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.16/html/planning_your_deployment/network-requirements_rhodf

      Chapter/Section Number and Title: 8.2.1.2 and 8.2.2

      Product Version: 4.16

      Environment Details: Multus

      Any other versions of this document that also needs this update: Only 4.16+

      Additional information:

              edonnell@redhat.com Erin Donnelly
              blaine.gardner Blaine Gardner
              Neha Berry Neha Berry
              Votes:
              0 Vote for this issue
              Watchers:
              10 Start watching this issue

                Created:
                Updated: