Skip to content

Commit b2e89c3

Browse files
committed
docs: added migration steps
1 parent 4257996 commit b2e89c3

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ uninstall:
2828
kubectl delete ns $(NAMESPACE)
2929

3030
upgrade:
31-
helm upgrade connaisseur helm -n $(NAMESPACE) --wait
31+
helm upgrade connaisseur helm -n $(NAMESPACE) --wait
3232

3333
annihilate:
3434
kubectl delete all,mutatingwebhookconfigurations,clusterroles,clusterrolebindings,configmaps,secrets,serviceaccounts,crds -lapp.kubernetes.io/instance=connaisseur -n $(NAMESPACE)

docs/migrating_to_version_3.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ Connaisseur version 3.0 is out and brings along many new features, but also brea
55
For those breaking changes, we've set up a [script](https://github.com/sse-secure-systems/connaisseur/blob/master/scripts/upgrade_to_version_3.py) that migrates your existing Connaisseur configuration.
66
Read on for the list of most interesting changes.
77

8+
## How to migrate
9+
10+
0. Read the [Major changes](#major-changes) and [API changes](#api-changes) sections to get an overview of what's new
11+
1. Run `python3 scripts/upgrade_to_version_3.py`
12+
2. Check the diff of your `helm/values.yaml` and make sure everything is as expected
13+
3. Run `make upgrade` or alternatively `helm upgrade connaisseur helm -n <your-namespace> --wait`
14+
4. Enjoy the new version :tada: :crossed_fingers:
15+
816
## Major changes
917

1018
- NEW: Support for Cosign 2.0

0 commit comments

Comments
 (0)