From 9908ec9c1cfdf0c57dda4b6035d51f464cdb3cf3 Mon Sep 17 00:00:00 2001 From: jc-berger Date: Wed, 10 Feb 2021 17:06:54 -0500 Subject: [PATCH] created getting started wtih gitops procedure module corrected metadata, module structure, and minor content changes revised content, made modules and assembly corrected typo to remove build error changed xref to resolve build error added module to include openshift login content and structure changes to modules and assembly fixed xref to resolve build error fixed xref to resolve build error# more content and heading changes modular and structural changes changed introduction to module minor grmmatical changes corrected UI elements --- _topic_map.yml | 4 +-- ...getting-started-with-openshift-gitops.adoc | 15 ++++++++++ ...the-operator-provided-argocd-instance.adoc | 28 +++++++++++++++++++ 3 files changed, 45 insertions(+), 2 deletions(-) create mode 100644 cicd/gitops/getting-started-with-openshift-gitops.adoc create mode 100644 modules/launching-the-operator-provided-argocd-instance.adoc diff --git a/_topic_map.yml b/_topic_map.yml index b04829fda81c..2f30363db0bb 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -1289,8 +1289,8 @@ Topics: Topics: - Name: Understanding OpenShift GitOps File: understanding-openshift-gitops -# - Name: Getting started with OpenShift GitOps -# File: getting-started-with-openshift-gitops + - Name: Getting started with OpenShift GitOps + File: getting-started-with-openshift-gitops --- Name: Images Dir: openshift_images diff --git a/cicd/gitops/getting-started-with-openshift-gitops.adoc b/cicd/gitops/getting-started-with-openshift-gitops.adoc new file mode 100644 index 000000000000..3ac2f16343c5 --- /dev/null +++ b/cicd/gitops/getting-started-with-openshift-gitops.adoc @@ -0,0 +1,15 @@ +[id="getting-started-with-openshift-gitops"] += Getting started with OpenShift GitOps +include::modules/common-attributes.adoc[] +:context: getting-started-with-openshift-gitops +toc::[] + +Red Hat OpenShift GitOps uses Argo CD as the core declarative tool and adds other tooling to enable teams to implement GitOps workflows across clusters. +This section walks you through the process of launching Argo CD using the web console and logging into it. + +== Prerequisites + +* You must install the xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Red Hat OpenShift GitOps Operator] listed in the OpenShift OperatorHub by using the default installation options. + +//Procedure Module +include::modules/launching-the-operator-provided-argocd-instance.adoc[leveloffset=+1] diff --git a/modules/launching-the-operator-provided-argocd-instance.adoc b/modules/launching-the-operator-provided-argocd-instance.adoc new file mode 100644 index 000000000000..6e77919c5959 --- /dev/null +++ b/modules/launching-the-operator-provided-argocd-instance.adoc @@ -0,0 +1,28 @@ +// Module is included in the following assemblies: +// +// * openshift-docs/cicd/gitops/getting-started--with-openshift-gitops.adoc + +[id="launching-the-operator-provided-argocd-instance_{context}"] += Launching the Operator provided Argo CD instance + +Red Hat OpenShift GitOps uses Argo CD to manage specific cluster-scoped resources, including: platform operators, optional Operator Lifecycle Manager (OLM) operators, and user management. + +To launch the Argo CD instance for your cluster configuration, ensure that the Red Hat OpenShift GitOps Operator is installed on your cluster. After the Operator is installed, it is applicable to all namespaces on the entire cluster. When you install the Red Hat OpenShift GitOps Operator, it automatically sets up a ready-to-use Argo CD instance that is available in the `openshift-gitops` namespace, and an Argo CD icon is displayed in the console toolbar. + +After you install the Red Hat OpenShift GitOps Operator, launch into the Argo CD instance from the *Console Application Launcher* to use Argo CD. + +.Prerequisites + +* You have installed the Red Hat OpenShift GitOps Operator. + +.Procedure + +. In the *Administrator* perspective of the web console, navigate to *Operators* -> *Installed Operators*. +. Navigate to *Red Hat applications* -> *Application Stages* -> *Argo CD*. The login page of the Argo CD UI is displayed in a new window. +. Obtain the password for the Argo CD instance: +.. Navigate to the *Developer* perspective of the web console. A list of available projects is displayed. +.. Navigate to the `openshift-gitops` project. +.. Select the *Secrets* tab. +.. Select the *argocd-cluster-cluster* instance to display the password. +.. Copy the password. +. Use this password to log into the Argo CD UI in the new window.