Uploaded image for project: 'OpenShift Virtualization'
  1. OpenShift Virtualization
  2. CNV-79939

[CNV4.20] ConsoleQuickStart guides missing on full-Konflux builds

XMLWordPrintable

    • Product / Portfolio Work
    • 0.42
    • False
    • Hide

      None

      Show
      None
    • False
    • v4.20.8.rhel9-31
    • None

      Description of problem:

                                                                                                                                                                                                             
        ConsoleQuickStart resources are not deployed on OpenShift clusters when using full-Konflux builds of CNV 4.20 and 4.21. The HCO operator expects processed QuickStart YAML manifests in the quickStart/ directory 
        of the container image, but the Konflux build pipeline does not process the QuickStart template files (*.in): it neither sets the correct version in documentation references nor renames the templates to their  
        final YAML file names. As a result, the operator silently skips QuickStart registration and users do not see any ConsoleQuickStart guides in the OpenShift console.                                               
                                                                                                                                                                                                                          
        A fix already exists for CNV 4.99 (v4-99 konflux-builds MR 112) but has not been backported to CNV 4.20 or 4.21.                                                                                                  
        

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

        - CNV 4.20 (full-Konflux builds)
        - CNV 4.21 (full-Konflux builds)
        - Component: hyperconverged-cluster-operator
        - Fixed in: CNV 4.99 (konflux-builds MR 112)
        

      How reproducible:

        Always — on any cluster deployed using full-Konflux builds of CNV 4.20 or 4.21.
        This does not affect legacy (non-Konflux) builds.
        

      Steps to Reproduce:

        1. Deploy OpenShift Virtualization (CNV) 4.20 or 4.21 using a full-Konflux build.
        2. Verify HCO is running and the HyperConverged CR is reconciled successfully.
        3. Check for ConsoleQuickStart resources in the cluster:
           oc get consolequickstarts -l app.kubernetes.io/managed-by=hco-operator
        

      Actual results:

        No ConsoleQuickStart resources are created by HCO. The QuickStart guides are completely
        absent from the OpenShift console.
      
        The HCO operator's quickStart/ directory in the container image contains unprocessed
        template files (*.in) instead of finalized YAML manifests. The operator's
        ValidateManifestDir function finds no .yaml files and silently skips QuickStart
        handler registration — no error is logged.
        

      Expected results:

        ConsoleQuickStart resources should be deployed on the cluster, with correct documentation
        version references matching the CNV release. Users should see QuickStart guides available
        in the OpenShift console to help them get started with virtualization features.
        

      Additional info:

        Root Cause:
        The Konflux build pipeline for CNV 4.20 and 4.21 does not include the processing step
        that:
          1. Sets the correct CNV version in documentation URL references within QuickStart guides.
          2. Renames template files (*.in) to their final names (*.yaml).
      
        Without this processing, the HCO operator finds no .yaml files in the quickStart/
        directory at runtime. The ValidateManifestDir function in pkg/util/file.go treats a
        missing or empty directory as a non-fatal condition (returns nil error), so the operator
        starts successfully but without any ConsoleQuickStart handlers.
      
        Fix:
        Backport the fix from v4-99 konflux-builds MR 112 to the CNV 4.20 and 4.21 Konflux
        build configurations:
        https://gitlab.cee.redhat.com/openshift-virtualization/konflux-builds/v4-99/hyperconverged-cluster-operator/-/merge_requests/112
      
        Impact:
        - All users on full-Konflux builds of CNV 4.20 and 4.21 are missing QuickStart guides.
        - No functional impact to VM operations, but degrades the user onboarding experience.
        - This became visible now because CNV 4.20 and 4.21 started using Konflux-only builds.
      
        Upstream references:
        - Upstream commit 76ccc850b ("QuickStarts: Use fs.FS interface instead of the os pkg")
          removed the QUICK_START_FILES_LOCATION environment variable fallback, making the
          operator rely solely on the quickStart/ directory relative to the working directory.
        - The production Dockerfile (build/Dockerfile) copies from assets/ which does not
          contain a quickStart/ directory — this is expected to be provided by the downstream
          build process.
        

              ocohen@redhat.com Oren Cohen
              rlobillo Ramón Lobillo
              Ramón Lobillo Ramón Lobillo
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: