|
@@ -319,75 +319,25 @@ As an alternative, use one of the preset configurations for pod affinity, pod an
|
|
|
|
|
|
### Prometheus metrics parameters
|
|
|
|
|
|
-| Name | Description | Value |
|
|
|
-| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
|
|
|
-| `metrics.enabled` | Enable the export of Prometheus metrics | `false` |
|
|
|
-| `metrics.authProxy.enabled` | | `false` |
|
|
|
-| `metrics.authProxy.image.registry` | kube-auth-proxy image registry | `REGISTRY_NAME` |
|
|
|
-| `metrics.authProxy.image.repository` | kube-auth-proxy image repository | `REPOSITORY_NAME/kube-auth-proxy` |
|
|
|
-| `metrics.authProxy.image.digest` | kube-auth-proxy image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
|
|
|
-| `metrics.authProxy.image.pullPolicy` | kube-auth-proxy image pull policy | `IfNotPresent` |
|
|
|
-| `metrics.authProxy.image.pullSecrets` | Specify docker-registry secret names as an array | `[]` |
|
|
|
-| `metrics.authProxy.command` | Override default container command (useful when using custom images) | `[]` |
|
|
|
-| `metrics.authProxy.args` | Override default container args (useful when using custom images) | `[]` |
|
|
|
-| `metrics.authProxy.extraArgs` | Add extra arguments to the default container args section | `[]` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.enabled` | Enable Prometheus kube-auth-proxy containers' Security Context | `true` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.seLinuxOptions` | Set SELinux options in container | `{}` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.runAsUser` | Set Prometheus kube-auth-proxy containers' Security Context runAsUser | `1001` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.runAsGroup` | Group ID for the Prometheus kube-auth-proxy container | `1001` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.runAsNonRoot` | Set Prometheus kube-auth-proxy containers' Security Context runAsNonRoot | `true` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.privileged` | Set Prometheus kube-auth-proxy container's Security Context privileged | `false` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.allowPrivilegeEscalation` | Set Prometheus kube-auth-proxy containers' Security Context allowPrivilegeEscalation | `false` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.readOnlyRootFilesystem` | Set Prometheus kube-auth-proxy containers' Security Context readOnlyRootFilesystem | `true` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.capabilities.drop` | Set Prometheus kube-auth-proxy containers' Security Context capabilities to be dropped | `["ALL"]` |
|
|
|
-| `metrics.authProxy.containerSecurityContext.seccompProfile.type` | Set Prometheus kube-auth-proxy container's Security Context seccomp profile | `RuntimeDefault` |
|
|
|
-| `metrics.authProxy.containerPorts.https` | kube-auth-proxy container port | `8443` |
|
|
|
-| `metrics.authProxy.containerPorts.health` | kube-auth-proxy health port | `8081` |
|
|
|
-| `metrics.authProxy.extraContainerPorts` | Optionally specify extra list of additional container ports | `[]` |
|
|
|
-| `metrics.authProxy.extraVolumeMounts` | Optionally specify extra list of additional volumeMounts for kube-auth-proxy | `[]` |
|
|
|
-| `metrics.authProxy.customLivenessProbe` | Custom livenessProbe that overrides the default one | `{}` |
|
|
|
-| `metrics.authProxy.customReadinessProbe` | Custom readinessProbe that overrides the default one | `{}` |
|
|
|
-| `metrics.authProxy.customStartupProbe` | Custom startupProbe that overrides the default one | `{}` |
|
|
|
-| `metrics.authProxy.lifecycleHooks` | for the kube-auth-proxy containers' to automate configuration before or after startup | `{}` |
|
|
|
-| `metrics.authProxy.extraEnvVars` | Array with extra environment variables to add to kube-auth-proxy containers | `[]` |
|
|
|
-| `metrics.authProxy.extraEnvVarsCM` | Name of existing ConfigMap containing extra env vars for ClickHouse Operator Metrics exporter containers | `""` |
|
|
|
-| `metrics.authProxy.extraEnvVarsSecret` | Name of existing Secret containing extra env vars for ClickHouse Operator Metrics exporter containers | `""` |
|
|
|
-| `metrics.authProxy.resourcesPreset` | Set container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if metrics.authProxy.resources is set (metrics.authProxy.resources is recommended for production). | `micro` |
|
|
|
-| `metrics.authProxy.resources` | Set container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
|
|
|
-| `metrics.authProxy.livenessProbe.enabled` | Enable livenessProbe | `true` |
|
|
|
-| `metrics.authProxy.livenessProbe.initialDelaySeconds` | Initial delay seconds for livenessProbe | `5` |
|
|
|
-| `metrics.authProxy.livenessProbe.periodSeconds` | Period seconds for livenessProbe | `10` |
|
|
|
-| `metrics.authProxy.livenessProbe.timeoutSeconds` | Timeout seconds for livenessProbe | `30` |
|
|
|
-| `metrics.authProxy.livenessProbe.failureThreshold` | Failure threshold for livenessProbe | `3` |
|
|
|
-| `metrics.authProxy.livenessProbe.successThreshold` | Success threshold for livenessProbe | `1` |
|
|
|
-| `metrics.authProxy.readinessProbe.enabled` | Enable readinessProbe | `true` |
|
|
|
-| `metrics.authProxy.readinessProbe.initialDelaySeconds` | Initial delay seconds for readinessProbe | `5` |
|
|
|
-| `metrics.authProxy.readinessProbe.periodSeconds` | Period seconds for readinessProbe | `10` |
|
|
|
-| `metrics.authProxy.readinessProbe.timeoutSeconds` | Timeout seconds for readinessProbe | `30` |
|
|
|
-| `metrics.authProxy.readinessProbe.failureThreshold` | Failure threshold for readinessProbe | `3` |
|
|
|
-| `metrics.authProxy.readinessProbe.successThreshold` | Success threshold for readinessProbe | `1` |
|
|
|
-| `metrics.authProxy.startupProbe.enabled` | Enable startupProbe | `false` |
|
|
|
-| `metrics.authProxy.startupProbe.initialDelaySeconds` | Initial delay seconds for startupProbe | `5` |
|
|
|
-| `metrics.authProxy.startupProbe.periodSeconds` | Period seconds for startupProbe | `10` |
|
|
|
-| `metrics.authProxy.startupProbe.timeoutSeconds` | Timeout seconds for startupProbe | `30` |
|
|
|
-| `metrics.authProxy.startupProbe.failureThreshold` | Failure threshold for startupProbe | `3` |
|
|
|
-| `metrics.authProxy.startupProbe.successThreshold` | Success threshold for startupProbe | `1` |
|
|
|
-| `metrics.service.ports.metrics` | kube-auth-proxy service port | `443` |
|
|
|
-| `metrics.service.clusterIP` | Static clusterIP or None for headless services | `""` |
|
|
|
-| `metrics.service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` |
|
|
|
-| `metrics.service.labels` | labels for the metrics service | `{}` |
|
|
|
-| `metrics.service.annotations` | Annotations for the metrics service | `{}` |
|
|
|
-| `metrics.serviceMonitor.enabled` | if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`) | `false` |
|
|
|
-| `metrics.serviceMonitor.namespace` | Namespace in which Prometheus is running | `""` |
|
|
|
-| `metrics.serviceMonitor.annotations` | Additional custom annotations for the ServiceMonitor | `{}` |
|
|
|
-| `metrics.serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` |
|
|
|
-| `metrics.serviceMonitor.jobLabel` | The name of the label on the target service to use as the job name in Prometheus | `""` |
|
|
|
-| `metrics.serviceMonitor.honorLabels` | honorLabels chooses the metric's labels on collisions with target labels | `false` |
|
|
|
-| `metrics.serviceMonitor.interval` | Interval at which metrics should be scraped. | `""` |
|
|
|
-| `metrics.serviceMonitor.scrapeTimeout` | Timeout after which the scrape is ended | `""` |
|
|
|
-| `metrics.serviceMonitor.metricRelabelings` | Specify additional relabeling of metrics | `[]` |
|
|
|
-| `metrics.serviceMonitor.relabelings` | Specify general relabeling | `[]` |
|
|
|
-| `metrics.serviceMonitor.selector` | Prometheus instance selector labels | `{}` |
|
|
|
+| Name | Description | Value |
|
|
|
+| ------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------- |
|
|
|
+| `metrics.enabled` | Enable the export of Prometheus metrics | `false` |
|
|
|
+| `metrics.service.ports.metrics` | kube-auth-proxy service port | `443` |
|
|
|
+| `metrics.service.clusterIP` | Static clusterIP or None for headless services | `""` |
|
|
|
+| `metrics.service.sessionAffinity` | Control where client requests go, to the same pod or round-robin | `None` |
|
|
|
+| `metrics.service.labels` | labels for the metrics service | `{}` |
|
|
|
+| `metrics.service.annotations` | Annotations for the metrics service | `{}` |
|
|
|
+| `metrics.serviceMonitor.enabled` | if `true`, creates a Prometheus Operator ServiceMonitor (also requires `metrics.enabled` to be `true`) | `false` |
|
|
|
+| `metrics.serviceMonitor.namespace` | Namespace in which Prometheus is running | `""` |
|
|
|
+| `metrics.serviceMonitor.annotations` | Additional custom annotations for the ServiceMonitor | `{}` |
|
|
|
+| `metrics.serviceMonitor.labels` | Extra labels for the ServiceMonitor | `{}` |
|
|
|
+| `metrics.serviceMonitor.jobLabel` | The name of the label on the target service to use as the job name in Prometheus | `""` |
|
|
|
+| `metrics.serviceMonitor.honorLabels` | honorLabels chooses the metric's labels on collisions with target labels | `false` |
|
|
|
+| `metrics.serviceMonitor.interval` | Interval at which metrics should be scraped. | `""` |
|
|
|
+| `metrics.serviceMonitor.scrapeTimeout` | Timeout after which the scrape is ended | `""` |
|
|
|
+| `metrics.serviceMonitor.metricRelabelings` | Specify additional relabeling of metrics | `[]` |
|
|
|
+| `metrics.serviceMonitor.relabelings` | Specify general relabeling | `[]` |
|
|
|
+| `metrics.serviceMonitor.selector` | Prometheus instance selector labels | `{}` |
|
|
|
|
|
|
The above parameters map to the env variables defined in [bitnami/grafana-k6-operator](https://github.com/bitnami/containers/tree/main/bitnami/grafana-k6-operator). For more information please refer to the [bitnami/grafana-k6-operator](https://github.com/bitnami/containers/tree/main/bitnami/grafana-k6-operator) image documentation.
|
|
|
|
|
@@ -416,6 +366,12 @@ helm install my-release -f values.yaml REGISTRY_NAME/REPOSITORY_NAME/grafana-k6-
|
|
|
|
|
|
Find more information about how to deal with common errors related to Bitnami's Helm charts in [this troubleshooting guide](https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues).
|
|
|
|
|
|
+## Upgrading
|
|
|
+
|
|
|
+### To 1.0.0
|
|
|
+
|
|
|
+This major release introduces some breaking changes, including the removal of the `kube-rbac-proxy` image. Section `metrics.authProxy` has been removed accordingly. Find more details in the [release notes](https://github.com/grafana/k6-operator/releases/tag/v0.0.22).
|
|
|
+
|
|
|
## License
|
|
|
|
|
|
Copyright © 2025 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
|