Skip to content

Commit c7be5d6

Browse files
committed
Fix typos and explanations
1 parent 9e81e2f commit c7be5d6

File tree

1 file changed

+30
-23
lines changed

1 file changed

+30
-23
lines changed

content/modules/ROOT/pages/03-configuration.adoc

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,15 @@ few additional capabilities specific to OpenShift.
8686
[#config-health-checks]
8787
== Argo CD Health Checks
8888

89-
Argo CD has the ability to monitor the health of resources that it has deployed. When an Argo CD detects that a deployed Resource
89+
Argo CD has the ability to monitor the health of resources that it has deployed. When Argo CD detects that a deployed Resource
9090
is in a non-Healthy state (Degrade, Progressing, etc) this is because the associated health check is reporting
9191
this status.
9292

9393
[IMPORTANT]
9494
Argo CD Health Checks provide a quick and easy way to monitor the status of resources being managed by Argo CD. If you deploy
9595
some additional alerting in your monitoring for Argo CD Applications you essentially get resource alerting
96-
for free. OpenShift GitOps includes an alert for the Out-of-Sync status, but you can view an example of additional
97-
alerting on health status link:https://github.com/gnunn-gitops/acm-hub-bootstrap/blob/main/components/policies/gitops/base/manifests/gitops-alerting/base/prometheus-rules.yaml[here,window="_blank"].
96+
for free. OpenShift GitOps includes an alert for the Out-of-Sync status, but you can view a blog of how to create additional
97+
alerting based on health status link:https://developers.redhat.com/blog/2025/07/24/create-additional-alerts-openshift-gitops[here,window="_blank"].
9898

9999
These health statuses are also used to support features like link:https://argo-cd.readthedocs.io/en/stable/user-guide/sync-waves[Sync Waves, window="_blank"]
100100
which deploy resources in a prescribed order. Argo CD will not deploy subsequent resources until earlier resources are in a Healthy state as determined by
@@ -114,9 +114,9 @@ these statuses of most to least healthy statuses: _Healthy_, _Suspended_, _Progr
114114

115115
Argo CD health checks are sourced from three locations:
116116

117-
1. _Native_. These health checks are for standard Kubernetes resources (Deployment, Job, etc) are written in Go. They can
117+
1. _Native_. These health checks are for standard Kubernetes resources (Deployment, Job, etc) and are written in Go. They can
118118
be reviewed in the link:https://github.com/argoproj/gitops-engine/tree/master/pkg/health[gitops-engine, window="_blank"] repository.
119-
2. _Included_. These health checks are written in LUA and a large number of custom health checks ship with Argo CD, these can be reviewed
119+
2. _Included_. These health checks are written in LUA with a large number of health checks shipped with Argo CD, these can be reviewed
120120
in the Argo CD repository in the link:https://github.com/argoproj/argo-cd/tree/master/resource_customizations[resource_customizations, window="_blank" ]
121121
folder.
122122
3. _Custom_. These are health checks that you create yourself and configure in Argo CD. This can be done for resources that do not have a
@@ -209,9 +209,10 @@ STATUS: Progressing
209209
MESSAGE
210210
----
211211

212-
Note the command confirms that Argo CD considers the PVC to be `Progressing`, let's change that with the following .
212+
Note the command confirms that Argo CD considers the PVC to be `Progressing`, let's change that with the following
213+
custom health check writtin in LUA to override the default one:
213214

214-
[source,yaml,subs="attributes",role=execute]
215+
[source,yaml,subs="+macros,attributes+"]
215216
----
216217
hs = {}
217218
if (obj.status ~= nil and obj.status.phase ~= nil) then
@@ -271,7 +272,7 @@ resource.customizations.health.PersistentVolumeClaim: |
271272
return hs
272273
----
273274

274-
Now test the status that is returned using the Argo CD CLI again but using our new configmap:
275+
Now test the status that is returned using the Argo CD CLI again but using our new configmap with the updated PVC health check:
275276

276277
[.console-input]
277278
[source,yaml,subs="attributes",role=execute]
@@ -288,20 +289,22 @@ STATUS: Healthy
288289
MESSAGE: Pending
289290
----
290291

291-
Great, our updated health check is working! Let's go ahead and patch it into ArgoCD Custom Resource on the cluster
292-
to take advantage of it:
292+
Great, our updated health check is working! The status is returned as `Healthy` to Argo CD but we set the message field to the
293+
Kubernetes status of the PVC to provide additional context.
294+
295+
Let's go ahead and patch it into our ArgoCD Custom Resource on the cluster to take advantage of it:
293296

294297
[.console-input]
295298
[source,yaml,subs="attributes",role=execute]
296299
----
297300
oc patch -n user{usernum}-argocd argocd argocd --type=merge --patch-file=/home/lab-user/workshop/content/modules/ROOT/examples/health/health-check-patch.yaml
298301
----
299302

300-
Go back Argo CD and press the `Refresh` button
303+
Go back Argo CD and press the `Refresh` button to cause the heath check to be re-evaluated:
301304

302305
image::argocd-refresh.png[]
303306

304-
In twenty to thirty seconds you should see the Refresh complete and the Application properly sync'ed.
307+
In twenty to thirty seconds you should see the Refresh complete and the Application become properly synced.
305308

306309
image::argocd-health-test-synced.png[]
307310

@@ -346,6 +349,8 @@ include::ROOT:example$enable-applicationset/enable-applicationset-patch.yaml[]
346349
There are more configuraton options available then just `enabled`, feel free to explore them
347350
by running `oc explain argocd.spec.applicationSet`.
348351

352+
Apply the patch:
353+
349354
[.console-input]
350355
[source,yaml,subs="attributes",role=execute]
351356
----
@@ -377,26 +382,28 @@ The `applicationset-controller` has now been deployed.
377382
== Enabling Terminal
378383

379384
The Argo CD user interface, when viewing a pod, can optionally show a link:https://argo-cd.readthedocs.io/en/latest/operator-manual/web_based_terminal/[terminal, window="_blank"]
380-
tab similar to what you see in the OpenShift console. This can be useful for Organizations which use the Argo CD UI
381-
as a means for managing kubernetes resources.
385+
tab similar to what you see in the OpenShift console. This can be useful for organizations which use the Argo CD UI
386+
as the primary means for managing Kubernetes resources.
382387

383-
By default this is not enabled, in the health application that was deployed previously click on the
384-
pod.
388+
While we previously gave permissions for the terminal in the previous module, by default this is not enabled. To verify this,
389+
in the health application that was deployed previously click on the pod.
385390

386391
image::argocd-select-pod.png[]
387392

388-
Note that the only tabs available are `SUMMARY`, `EVENTS` and `LOGS`.
393+
Note that the only tabs available are `SUMMARY`, `EVENTS` and `LOGS` with no `TERMINAL` tab appearing.
389394

390395
image::argocd-pod-tabs.png[]
391396

392-
As mentioned previously, not all Argo CD settings are defined in the ArgoCD Custom Resource. For cases
393-
where a setting is not defined, we can use the `extraConfig` to have the operator add these items
397+
As mentioned previously, not all Argo CD settings are defined in the ArgoCD Custom Resource and enabling
398+
the terminal is one of those cases.
399+
400+
For cases like this where a setting is not defined, we can use the `extraConfig` to have the operator add these items
394401
directly to the `argocd-cm` ConfigMap. Whatever is defined, correctly or incorrectly, will be copied
395-
to this configmap so some care should be taken when using this feature.
402+
to this ConfigMap so some care should be taken when using this feature.
396403

397404
[IMPORTANT]
398405
Before using `extraConfig`, you should always validate the option you want to set is not in fact
399-
available in the Operator. Also never edit the `argocd-cm` ConfigMap directly, the operator will
406+
available in the Operator. Also as a reminder never edit the `argocd-cm` ConfigMap directly, the operator will
400407
revert any manual changes.
401408

402409
Review the patch that we are going to apply:
@@ -414,12 +421,12 @@ Apply the patch:
414421
oc patch -n {user}-argocd argocd argocd --type=merge --patch-file=/home/lab-user/workshop/content/modules/ROOT/examples/pod-exec/enable-terminal-patch.yaml
415422
----
416423

417-
Verify that you can now see the terminal tab for the pod resource:
424+
Verify that you can now see the terminal tab for the pod resource, note that you will need to close the Pod view and then re-open it:
418425

419426
image::argocd-terminal.png[]
420427

421428
[IMPORTANT]
422-
As per the Argo CD Documentation, the `argocd-server` ServiceAccount must be granted additional permissions with Kubernetes RBAC
429+
As per the link:https://argo-cd.readthedocs.io/en/latest/operator-manual/web_based_terminal/[Argo CD Documentation, window="_blank"], the `argocd-server` ServiceAccount must be granted additional permissions with Kubernetes RBAC
423430
to enable the terminal. These permissions have already been applied by specifying a custom ClusterRole for the GitOps Operator.
424431

425432
[#config-conclusion]

0 commit comments

Comments
 (0)