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

OVN-K UDN API documentation around Subnets is outdated

XMLWordPrintable

    • None
    • 7
    • OSDOCS Sprint 261
    • 1
    • False
    • Hide

      None

      Show
      None
    • Release Note Not Required
    • In Progress

      Description of problem:

      OVN-K UDN API documentation about Subnets field is outdated [1] bullet (6)
      It should be fixed according to [2].
      
      
      Regarding the example at [1]:
      - It Specifics empty JoinSubnets, but it has no affect and should not be mentioned in a reference example in this form.
      - The 'Example output' spec misses the second IPv6 subnet.
      
      In general, since each topology (currently layer2, layer3) could have different spec, such as the Subnets field, I think it make more sense having example for each in this doc [1] with explanations for each field.
      
      [1] https://github.com/JoeAldinger/openshift-docs/blob/main/modules/nw-udn-cr.adoc#creating-a-userdefinednetwork-custom-resource    
      [2] https://github.com/openshift/openshift-docs/pull/81383/files#r1770537850
      
      

      Version-Release number of selected component (if applicable):

      4.17    

      How reproducible:

          

      Steps to Reproduce:

          1.
          2.
          3.
          

      Actual results:

          

      Expected results:

          

      Additional info:

          

            jaldinge@redhat.com Joe Aldinger
            omergi@redhat.com Or Mergi
            Anurag Saxena Anurag Saxena
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: