operator-framework / operator-framework/operator-controller

[epic] Add support for handling helm charts

Open
#962 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic lifecycle/frozen v1.x
Dominant language
Go
Stars
213
Forks
85
Avg merge
2d 1m
Merged PRs (30d)
38

Description

In OLMv1, we plan to support the registry+v1 bundle format in order to provide a means for migration from OLMv0. However, we recognize the many pain points and limitations of that format (to name a few: limited types of supported objects, lack of templating, too opinionated out how RBAC is generated)

In order to provide operator authors and cluster admins with more flexibility and control, this epic tracks the work necessary to support managing native helm charts in OLMv1.

[!WARNING]
A meta concern is that the below list of concerns has continued to grow as we have discovered more of Helm's behaviors. IMO, we need to do one of the following:

  1. Force cluster admins to acknowledge that they working with helm charts and helm behaviors, and then always do exactly what helm would do (is this even possible?).
  2. Don't use Helm as the backend engine that applies and lifecycles extension content.

EDIT: OLMv1 is converging on use of the boxcutter library via the experimental ClusterObjectSet API, so all bundle formats would need to be able to be translated to a ClusterObjectSet. This presents a problem though because:

  1. Arbitrary helm charts may not work out of the box with OLMv1's opinions on rendering/transpiling to ClusterObjectSet
  2. Boxcutter does not support (and will not support) many of Helm's behaviors.

I've started to capture some of these square-peg, round-hole problems below

Some items to consider:

  • Not all helm charts are conducive to being used in a declarative, always reconciling controller. Charts that use template functions that cause non-deterministic output (e.g. rand* functions) will cause a reconciler to continuously detect and rollout changes.
  • Helm charts that use hooks may be problematic in a reconciler because they introduce phases that require waiting. If we need/want to support helm hooks, we may need to figure out how to make the helm install/upgrade/uninstall processes asynchronous. (see https://github.com/operator-framework/operator-controller/issues/995)
  • Helm doesn't lifecycle CRDs in the ./crds directory when performing upgrades. It ignores them if the CRDs are already present on the cluster. If helm chart authors understand this behavior of helm and make assumptions about it, it is unsafe for OLMv1 to treat them differently. However one of the primary goals of OLMv1 is to lifecycle CRDs. This Helm behavior pits helm chart authors against ClusterExtension users who have opposing expectations of CRD lifecycling.
  • Helm supports a helm.sh/resource-policy: keep annotation, which gives chart authors the ability to control helm's behavior when uninstalling a chart. We specifically designed the ClusterExtension API to give cluster admins the ultimate control (see #775), not the extension author. So we currently use owner references to propogate deletions from the ClusterExtension, which means manifests that use this annotation would be deleted. How do we reconcile this ?
  • Helm supports chart dependencies, and the Helm CLI facilitates resolving, unpacking, and templating dependencies as part of a Helm release. There are multiple concerns with this:
    1. OLMv1 does not support dependencies. Helm's idea of a dependency could theoretically work in OLMv1 because the dependencies are resolved, included, and owned within the scope of a single ClusterExtension. However these nuances may be difficult to document and hard for users to understand.
    2. Helm dependencies might assume a certain distribution mechanism that is not supported in OLM. OLMv1 today supports only distribution via image registries, and is not configured to know anything about helm repositories. Would we try to build (what would likely be complex) solutions to these problems or would we simply reject Helm charts that specify dependencies? Perhaps there is an avenue to support helm charts whose dependencies are inlined or which are all OCI-based.
  • Upstream Helm supports HTTPS and OCI based chart distribution. OLMv1 currently supports only OCI-based distribution. operator-controller uses the containers/image library to interact directly with image registries. We need to investigate whether Helm OCI Artifact charts would be supported (and therefore extractable) with this library.
    • EDIT: We have proved that container/image library can pull OCI artifacts. However, it requires using lower-level library primatives. Not a blocker, but an important implementation detail.
  • Helm is constantly adding features. If a new feature is added, or an existing behavior changes in a new helm major version, such that it falls in a similar category as the above concerns, the OLM project maintainers need awareness so that we can adapt or adjust prior to those features/behaviors "sneaking" into OLM under our noses. If we pull a new version of helm's SDK into our project and don't block use of a new feature that was added, we must continue supporting that feature to avoid breaking changes for our users. This is a major concern. We likely need to have OLM maintainers invest significant time with the helm community so that we:
    • have awareness of incoming changes
    • have influence on design discussion and proposals.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Helm behavior concerns listed in this epic, especially non-deterministic functions, hooks, CRD lifecycle, resource-policy annotations, dependencies, and OCI distribution. Read the related issues #995 and #775 for existing context. This epic is complete only after the project makes and documents decisions for the unresolved compatibility and lifecycle questions.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, helm
Domain
infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.