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

OCP MC docs don't highlight that Butane .version is different than z-stream OCP version

    XMLWordPrintable

Details

    Description

      Description of problem:

      By looking at the documentation one could think that the .version specified in Butane template files (.bu) should match z-stream from the RHOCP cluster.
      This is actually a specification for Butane itself and doesn't relate in any way to RHOCP, see [0]
      
      [0] https://coreos.github.io/butane/specs/
      
      

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

      Documentation bug is from RHOCP 4.8 onwards (since Butane was introduced)

      How reproducible:

      Look at documentation specific to y-stream RHOCP version at chrony configuration section. See [1] (4.8 doc):
      
      [1] https://docs.openshift.com/container-platform/4.8/installing/install_config/installing-customizing.html#installation-special-config-chrony_installing-customizing

      Steps to Reproduce:

      1. Look at the docs
      2. No mention that RHOCP z-stream is not in any way related to .version in .bu files examples
      

      Actual results:

      See above

      Expected results:

      Should be highlighted somewhere that z-stream is not related.
      I.e. RHOCP 4.10 docs should say something like "please note that .bu files .version needs to stick with x.y.0"

      Additional info:

       

      Attachments

        Activity

          People

            kalexand@redhat.com Kathryn Alexander
            rh-ee-sizucchi Simone Massimo Zucchi
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated: