@@ -37,54 +37,52 @@ of the component (app) and an optional `skip` field that can be set to `true`:
37
37
38
38
## Adding an application to UnderStack
39
39
40
- Adding an application to be part of UnderStack involves modifying the
41
- ` apps/appsets/*.yaml` file that is appropriate for what you are attempting to add.
40
+ Adding an application to UnderStack involves deciding on the correct ApplicationSet
41
+ (AppSet) to include it in, then going to that AppSet's directory in ` apps/<appset>/`
42
+ and adding a YAML file which contains the application configuration.
42
43
43
- The general form should be :
44
+ The YAML file should contain :
45
+
46
+ - A `component` field that matches the application name
47
+ - All sources necessary to load the application
48
+ - A `ref` field set to either `understack` or `deploy` instead of explicitly
49
+ specifying `repoURL` and `targetRevision` for the UnderStack repo and your deploy repo
50
+
51
+ Example application configuration :
44
52
45
53
{% raw %}
46
54
47
55
` ` ` yaml
48
- # list item per ArgoCD Application
49
- # the component value will appear as the ArgoCD Application name
50
- - component: dex
51
- # the below line can be added to install this into a different namespace than the component
52
- # componentNamespace: dex-system
53
- # this allows this component to not be installed
54
- skipComponent: '{{has "dex" ((default "[]" (index .metadata.annotations "uc_skip_components") | fromJson))}}'
55
- # defines all the sources used, the upstream chart or upstream source should come first
56
- # uc_repo_ in this context is the understack repo
57
- # uc_deploy_ in this context is the deploy specific repo
58
- sources:
59
- - repoURL: https://charts.dexidp.io
60
- chart: dex
61
- targetRevision: 0.16.0
62
- helm:
63
- releaseName: dex
64
- valueFiles:
65
- # this pulls defaults from the understack repo
66
- - $understack/components/dex/values.yaml
67
- # this pulls overrides from your deploy repo
68
- - $deploy/{{.name}}/helm-configs/dex.yaml
69
- # this makes it so the above don't have to exist
70
- ignoreMissingValueFiles: true
71
- - repoURL: '{{index .metadata.annotations "uc_repo_git_url"}}'
72
- targetRevision: '{{index .metadata.annotations "uc_repo_ref"}}'
73
- # path should only be here if you have manifests you want loaded
74
- path: 'components/dex'
75
- # ref is used above in the chart for the valueFiles
76
- ref: understack
77
- - repoURL: '{{index .metadata.annotations "uc_deploy_git_url"}}'
78
- targetRevision: '{{index .metadata.annotations "uc_deploy_ref"}}'
79
- # ref is used in the chart valueFiles
80
- ref: deploy
81
- # only needed if manifests should be here
82
- path: '{{.name}}/manifests/dex'
56
+ component: dex
57
+ # optional: install into a different namespace than the component name
58
+ # componentNamespace: dex-system
59
+ sources:
60
+ - repoURL: https://charts.dexidp.io
61
+ chart: dex
62
+ targetRevision: 0.16.0
63
+ helm:
64
+ releaseName: dex
65
+ valueFiles:
66
+ # pulls defaults from the understack repo
67
+ - $understack/components/dex/values.yaml
68
+ # pulls overrides from your deploy repo
69
+ - $deploy/{{.name}}/helm-configs/dex.yaml
70
+ ignoreMissingValueFiles: true
71
+ - ref: understack
72
+ # path should only be here if you have manifests to load
73
+ path: 'components/dex'
74
+ - ref: deploy
75
+ # only needed if manifests should be here
76
+ path: '{{.name}}/manifests/dex'
83
77
` ` `
84
78
85
79
{% endraw %}
86
80
87
81
# # Removing an application from UnderStack
88
82
83
+ Removing an application permanently from UnderStack is as easy as
84
+ deleting its YAML config from its AppSet in the `apps/<appset>/`
85
+ directory.
86
+
89
87
[argocd] : <https://argo-cd.readthedocs.io/en/stable/>
90
88
[argocd-appset] : <https://argo-cd.readthedocs.io/en/stable/operator-manual/applicationset/>
0 commit comments