Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Small edits to docs/user-guide/application-set.md #17434

Merged
merged 2 commits into from
Mar 7, 2024
Merged

docs: Small edits to docs/user-guide/application-set.md #17434

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c54ff37
Update application-set.md
ndouglas Mar 7, 2024
a521397
Make example code consistent with examples elsewhere.
ndouglas Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/user-guide/application-set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
### Automating the generation of Argo CD Applications with the ApplicationSet Controller

The [ApplicationSet controller](../operator-manual/applicationset/index.md) is a part of Argo CD adds Application automation, and seeks to improve multi-cluster support and cluster multitenant support within Argo CD. Argo CD Applications may be templated from multiple different sources, including from Git or Argo CD's own defined cluster list.
The [ApplicationSet controller](../operator-manual/applicationset/index.md) adds Application automation and seeks to improve multi-cluster support and cluster multitenant support within Argo CD. Argo CD Applications may be templated from multiple different sources, including from Git or Argo CD's own defined cluster list.

The set of tools provided by the ApplicationSet controller may also be used to allow developers (without access to the Argo CD namespace) to independently create Applications without cluster-administrator intervention.

!!! warning
Be aware of the [security implications](../operator-manual/applicationset/Security.md) before allowing developers to
create Applications via ApplicationSets.

The ApplicationSet controller is installed alongside Argo CD (within the same namespace), and the controller automatically generates Argo CD Applications based on the contents of a new `ApplicationSet` Custom Resource (CR).
The ApplicationSet controller automatically generates Argo CD Applications based on the contents of an `ApplicationSet` Custom Resource (CR).

Here is an example of an `ApplicationSet` resource that can be used to target an Argo CD Application to multiple clusters:
```yaml
Expand All @@ -17,6 +17,8 @@ kind: ApplicationSet
metadata:
name: guestbook
spec:
goTemplate: true
goTemplateOptions: ["missingkey=error"]
generators:
- list:
elements:
Expand All @@ -28,15 +30,15 @@ spec:
url: https://9.8.7.6
template:
metadata:
name: '{{cluster}}-guestbook'
name: '{{.cluster}}-guestbook'
spec:
project: default
project: my-project
source:
repoURL: https://github.com/argoproj/argo-cd.git
repoURL: https://github.com/infra-team/cluster-deployments.git
targetRevision: HEAD
path: applicationset/examples/list-generator/guestbook/{{cluster}}
path: guestbook/{{.cluster}}
destination:
server: '{{url}}'
server: '{{.url}}'
namespace: guestbook
```

Expand All @@ -46,6 +48,4 @@ Likewise, changes made to the ApplicationSet `template` fields will automaticall

Within ApplicationSet there exist other more powerful generators in addition to the List generator, including the Cluster generator (which automatically uses Argo CD-defined clusters to template Applications), and the Git generator (which uses the files/directories of a Git repository to template applications).

To learn more about the ApplicationSet controller, check out [ApplicationSet documentation](../operator-manual/applicationset/index.md) to install the ApplicationSet controller alongside Argo CD.

**Note:** Starting `v2.3` of Argo CD, we don't need to install ApplicationSet Controller separately. It would be instead as part of Argo CD installation.
To learn more about the ApplicationSet controller, check out the [ApplicationSet documentation](../operator-manual/applicationset/index.md).
Loading