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

VSphereStorageDriver does not document the platform default

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done-Errata
    • Blocker
    • 4.14.0
    • 4.14
    • Storage / Operators
    • None
    • No
    • Storage Sprint 233, Storage Sprint 235
    • 2
    • Rejected
    • False
    • Hide

      None

      Show
      None
    • N/A
    • Release Note Not Required

    Description

      Description of problem:

      API fields that are defaulted by a controller should document what their default is for each release version.
      Currently the field documents that "if empty, subject to platform chosen default", but it does not state what that is.
      
      To fix this, please add, after the platform chosen default prose:
      // The current default is XYZ.
      
      This will allow users to track the platform defaults over time from the API documentation.
      
      I would like to see this fixed before 4.13 and 4.14 are released please, it should be pretty quick to fix if we understand what those defaults are.

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

       

      How reproducible:

       

      Steps to Reproduce:

      1.
      2.
      3.
      

      Actual results:

       

      Expected results:

       

      Additional info:

       

      Attachments

        Issue Links

          Activity

            People

              jdobson@redhat.com Jonathan Dobson
              joelspeed Joel Speed
              Wei Duan Wei Duan
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: