added helm readme

.github/workflows/helm.yml

@@ -34,6 +34,7 @@ jobs:
         sed -i "s#ersion: latest#ersion: ${{ steps.release_name.outputs.VERSION }}#g" ../build/helm/dynratelimiter-operator/Chart.yaml
         sed -i "s#ersion: v#ersion: #g" ../build/helm/dynratelimiter-operator/Chart.yaml
         helm package ../build/helm/dynratelimiter-operator
+        cp ../build/helm/dynratelimiter-operator/README.md ../../helm-charts/dynratelimiter-operator.md
         mv * ../../helm-charts/
         cd ../../helm-charts
         helm repo index . --url https://arivum.github.io/helm-charts

build/helm/dynratelimiter-operator/README.md

@@ -0,0 +1,43 @@
+### DynRateLimiter Operator
+
+Create your `values.yaml`
+
+```yaml
+# your values.yaml to override default values
+namespace: finnie-pipeline-operator-system
+image:
+	pullSecrets:
+		- name: my-pullsecret
+```
+
+Then, install the `DynRateLimiter Operator` with Helm:
+
+```bash
+# deploy using your values.yaml
+helm install -f values.yaml dynratelimiter-operator arivum/dynratelimiter-operator
+```
+
+#### Available chart properties
+
+| Property       |   Description         | Default               |
+| -------------- | --------------------- | --------------------- |
+| `replicaCount` | Number of replicas    | `1`                   |
+| `appname`      | App Name, certificates and service name will be derived from this value    | `dynratelimiter-operator`      |
+| `namespace`    | Namespace to deploy the operator to  | `dynratelimiter-operator`  |
+| `image.repository`  | Image repository | `ghcr.io/arivum/dynratelimiter/dynratelimiter-operator` |
+| `image.tag`  | Image tag  | `latest` |
+| `image.pullPolicy`  | Image pull policy | `IfNotPresent` |
+| `imagePullSecrets`  | A list of image pull secrets when using your own image | `[]` |
+| `nameOverride`  | Overrides the basename for deployments etc. | `""` |
+| `fullnameOverride` | Completly overrides the auto-generated names for deployments etc. | `""` |
+| `logging.level` | Log level. Must be one of `[info, debug, warn, error, trace]` | `info` |
+| `logging.format` | Log format. Choose one of `[gofmt, json]` | `gofmt` |
+| `mutationConfig.image` | Configures the image that gets injected into annotated pods by the operator | `ghcr.io/arivum/dynratelimiter/dynratelimiter` |
+| `mutationConfig.tag` | Configures the tag of image that gets injected into annotated pods by the operator | `latest` |
+| `service.type` | Kubernetes serivce type | `ClusterIP` |
+| `service.port` | Kubernetes service port | `443` |
+| `service.targetPort` | Kubernetes service target port and listen port of the dynratelimit-operator application | `8443` |
+| `resources` | Pod resource requests and limits | `{}` |
+| `nodeSelector` | Kubernetes node selector | `{}` |
+| `tolerations` | Kuberentes tolerations | `[]` |
+| `affinity` | Kubernetes pod affinity | `{}` |

build/helm/dynratelimiter-operator/values.yaml

@@ -53,5 +53,3 @@ nodeSelector: {}
 tolerations: []
 
 affinity: {}
-
-caBundle: