Skip to content

Commit 7306953

Browse files
authored
Use --app-namespace rather than -n for dedicated option in state-namespace.md
When using a dedicated namespace for state storage, the docs currently suggest specifying this namespace via the `-n` flag. However this can lead to undesirable behaviors, since the app is typically being deployed to a different namespace. In my case, I had a resource where I had neglected to specify the namespace, and it would have ended up getting deployed to the state-storage namespace rather than the same namespace as the rest of the app. This was discussed in carvel-dev/kapp#815 and fixed in carvel-dev/kapp#814 with the introduction of the `--app-namespace` flag, which controls which is used for state storage independently of the app namespace. However the docs did not reflect this change. This commit adjusts the documentation to recommend using `--app-namespace` when storing configs in a separate namespace.
1 parent 4f0489d commit 7306953

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

site/content/kapp/docs/develop/state-namespace.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Namespace for State Storage
66

77
To show list of deployed applications (via `kapp ls`), kapp manages metadata `ConfigMap` for each saved application. Each metadata `ConfigMap` contains generated label used to label all application resources. Additionally kapp creates `ConfigMap` per each deploy to record deployment history (seen via `kapp app-change list -a app1`).
88

9-
`-n` (`--namespace`) flag allows to control which namespace is used for finding and storing metadata `ConfigMaps`. If namespace is not explicitly specified your current namespace is selected from kube config (typically `~/.kube/config`).
9+
`--app-namespace` flag allows to control which namespace is used for finding and storing metadata `ConfigMaps`. If namespace is not explicitly specified the app-wide namespace is used as specified by `-n` or `--namespace`); if `-n` is not specified your current namespace is selected from kube config (typically `~/.kube/config`).
1010

1111
There are currently two approaches to deciding which namespace to use for storing metadata `ConfigMaps`:
1212

@@ -22,8 +22,8 @@ There are currently two approaches to deciding which namespace to use for storin
2222

2323
```bash
2424
$ kubectl create ns apps
25-
$ kapp deploy -n apps -f app1/config.yml
26-
$ kapp deploy -n apps -f app2/config.yml
25+
$ kapp deploy --app-namespace apps -f app1/config.yml
26+
$ kapp deploy --app-namespace apps -f app2/config.yml
2727
$ kapp ls -n apps
2828
```
2929

0 commit comments

Comments
 (0)