✨ Set up right watches and all labels to postrenderer #763

varshaprasad96 · 2024-04-17T23:46:39Z

I don't think there is need to list helm releases, to find metadata. The helm install code, in the getReleaseState method does comparison of the templated and existing chart and finds if changes are needed.

Additionally, based on the documentation, helm by default creates and manages secrets for each release, and if we want pass any additional sensitive data to the chart, we need to do so while templating. Which means, we can use the default release which the helm creates and store bundle version and name through annotations in the chart.

Description

Reviewer Checklist

API Go Documentation
Tests: Unit Tests (and E2E Tests, if appropriate)
Comprehensive Commit Messages
Links to related GitHub Issue(s)

tmshort · 2024-04-18T13:58:28Z

internal/rukpak/util/labels.go

+	CoreOwnerKindKey          = "core.clusterextension.io/owner-kind"
+	CoreOwnerNameKey          = "core.clusterextension.io/owner-name"
+	ResolvedBundleCatalogID   = "core.clusterextension.io/catalog-id"
+	ResolvedbundlePackageName = "core.clusterextension.io/package-name"
+	ResolvedbundleName        = "core.clusterextension.io/bundle-name"
+	ResolvedbundleVersion     = "core.clusterextension.io/bundle-version"


I don't believe we "own" the clusterextension.io domain, but this is a PoC...

+1 these should definitely be updated before 1.0.0

I'd suggest olm.operatorframework.io/*

Also a few nits on naming:

CamelCase words in the identifier (e.g. Resolvedbundle should be ResolvedBundle)

Consistently use Key suffix to all of the identifiers to clarify that these are to be used for label/annotation keys.

Drop Core prefix.

Overall, align the identifier name with the value of the constant. e.g.

"core.clusterextension.io/catalog-id" would map to CatalogIDKey

"core.clusterextension.io/package-name" would map to PackageNameKey

etc.

This is a PoC branch, so it's not going into main as-is.

tmshort · 2024-04-18T14:00:32Z

internal/controllers/clusterextension_controller.go

@@ -460,6 +471,58 @@ func (r *ClusterExtensionReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return nil
 }

+func mapOwneeToOwnerHandler(cl client.Client, log logr.Logger, owner client.Object) crhandler.EventHandler {


It took me a second to "get" this name. Is "ownee" even a word? :)

joelanford · 2024-04-18T14:22:55Z

internal/controllers/clusterextension_controller.go

+			util.ResolvedbundleName:        bundle.Name,
+			util.ResolvedbundlePackageName: bundle.Package,
+			util.ResolvedbundleVersion:     bundleVersion.String(),


No catalogID here? Can we drop that constant?

Co-authored-by: [email protected] <[email protected]>

…rk#763) Co-authored-by: [email protected] <[email protected]>

plug in resolver Deal with removal of HigherBundleVersion Removed in e079129 Signed-off-by: Todd Short <[email protected]> :sparkles: Starting Helm POC - pull in some rukpak (#756) * Fix suite_test.go Signed-off-by: Todd Short <[email protected]> * Copy over some rukpak code and replace BundleDeployment Replace BundleDeployment in the Unpack APIs with a combination of BundleSource and ClusterExtension. It builds... Signed-off-by: Todd Short <[email protected]> * fixup! Copy over some rukpak code and replace BundleDeployment --------- Signed-off-by: Todd Short <[email protected]> Plugin unpacker, add Handler (#757) Signed-off-by: Varsha Prasad Narsing <[email protected]> Co-authored-by: [email protected] <[email protected]> A bit of cleanup (#761) Signed-off-by: Todd Short <[email protected]> :warning: Install the helm chart (#762) * Install the helm chart Signed-off-by: Todd Short <[email protected]> * fixup! Install the helm chart Signed-off-by: Todd Short <[email protected]> --------- Signed-off-by: Todd Short <[email protected]> Set up right watches and all labels to postrenderer (#763) Co-authored-by: [email protected] <[email protected]> :warning: Update owner keys (#765) * Update owner keys Signed-off-by: Todd Short <[email protected]> * fixup! Update owner keys Signed-off-by: Todd Short <[email protected]> --------- Signed-off-by: Todd Short <[email protected]> No more panics (#767) Signed-off-by: Todd Short <[email protected]> Add relevant RBAC to enable controller to watch resources (#776) Co-authored-by: [email protected] <[email protected]> Changes required for ClusterExtension to install an operator (#789) * Add relevant RBAC to enable controller to watch resources * Debugging iteration - one * ClusterExtension installing the operator - working --------- Co-authored-by: [email protected] <[email protected]> Fix some lints (#793) Signed-off-by: Todd Short <[email protected]> :sparkles: Getting cluster extension running (#795) * Getting cluster extension running * Specify namespace to create secret Set resolved and installed versions (#806) Remove install references to rukpak (#805) Signed-off-by: Todd Short <[email protected]> Consolidate error message generation (#807) Signed-off-by: Todd Short <[email protected]> Add make kind-redeploy (#808) Signed-off-by: Todd Short <[email protected]> Use rukpak as a library (#821) Signed-off-by: Todd Short <[email protected]> Improve caching and fix constant reconciles (#825) Improve performance by caching objects that only have ClusterExtension as owners. Signed-off-by: Varsha Prasad Narsing <[email protected]> Fix linter (#826) Signed-off-by: Varsha Prasad Narsing <[email protected]> Move helm-operator-plugin (#828) Signed-off-by: Todd Short <[email protected]> Really fix linter (#833) Signed-off-by: Todd Short <[email protected]>

plug in resolver Deal with removal of HigherBundleVersion Removed in e079129 Signed-off-by: Todd Short <[email protected]> :sparkles: Starting Helm POC - pull in some rukpak (operator-framework#756) * Fix suite_test.go Signed-off-by: Todd Short <[email protected]> * Copy over some rukpak code and replace BundleDeployment Replace BundleDeployment in the Unpack APIs with a combination of BundleSource and ClusterExtension. It builds... Signed-off-by: Todd Short <[email protected]> * fixup! Copy over some rukpak code and replace BundleDeployment --------- Signed-off-by: Todd Short <[email protected]> Plugin unpacker, add Handler (operator-framework#757) Signed-off-by: Varsha Prasad Narsing <[email protected]> Co-authored-by: [email protected] <[email protected]> A bit of cleanup (operator-framework#761) Signed-off-by: Todd Short <[email protected]> :warning: Install the helm chart (operator-framework#762) * Install the helm chart Signed-off-by: Todd Short <[email protected]> * fixup! Install the helm chart Signed-off-by: Todd Short <[email protected]> --------- Signed-off-by: Todd Short <[email protected]> Set up right watches and all labels to postrenderer (operator-framework#763) Co-authored-by: [email protected] <[email protected]> :warning: Update owner keys (operator-framework#765) * Update owner keys Signed-off-by: Todd Short <[email protected]> * fixup! Update owner keys Signed-off-by: Todd Short <[email protected]> --------- Signed-off-by: Todd Short <[email protected]> No more panics (operator-framework#767) Signed-off-by: Todd Short <[email protected]> Add relevant RBAC to enable controller to watch resources (operator-framework#776) Co-authored-by: [email protected] <[email protected]> Changes required for ClusterExtension to install an operator (operator-framework#789) * Add relevant RBAC to enable controller to watch resources * Debugging iteration - one * ClusterExtension installing the operator - working --------- Co-authored-by: [email protected] <[email protected]> Fix some lints (operator-framework#793) Signed-off-by: Todd Short <[email protected]> :sparkles: Getting cluster extension running (operator-framework#795) * Getting cluster extension running * Specify namespace to create secret Set resolved and installed versions (operator-framework#806) Remove install references to rukpak (operator-framework#805) Signed-off-by: Todd Short <[email protected]> Consolidate error message generation (operator-framework#807) Signed-off-by: Todd Short <[email protected]> Add make kind-redeploy (operator-framework#808) Signed-off-by: Todd Short <[email protected]> Use rukpak as a library (operator-framework#821) Signed-off-by: Todd Short <[email protected]> Improve caching and fix constant reconciles (operator-framework#825) Improve performance by caching objects that only have ClusterExtension as owners. Signed-off-by: Varsha Prasad Narsing <[email protected]> Fix linter (operator-framework#826) Signed-off-by: Varsha Prasad Narsing <[email protected]> Move helm-operator-plugin (operator-framework#828) Signed-off-by: Todd Short <[email protected]> Really fix linter (operator-framework#833) Signed-off-by: Todd Short <[email protected]>

plug in resolver Deal with removal of HigherBundleVersion Removed in e079129 Signed-off-by: Todd Short <[email protected]> :sparkles: Starting Helm POC - pull in some rukpak (#756) * Fix suite_test.go Signed-off-by: Todd Short <[email protected]> * Copy over some rukpak code and replace BundleDeployment Replace BundleDeployment in the Unpack APIs with a combination of BundleSource and ClusterExtension. It builds... Signed-off-by: Todd Short <[email protected]> * fixup! Copy over some rukpak code and replace BundleDeployment --------- Signed-off-by: Todd Short <[email protected]> Plugin unpacker, add Handler (#757) Signed-off-by: Varsha Prasad Narsing <[email protected]> Co-authored-by: [email protected] <[email protected]> A bit of cleanup (#761) Signed-off-by: Todd Short <[email protected]> :warning: Install the helm chart (#762) * Install the helm chart Signed-off-by: Todd Short <[email protected]> * fixup! Install the helm chart Signed-off-by: Todd Short <[email protected]> --------- Signed-off-by: Todd Short <[email protected]> Set up right watches and all labels to postrenderer (#763) Co-authored-by: [email protected] <[email protected]> :warning: Update owner keys (#765) * Update owner keys Signed-off-by: Todd Short <[email protected]> * fixup! Update owner keys Signed-off-by: Todd Short <[email protected]> --------- Signed-off-by: Todd Short <[email protected]> No more panics (#767) Signed-off-by: Todd Short <[email protected]> Add relevant RBAC to enable controller to watch resources (#776) Co-authored-by: [email protected] <[email protected]> Changes required for ClusterExtension to install an operator (#789) * Add relevant RBAC to enable controller to watch resources * Debugging iteration - one * ClusterExtension installing the operator - working --------- Co-authored-by: [email protected] <[email protected]> Fix some lints (#793) Signed-off-by: Todd Short <[email protected]> :sparkles: Getting cluster extension running (#795) * Getting cluster extension running * Specify namespace to create secret Set resolved and installed versions (#806) Remove install references to rukpak (#805) Signed-off-by: Todd Short <[email protected]> Consolidate error message generation (#807) Signed-off-by: Todd Short <[email protected]> Add make kind-redeploy (#808) Signed-off-by: Todd Short <[email protected]> Use rukpak as a library (#821) Signed-off-by: Todd Short <[email protected]> Improve caching and fix constant reconciles (#825) Improve performance by caching objects that only have ClusterExtension as owners. Signed-off-by: Varsha Prasad Narsing <[email protected]> Fix linter (#826) Signed-off-by: Varsha Prasad Narsing <[email protected]> Move helm-operator-plugin (#828) Signed-off-by: Todd Short <[email protected]> Really fix linter (#833) Signed-off-by: Todd Short <[email protected]>

Set up right watches and all labels to postrenderer

6d4989c

varshaprasad96 requested a review from a team as a code owner April 17, 2024 23:46

tmshort reviewed Apr 18, 2024

View reviewed changes

tmshort approved these changes Apr 18, 2024

View reviewed changes

tmshort merged commit 3ad299f into operator-framework:helm-poc Apr 18, 2024

joelanford reviewed Apr 18, 2024

View reviewed changes

tmshort pushed a commit that referenced this pull request Apr 29, 2024

Set up right watches and all labels to postrenderer (#763)

7131be3

Co-authored-by: [email protected] <[email protected]>

bentito pushed a commit to bentito/operator-controller that referenced this pull request May 3, 2024

Set up right watches and all labels to postrenderer (operator-framewo…

eaab355

…rk#763) Co-authored-by: [email protected] <[email protected]>

tmshort mentioned this pull request May 3, 2024

Helm PoC latest rebase - DO NOT MERGE #834

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ Set up right watches and all labels to postrenderer #763

✨ Set up right watches and all labels to postrenderer #763

Uh oh!

varshaprasad96 commented Apr 17, 2024

Uh oh!

tmshort Apr 18, 2024

Uh oh!

joelanford Apr 18, 2024

Uh oh!

joelanford Apr 18, 2024

Uh oh!

tmshort Apr 18, 2024

Uh oh!

tmshort Apr 18, 2024

Uh oh!

tmshort Apr 18, 2024

Uh oh!

joelanford Apr 18, 2024

Uh oh!

tmshort Apr 18, 2024

Uh oh!

Uh oh!

✨ Set up right watches and all labels to postrenderer #763

✨ Set up right watches and all labels to postrenderer #763

Uh oh!

Conversation

varshaprasad96 commented Apr 17, 2024

Description

Reviewer Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!