H4HIP: Adding a HIP on charts v3 #381
Conversation
hips/hip-0000.md
Outdated
|
|
||
| ## Abstract | ||
|
|
||
| This HIP proposes the creation of charts v3, updating Helm to handle charts v2 and v3, and a |
There was a problem hiding this comment.
The only problem, is we don't quite know what v3 would look like yet I think.
So we should aim to support both v2 and a future (or "placeholder") v3?
There was a problem hiding this comment.
This HIP proposes adding a new apiVersion for charts without removing any existing versions. The design enables multiple apiVersions of charts, with significant differences, to be handled by Helm.
We must ensure existing charts continue to work so we cannot remove the old apiVersion without breaking that. If the existing code for the existing apiVersion is massively changed it will be difficult to ensure charts don't break across apiVersions.
hips/hip-0000.md
Outdated
|
|
||
| Describe the syntax and semantics of any new feature. | ||
|
|
||
|
|
There was a problem hiding this comment.
Agree with Geroge's comment here #381 (comment), as well as Matt's rationale for getting a HIP on this in place. Perhaps we should say that outright here. Something like this?
| TBD while this HIP is in draft mode. This allows us to acknowledge and make a promise for charts API v2 backwards compatibility in Helm 4 while leaving space for the upcoming radical changes we have not yet decided on. |
There was a problem hiding this comment.
I massively updated the HIP. The whole idea is to enable major changes to charts while ensuring existing charts continue to work without a problem.
|
Some things the new |
| To illustrate this, while in development the `chart` package will have the following structure: | ||
|
|
||
| ``` | ||
| internal/chart |
There was a problem hiding this comment.
I suspect a new chart version, will also warrant a new release version.
As such, we will also want pkg/release/{v2,v3}
(Eventually, also code which will turn a chart v3 into a release v3. But I think the structure of that code can be left for another day)
There was a problem hiding this comment.
Good call. Updated
hips/hip-0020.md
Outdated
| ## Backwards compatibility | ||
|
|
||
| This development and process is designed with backwards compatibility in mind. The package | ||
| locations will change, which is ok in a major version of Rancher. The existing charts will be preserved |
There was a problem hiding this comment.
| locations will change, which is ok in a major version of Rancher. The existing charts will be preserved | |
| locations will change, which is ok in a major version of Helm. The existing charts will be preserved |
:)
There was a problem hiding this comment.
oops. You have no idea how often I type that.
Signed-off-by: Matt Farina <[email protected]>
mattfarina
force-pushed
the
charts-v3
branch
from
e5c7a96 to
acf714c
Compare
This HIP outlines creating a new chart version of v3 to enable some more radical changes without disrupting current charts and the Helm 4 timeline.