Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-2728

Update Builds docs for declarative configs

XMLWordPrintable

    • 5
    • Documentation (Ref Guide, User Guide, etc.)

      OpenShift docs often demonstrates workflows that rely on web console and imperative CLI instructions (e.g. oc edit, oc patch, oc adm policy add-role-to-user, etc) in order to configure various aspects of an OpenShift cluster. Customers are increasingly gravitated towards using GitOps principles for managing cluster configs in order to guarantee repeatability and consistency across multiple clusters. As a consequence, customers are left on their own to discover declarative equivalent of what is described in OpenShift docs so that they can store them in a Git repository, which is a daunting task even for customers with advanced OpenShift skills. Read more details in the parent epic.

      The following docs require a declarative descriptions and examples:

      • Creating build inputs > Source clone secrets
      • Creating build inputs > Using docker credentials for private registries
      • Creating build inputs > Service serving certificate secrets
      • Securing builds by strategy
      • Setting up additional trusted certificate authorities for builds

      Not in Scope

      Secret management outside what Kubernetes provides is not within the scope of this story.

      Acceptance Criteria

      • Docs include sufficient instructions on how to describe the above configuration in a way that could be stored in a Git repository
      • Any items which cannot be configured via pure YAML (ex - oc patch, oc secrets link) should include instructions that are compatible for ArgoCD (and other gitops tools)

      Notes

      Docs PR for ArgoCD integration: https://github.com/openshift/openshift-docs/pull/19429

      Why is this important

      This work was originally planned for OCP 4.4 .In the beginning of ramping up our efforts around GitOps for cluster management. Now, one year later, we have had one GitOps product out (RHACM) and another will be out in Q1 while OpenShift docs remain far behind in supporting this model. We frequently hear complaints from customers on this specific issue which is why this epic was introduced in the first place. The goal is to take steps to address it by the RH Summit timeframe which aligns with OCP 4.8. 

              Unassigned Unassigned
              rh-ee-ssadeghi Siamak Sadeghianfar
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: