Add Helm as a bundle MediaType #25

Bowenislandsong · 2020-05-28T17:15:54Z

This enhancement extend OLM's ability to accept helm charts as bundle mediatype where raw helm charts can be consumed by OLM.

njhale

Thanks for writing this up. Some initial comments.

njhale · 2020-05-28T19:54:10Z

enhancements/helm-mediatype.md

+## Open Questions [optional]
+
+ - How to reflect helm's [chart dependencies](https://helm.sh/docs/topics/charts/#chart-dependencies) either `from a registry` or `provided`?
+ - Is it OLM's responsibility to deploy provided dependent charts?


Suggested change

- Is it OLM's responsibility to deploy provided dependent charts?

- Is it OLM's responsibility to deploy chart dependencies?

njhale · 2020-05-28T19:54:16Z

enhancements/helm-mediatype.md

+
+ - How to reflect helm's [chart dependencies](https://helm.sh/docs/topics/charts/#chart-dependencies) either `from a registry` or `provided`?
+ - Is it OLM's responsibility to deploy provided dependent charts?
+ - Charts deprecation and where to reflect that in the bundle? [Deprecate Charts]() [Deprecate APIs](https://helm.sh/docs/topics/kubernetes_apis/)


We first need to ask whether bundles support this feature.

njhale · 2020-05-28T19:54:19Z

enhancements/helm-mediatype.md

+ - How to reflect helm's [chart dependencies](https://helm.sh/docs/topics/charts/#chart-dependencies) either `from a registry` or `provided`?
+ - Is it OLM's responsibility to deploy provided dependent charts?
+ - Charts deprecation and where to reflect that in the bundle? [Deprecate Charts]() [Deprecate APIs](https://helm.sh/docs/topics/kubernetes_apis/)
+ - CRDs from helm charts are all provided with Helm 3 with the deprecation of crd-install hooks, we should not need to support versions before Helm 3.


this is a statement

njhale · 2020-05-28T19:54:22Z

enhancements/helm-mediatype.md

+ - Is it OLM's responsibility to deploy provided dependent charts?
+ - Charts deprecation and where to reflect that in the bundle? [Deprecate Charts]() [Deprecate APIs](https://helm.sh/docs/topics/kubernetes_apis/)
+ - CRDs from helm charts are all provided with Helm 3 with the deprecation of crd-install hooks, we should not need to support versions before Helm 3.
+ - Not all Helm capabilities are supported. Creating methods of vetting if a helm chart is usable for OLM. Is there anything else to consider other than the provided kinds of Kube manifests and the existence of required CSV information?


Suggested change

- Not all Helm capabilities are supported. Creating methods of vetting if a helm chart is usable for OLM. Is there anything else to consider other than the provided kinds of Kube manifests and the existence of required CSV information?

- What Helm chart features will be supported by bundles?

njhale · 2020-05-28T19:54:25Z

enhancements/helm-mediatype.md

+ - Charts deprecation and where to reflect that in the bundle? [Deprecate Charts]() [Deprecate APIs](https://helm.sh/docs/topics/kubernetes_apis/)
+ - CRDs from helm charts are all provided with Helm 3 with the deprecation of crd-install hooks, we should not need to support versions before Helm 3.
+ - Not all Helm capabilities are supported. Creating methods of vetting if a helm chart is usable for OLM. Is there anything else to consider other than the provided kinds of Kube manifests and the existence of required CSV information?
+ - How to avoid OLM/Registry from previous version to install/add Helm charts so that no error should be thrown rather not allowed or able to do so? UX experience.


njhale · 2020-05-28T19:55:44Z

enhancements/helm-mediatype.md

+
+## Summary
+
+This enhancement adds support to accept `helm chart` media type for [Operator Bundle spec](https://github.com/openshift/enhancements/blob/master/enhancements/olm/operator-bundle.md), [operator-registry](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go), and [OLM](https://github.com/operator-framework/operator-lifecycle-manager) and enables deploying helm-based operators.


Is there a schema/convention for media types? i.e. helm+v3 over helm chart.

njhale · 2020-05-28T19:57:17Z

enhancements/helm-mediatype.md

+
+## Summary
+
+This enhancement adds support to accept `helm chart` media type for [Operator Bundle spec](https://github.com/openshift/enhancements/blob/master/enhancements/olm/operator-bundle.md), [operator-registry](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go), and [OLM](https://github.com/operator-framework/operator-lifecycle-manager) and enables deploying helm-based operators.


This enhancement should cover the design/UX for for opm, and potentially pipelines, too.

njhale · 2020-05-28T19:58:27Z

enhancements/helm-mediatype.md

+
+## Summary
+
+This enhancement adds support to accept `helm chart` media type for [Operator Bundle spec](https://github.com/openshift/enhancements/blob/master/enhancements/olm/operator-bundle.md), [operator-registry](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go), and [OLM](https://github.com/operator-framework/operator-lifecycle-manager) and enables deploying helm-based operators.


and enables deploying helm-based operators.

and enables deployment/upgrading helm-based operators.

njhale · 2020-05-28T19:59:17Z

enhancements/helm-mediatype.md

+Helm 3
+
+
+### User Stories by Persona


We're missing the Operator Author.

njhale · 2020-05-28T20:00:00Z

enhancements/helm-mediatype.md

+
+Not all Helm charts with their provided resources can be supported by OLM. The list of supported Kube manifests kinds is available [here](https://github.com/operator-framework/operator-registry/blob/7437af6d40bd9992ddede1aaee6223677b3b896f/pkg/lib/bundle/supported_resources.go#L23) which OLM will be in charge of creating them.
+
+### UX Experience


The UX for opm should be a priority. We should write it up README-style.

ecordell · 2020-06-05T19:03:13Z

enhancements/helm-mediatype.md

+
+## Summary
+
+This enhancement adds support to accept `helm chart` media type for [Operator Bundle spec](https://github.com/openshift/enhancements/blob/master/enhancements/olm/operator-bundle.md), [operator-registry](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go), and [OLM](https://github.com/operator-framework/operator-lifecycle-manager) and enables deployment/upgrading helm-based operators. This enhancement covers the design/UX for opm and OLM, and pipeline for building, adding, and installing helm-based operators that follow the [conventions](https://helm.sh/docs/chart_best_practices/conventions/) of `Helm+v3`.


the operator-registry link is a link to the CSV type definition

exdx · 2020-06-05T19:10:06Z

enhancements/helm-mediatype.md

+This enhancement adds support to accept `helm chart` media type for [Operator Bundle spec](https://github.com/openshift/enhancements/blob/master/enhancements/olm/operator-bundle.md), [operator-registry](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go), and [OLM](https://github.com/operator-framework/operator-lifecycle-manager) and enables deployment/upgrading helm-based operators. This enhancement covers the design/UX for opm and OLM, and pipeline for building, adding, and installing helm-based operators that follow the [conventions](https://helm.sh/docs/chart_best_practices/conventions/) of `Helm+v3`.
+
+## Motivation
+Operator authors and cluster admins may find themselves in the split between choosing to support/install operators via OLM or Helm. Helm users hoping to have OLM's operator management experience would have to convert their existing chart into OLM bundle. As many similarities as there are between the two projects, supporting/installing through either mechanism expects different packaging methods and pipeline. By supporting [Helm chart](https://hub.helm.sh/) as a bundle media type, OLM would become approachable to the Helm community without requiring operator authors to explicitly support OLM. It also gives cluster admins the ability to bring Helm-based operators on clusters using OLM.


Have we thought about what helm users lose from converting their bundle to an OLM bundle? Helm has a concept of revisions, which allow you to track what was deployed to the cluster and when. By converting to an OLM bundle, we do enable manifests to get on the cluster, but lose other helm related metadata. Have we thought about importing helm libraries and providing a more first-class experience for existing helm users?

kevinrizza · 2020-06-05T19:05:50Z

enhancements/helm-mediatype.md

+
+- Support, update, and lifecycle existing operators installed via Helm.
+- Building a bundle from helm charts without putting any restrictions on the contents of [templates](https://helm.sh/docs/chart_best_practices/templates/#helm) directory and metadata.
+- Support/Replace all capabilities of Helm in deploying Helm charts.


This seems reasonable, but should a goal be to explicitly list what we are/aren't going to support as a result of this?

kevinrizza · 2020-06-05T19:08:45Z

enhancements/helm-mediatype.md

+
+Special mappings from [Chart.yaml](https://helm.sh/docs/topics/charts/#the-chartyaml-file) -> `olm.yaml`:
+```
+kubeVersion -> minKubeVersion  # KubeVersion describes a range of compatible Kube versions which olm takes the minimum value


OLM doesn't currently do anything with minKubeVersion, no? Would we actively support it as part of this conversion?

This enhancement extend OLM's ability to accept helm charts as bundle mediatype where raw helm charts can be consumed by OLM.

camilamacedo86 · 2020-09-01T14:39:01Z

enhancements/helm-mediatype.md

+
+## Summary
+
+This enhancement adds support to accept `helm chart` media type for [Operator Bundle spec](https://github.com/openshift/enhancements/blob/master/enhancements/olm/operator-bundle.md), [operator-registry](https://github.com/operator-framework/operator-registry), and [OLM](https://github.com/operator-framework/operator-lifecycle-manager) to enable deployment/upgrading helm-based operators. This enhancement covers the design/UX for opm and OLM, and pipeline for building, adding, and installing helm-based operators that follow the [conventions](https://helm.sh/docs/chart_best_practices/conventions/) of `Helm+v3`.


Operator-SDK allows users to create operators based on the helm-charts and it provides the features for them to work with as build the bundle. So, why it would be required?

That requires the helm chart developer to convert their chart into an operator bundle. IMO this would be more valuable if there was a way for OLM to consume helm charts directly rather than have a manual conversion take place before they could be consumed (which adding a bundle type as is described above doesn't accomplish)

IMO it is not part of the domain of responsibility of OLM. OLM has the goal to distribute operators projects which can be done via the bundle. Also, will OLM generate the CRD's? will OLM generate a controller using helm native implementation to manage the charts?

c/c @njhale

That's true today, but that's just because OLM has currently limited itself to deploying and installing operators. It seems reasonable for OLM to potentially branch out to other types of applications on a cluster outside the scope of the strict definition of operators defined by the operator framework's bundle format.

It may be that in the case of helm charts we can't easily define a UX that enables the templating system that helm defines. But at a high level one of the killer features that I see OLM provides is it's dependency resolution. Why should the dependency resolver be limited just to other bundles if there was a convenient entryway for non-operators (but still applications or kube objects) to be applied in addition to operators in the strictest sense of the world. We already allow users to add certain additional kube types to their bundles in OLM, why do those kube types need be included in the bundle as a yaml object itself?

njhale reviewed May 28, 2020

View reviewed changes

Bowenislandsong force-pushed the helm branch 3 times, most recently from dcfaceb to 0289505 Compare June 5, 2020 18:55

ecordell reviewed Jun 5, 2020

View reviewed changes

exdx reviewed Jun 5, 2020

View reviewed changes

kevinrizza reviewed Jun 5, 2020

View reviewed changes

Add Helm as a bundle MediaType

e5e13b5

This enhancement extend OLM's ability to accept helm charts as bundle mediatype where raw helm charts can be consumed by OLM.

Bowenislandsong force-pushed the helm branch from 0289505 to e5e13b5 Compare June 29, 2020 12:58

camilamacedo86 reviewed Sep 1, 2020

View reviewed changes

camilamacedo86 mentioned this pull request Oct 22, 2020

Enable CRD validation generation for Helm and Ansible operator-framework/operator-sdk#3770

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Helm as a bundle MediaType #25

Add Helm as a bundle MediaType #25

Bowenislandsong commented May 28, 2020

njhale left a comment

njhale May 28, 2020

njhale May 28, 2020

njhale May 28, 2020

njhale May 28, 2020

njhale May 28, 2020

njhale May 28, 2020

njhale May 28, 2020

njhale May 28, 2020

njhale May 28, 2020

njhale May 28, 2020

ecordell Jun 5, 2020

exdx Jun 5, 2020

kevinrizza Jun 5, 2020

kevinrizza Jun 5, 2020

camilamacedo86 Sep 1, 2020

kevinrizza Sep 1, 2020

camilamacedo86 Sep 1, 2020 •

edited

Loading

kevinrizza Sep 1, 2020

	- Is it OLM's responsibility to deploy provided dependent charts?
	- Is it OLM's responsibility to deploy chart dependencies?

	- Not all Helm capabilities are supported. Creating methods of vetting if a helm chart is usable for OLM. Is there anything else to consider other than the provided kinds of Kube manifests and the existence of required CSV information?
	- What Helm chart features will be supported by bundles?


		## Summary

		This enhancement adds support to accept `helm chart` media type for [Operator Bundle spec](https://github.com/openshift/enhancements/blob/master/enhancements/olm/operator-bundle.md), [operator-registry](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go), and [OLM](https://github.com/operator-framework/operator-lifecycle-manager) and enables deploying helm-based operators.


		Not all Helm charts with their provided resources can be supported by OLM. The list of supported Kube manifests kinds is available [here](https://github.com/operator-framework/operator-registry/blob/7437af6d40bd9992ddede1aaee6223677b3b896f/pkg/lib/bundle/supported_resources.go#L23) which OLM will be in charge of creating them.

		### UX Experience

Add Helm as a bundle MediaType #25

Are you sure you want to change the base?

Add Helm as a bundle MediaType #25

Conversation

Bowenislandsong commented May 28, 2020

njhale left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Sep 1, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Sep 1, 2020 •

edited

Loading