Skip to content

Commit 21a4781

Browse files
committed
docs: update the documentation on how to skip deploying an app
Fix up the documentation to reference how the appsets have mutated on how to skip an application from being deployed.
1 parent 471c508 commit 21a4781

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

docs/deploy-guide/add-remove-app.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,16 @@ in your deployment repo.
2323

2424
## Removing an application for a specific deploy
2525

26-
To remove an application from being deployed, add or modify the `uc_skip_components`
27-
annotation on the Kubernetes Secret which defines the cluster in the `argocd` namespace.
28-
The `uc_skip_components` annotation is a string-ified JSON list of applications to
29-
skip like:
26+
To remove an application from being deployed, create an `apps.yaml` file in your deployment
27+
repo at `$DEPLOY_NAME/apps.yaml`). The `apps.yaml` file
28+
contains a list of objects, where each object has a `component` field that is the name
29+
of the component (app) and an optional `skip` field that can be set to `true`:
3030

3131
```yaml
32-
uc_skip_components: |
33-
["metallb"]
32+
- component: metallb
33+
skip: true
34+
- component: dex
35+
skip: false # optional, defaults to false
3436
```
3537
3638
## Adding an application to UnderStack

docs/deploy-guide/management-cluster.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,6 @@ different configurations.
9494
: Git reference to use of the deploy repo. Can only be set for `dev` env
9595
clusters.
9696

97-
`uc_skip_components`
98-
: string-ified JSON list of components or services from UnderStack to not
99-
install in this cluster.
100-
10197
### Deploying your Cluster Config
10298

10399
Once you have the Kubernetes secret which defines your cluster config ready

0 commit comments

Comments
 (0)