Skip to content

Commit fe41bbc

Browse files
committed
update versions; docs: add Helm instructions
1 parent c7865a5 commit fe41bbc

File tree

5 files changed

+34
-2
lines changed

5 files changed

+34
-2
lines changed

.github/workflows/push.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: "push"
2+
name: "Release k6-operator"
33

44
on:
55
workflow_dispatch:

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Current Operator version
2-
VERSION ?= 0.0.10
2+
VERSION ?= 0.0.11
33
# Default bundle image tag
44
BUNDLE_IMG ?= k6-controller-bundle:$(VERSION)
55
# Options for 'bundle-build'

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,22 @@ curl https://raw.githubusercontent.com/grafana/k6-operator/main/bundle.yaml | ku
2323

2424
Bundle includes default manifests for k6-operator, including `k6-operator-system` namespace and k6-operator Deployment with latest tagged Docker image. Customizations can be made on top of this manifest as needs be, e.g. with `kustomize`.
2525

26+
#### Deployment with Helm
27+
28+
Helm releases of k6-operator are published together with other Grafana Helm charts and can be installed with the following commands:
29+
30+
```bash
31+
helm repo add grafana https://grafana.github.io/helm-charts
32+
helm repo update
33+
helm install k6-operator grafana/k6-operator
34+
```
35+
36+
Passing additional configuration can be done with `values.yaml` (example can be found [here](https://github.com/grafana/k6-operator/blob/main/charts/k6-operator/samples/customAnnotationsAndLabels.yaml)):
37+
38+
```bash
39+
helm install k6-operator grafana/k6-operator -f values.yaml
40+
```
41+
2642
#### Makefile deployment
2743

2844
In order to install the operator with Makefile, the following additional tooling must be installed:

docs/releases.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Release workflow
2+
3+
Current release process is rather heavy on manual interventions:
4+
5+
1. _manual_ Create a Github release.
6+
2. "Release" workflow is triggered:
7+
- build of new Docker images from `main`
8+
- PR to update bundle
9+
3. _manual_ Review and merge PR with bundle update.
10+
4. _manual_ Update operator's version in `values.yaml` and bump `Chart.yaml`.
11+
5. "Helm release" workflow is triggered, publishing to Helm Grafana repo.
12+
6. _manual_ Update Makefile with latest version, as well as `docs/versioning.md`.

docs/versioning.md

+4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ Since around v0.0.7 k6-operator has been releasing a default runner image togeth
2121
| v0.0.10rc2 | [runner-v0.0.10rc2](ghcr.io/grafana/operator:runner-v0.0.10rc2) | v0.45.0 |
2222
| v0.0.10rc3 | [runner-v0.0.10rc3](ghcr.io/grafana/k6-operator:runner-v0.0.10rc3) | v0.45.0 |
2323
| v0.0.10 | [runner-v0.0.10](ghcr.io/grafana/k6-operator:runner-v0.0.10) | v0.46.0 |
24+
| v0.0.11rc1 | [runner-v0.0.11rc1](ghcr.io/grafana/k6-operator:runner-v0.0.11rc1) | v0.46.0 |
25+
| v0.0.11rc2 | [runner-v0.0.11rc2](ghcr.io/grafana/k6-operator:runner-v0.0.11rc2) | v0.46.0 |
26+
| v0.0.11rc3 | [runner-v0.0.11rc3](ghcr.io/grafana/k6-operator:runner-v0.0.11rc3) | v0.46.0 |
27+
| v0.0.11 | [runner-v0.0.11](ghcr.io/grafana/k6-operator:runner-v0.0.11) | v0.47.0 |
2428

2529
### What was used before?
2630

0 commit comments

Comments
 (0)