helm: add support for history-max parameter #164
Merged
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
The --history-max parameter allows the user to set a maximum amount of revisions per release to be kept in the history. By default helm keeps 10 revisions per release, which means that 10 secrets will be kept per release.
Codecov Report
@@ Coverage Diff @@
## main #164 +/- ##
=======================================
Coverage 24.02% 24.02%
=======================================
Files 1 1
Lines 154 154
Branches 29 29
=======================================
Hits 37 37
- Misses 111 112 +1
+ Partials 6 5 -1
Continue to review full report at Codecov.
|
Akasurde
reviewed
Jul 9, 2021
Akasurde
reviewed
Jul 9, 2021
Akasurde
reviewed
Jul 9, 2021
When the history_max option is not set, the module will not pass '--history-max' to the CLI command. This ensures that the defaults of the helm CLI will alwasy be used.
|
Thanks for you review @Akasurde , I've added your remarks to the PR. Thanks! |
abikouo
approved these changes
Jul 13, 2021
|
Thanks for reviewing @abikouo! |
Should be ok now. |
gravesm
requested changes
Jul 15, 2021
There was a problem hiding this comment.
@vvanouytsel Thank you for the PR! The --history-max option is not supported for helm install which is used when the replace param is set. The history_max and replace parameters will need to be set to mutually exclusive. This can be done here:
kubernetes.core/plugins/modules/helm.py
Line 554 in b32e5cd
kubernetes.core/plugins/modules/k8s.py
Line 65 in b32e5cd
The 'history_max' parameter is not available when using the 'helm install' command, it is only implemented for 'helm ugprade'. The 'replace' option uses the 'install' parameter, thus 'replace' and 'history_max' have to be mutually exclusive.
|
@gravesm Thanks for your review! |
gravesm
requested changes
Jul 15, 2021
This was referenced Sep 16, 2021
softwarefactory-project-zuul bot
pushed a commit
that referenced
this pull request
Apr 26, 2022
Add helm dependency update SUMMARY Execute the helm dependency update under the hood when found dependencies block in Chart.yaml file. Support the execution of: Standalone dependency update by executing: helm dependency update CHART Inline dependency update when specifying the helm chart_repo_url by adding --dependency-update to the helm install command. ISSUE TYPE Feature Pull Request #191 COMPONENT NAME helm, helm_template ADDITIONAL INFORMATION There is a doc generated for history_max option for the helm module. I think that is not generated in the previous PR #164. There is others changes affect the docs/ folder when I run the collection_prep_add_docs -p . command. These changes are added in the last commit 64eab40. I let you decide rather we keep the commit or remove it. The --dependency-update insertion option is tested used a local helm chart repository create via docker. So here are the tasks that test this feature. Maybe if we create a GitHub repository for the helm chart, we can add this test code in the CI pipeline. # Test The update dependency with chart_repo_url - name: "Test chart without dependencies block and chart_repo_url defined" block: - name: "Test chart without dependencies block and chart_repo_url defined" helm: binary_path: "{{ helm_binary }}" name: test chart_ref: "ingress-nginx" chart_repo_url: https://kubernetes.github.io/ingress-nginx chart_version: "{{ chart_source_version | default(omit) }}" namespace: "{{ helm_namespace }}" create_namespace: yes register: release - assert: that: - "'--dependency-update' not in release.command" - "'upgrade' in release.command" success_msg: "Command does not contains '--dependency-update' options" fail_msg: "Command contains '--dependency-update' options" - name: "Test chart with dependencies block and chart_repo_url defined and replace True" block: - name: "Test chart with dependencies block and chart_repo_url defined and replace True" helm: binary_path: "{{ helm_binary }}" name: test1 chart_ref: "dep_up" chart_repo_url: http://repo:8080/charts chart_version: "{{ chart_source_version | default(omit) }}" namespace: "{{ helm_namespace }}" create_namespace: yes replace: true register: release - debug: var=release - assert: that: - "'--dependency-update' in release.command" - "'install' in release.command" success_msg: "Command contains '--dependency-update' options with helm install command" fail_msg: "Command not contains '--dependency-update' with helm install command" - name: "Test chart with dependencies block and chart_repo_url defined and replace False fails" block: - name: "Test chart with dependencies block and chart_repo_url defined and replace False fails" helm: binary_path: "{{ helm_binary }}" name: test2 chart_ref: "dep_up" chart_repo_url: http://repo:8080/charts chart_version: "{{ chart_source_version | default(omit) }}" namespace: "{{ helm_namespace }}" create_namespace: yes replace: false register: release ignore_errors: true - assert: that: - release.failed - release.msg == "'--dependency-update' hasn't been supported yet with 'helm upgrade'. Please use 'helm install' instead by adding 'replace' option" success_msg: "Command build fail when adding '--dependency-update' with the helm upgrade command" Reviewed-by: Mike Graves <[email protected]> Reviewed-by: Wissem BEN CHAABANE <[email protected]> Reviewed-by: Bikouo Aubin <None>
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.
SUMMARY
The --history-max parameter allows the user to set a maximum amount of
revisions per release to be kept in the history.
By default helm keeps 10 revisions per release, which means that 10
secrets will be kept per release. If you have multiple helm releases, the amount of secrets created by Helm will quickly add up.
With supporting the 'history-max' CLI parameter via the ansible module, the user will have the posibility to determine how many revisions he wants to keep per release.
ISSUE TYPE
COMPONENT NAME
plugins/modules/helm.py
ADDITIONAL INFORMATION
Before change:
After change:
Without history_max set:
With history_max set: