bitnamicharts/grafana-k6-operator repository overview

⁠Bitnami Secure Images Helm chart for Grafana k6 Operator

Grafana k6 Operator is a Kubernetes operator that enables running distributed k6 load tests in a cluster, automating test execution and scaling for performance validation.

Overview of Grafana k6 Operator⁠

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

⁠ TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/grafana-k6-operator

⁠ Introduction

This chart bootstraps a Grafana k6 Operator⁠ deployment on a Kubernetes⁠ cluster using the Helm⁠ package manager.

⁠ Before you begin

• Kubernetes 1.23+
• Helm 3.8.0+

⁠ Installing the Chart

To install the chart with the release name my-release:

helm install my-release REGISTRY_NAME/REPOSITORY_NAME/grafana-k6-operator

The command deploys Grafana k6 Operator on the Kubernetes cluster in the default configuration. The Parameters⁠ section lists the parameters that can be configured during installation.

⁠ Configuration and installation details

This section describes credentials, configuration, and other installation options.

⁠ Rolling VS Immutable tags⁠

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

⁠ Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart⁠. However, in production workloads using resourcesPreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation⁠.

⁠ Prometheus metrics

This chart can be integrated with Prometheus by setting metrics.enabled to true. This will expose the Grafana k6 Operator native Prometheus endpoint in a metrics service, which can be configured under the metrics.service section. It will have the necessary annotations to be automatically scraped by Prometheus.

It is possible to set RBAC-based authentication to this endpoint by setting authProxy.enabled=true, this will deploy a sidecar with kube-rbac-proxy⁠ and only the authorized ServiceAccounts will be able to access the metrics.

⁠Prometheus requirements

It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart⁠ or the Bitnami Kube Prometheus helm chart⁠ to easily have a working Prometheus in your cluster.

⁠Integration with Prometheus Operator

The chart can deploy ServiceMonitor objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true. Ensure that the Prometheus Operator CustomResourceDefinitions are installed in the cluster or it will fail with the following error:

no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

Install the Bitnami Kube Prometheus helm chart⁠ for having the necessary CRDs and the Prometheus Operator.

⁠ Sidecars

If additional containers are needed in the same pod as grafana-k6-operator (such as additional metrics or logging exporters), they can be defined using the sidecars parameter:

sidecars:
- name: your-image-name
  image: your-image
  imagePullPolicy: Always
  ports:
  - name: portname
    containerPort: 1234

If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts parameter (where available), as shown in the example below:

service:
  extraPorts:
  - name: extraPort
    port: 11311
    targetPort: 11311

If additional init containers are needed in the same pod, they can be defined using the initContainers parameter. Here is an example:

initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

Learn more about sidecar containers⁠ and init containers⁠.

⁠ Deploying extra resources

Apart from the Operator, you may want to deploy TestRun objects. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy parameter. The following example creates a TestRun object with a ConfigMap with the testing code:

extraDeploy:
- apiVersion: k6.io/v1alpha1
  kind: TestRun
  metadata:
    name: testrun-sample
  spec:
    parallelism: 2
    script:
      configMap:
        name: k6-test
        file: test.js
- apiVersion: v1
  kind: ConfigMap
  metadata:
    name: k6-test
  data:
    test.js: |
      import http from 'k6/http';
      import { Rate } from 'k6/metrics';
      import { check, sleep } from 'k6';

      const failRate = new Rate('failed_requests');

      export let options = {
        stages: [
          { target: 200, duration: '30s' },
          { target: 0, duration: '30s' },
        ],
        thresholds: {
          failed_requests: ['rate<=0'],
          http_req_duration: ['p(95)<500'],
        },
      };

      export default function () {
        const result = http.get('https://quickpizza.grafana.com');
        check(result, {
          'http response status code is 200': result.status === 200,
        });
        failRate.add(result.status !== 200);
        sleep(1);
      }

Check the Grafana k6 Operator official documentation⁠ for the list of available objects.

⁠ Pod affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod affinity in the kubernetes documentation⁠.

As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common⁠ chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters inside the operator, apiserver and cluster sections.

⁠ FIPS parameters

The FIPS parameters only have effect if you are using images from the Bitnami Secure Images catalog⁠.

For more information on this new support, please refer to the FIPS Compliance section⁠.

⁠ Parameters

The following subsections list global, common, and component-specific parameters.

⁠ Global parameters

⁠ Common parameters

Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://techdocs.broadcom.com/us/en/vmware-tanzu/bitnami-secure-images/bitnami-secure-images/services/bsi-app-doc/apps-charts-grafana-k6-operator-index.html⁠