Bug 1958139

Summary: Enhance the Red Hat OpenShift GitOps documentation with a pre-requisites section
Product: OpenShift Container Platform Reporter: Robert Sandu <rsandu>
Component: DocumentationAssignee: Petr Kovar <pkovar>
Status: CLOSED NOTABUG QA Contact: Xiaoli Tian <xtian>
Severity: unspecified Docs Contact: Petr Kovar <pkovar>
Priority: unspecified    
Version: 4.9CC: aos-bugs
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-02-20 16:00:28 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Robert Sandu 2021-05-07 09:55:32 UTC
Document URL: https://docs.openshift.com/container-platform/4.7/cicd/gitops/

Section Number and Name: a new pre-requisites section, in either of these two [0][1] sections.

Describe the issue: Red Hat OpenShift GitOps 1.1 relies on parallel components, like Red Hat OpenShift Pipelines, for certain operations.

Suggestions for improvement: a customer should have a list of said parallel components in a pre-requisites list of the Red Hat OpenShift GitOps documentation.

Additional information:
- If the pre-requisites are not met (i.e. an older-than-required Pipelines release might be already installed), this can lead to a `ResolutionFailed` situation and the GitOps operator installation finish with an `Unknown failure` state.

[0] https://docs.openshift.com/container-platform/4.7/cicd/gitops/understanding-openshift-gitops.html
[1] https://docs.openshift.com/container-platform/4.7/cicd/gitops/installing-openshift-gitops.html

Comment 6 Petr Kovar 2023-02-20 16:00:28 UTC
Closed in https://issues.redhat.com/browse/RHDEVDOCS-3899.