Uploaded image for project: 'OpenShift Request For Enhancement'
  1. OpenShift Request For Enhancement
  2. RFE-7526

Enhance oc explain Documentation for images.config.openshift.io.spec.additionalTrustedCA with ConfigMap Example

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • 4.18
    • oc
    • None
    • Product / Portfolio Work
    • None
    • False
    • Hide

      None

      Show
      None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      1. Proposed Title of this Feature Request
      Enhance oc explain Documentation for images.config.openshift.io.spec.additionalTrustedCA with ConfigMap Example

      2. What is the nature and description of the request?
      The current output of the oc explain images.config.openshift.io.spec.additionalTrustedCA command lacks a concrete example of the expected ConfigMap format that provides additional trusted CA certificates. This creates confusion for users attempting to configure additional trust for image pulling operations. The request is to enhance the CLI output by including a sample ConfigMap (similar to proxy.spec.trustedCA) that clearly shows the required structure, key (ca-bundle.crt), and namespace.

      3. Why does the customer need this? (List the business requirements here)
      Ease of Configuration: Customers often rely on oc explain to understand OpenShift CRD fields and expected configurations. A lack of a sample increases trial-and-error and potential misconfiguration.

      Consistency with Other Resources: Fields like proxy.spec.trustedCA already provides an inline sample ConfigMap, improving usability. Users expect consistent guidance across similar fields.

      Reduced Support Dependency: Clear CLI documentation helps customers configure features independently, reducing reliance on Red Hat support or external documentation.

      Faster Troubleshooting & Implementation: Proper examples allow users to quickly implement additional trusted CAs for operations like image pulls, builds, and imagestream imports—especially in disconnected or secured environments.

      Improved Adoption: Better documentation improves user confidence and adoption of secure practices like CA injection.

      4. List any affected packages or components
      oc CLI

      Documentation associated with CRDs presented via oc explain

       

              gausingh@redhat.com Gaurav Singh
              rhn-support-dpateriy Divyam Pateriya
              None
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                None
                None