[EV-5302] Add set licenseKeyContent file to helm upgrade #1716
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
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@ctauchen could I please get your review? There a number of failures, but from the looks of it they are unrelated to this change. |
ctauchen
reviewed
Oct 11, 2024
| @@ -144,11 +144,13 @@ These steps differ based on your cluster type. If you are unsure of your cluster | |||
| ? ( | |||
| `helm upgrade calico-enterprise --reuse-values --values=<path-to-values-yaml> tigera-operator-v0.0.tgz \\ | |||
| --set-file imagePullSecrets.tigera-pull-secret=<path-to-pull-secret>,tigera-prometheus-operator.imagePullSecrets.tigera-pull-secret=<path-to-pull-secret> \\ | |||
| --set-file licenseKeyContent=<path/to/license/file/yaml> \\ | |||
There was a problem hiding this comment.
Suggested change
| --set-file licenseKeyContent=<path/to/license/file/yaml> \\ | |
| --set-file licenseKeyContent=<path-to-license-file-yaml> \\ |
Just to follow the convention already in this code block and elsewhere in the documentation. Otherwise LGTM.
There was a problem hiding this comment.
@ctauchen Thanks! The paths were updated to using the convention. The commits were squashed
dimitri-nicolo
force-pushed
the
dimitri-EV-5302
branch
from
1d21b25
to
031dd8c
Compare
|
LGTM. Ready to merge? |
Yes please! |
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.
As part of our automation efforts, we eliminated the manual step of adding license.yaml and instead embedded the licenseKey directly into the
helm installcommand. To ensure compatibility, a small template was added to convert the license from v3 to v1, since the CRD is installed before the API server is available. This change made the license resource Helm-managed. Consequently, if the license is not provided during any subsequent helm upgrade, Helm will delete the resource, assuming it's no longer needed.To address this, the following line has been added to the
helm upgradecommand in our documentation:Going forward, the license file must be specified during upgrades.
I considered using the
keepannotation, which instructs Helm to ignore specific files. However, this requires manually updating the license file prior to upgrade, and it introduces side effects—such as Helm disregarding the file duringhelm uninstall. Ultimately, updating our documentation proved to be the cleanest solution.Product Version(s):
[Main][v3.20]
Issue:
https://tigera.atlassian.net/browse/EV-5302
Link to docs preview:
SME review:
DOCS review:
Additional information:
Merge checklist: