-
Story
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
13
-
False
-
None
-
False
-
-
Story (Required)
As a user of Rollouts within OpenShift GitOps, I wish to have documentation in OpenShift GitOps docs that provides an example of how to use AnalysisTemplates (via prometheus integration) with OpenShift's user workload monitoring (prometheus)
Background/Approach (Required)
Based on work done on https://issues.redhat.com/browse/GITOPS-2414. See John's summary here: https://docs.google.com/document/d/10iVhz7_ika8NRGwho1B7OUj6O4YdstHEm6Ib_Q9rkyc/edit
Recently there was a request in the #forum-openshift-gitops Slack channel, asking why we don't have OpenShift workload monitoring documented: https://redhat-internal.slack.com/archives/CMP95ST2N/p1721142134017809
Clearly there is a demand for this, in addition to identifying this as a focus area for us pre-Rollouts GA, so we should complete our work to document this.
Acceptance Criteria (Mandatory)
- Document an example procedure for using Argo Rollouts AnalysisTemplates with openshift workload monitoring
- Procedure would be, basically:
- Create AnalysisTemplate
- Create Rollout pointing to AnalysisTemplate
- Use rollouts status command to watch the Rollout progress
- Gerald has an example here we can borrow, rather than reinventing the wheel: https://github.com/gitops-examples/rollouts-demo
- Style of procedure is roughly similar to the other procedures we have for Argo Rollouts: https://docs.openshift.com/gitops/1.13/argo_rollouts/getting-started-with-argo-rollouts.html
- We can assume (as a documented prereq) that the user has already enabled openshift workload monitoring
- At the moment, this scenario requires use of 'insecure: true' in the AnalysisTemplate. This is documented as an upstream issue here: https://github.com/argoproj/argo-rollouts/issues/2298
- We can include a reference to this upstream issue in the docs.