{"id":20102959,"url":"https://github.com/stackrox/helm-operator","last_synced_at":"2025-05-06T08:31:03.715Z","repository":{"id":38257129,"uuid":"368443547","full_name":"stackrox/helm-operator","owner":"stackrox","description":"Helm operator fork of https://github.com/operator-framework/helm-operator-plugins","archived":false,"fork":false,"pushed_at":"2024-09-17T06:28:25.000Z","size":1912,"stargazers_count":3,"open_issues_count":8,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-09-17T09:03:38.735Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackrox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-18T07:44:02.000Z","updated_at":"2024-09-17T06:27:11.000Z","dependencies_parsed_at":"2024-04-19T08:32:57.252Z","dependency_job_id":"1f6d281c-1908-4e7f-a0dc-d2ec9077826b","html_url":"https://github.com/stackrox/helm-operator","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Fhelm-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Fhelm-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Fhelm-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackrox%2Fhelm-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackrox","download_url":"https://codeload.github.com/stackrox/helm-operator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224495983,"owners_count":17321025,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T17:33:46.013Z","updated_at":"2024-11-13T17:33:46.939Z","avatar_url":"https://github.com/stackrox.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# helm-operator\n\n![Build Status](https://github.com/stackrox/helm-operator/workflows/CI/badge.svg?branch=main)\n\nReimplementation of the helm operator to enrich the Helm operator's reconciliation with custom Go code to create a \nhybrid operator.\n\n## Introduction\n\nThe Helm operator type automates Helm chart operations\nby mapping the [values](https://helm.sh/docs/chart_template_guide/values_files/) of a Helm chart exactly to a \n`CustomResourceDefinition` and defining its watched resources in a `watches.yaml` \n[configuration](https://sdk.operatorframework.io/docs/building-operators/helm/tutorial/#watch-the-nginx-cr) file.\n\nFor creating a [Level II+](https://sdk.operatorframework.io/docs/advanced-topics/operator-capabilities/operator-capabilities/) operator \nthat reuses an already existing Helm chart, a [hybrid](https://github.com/operator-framework/operator-sdk/issues/670)\nbetween the Go and Helm operator types is necessary.\n\nThe hybrid approach allows adding customizations to the Helm operator, such as:\n- value mapping based on cluster state, or \n- executing code in specific events.\n\n## Quick start\n\n### Creating a Helm reconciler\n\n```go\n// Operator's main.go\nchart, err := loader.Load(\"path/to/chart\")\nif err != nil {\n panic(err)\n}\n\nreconciler := reconciler.New(\n reconciler.WithChart(*chart),\n reconciler.WithGroupVersionKind(gvk),\n)\n\nif err := reconciler.SetupWithManager(mgr); err != nil {\n panic(fmt.Sprintf(\"unable to create reconciler: %s\", err))\n}\n```\n\n## Why a fork?\n\nThe Helm operator type automates Helm chart operations\nby mapping the [values](https://helm.sh/docs/chart_template_guide/values_files/) of a Helm chart exactly to a \n`CustomResourceDefinition` and defining its watched resources in a `watches.yaml` \n[configuration](https://sdk.operatorframework.io/docs/building-operators/helm/tutorial/#watch-the-nginx-cr) file.\n\nFor creating a [Level II+](https://sdk.operatorframework.io/docs/advanced-topics/operator-capabilities/operator-capabilities/) operator \nthat reuses an already existing Helm chart, we need a [hybrid](https://github.com/operator-framework/operator-sdk/issues/670)\nbetween the Go and Helm operator types.\n\nThe hybrid approach allows adding customizations to the Helm operator, such as:\n- value mapping based on cluster state, or \n- executing code in specific events.\n\n### Quickstart\n\n- Add this module as a replace directive to your `go.mod`:\n\n  ```\n  go mod edit -replace=github.com/joelanford/helm-operator=github.com/stackrox/helm-operator@main\n  ```\n\n  For example:\n\n  ```go\n  chart, err := loader.Load(\"path/to/chart\")\n  if err != nil {\n     panic(err)\n  }\n\n  reconciler := reconciler.New(\n     reconciler.WithChart(*chart),\n     reconciler.WithGroupVersionKind(gvk),\n  )\n\n  if err := reconciler.SetupWithManager(mgr); err != nil {\n     panic(fmt.Sprintf(\"unable to create reconciler: %s\", err))\n  }\n  ```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackrox%2Fhelm-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackrox%2Fhelm-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackrox%2Fhelm-operator/lists"}