Uploaded image for project: 'OpenShift GitOps'
  1. OpenShift GitOps
  2. GITOPS-3948

Docs: Rollouts Architecture

XMLWordPrintable

    • 13
    • False
    • None
    • False
    • SECFLOWOTL-93 - Promote Rollouts to GA
    • GITOPS Service EE Sprint 257, GITOPS Service EE Sprint 258, GitOps Scarlet - Sprint 3257, GitOps Scarlet - Sprint 3256

      Story (Required)

      It would likely be beneficial to have a page within the OpenShift docs that describes the architecture of Argo Rollouts.

      Similar content to https://argo-rollouts.readthedocs.io/en/stable/architecture/, but with our voice, and referencing corresponding OpenShift technologies (service mesh rather than istio, etc)

      This would be a high level overview of Rollouts concepts at a technical level,

      (There is already related paragraph in the existing OpenShift GitOps Rollouts docs, but it deserves its own page.)

      Acceptance Criteria:

      • Learn more about Rollouts architecture, and build up an understanding of the concepts (we're all doing this as a team, but I want to call it out here to specifically to ensure the owner of this item reserve the time to do, so that the docs they write are accurate)
      • Possible topics (brainstorming):
        • What is the difference between (OpenShift) Rollouts (manager) operator and Rollouts controller itself
        • What does the Rollouts Controller do
        • What is the Rollouts resource
        • Ingress/traffic management
        • What is AnalysisTemplate and AnalysisRun (especially as it related to what OpenShift supports)
        • Metric providers (especially as it relates to what OpenShift supports)
        • Anything else you can think of?
      • Write Google Doc page containing contents, and link it to this JIRA issue
      • Submit to team lead for content review, then to doc team for style review (and to get it into docs)

            jgwest Jonathan West
            jgwest Jonathan West
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: