refactoring

Author: Uburro

Makefile

@@ -121,10 +121,10 @@ PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 docker-buildx: ## Build and push docker image for the manager for cross-platform support
 	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
 	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
-	- $(CONTAINER_TOOL) buildx create --name fluxcd-trigger-operator-builder
-	$(CONTAINER_TOOL) buildx use fluxcd-trigger-operator-builder
+	- $(CONTAINER_TOOL) buildx create --name helmrelease-trigger-operator-builder
+	$(CONTAINER_TOOL) buildx use helmrelease-trigger-operator-builder
 	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
-	- $(CONTAINER_TOOL) buildx rm fluxcd-trigger-operator-builder
+	- $(CONTAINER_TOOL) buildx rm helmrelease-trigger-operator-builder
 	rm Dockerfile.cross
 
 .PHONY: build-installer

PROJECT

@@ -5,6 +5,6 @@
 domain: uburro.github.com
 layout:
 - go.kubebuilder.io/v4
-projectName: fluxcd-trigger-operator
-repo: github.com/uburro/fluxcd-trigger-operator
+projectName: helmrelease-trigger-operator
+repo: github.com/uburro/helmrelease-trigger-operator
 version: "3"

README.md

@@ -1,18 +1,18 @@
-# FluxCD Trigger Operator
+# HelmRelease Trigger Operator
 
 A Kubernetes controller that automatically triggers HelmRelease reconciliation when associated ConfigMaps are updated, enabling seamless configuration-driven GitOps workflows.
 
 ## Disclaimer
 
-**Important:** This project is not affiliated with FluxCD or ControlPlaneIO-FluxCD. It is an independent operator designed to simplify deployments with FluxCD, specifically when using the `valuesFrom` feature in HelmRelease configurations. The FluxCD Trigger Operator provides additional functionality for triggering HelmRelease reconciliations based on ConfigMap updates, but it is not officially supported or endorsed by the FluxCD project or its maintainers.
+**Important:** This project is not affiliated with FluxCD or ControlPlaneIO-FluxCD. It is an independent operator designed to simplify deployments with FluxCD, specifically when using the `valuesFrom` feature in HelmRelease configurations. The HelmRelease Trigger Operator provides additional functionality for triggering HelmRelease reconciliations based on ConfigMap updates, but it is not officially supported or endorsed by the FluxCD project or its maintainers.
 
 ## Overview
 
-The FluxCD Trigger Operator monitors ConfigMaps with specific labels and annotations, automatically triggering FluxCD HelmRelease reconciliation when configuration changes are detected. This enables dynamic configuration management where ConfigMap updates can immediately trigger application redeployments without manual intervention.
+The HelmRelease Trigger Operator monitors ConfigMaps with specific labels and annotations, automatically triggering FluxCD HelmRelease reconciliation when configuration changes are detected. This enables dynamic configuration management where ConfigMap updates can immediately trigger application redeployments without manual intervention.
 
 ## How It Works
 
-The operator watches for ConfigMaps labeled with `github.com/uburro/fluxcd-trigger-operator: "true"` and:
+The operator watches for ConfigMaps labeled with `github.com/uburro/helmrelease-trigger-operator: "true"` and:
 
 1. **Monitors ConfigMap Changes**: Detects create, update, and generic events on labeled ConfigMaps
 2. **Extracts HelmRelease References**: Uses annotations to identify the target HelmRelease
@@ -31,13 +31,13 @@ The operator watches for ConfigMaps labeled with `github.com/uburro/fluxcd-trigg
 
 ### Autodiscovery
 
-The FluxCD Trigger Operator implements **autodiscovery** by scanning all HelmReleases in the cluster and automatically labeling those that use the `valuesFrom` feature. This ensures that HelmReleases relying on external ConfigMaps or Secrets for their values are dynamically included in the operator's reconciliation workflow.
+The HelmRelease Trigger Operator implements **autodiscovery** by scanning all HelmReleases in the cluster and automatically labeling those that use the `valuesFrom` feature. This ensures that HelmReleases relying on external ConfigMaps or Secrets for their values are dynamically included in the operator's reconciliation workflow.
 
 #### How Autodiscovery Works:
 1. **HelmRelease Scanning**: The operator scans all HelmReleases in the cluster.
 2. **`valuesFrom` Detection**: It checks if the HelmRelease configuration includes the `valuesFrom` field, which indicates dependency on external resources like ConfigMaps or Secrets.
 3. **Automatic Labeling**: For HelmReleases using `valuesFrom`, the operator adds the following labels:
-   - `"uburro.github.com/fluxcd-trigger-operator": "true"`: Marks the HelmRelease as managed by the operator.
+   - `"uburro.github.com/helmrelease-trigger-operator": "true"`: Marks the HelmRelease as managed by the operator.
    - `"uburro.github.com/helmreleases-namespace": "<namespace>"`: Specifies the namespace of the HelmRelease.
    - `"uburro.github.com/helmreleases-name": "<name>"`: Specifies the name of the HelmRelease.
 
@@ -57,12 +57,17 @@ The FluxCD Trigger Operator implements **autodiscovery** by scanning all HelmRel
 ```bash
 kustomize build config/default | kubectl apply -f
 ```
+or
+
+```
+helm install hrto oci://ghcr.io/uburro/helmrelease-trigger-operator
+```
 
 ### Verify Installation
 
 ```bash
-kubectl get pods -n fluxcd-trigger-operator-system
-kubectl logs -n fluxcd-trigger-operator-system deployment/fluxcd-trigger-operator
+kubectl get pods -n helmrelease-trigger-operator-system
+kubectl logs -n helmrelease-trigger-operator-system deployment/helmrelease-trigger-operator
 ```
 
 ## Configuration
@@ -74,7 +79,7 @@ ConfigMaps must have the following label to be monitored by the operator:
 ```yaml
 metadata:
   labels:
-    github.com/uburro/fluxcd-trigger-operator: "true"
+    github.com/uburro/helmrelease-trigger-operator: "true"
 ```
 
 ### Required ConfigMap Annotations
@@ -140,7 +145,7 @@ metadata:
   name: my-app-config
   namespace: default
   labels:
-    github.com/uburro/fluxcd-trigger-operator: "true"
+    github.com/uburro/helmrelease-trigger-operator: "true"
   annotations:
     uburro.github.com/helmreleases-name: "my-app"
     uburro.github.com/helmreleases-namespace: "flux-system"
@@ -174,7 +179,7 @@ metadata:
   name: production-config
   namespace: app-configs
   labels:
-    github.com/uburro/fluxcd-trigger-operator: "true"
+    github.com/uburro/helmrelease-trigger-operator: "true"
   annotations:
     uburro.github.com/helmreleases-name: "production-app"
     uburro.github.com/helmreleases-namespace: "production"
@@ -193,7 +198,7 @@ The operator requires the following Kubernetes permissions:
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
-  name: fluxcd-trigger-operator
+  name: helmrelease-trigger-operator
 rules:
 # ConfigMap permissions
 - apiGroups: [""]
@@ -212,10 +217,10 @@ rules:
 
 ```bash
 # View operator logs
-kubectl logs -n fluxcd-trigger-operator-system deployment/fluxcd-trigger-operator
+kubectl logs -n helmrelease-trigger-operator-system deployment/helmrelease-trigger-operator
 
 # Check if ConfigMaps are being watched
-kubectl get configmaps -l github.com/uburro/fluxcd-trigger-operator=true -A
+kubectl get configmaps -l github.com/uburro/helmrelease-trigger-operator=true -A
 
 # Verify HelmRelease reconciliation
 kubectl get helmreleases -A
@@ -225,7 +230,7 @@ kubectl describe helmrelease my-app -n flux-system
 ### Common Issues
 
 1. **ConfigMap changes not triggering reconciliation**
-   - Verify the ConfigMap has the required label: `github.com/uburro/fluxcd-trigger-operator: "true"`
+   - Verify the ConfigMap has the required label: `github.com/uburro/helmrelease-trigger-operator: "true"`
    - Check annotations for correct HelmRelease name and namespace
    - Ensure the target HelmRelease exists
 
@@ -247,7 +252,7 @@ kubectl get configmap my-app-config -o yaml
 kubectl get helmrelease my-app -o jsonpath='{.status.history[0]}'
 
 # Monitor operator events
-kubectl get events -n fluxcd-trigger-operator-system
+kubectl get events -n helmrelease-trigger-operator-system
 
 # Check if reconciliation was triggered
 kubectl get helmrelease my-app -o jsonpath='{.metadata.annotations.reconcile\.fluxcd\.io/forceAt}'
@@ -288,7 +293,7 @@ kubectl get helmrelease my-app -o jsonpath='{.metadata.annotations.reconcile\.fl
 
 | Constant | Value | Description |
 |----------|-------|-------------|
-| `LabelConfigMapReconcilerNameSourceKey` | `github.com/uburro/fluxcd-trigger-operator` | Required label for monitoring |
+| `LabelConfigMapReconcilerNameSourceKey` | `github.com/uburro/helmrelease-trigger-operator` | Required label for monitoring |
 | `AnnotationHelmReleaseNameKey` | `uburro.github.com/helmreleases-name` | HelmRelease name annotation |
 | `AnnotationHelmReleaseNamespaceKey` | `uburro.github.com/helmreleases-namespace` | HelmRelease namespace annotation |
 | `AnnotationDigistKey` | `uburro.github.com/config-digest` | Digest tracking annotation |

cmd/main.go

@@ -40,7 +40,7 @@ import (
 
 	// +kubebuilder:scaffold:imports
 
-	"github.com/uburro/fluxcd-trigger-operator/internal/controller"
+	"github.com/uburro/helmrelease-trigger-operator/internal/controller"
 
 	helmv2 "github.com/fluxcd/helm-controller/api/v2"
 

config/default/kustomization.yaml

@@ -1,12 +1,12 @@
 # Adds namespace to all resources.
-namespace: fluxcd-trigger-operator-system
+namespace: helmrelease-trigger-operator-system
 
 # Value of this field is prepended to the
 # names of all resources, e.g. a deployment named
 # "wordpress" becomes "alices-wordpress".
 # Note that it should also match with the prefix (text before '-') of the namespace
 # field above.
-namePrefix: fluxcd-trigger-operator-
+namePrefix: helmrelease-trigger-operator-
 
 # Labels to add to all resources and selectors.
 #labels:

config/default/metrics_service.yaml

@@ -3,7 +3,7 @@ kind: Service
 metadata:
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: fluxcd-trigger-operator
+    app.kubernetes.io/name: helmrelease-trigger-operator
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-service
   namespace: system
@@ -15,4 +15,4 @@ spec:
     targetPort: 8443
   selector:
     control-plane: controller-manager
-    app.kubernetes.io/name: fluxcd-trigger-operator
+    app.kubernetes.io/name: helmrelease-trigger-operator

config/manager/manager.yaml

@@ -3,7 +3,7 @@ kind: Namespace
 metadata:
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: fluxcd-trigger-operator
+    app.kubernetes.io/name: helmrelease-trigger-operator
     app.kubernetes.io/managed-by: kustomize
   name: system
 ---
@@ -14,21 +14,21 @@ metadata:
   namespace: system
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: fluxcd-trigger-operator
+    app.kubernetes.io/name: helmrelease-trigger-operator
     app.kubernetes.io/managed-by: kustomize
 spec:
   selector:
     matchLabels:
       control-plane: controller-manager
-      app.kubernetes.io/name: fluxcd-trigger-operator
+      app.kubernetes.io/name: helmrelease-trigger-operator
   replicas: 1
   template:
     metadata:
       annotations:
         kubectl.kubernetes.io/default-container: manager
       labels:
         control-plane: controller-manager
-        app.kubernetes.io/name: fluxcd-trigger-operator
+        app.kubernetes.io/name: helmrelease-trigger-operator
     spec:
       # TODO(user): Uncomment the following code to configure the nodeAffinity expression
       # according to the platforms which are supported by your solution.

config/network-policy/allow-metrics-traffic.yaml

@@ -5,15 +5,15 @@ apiVersion: networking.k8s.io/v1
 kind: NetworkPolicy
 metadata:
   labels:
-    app.kubernetes.io/name: fluxcd-trigger-operator
+    app.kubernetes.io/name: helmrelease-trigger-operator
     app.kubernetes.io/managed-by: kustomize
   name: allow-metrics-traffic
   namespace: system
 spec:
   podSelector:
     matchLabels:
       control-plane: controller-manager
-      app.kubernetes.io/name: fluxcd-trigger-operator
+      app.kubernetes.io/name: helmrelease-trigger-operator
   policyTypes:
     - Ingress
   ingress:

config/prometheus/monitor.yaml

@@ -4,7 +4,7 @@ kind: ServiceMonitor
 metadata:
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: fluxcd-trigger-operator
+    app.kubernetes.io/name: helmrelease-trigger-operator
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-monitor
   namespace: system
@@ -24,4 +24,4 @@ spec:
   selector:
     matchLabels:
       control-plane: controller-manager
-      app.kubernetes.io/name: fluxcd-trigger-operator
+      app.kubernetes.io/name: helmrelease-trigger-operator

config/rbac/leader_election_role.yaml

@@ -3,7 +3,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
   labels:
-    app.kubernetes.io/name: fluxcd-trigger-operator
+    app.kubernetes.io/name: helmrelease-trigger-operator
     app.kubernetes.io/managed-by: kustomize
   name: leader-election-role
 rules: