Skip to content

Commit

Permalink
update versions; docs: add Helm instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
yorugac committed Oct 23, 2023
1 parent c7865a5 commit fe41bbc
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/push.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: "push"
name: "Release k6-operator"

on:
workflow_dispatch:
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Current Operator version
VERSION ?= 0.0.10
VERSION ?= 0.0.11
# Default bundle image tag
BUNDLE_IMG ?= k6-controller-bundle:$(VERSION)
# Options for 'bundle-build'
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,22 @@ curl https://raw.githubusercontent.com/grafana/k6-operator/main/bundle.yaml | ku

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`.

#### Deployment with Helm

Helm releases of k6-operator are published together with other Grafana Helm charts and can be installed with the following commands:

```bash
helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
helm install k6-operator grafana/k6-operator
```

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)):

```bash
helm install k6-operator grafana/k6-operator -f values.yaml
```

#### Makefile deployment

In order to install the operator with Makefile, the following additional tooling must be installed:
Expand Down
12 changes: 12 additions & 0 deletions docs/releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Release workflow

Current release process is rather heavy on manual interventions:

1. _manual_ Create a Github release.
2. "Release" workflow is triggered:
- build of new Docker images from `main`
- PR to update bundle
3. _manual_ Review and merge PR with bundle update.
4. _manual_ Update operator's version in `values.yaml` and bump `Chart.yaml`.
5. "Helm release" workflow is triggered, publishing to Helm Grafana repo.
6. _manual_ Update Makefile with latest version, as well as `docs/versioning.md`.
4 changes: 4 additions & 0 deletions docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Since around v0.0.7 k6-operator has been releasing a default runner image togeth
| v0.0.10rc2 | [runner-v0.0.10rc2](ghcr.io/grafana/operator:runner-v0.0.10rc2) | v0.45.0 |
| v0.0.10rc3 | [runner-v0.0.10rc3](ghcr.io/grafana/k6-operator:runner-v0.0.10rc3) | v0.45.0 |
| v0.0.10 | [runner-v0.0.10](ghcr.io/grafana/k6-operator:runner-v0.0.10) | v0.46.0 |
| v0.0.11rc1 | [runner-v0.0.11rc1](ghcr.io/grafana/k6-operator:runner-v0.0.11rc1) | v0.46.0 |
| v0.0.11rc2 | [runner-v0.0.11rc2](ghcr.io/grafana/k6-operator:runner-v0.0.11rc2) | v0.46.0 |
| v0.0.11rc3 | [runner-v0.0.11rc3](ghcr.io/grafana/k6-operator:runner-v0.0.11rc3) | v0.46.0 |
| v0.0.11 | [runner-v0.0.11](ghcr.io/grafana/k6-operator:runner-v0.0.11) | v0.47.0 |

### What was used before?

Expand Down

0 comments on commit fe41bbc

Please sign in to comment.