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

ClusterVersion capabilities patch example should use enum values

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • 4.13, 4.14, 4.15, 4.16, 4.17
    • Moderate
    • None
    • False
    • Hide

      None

      Show
      None

      Description of problem

      We've had ClusterVersion capabilities since 4.11, with an enum of values that starts with v4.11. 4.12 docs say:

      For baselineCapabilitySet you can specify vCurrent, v4.11, v4.12, or None.

      which accurately reflects the 4.12 enum. But starting with 4.13 docs:

      For baselineCapabilitySet you can specify vCurrent, v4.12, v4.13, or None.

      which (accidentally) excludes the 4.13 enum's v4.11. I suspect that branching logic like "let's take all 4.y references to 4.(y+1)" got carried away and moved these, without realizing that this string was trying to represent an enum that would only grow with time.

      To address this bug, the dev branch should be updated to list all the current enum values, and older 4.y docs should be updated to match their 4.y's enum values. Or the string should be rephrased to tell folks to look at table 1 below for valid values. Or something.

      Version-Release number of selected component

      4.13 and later docs.

      How reproducible

      Every time.

      Steps to Reproduce

      1. Read the baselineCapabilitySet patch doc line.
      2. Check the following table for that 4.y's capability set options.

      Actual results

      baselineCapabilitySet patch docs only list two v4.y values, even for 4.y releases where there are more than two v4.y values in the table of known capability sets.

      Expected results

      baselineCapabilitySet patch docs should list that 4.y's capability set enum options.

            bscott@redhat.com Ben Scott
            trking W. Trevor King
            Evgeni Vakhonin Evgeni Vakhonin
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: