Skip to content
This repository was archived by the owner on Oct 19, 2024. It is now read-only.

Commit 2fb3326

Browse files
author
Alexander Matyushentsev
authored
docs: improve kustomization getting started guide (#265)
Signed-off-by: Alexander Matyushentsev <[email protected]>
1 parent 9918a87 commit 2fb3326

File tree

2 files changed

+21
-36
lines changed

2 files changed

+21
-36
lines changed

docs/index.md

Lines changed: 17 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,23 @@ kubectl patch app <my-app> -n argocd -p '{"metadata": {"annotations": {"notifica
5151

5252
Try syncing and application and get the notification once sync is completed.
5353

54+
## Kustomize Getting Started
55+
56+
The argocd-notification manifests can also be installed using [Kustomize](https://kustomize.io/). To install
57+
argocd-notifications, we recommend using the remote kustomize resource:
58+
59+
```yaml
60+
apiVersion: kustomize.config.k8s.io/v1beta1
61+
kind: Kustomization
62+
63+
namespace: argocd
64+
resources:
65+
- https://raw.githubusercontent.com/argoproj-labs/argocd-notifications/stable/manifests/install.yaml
66+
67+
patchesStrategicMerge:
68+
- https://raw.githubusercontent.com/argoproj-labs/argocd-notifications/stable/catalog/install.yaml
69+
```
70+
5471
## Helm v3 Getting Started
5572
5673
argocd-notifications is now on [Helm Hub](https://hub.helm.sh/charts/argo/argocd-notifications) as a Helm v3 chart, making it even easier to get started as
@@ -66,37 +83,3 @@ helm install argo/argocd-notifications --generate-name \
6683
```
6784

6885
For more information or to contribute, check out the [argoproj/argo-helm repository](https://github.com/argoproj/argo-helm/tree/master/charts/argocd-notifications).
69-
70-
## Kustomize Getting Started
71-
72-
argocd-notification manifests can also be installed using [Kustomize](https://kustomize.io/). To install
73-
argocd-notifications, we recommended saving a tagged release of the `install.yaml`:
74-
75-
```shell
76-
curl -o argocd-notifications-v1.1.0-install.yaml https://raw.githubusercontent.com/argoproj-labs/argocd-notifications/v1.1.0/manifests/install.yaml
77-
```
78-
79-
The tagged release should then be included in a `kustomization.yaml`:
80-
```yaml
81-
namespace: argocd
82-
resources:
83-
- argocd-notifications-v1.1.0-install.yaml
84-
```
85-
86-
If you would like to also install Triggers and Templates from the Catalog, we recommend
87-
saving a tagged release of the catalog `install.yaml`:
88-
89-
```shell
90-
curl -o argocd-notifications-catalog-v1.1.0-install.yaml https://raw.githubusercontent.com/argoproj-labs/argocd-notifications/v1.1.0/catalog/install.yaml
91-
```
92-
93-
The tagged release should then be patched into the base argocd-notifications install
94-
manifest in your `kustomization.yaml`:
95-
96-
```yaml
97-
namespace: argocd
98-
resources:
99-
- argocd-notifications-v1.1.0-install.yaml
100-
patchesStrategicMerge:
101-
- argocd-notifications-catalog-v1.1.0-install.yaml
102-
```

docs/triggers.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
The trigger defines the condition when the notification should be sent. The definition includes name, condition
2-
and notification templates reference.
2+
and notification templates reference. The condition is a predicate expression that returns true if the notification
3+
should be sent. The trigger condition evaluation is powered by [antonmedv/expr](https://github.com/antonmedv/expr).
4+
The condition language syntax is described at [Language-Definition.md](https://github.com/antonmedv/expr/blob/master/docs/Language-Definition.md).
35

46
The trigger is configured in `argocd-notifications-cm` ConfigMap. For example the following trigger sends a notification
5-
when application sync status changes to `Unknown` using `app-sync-status` template:
7+
when application sync status changes to `Unknown` using the `app-sync-status` template:
68

79
```yaml
810
apiVersion: v1

0 commit comments

Comments
 (0)