Use --app-namespace rather than -n for dedicated option in state-namespace docs #734
Conversation
✅ Deploy Preview for carvel ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Yes! Please, can this be merged - the current docs are pretty misleading. More generally it'd be great in the |
There was a problem hiding this comment.
Thank you for the updates @jfmontanaro!
Your changes look good to me. Could you also make the same changes in the v0.59.0 and v0.60.0 (v0.59.0 was the release where this flag was introduced).
Also, please sign your commits to make the DCO bot happy :)
|
Hi @praveenrewar, happy to do that - I just made the first commit directly on github, so it was signed with github's signature. Is that sufficient or should I sign it with something specific to me? |
|
@jfmontanaro You need to sign the commit with an email that is associated with your GitHub account. You can squash your existing commit with a new commit and sign it. |
…space.md When using a dedicated namespace for state storage, the docs currently suggest specifying this namespace via the 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 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 when storing configs in a separate namespace. Signed-off-by: Joseph Montanaro <[email protected]>
jfmontanaro
force-pushed
the
app-namespace-state-storage
branch
from
7306953 to
8fe5af9
Compare
Signed-off-by: Joseph Montanaro <[email protected]>
|
Got it, sorry. I thought you were talking about some kind of cryptographic signature, since I know that is a thing that Git can do. I've made those changes, so from my perspective everything here is good to go. |
When using a dedicated namespace for state storage, the docs currently suggest specifying this namespace via the
-nflag. 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-namespaceflag, 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-namespacewhen storing configs in a separate namespace.