add helm readme

.github/workflows/upload-helm-chart.yml

@@ -36,7 +36,7 @@ jobs:
         uses: engineerd/[email protected]
         with:
           name: cr
-          url: https://github.com/helm/chart-releaser/releases/download/v1.2.1/chart-releaser_1.2.1_linux_amd64.tar.gz
+          url: https://github.com/helm/chart-releaser/releases/download/v1.4.1/chart-releaser_1.4.1_linux_amd64.tar.gz
           pathInArchive: cr
 
       - name: Upload Chart

Makefile

@@ -81,12 +81,14 @@ CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 SEMVER ?= $(LOCALBIN)/semver
 HELM_DOCS ?= $(LOCALBIN)/helm-docs
 MOCKGEN ?= $(LOCALBIN)/mockgen
+GORELEASER ?= $(LOCALBIN)/goreleaser
 
 ## Tool Versions
 CONTROLLER_TOOLS_VERSION ?= v0.10.0
 SEMVER_VERSION ?= latest
 HELM_DOCS_VERSION ?= v1.11.0
 MOCKGEN_VERSION ?= v1.6.0
+GORELEASER_VERSION ?= latest
 
 .PHONY: controller-gen
 controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
@@ -103,10 +105,10 @@ mockgen: $(MOCKGEN) ## Download mockgen locally if necessary.
 $(MOCKGEN): $(LOCALBIN)
 	test -s $(LOCALBIN)/mockgen|| GOBIN=$(LOCALBIN) go install github.com/golang/mock/mockgen@$(MOCKGEN_VERSION)
 
-GORELEASER = ./bin/goreleaser
-goreleaser: ## Download goreleaser locally if necessary.
-	$(call go-get-tool,$(GORELEASER),github.com/goreleaser/goreleaser)
+.PHONY: goreleaser
+goreleaser: $(GORELEASER) ## Download goreleaser locally if necessary.
+$(GORELEASER): $(LOCALBIN)
+	test -s $(LOCALBIN)/goreleaser|| GOBIN=$(LOCALBIN) go install github.com/goreleaser/goreleaser@$(GORELEASER_VERSION)
 
-MOCKGEN = ./bin/mockgen
-mockgen: ## Download mockgen locally if necessary.
-	$(call go-get-tool,$(MOCKGEN),github.com/golang/mock/[email protected])
+docs: helm-docs
+	@$(LOCALBIN)/helm-docs

helm/.helmignore

@@ -20,3 +20,4 @@
 .idea/
 *.tmproj
 .vscode/
+README.md.gotmpl

helm/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: k8s-event-logger-operator
-description: Kubernetes event logger operator
+description: This operator creates a logging pod that logs corev1.Event information as structured json log. The crd allows to configure the events to be logged.
 type: application
-version: "1.9.1"
-appVersion: "v1.9.1"
+version: "1.10.2"
+appVersion: "v1.10.2"

helm/README.md

@@ -0,0 +1,42 @@
+# k8s-event-logger-operator
+
+![Version: 1.10.2](https://img.shields.io/badge/Version-1.10.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.10.2](https://img.shields.io/badge/AppVersion-v1.10.2-informational?style=flat-square)
+
+This operator creates a logging pod that logs corev1.Event information as structured json log. The crd allows to configure the events to be logged.
+
+## Installation
+
+```console
+helm repo add bakito https://charts.bakito.net
+helm install k8s-event-logger-operator bakito/k8s-event-logger-operator
+```
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` | Assign custom [affinity] rules to the deployment |
+| eventLogger.leaderElection | bool | `true` | Enable leader election for the controller |
+| eventLogger.leaderElectionResourceLock | string | `nil` | Leader election lock type |
+| eventLogger.resources | object | `{"limits":{"cpu":"200m","memory":"256Mi"},"requests":{"cpu":"100m","memory":"64Mi"}}` | Resource limits and requests for the operator pods. |
+| fullnameOverride | string | `""` | String to fully override "argo-rollouts.fullname" template |
+| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
+| image.repository | string | `"ghcr.io/bakito/k8s-event-logger"` | Repository to use |
+| logging.level | string | `"info"` | Log level |
+| logging.timeEncoding | string | `"iso8601"` | Log time encoding |
+| nameOverride | string | `""` | String to partially override "argo-rollouts.fullname" template |
+| nodeSelector | object | `{}` | [Node selector] |
+| rbac.create | bool | `true` | Specifies whether rbac should be created |
+| rbac.roleName | string | `nil` | The name of the role and clusterrole to use. If not set and create is true, a name is generated using the fullname template |
+| resources | object | `{"limits":{"cpu":"200m","memory":"512Mi"},"requests":{"cpu":"100m","memory":"128Mi"}}` | Resource limits and requests for the operator pods. |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
+| serviceAccount.name | string | `nil` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| tolerations | list | `[]` | [Tolerations] for use with node taints |
+| webhook.caBundle | string | `"Cg=="` | certificate ca bundle |
+| webhook.certManager.enabled | bool | `false` | Enable cert manager setup |
+| webhook.certsSecret.name | string | `nil` | Certificate secret name |
+| webhook.enabled | bool | `false` | Specifies whether validation webhook should be created. |
+| webhook.openShiftServiceCert.enabled | bool | `false` | Enable OpenShift service certificate |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

helm/README.md.gotmpl

@@ -0,0 +1,17 @@
+{{ template "chart.header" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+## Installation
+
+```console
+helm repo add bakito https://charts.bakito.net
+helm install {{ template "chart.name" . }} bakito/{{ template "chart.name" . }}
+```
+
+{{ template "chart.valuesSection" . }}
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

helm/values.yaml

@@ -3,12 +3,17 @@
 # Declare variables to be passed into your templates.
 
 image:
+  # --  Repository to use
   repository: ghcr.io/bakito/k8s-event-logger
-  pullPolicy: Always
+  # -- Image pull policy
+  pullPolicy: IfNotPresent
 
 eventLogger:
+  # --  Enable leader election for the controller
   leaderElection: true
+  # --  Leader election lock type
   leaderElectionResourceLock:
+  # -- Resource limits and requests for the operator pods.
   resources:
     requests:
       cpu: 100m
@@ -18,35 +23,49 @@ eventLogger:
       memory: 256Mi
 
 logging: # see https://github.com/operator-framework/operator-sdk/blob/master/doc/user/logging.md
+  # -- Log level
   level: info
+  # -- Log time encoding
   timeEncoding: iso8601
 
 webhook:
+  # -- Specifies whether validation webhook should be created.
   enabled: false
+
   certManager:
+    # -- Enable cert manager setup
     enabled: false
+
   openShiftServiceCert:
+    # -- Enable OpenShift service certificate
     enabled: false
   certsSecret:
-    name: 
+    # -- Certificate secret name
+    name:
+  # -- certificate ca bundle
   caBundle: Cg==
 
+# -- String to partially override "argo-rollouts.fullname" template
 nameOverride: ""
+
+# -- String to fully override "argo-rollouts.fullname" template
 fullnameOverride: ""
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # The name of the service account to use.
+  # -- The name of the service account to use.
   # If not set and create is true, a name is generated using the fullname template
   name:
 
 rbac:
+  # -- Specifies whether rbac should be created
   create: true
-  # The name of the role and clusterrole to use.
+  # -- The name of the role and clusterrole to use.
   # If not set and create is true, a name is generated using the fullname template
   roleName:
 
+# -- Resource limits and requests for the operator pods.
 resources:
   requests:
     cpu: 100m
@@ -55,8 +74,11 @@ resources:
     cpu: 200m
     memory: 512Mi
 
-nodeSelector: {}
+# -- [Node selector]
+nodeSelector: { }
 
-tolerations: []
+# -- [Tolerations] for use with node taints
+tolerations: [ ]
 
-affinity: {}
+# -- Assign custom [affinity] rules to the deployment
+affinity: { }