Skip to content

Commit f2df371

Browse files
Merge pull request #640 from varshab1210/install-doc-update
Update usage guide for operator installation
2 parents 7b349b8 + 76f020f commit f2df371

9 files changed

+55
-13
lines changed

docs/OpenShift GitOps Usage Guide.md

Lines changed: 55 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@
2323

2424
## Installing OpenShift GitOps
2525

26+
#### Terminologies:
27+
28+
* **Update channel**: Choose the channel according to the required operator version. latest channel points to the latest released version
29+
30+
**Note**: For installing a z stream release, upgrade the operator in the respective versioned channel (or in the latest accordingly)
31+
* **Installation mode**: As mentioned, the operator is only supported in default mode, retaining the value as is.
32+
* **Installed Namespace**: openshift-operators namespace was the default installation namespace. Starting 1.10.0, we support installation in openshift-gitops-operator namespace as default. Choosing this namespace and enabling the Namespace monitoring option below, enables the monitoring. openshift-operators can also be used as the installation namespace but monitoring wouldn’t be possible with this namespace.
33+
* **Update approval**: As the name suggests, with Automatic approval, updates are applied automatically, whereas with Manual approval, updates would require Manual intervention
34+
* **Console plugin**: Enable/ Disable console plugin
35+
36+
2637
### Operator Install GUI
2738

2839
To install OpenShift GitOps, find the OpenShift GitOps Operator in OperatorHub by typing "gitops" in the search box and click on the OpenShift GitOps Operator.
@@ -49,32 +60,61 @@ apiVersion: operators.coreos.com/v1alpha1
4960
kind: Subscription
5061
metadata:
5162
name: openshift-gitops-operator
52-
namespace: openshift-gitops-operator
63+
namespace: <Installed namespace>
64+
labels:
65+
operators.coreos.com/openshift-gitops-operator.openshift-operators: ''
5366
spec:
54-
channel: stable
55-
installPlanApproval: Automatic
67+
channel: <Update channel>
68+
installPlanApproval: <Update approval>
5669
name: openshift-gitops-operator
5770
source: redhat-operators
5871
sourceNamespace: openshift-marketplace
59-
```
72+
startingCSV: openshift-gitops-operator.v<version of the operator>
73+
```
6074

6175

6276
Then, you apply this to the cluster.
6377

6478
`$ oc apply -f openshift-gitops-sub.yaml`
6579

80+
#### Note:
81+
* startingCSV parameter in the subscription allows you to choose the required version
82+
* If you want the Installed namespace to be openshift-gitops-operator
83+
* Create the namespace and the OperatorGroup before applying the subscription
84+
* You can enable cluster monitoring manually by adding the below mentioned label
85+
86+
```
87+
// Create the namespace
88+
$ oc create ns openshift-gitops-operator
89+
90+
// Create the OperatorGroup
91+
$ oc create -f - <<EOF
92+
apiVersion: operators.coreos.com/v1
93+
kind: OperatorGroup
94+
metadata:
95+
name: openshift-gitops-operator
96+
namespace: openshift-gitops-operator
97+
spec:
98+
upgradeStrategy: Default
99+
100+
// Enable cluster monitoring
101+
$ oc label namespace openshift-gitops-operator openshift.io/cluster-monitoring=true
102+
```
103+
66104
After a while (about 1-2 minutes), you should see the following Pods appear.
67105

68106
```
69-
$ oc get pods -n openshift-gitops
70-
NAME READY STATUS RESTARTS AGE
71-
cluster-b5798d6f9-zr576 1/1 Running 0 65m
72-
kam-69866d7c48-8nsjv 1/1 Running 0 65m
73-
openshift-gitops-application-controller-0 1/1 Running 0 53m
74-
openshift-gitops-applicationset-controller-6447b8dfdd-5ckgh 1/1 Running 0 65m
75-
openshift-gitops-redis-74bd8d7d96-49bjf 1/1 Running 0 65m
76-
openshift-gitops-repo-server-c999f75d5-l4rsg 1/1 Running 0 65m
77-
openshift-gitops-server-5785f7668b-wj57t 1/1 Running 0 53m
107+
$ oc get pods -n openshift-gitops
108+
NAME READY STATUS RESTARTS AGE
109+
cluster-65885cfb44-x6lx4 1/1 Running 0 55s
110+
gitops-plugin-58b577c9c9-p78xl 1/1 Running 0 55s
111+
kam-84c7c688c7-5h6pz 1/1 Running 0 55s
112+
openshift-gitops-application-controller-0 1/1 Running 0 52s
113+
openshift-gitops-applicationset-controller-f66d47bc4-9rsd8 1/1 Running 0 52s
114+
openshift-gitops-dex-server-55f8c6c44-s9jcl 1/1 Running 0 51s
115+
openshift-gitops-redis-75d88d67c8-jrvr5 1/1 Running 0 52s
116+
openshift-gitops-repo-server-77987b679-mr6ld 1/1 Running 0 52s
117+
openshift-gitops-server-86df579bbf-zz9lx 1/1 Running 0 52s
78118
```
79119

80120
### Installation of OpenShift GitOps without ready-to-use Argo CD instance, for ROSA/OSD
@@ -134,6 +174,8 @@ And now you can log in to the Argo CD UI as *admin* using the retrieved password
134174

135175
![image alt text](assets/8.argocd_login_ui.png)
136176

177+
GitOps Operator comes with a bundled Dex instance which can be configured for authenticating with Argo CD component of Openshift GitOps. For logging in, click on **LOG IN VIA OPENSHIFT** and use the credentials for kubeadmin user when redirected to Openshift login page.
178+
137179
### Create an Argo CD Application
138180

139181
Now, you can create an Argo CD application and let Argo CD keep application resources live states in sync with the configuration in Git.
200 KB
Loading
317 KB
Loading
149 KB
Loading
-57.9 KB
Loading
53.6 KB
Loading
-8.49 KB
Loading
65.4 KB
Loading

docs/assets/8.argocd_login_ui.png

1.03 MB
Loading

0 commit comments

Comments
 (0)