Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-7564

[Docs] Support Pre-Configured RHDH Deployments in Operator

    • RHDH Documentation 3276, RHDH Documentation 3277, RHDH Documentation 3278, RHDH Documentation 3279, RHDH Documentation 3282

      Feature Overview (aka. Goal Summary)

      Implement a flexible framework for supporting flavors in the RHDH Operator, enabling the deployment of opinionated, pre-configured RHDH installations tailored to specific use cases. This feature extends the existing operator profiles mechanism to provide turnkey solutions that avoid the "blank page" experience of an empty RHDH installation.

      For reference see the design Document

      Goals (aka. expected user outcomes)

      • Platform engineers can deploy RHDH instances with pre-configured components optimized for specific use cases
      • Reduce initial setup complexity and time-to-value for new RHDH deployments
      • Enable the definition of the Orchestrator via the operator

      Requirements (aka. Acceptance Criteria):

      • Multiple flavors can be shipped via the OLM bundle
      • Flavors can be selected via a flavor directive and the backstage custom resource
      • Extend the BackstageSpec CRD to include flavor selection
      • Implement a standardized directory structure for flavor definitions
      • Support flavor-specific configuration overrides in the BackstageSpec
        • A flavor can be modified via the kustomize library similar to the patch directive for deployments
        • flavor specific and named overrides should be implemented by exposing more of the kustomize library
      • Implement documentation for using and creating flavors

      Out of Scope (Optional)

      • Creating every possible flavor combination
      • Handling runtime reconfiguration of flavors after initial deployment
      • Managing application-level content beyond initial deployment
      • Shipping custom flavors outside of the OLM bundle
      • Upgrading of flavors

      Customer Considerations (Optional)

      • Customers will need clear documentation on available flavors and their requirements

      Documentation Considerations

      • Document the flavor framework architecture and implementation
      • Create guides for developing and distributing custom flavors
      • Document the flavor manifest schema and configuration options

              gforde@redhat.com Gerry Forde
              hmanwani@redhat.com Heena Manwani
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: