Added upgrade guide

This commit is contained in:
mmontes11
2024-09-13 16:18:37 +02:00
parent f80f4d5aeb
commit 66fdecb038
2 changed files with 54 additions and 1 deletions

53
docs/UPGRADE_v0.0.31.md Normal file
View File

@ -0,0 +1,53 @@
# Upgrade guide v0.0.31
This guide illustrates, step by step, how to migrate to `v0.0.31` from previous versions.
- Uninstall you current `mariadb-operator` for preventing conflicts:
```bash
helm uninstall mariadb-operator
```
Alternatively, you may only downscale and delete the webhook configurations:
```bash
kubectl scale deployment mariadb-operator --replicas=0
kubectl scale deployment mariadb-operator-webhook --replicas=0
kubectl delete validatingwebhookconfiguration mariadb-operator-webhook
kubectl delete mutatingwebhookconfiguration mariadb-operator-webhook
```
- Upgrade CRDs to `v0.0.31`:
> [!IMPORTANT]
> Helm does not handle CRD upgrades. See [helm docs](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#some-caveats-and-explanations).
```bash
kubectl replace -f https://github.com/mariadb-operator/mariadb-operator/releases/download/helm-chart-0.31.0/crds.yaml
```
- If you are using Galera, apply the following changes in the `MariaDB` resources:
Update the `init` and `agent` containers to `v0.0.31`:
```diff
apiVersion: k8s.mariadb.com/v1alpha1
kind: MariaDB
metadata:
name: mariadb
spec:
galera:
agent:
- image: docker-registry3.mariadb.com/mariadb-operator/mariadb-operator:v0.0.30
+ image: docker-registry3.mariadb.com/mariadb-operator/mariadb-operator:v0.0.31
initContainer:
- image: docker-registry3.mariadb.com/mariadb-operator/mariadb-operator:v0.0.30
+ image: docker-registry3.mariadb.com/mariadb-operator/mariadb-operator:v0.0.31
```
- Upgrade `mariadb-operator` to `v0.0.31`:
```bash
helm repo update mariadb-operator
helm upgrade --install mariadb-operator mariadb-operator/mariadb-operator --version 0.31.0
```
- If you previously decided to downscale the operator, make sure you upscale it back:
```bash
kubectl scale deployment mariadb-operator -n default --replicas=1
kubectl scale deployment mariadb-operator-webhook -n default --replicas=1
```

View File

@ -1,4 +1,4 @@
This is a patch release to fix some regressions related to the Galera. If you are using Galera and `ReadWriteOnce` storage, it is highly recommended to upgrade.
This is a patch release to fix some regressions related to the Galera. If you are using Galera with `ReadWriteOnce` storage, it is highly recommended to upgrade. Please, follow the __[UPGRADE GUIDE](https://github.com/mariadb-operator/mariadb-operator/blob/main/docs/UPGRADE_v0.0.31.md)__.
When using `ReadWriteOnce` storage, if the Galera recovery `Jobs` (introduced in [v0.0.30](https://github.com/mariadb-operator/mariadb-operator/releases/tag/v0.0.30)) are not scheduled in the same node as the `MariaDB` `Pods`, they will be unable to attach the PVC and the recovery will not progress. See the following issues for further detail: https://github.com/mariadb-operator/mariadb-operator/issues/840