✨ Add support for deploying OCI helm charts in OLM v1 #1971
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1971 +/- ##
==========================================
+ Coverage 74.66% 74.74% +0.07%
==========================================
Files 81 82 +1
Lines 7365 7530 +165
==========================================
+ Hits 5499 5628 +129
- Misses 1528 1553 +25
- Partials 338 349 +11
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
OchiengEd
force-pushed
the
helm_explorations
branch
from
3b36dfb to
272dcbf
Compare
OchiengEd
force-pushed
the
helm_explorations
branch
from
272dcbf to
39948a0
Compare
OchiengEd
force-pushed
the
helm_explorations
branch
4 times, most recently
from
6dfc6c0 to
059008d
Compare
|
When pulling a Helm chart with a provenance file, at this time we have chosen to skip pulling the layer to the cache filesystem since we have no logic in place at this time to verify the chart integrity. operator-controller/internal/shared/util/image/helm.go Lines 62 to 65 in 059008d |
OchiengEd
requested review from
joelanford,
camilamacedo86,
trgeiger and
kevinrizza
OchiengEd
force-pushed
the
helm_explorations
branch
2 times, most recently
from
797bddb to
85f9e44
Compare
OchiengEd
force-pushed
the
helm_explorations
branch
from
036e4c8 to
0dfea34
Compare
| @@ -209,6 +211,17 @@ func (h *Helm) buildHelmChart(bundleFS fs.FS, ext *ocv1.ClusterExtension) (*char | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| if features.OperatorControllerFeatureGate.Enabled(features.HelmChartSupport) { | |||
There was a problem hiding this comment.
We've been trying to put the feature checks in main. Wdyt about refactoring to have another implementation of the BundleToHelmChart converter that accepts chart bundles, or maybe that can route between different bundle types? Then if the feature gate is enabled, use that one?
There was a problem hiding this comment.
I do not have any concerns with having feature checks in main. I think that would be the ideal scenario as it would allow for feature-gated functionality to be tested at build time.
Trying to look at the issue from afar, our challenge in this case is we are trying to run tests on a feature gated function, pullChart() while we are not allowing a portion of the code in the cache's Store() method not to run since the feature gate is not enabled. The big question therefore is how do we navigate this quandary?
There was a problem hiding this comment.
I do not have any concerns with having feature checks in main. I think that would be the ideal scenario as it would allow for feature-gated functionality to be tested at build time.
We are working towards to it
See; #1980
We will use the experimental CRD and have all feature flags enabled for our e2e tests.
OchiengEd
force-pushed
the
helm_explorations
branch
2 times, most recently
from
fb98756 to
78069c9
Compare
internal/shared/util/image/cache.go
Outdated
| if layer.MediaType == registry.ChartLayerMediaType { | ||
| if features.OperatorControllerFeatureGate.Enabled(features.HelmChartSupport) || testing.Testing() { | ||
| if err := storeChartLayer(dest, layer); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| } else { | ||
| if _, err := archive.Apply(ctx, dest, layer.Reader, applyOpts...); err != nil { | ||
| return fmt.Errorf("error applying layer[%d]: %w", layer.Index, err) | ||
| } |
There was a problem hiding this comment.
I may have mentioned this elsewhere. If I did, apologies for repeating myself...
I feel like a better way of handling this would be to register handlers for media types. Then this section of the code would lookup the media type of the layer and then call whatever handler is found (or error if there isn't one).
With that setup, the registration of the helm chart media type/handler would be feature gated, but this code would not.
There was a problem hiding this comment.
Code has been refactored. Hopefully I got your suggestion right.
OchiengEd
force-pushed
the
helm_explorations
branch
from
78069c9 to
742cb8a
Compare
OchiengEd
force-pushed
the
helm_explorations
branch
from
742cb8a to
46af89e
Compare
There was a problem hiding this comment.
Thank you a lot for your contribution 🥇
I’m OK with the changes 👍 Well done 🎉
/lgtm
IHMO: It is an initial implementation, and as follow-up, I think we need to do:
- Documentation (docs/draft) and a demo automated for this one
- A discussion around the remaining caveats, particularly how we plan to store the Helm chart bundle in the catalog via OPM
Would be great to get a PTAL from or at least one of them @joelanford, @thetechnick, and @perdasilva before get this one merged.
Thank you 🙌
|
Hi @OchiengEd, Just to clarify: In the F2F, we talked about using a single internal type and converting everything to it. We also discussed having only one runtime—Buxcutter. PoC: #1946 Supporting Helm fully will take time, and it is a big journey as we have been discussing. There are still open questions and blockers. If we go with this approach (internal format), we probably want OPM/OLM to support the internal type first before anything else. I created an internal Slack channel so that we can discuss all details and caveats. I’m OK merging this since it’s behind a feature gate—safe to experiment and doesn’t break anything. But it may change later. PS: If we get it merged, it would be great to have a small doc with automated demo steps (as done for others feature gates), so people can understand what was done and iterate Leaving final call to @joelanford, @thetechnick, and @perdasilva. 🔨 |
|
@OchiengEd @itroyano |
OchiengEd
force-pushed
the
helm_explorations
branch
from
46af89e to
c6c3ca8
Compare
|
New changes are detected. LGTM label has been removed. |
* added support for deploying OCI helm charts which sits behind the HelmChartSupport feature gate * extend the Cache Store() method to allow storing of Helm charts * inspect chart archive contents * added MediaType to the LayerData struct Signed-off-by: Edmund Ochieng <[email protected]>
Signed-off-by: Edmund Ochieng <[email protected]>
Signed-off-by: Edmund Ochieng <[email protected]>
OchiengEd
force-pushed
the
helm_explorations
branch
from
c6c3ca8 to
02f39cc
Compare
|
@camilamacedo86 @tmshort The documentation and feature-gated APIs concerns should be resolved. Kindly review and advice if anything else is needed at this time. |
| To enable the Helm Chart support feature gate, you need to patch the `operator-controller-controller-manager` deployment in the `olmv1-system` namespace. This will add the `--feature-gates=HelmChartSupport=true` argument to the manager container. | ||
|
|
||
| 1. **Create a patch file:** | ||
|
|
||
| ```bash | ||
| $ kubectl patch deployment -n olmv1-system operator-controller-controller-manager --type='json' -p='[{"op": "add", "path": "/spec/template/spec/containers/0/args/-", "value": "--feature-gates=HelmChartSupport=true"}]' | ||
| ``` | ||
|
|
||
| 2. **Wait for the controller manager pods to be ready:** | ||
|
|
||
| ```bash | ||
| $ kubectl -n olmv1-system wait --for condition=ready pods -l control-plane=operator-controller-controller-manager | ||
| ``` | ||
|
|
||
| Once the above wait condition is met, the `HelmChartSupport` feature gate should be enabled in operator controller. |
There was a problem hiding this comment.
There is a run-experimental make target that can be used to run this (of course it includes all other experimental features as well).
You might want to mention this alternative method.
There was a problem hiding this comment.
Good catch. Can we do a small revision after the PR is merged? I'm hesitant to add a change and kick out the one approval we have at this time.
|
The changes to the manifests look good! |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tmshort The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
Description
This pull request aims to add logic to OLM v1 for handling OCI Helm chart support. We expect more work to go into this feature as further discussion on this occurs on issue #962 and the Arbitrary Configuration RFC which may inform how
values.ymlwould be passed to Helm charts.Reviewer Checklist