Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HIP for setting AppVersion during install/upgrade #315

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+70 −0
Open

HIP for setting AppVersion during install/upgrade #315

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions hips/hip-00N.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
hip: "00N"
title: "Override AppVersion during install/upgrade"
authors: [ "Jason D'Amour <[email protected]>" ]
created: "2023-09-26"
type: "feature"
status: "draft"
---

_Ah, HIPs. Where good ideas come to be killed by beaurocracy_

## Abstract

Helm offers a means to reuse charts with different versions of an app. Literally the most basic functionality of this tool is something like `helm install some-chart --set image.tag=<version>`. So since Helm has its own fields documenting the AppVersion, that should be capable of being overriden also.

## Motivation

Currently, the only way to change AppVersion is to modify Chart.yaml. That is an even bigger problem when using a remote chart from a repository.

Currently without the ability of changing appVersion on upgrade, the result of helm history is:
```
REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION
1 Mon Jun 8 11:39:51 2020 superseded spring-1.0.0 1.0.0 Install complete
2 Mon Jun 8 12:19:21 2020 superseded spring-1.0.0 1.0.0 Upgrade complete
3 Mon Jun 8 12:20:51 2020 deployed spring-1.0.0 1.0.0 Upgrade complete
```
Ideally running
```
helm upgrade --app-version "$MY_AWESOME_VERSION" app ./chart
```

Wold result in a more user friendly helm history, like the one below. That shows that the chart has not changed but the app had new releases.
```
REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION
1 Mon Jun 8 11:39:51 2020 superseded spring-1.0.0 1.0.1 Install complete
2 Mon Jun 8 12:19:21 2020 superseded spring-1.0.0 1.0.2 Upgrade complete
3 Mon Jun 8 12:20:51 2020 deployed spring-1.0.0 1.0.3 Upgrade complete
```


## Rationale

The flag should be `--set-app-version` rather than `--app-version`, because `--app-version` could potentially be used in the future to request charts which provide that AppVersion, rather than overriding AppVersion for a specific chart.

## Specification

Add new flag `--set-app-version` to helm upgrade and helm install which sets .Chart.AppVersion on the installed release. If the chart is local, then `Chart.yaml` is updated.

## Backwards compatibility

No impact to existing workflows, its a new flag with new functionality

## Security implications

A bad actor could potentially make Helm a useful tool by accident

## How to teach this

Docs

## Open issues

- https://github.com/helm/helm/issues/8194
- Direct parent of HIP
- 95👍 at time-of-lock
- 500+👍 on the whole thread
- https://github.com/helm/helm/issues/3555
- This discussion opened the valid point of using `AppVersion` to filter for valid remote charts to install, similar to the existing `--version` flag.
- I left the `--app-version` moniker available for this potential feature, since `--version` and `--app-version` are both _request_ flags. `--set-app-version` is a directive.