search

carvel-dev / carvel

Carvel provides a set of reliable, single-purpose, composable tools that aid in your application building, configuration, and deployment to Kubernetes. This repo contains information regarding the Carvel open-source community.
https://carvel.dev/
Apache License 2.0
369 stars 109 forks source link

Use --app-namespace rather than -n for dedicated option in state-namespace docs #734

Closed jfmontanaro closed 3 months ago

jfmontanaro commented 3 months ago

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 https://github.com/carvel-dev/kapp/issues/815 and fixed in https://github.com/carvel-dev/kapp/pull/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.

netlify[bot] commented 3 months ago

Deploy Preview for carvel ready!

Name Link
Latest commit a6f89fa097e9ebb9cf228f40991409d3518a6ac2
Latest deploy log https://app.netlify.com/sites/carvel/deploys/65f0c7ecb26c5200080d0e8d
Deploy Preview https://deploy-preview-734--carvel.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

judahrand commented 3 months ago

Yes! Please, can this be merged - the current docs are pretty misleading.

More generally it'd be great in the --app-namespace could be added to the docs in all the relevant places. Currently it doesn't seem to appear anywhere.

jfmontanaro commented 3 months ago

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?

praveenrewar commented 3 months ago

@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. Details

jfmontanaro commented 3 months ago

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.