diff --git a/Makefile b/Makefile index 3e18db26..d0388e72 100644 --- a/Makefile +++ b/Makefile @@ -164,6 +164,10 @@ deploy-helm: manifests helm helm-template: manifests helm $(HELM) template k6-operator ./charts/k6-operator -f ./charts/k6-operator/values.yaml --set manager.image.name=$(IMG_NAME) --set manager.image.tag=$(IMG_TAG) +helm-docs: + go install github.com/norwoodj/helm-docs/cmd/helm-docs@v1.14.2 + $(shell go env GOPATH)/bin/helm-docs + helm-schema: go install github.com/dadav/helm-schema/cmd/helm-schema@0.12.0 $(shell go env GOPATH)/bin/helm-schema --chart-search-root ./charts/k6-operator diff --git a/charts/k6-operator/Chart.yaml b/charts/k6-operator/Chart.yaml index 7bf8dcf9..39a0e6ec 100644 --- a/charts/k6-operator/Chart.yaml +++ b/charts/k6-operator/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v1 appVersion: "0.0.17" description: A Helm chart to install the k6-operator name: k6-operator -version: 3.9.0 +version: 3.9.1 kubeVersion: ">=1.16.0-0" home: https://k6.io sources: diff --git a/charts/k6-operator/README.md b/charts/k6-operator/README.md index 993514a8..44d2de27 100644 --- a/charts/k6-operator/README.md +++ b/charts/k6-operator/README.md @@ -1,6 +1,6 @@ # k6-operator -![Version: 3.9.0](https://img.shields.io/badge/Version-3.9.0-informational?style=flat-square) ![AppVersion: 0.0.17](https://img.shields.io/badge/AppVersion-0.0.17-informational?style=flat-square) +![Version: 3.9.1](https://img.shields.io/badge/Version-3.9.1-informational?style=flat-square) ![AppVersion: 0.0.17](https://img.shields.io/badge/AppVersion-0.0.17-informational?style=flat-square) A Helm chart to install the k6-operator @@ -36,31 +36,35 @@ Kubernetes: `>=1.16.0-0` | authProxy.resources | object | `{}` | rbac-proxy resource limitation/request | | customAnnotations | object | `{}` | Custom Annotations to be applied on all resources | | customLabels | object | `{}` | Custom Label to be applied on all resources | +| global.image | object | `{"pullSecrets":[],"registry":""}` | Global image configuration | | global.image.pullSecrets | list | `[]` | Optional set of global image pull secrets | | global.image.registry | string | `""` | Global image registry to use if it needs to be overridden for some specific use cases (e.g local registries, custom images, ...) | | installCRDs | bool | `true` | Installs CRDs as part of the release | +| manager | object | `{"containerSecurityContext":{},"env":[],"envFrom":[],"image":{"pullPolicy":"IfNotPresent","registry":"ghcr.io","repository":"grafana/k6-operator","tag":"controller-v0.0.17"},"livenessProbe":{},"readinessProbe":{},"replicas":1,"resources":{"limits":{"cpu":"100m","memory":"100Mi"},"requests":{"cpu":"100m","memory":"50Mi"}},"serviceAccount":{"create":true,"name":"k6-operator-controller"}}` | controller-manager configuration | | manager.containerSecurityContext | object | `{}` | A security context defines privileges and access control settings for the container. | -| manager.env | object | `{}` | Environment variables to be applied on the controller | +| manager.env | list | `[]` | List of environment variables to set in the controller | +| manager.envFrom | list | `[]` | List of sources to populate environment variables in the controller | +| manager.image | object | `{"pullPolicy":"IfNotPresent","registry":"ghcr.io","repository":"grafana/k6-operator","tag":"controller-v0.0.17"}` | controller-manager image configuration | | manager.image.pullPolicy | string | `"IfNotPresent"` | pull policy for the image possible values Always, Never, IfNotPresent (default: IfNotPresent) | -| manager.image.registry | string | `"ghcr.io"` | | | manager.image.repository | string | `"grafana/k6-operator"` | controller-manager image repository | | manager.image.tag | string | `"controller-v0.0.17"` | controller-manager image tag | | manager.livenessProbe | object | `{}` | Liveness probe in Probe format | | manager.readinessProbe | object | `{}` | Readiness probe in Probe format | | manager.replicas | int | `1` | number of controller-manager replicas (default: 1) | | manager.resources | object | `{"limits":{"cpu":"100m","memory":"100Mi"},"requests":{"cpu":"100m","memory":"50Mi"}}` | controller-manager Resources definition | +| manager.resources.limits | object | `{"cpu":"100m","memory":"100Mi"}` | controller-manager Resources limits | | manager.resources.limits.cpu | string | `"100m"` | controller-manager CPU limit (Max) | | manager.resources.limits.memory | string | `"100Mi"` | controller-manager Memory limit (Max) | +| manager.resources.requests | object | `{"cpu":"100m","memory":"50Mi"}` | controller-manager Resources requests | | manager.resources.requests.cpu | string | `"100m"` | controller-manager CPU request (Min) | | manager.resources.requests.memory | string | `"50Mi"` | controller-manager Memory request (Min) | | manager.serviceAccount.create | bool | `true` | create the service account (default: true) | | manager.serviceAccount.name | string | `"k6-operator-controller"` | kubernetes service account for the k6 manager | +| namespace | object | `{"create":true}` | Namespace creation | | namespace.create | bool | `true` | create the namespace (default: true) | | nodeSelector | object | `{}` | Node Selector to be applied on all containers | | podAnnotations | object | `{}` | Custom Annotations to be applied on all pods | | podLabels | object | `{}` | Custom Label to be applied on all pods | | prometheus.enabled | bool | `false` | enables the prometheus metrics scraping (default: false) | -| tolerations | object | `{}` | Tolerations to be applied on all containers | +| tolerations | list | `[]` | Tolerations to be applied on all containers | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3) \ No newline at end of file