fix: add the namespace resource within helm templates #1332
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is unfortunate workaround due the difference in UX between `helm template` and `helm install` The project recommends `helm install` as a way to install EG which supports a `--create-namespace` flag to create a namespace However we also generate a static YAML using `helm template` as part of the release artficat so a user can install the YAML directly using `kubectl` instead of `helm` . The issue here is `helm template` does not support `--create-namespace`, so instead this commit adds a knob called `createNamespace` to the Helm chart which is `false` by default, but turned on during `make generate-manifests` Fixes: envoyproxy#1307 Signed-off-by: Arko Dasgupta <arko@tetrate.io>
Codecov Report
@@ Coverage Diff @@
## main #1332 +/- ##
==========================================
+ Coverage 61.80% 61.82% +0.01%
==========================================
Files 85 85
Lines 10853 10854 +1
==========================================
+ Hits 6708 6710 +2
Misses 3699 3699
+ Partials 446 445 -1 see 3 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
zirain
reviewed
Apr 20, 2023
| @@ -0,0 +1,6 @@ | |||
| {{ if .Values.createNamespace }} | |||
There was a problem hiding this comment.
maybe I'm out of date, I recall it's not a good practice to put namespace in a helm chart.
There was a problem hiding this comment.
it is not, but we are using helm as the source of truth for manifest templates, in the previous release it was kustomize
- for the common case using
helm installwe skip this file (createNamespaceisfalse) - for the manifest generation case to support install via 1 single YAML, we rely on it
zirain
approved these changes
Apr 20, 2023
Xunzhuo
approved these changes
Apr 20, 2023
|
Thanks @arkodg |
AliceProxy
pushed a commit
that referenced
this pull request
Apr 24, 2023
Add the namespace resource within helm templates This is unfortunate workaround due the difference in UX between `helm template` and `helm install` The project recommends `helm install` as a way to install EG which supports a `--create-namespace` flag to create a namespace However we also generate a static YAML using `helm template` as part of the release artficat so a user can install the YAML directly using `kubectl` instead of `helm` . The issue here is `helm template` does not support `--create-namespace`, so instead this commit adds a knob called `createNamespace` to the Helm chart which is `false` by default, but turned on during `make generate-manifests` Fixes: #1307 Signed-off-by: Arko Dasgupta <arko@tetrate.io> (cherry picked from commit 9d6d699) Signed-off-by: AliceProxy <alicewasko@datawire.io>
AliceProxy
added a commit
that referenced
this pull request
Apr 24, 2023
* Extension: fix pointer error (#1323) (cherry picked from commit 2bf9607) Signed-off-by: AliceProxy <alicewasko@datawire.io> * fix: add the namespace resource within helm templates (#1332) Add the namespace resource within helm templates This is unfortunate workaround due the difference in UX between `helm template` and `helm install` The project recommends `helm install` as a way to install EG which supports a `--create-namespace` flag to create a namespace However we also generate a static YAML using `helm template` as part of the release artficat so a user can install the YAML directly using `kubectl` instead of `helm` . The issue here is `helm template` does not support `--create-namespace`, so instead this commit adds a knob called `createNamespace` to the Helm chart which is `false` by default, but turned on during `make generate-manifests` Fixes: #1307 Signed-off-by: Arko Dasgupta <arko@tetrate.io> (cherry picked from commit 9d6d699) Signed-off-by: AliceProxy <alicewasko@datawire.io> --------- Signed-off-by: Arko Dasgupta <arko@tetrate.io> Signed-off-by: AliceProxy <alicewasko@datawire.io> Co-authored-by: Arko Dasgupta <arkodg@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an unfortunate workaround due the difference in UX between
helm templateandhelm installThe project recommends
helm installas a way to install EG which supports a--create-namespaceflag to create a namespace However we also generate a static YAML usinghelm templateas part of the release artifact so a user can install the YAML directly usingkubectlinstead ofhelm. The issue here ishelm templatedoes not support--create-namespace, so instead this commit adds a knob calledcreateNamespaceto the Helm chart which isfalseby default, but turned on duringmake generate-manifestsFixes: #1307