Uploaded image for project: 'Project Quay'
  1. Project Quay
  2. PROJQUAY-4885

Clear separation of Configuration Guide and Operator Guide

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Critical Critical
    • None
    • None
    • clair, documentation

      Currently, Operator-level configuration is spread out across 2 doc books:

      • Deploy Red Hat Quay on OpenShift with the Quay Operator
      • Configuring Quay (chapter 4 "config Tools" and chapter 5 "Quay Operator Components")

      This is confusing. When searching for ways to override the volume size for Operator-managed databases or what the operator-based monitoring integration looks like, one has to look in the general configuration guide for Quay whereas it would be more natural for this to be covered in the Quay Operator guide.

      There should be a clear separation:

      • Quay Operator guide for all operator-related and operator-managed configuration, anything that involves touching the QuayRegistry CR or editing the config-bundle secret, including: configuring unmanaged components instead of relying on managed components
      • Quay Configuration Guide: generic list of all supported Quay and Clair configuration tunables and all options

              rhn-support-stevsmit Steven Smith
              DanielMesser Daniel Messer
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: