Bug 2316335 - Yaml format issues in Multus examples
Summary: Yaml format issues in Multus examples
Keywords:
Status: NEW
Alias: None
Product: Red Hat OpenShift Data Foundation
Classification: Red Hat Storage
Component: documentation
Version: 4.16
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Erin Donnelly
QA Contact: Neha Berry
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2024-10-03 18:00 UTC by Blaine Gardner
Modified: 2024-10-09 19:04 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker OCSBZM-9299 0 None None None 2024-10-03 18:02:14 UTC

Description Blaine Gardner 2024-10-03 18:00:50 UTC
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]

  # 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:


Note You need to log in before you can comment on or make changes to this bug.