Skip to content

Commit c5b11fb

Browse files
Merge pull request #1252 from rackerlabs/update-app-guide
docs: update information on adding and removing components
2 parents 9cbe37c + e482815 commit c5b11fb

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

docs/deploy-guide/add-remove-app.md renamed to docs/design-guide/add-remove-app.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ UnderStack **Components** are deployed via [ArgoCD]
44
as [Applications][argocd-app], these are generated using [ArgoCD][argocd]'s
55
[ApplicationSet][argocd-appset] controller. This allows us to use common
66
patterns to deploy each of the components and allow specific environments
7-
to modify or disable some components. See the [Configuring Components](./component-config.md)
7+
to modify or disable some components. See the [Configuring Components](../deploy-guide/component-config.md)
88
guide for more info on how to do so.
99

1010
## Adding a Component to UnderStack
@@ -50,12 +50,26 @@ sources:
5050
5151
{% endraw %}
5252
53+
### Configuring the namespace
54+
55+
If the namespace you'll be adding the component to is currently not in
56+
use, you will have to add it to the appropriate AppProject for the
57+
ApplicationSet in one of the following:
58+
59+
- `apps/appsets/project-understack-infra.yaml`
60+
- `apps/appsets/project-understack-operators.yaml`
61+
- `apps/appsets/project-understack.yaml`
62+
5363
## Removing an application from UnderStack
5464

5565
Removing a Component permanently from UnderStack is as easy as
5666
deleting its YAML config from its AppSet in the `apps/<appset>/`
5767
directory.
5868

69+
!!! note
70+
Remove the namespace from the AppProject if it is no longer
71+
in use.
72+
5973
[argocd]: <https://argo-cd.readthedocs.io/en/stable/>
6074
[argocd-app]: <https://argo-cd.readthedocs.io/en/stable/user-guide/application-specification/>
6175
[argocd-appset]: <https://argo-cd.readthedocs.io/en/stable/operator-manual/applicationset/>

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ nav:
119119
- component-ansible.md
120120
- 'Design Guide':
121121
- design-guide/intro.md
122+
- design-guide/add-remove-app.md
122123
- design-guide/neutron-networking.md
123124
- design-guide/argo-workflows.md
124125
- design-guide/argo-events.md
@@ -142,7 +143,6 @@ nav:
142143
- deploy-guide/troubleshooting.md
143144
- Further Actions:
144145
- deploy-guide/extra-sites.md
145-
- deploy-guide/add-remove-app.md
146146
- deploy-guide/override-openstack-svc-config.md
147147
- 'Operator Guide':
148148
- operator-guide/index.md

0 commit comments

Comments
 (0)