document manual migration to v0.2.0

allaboutapps · Jan 7, 2025 · 95f9c4b · 95f9c4b
1 parent eb40485
commit 95f9c4b
Showing 1 changed file with 55 additions and 0 deletions.
diff --git a/docs/changes-v0.2.0.md b/docs/changes-v0.2.0.md
@@ -0,0 +1,55 @@
+# Migration to v0.2.0
+
+The following commit introduced a change in how the value of the `backup-ns.sh/weekly` label is generated. e.g. the value of the label is now `w04` instead of `YYYY-w04` (where 04 is the current week number).
+
+```bash
+commit eb40485eb9261ec134dfa6e8d4ce709bed695304 (HEAD -> dev, origin/mr/work, origin/dev, github/mr/work, github/dev, mr/work)
+Author: Mario Ranftl
+Date:   Tue Jan 7 18:06:25 2025 +0100
+
+    adds envx, switch to backup-ns.sh/weekly label to w04 only (without YYYY), snap labels, simulate test label generation
+```
+
+This change is released as part of v0.2.0.
+
+## Migration Steps
+
+For the retention logic to properly work, it's necessary to update the value of the `backup-ns.sh/weekly` label for all existing snapshots. The following steps describe how to do this:
+
+```bash
+# List all snapshots with weekly label
+kubectl get vs --all-namespaces -l"backup-ns.sh/weekly" -Lbackup-ns.sh/retain,backup-ns.sh/weekly
+
+# outputs e.g.:
+# NAME                            READYTOUSE   SOURCEPVC   SOURCESNAPSHOTCONTENT   RESTORESIZE   SNAPSHOTCLASS        SNAPSHOTCONTENT                                    CREATIONTIME   AGE     RETAIN                 WEEKLY
+# data-2024-12-23-001716-teefnb   true         data                                10Gi          a3cloud-csi-gce-pd   snapcontent-89b2b720-0ebc-4ad1-8ad5-cf1815deff16   15d            15d     daily_weekly_monthly   2024-w52
+# data-2024-12-30-002012-izgqoi   true         data                                10Gi          a3cloud-csi-gce-pd   snapcontent-3aa08d3a-584e-4b8a-bb3d-1d2d4a1f48bd   8d             8d      daily_weekly_monthly   2024-w53
+# data-2025-01-01-001709-sivtji   true         data                                10Gi          a3cloud-csi-gce-pd   snapcontent-d3075820-6eb2-4fa5-a5f3-afee76887441   6d18h          6d18h   daily_weekly_monthly   2025-w01
+# data-2025-01-06-003219-meaukv   true         data                                10Gi          a3cloud-csi-gce-pd   snapcontent-08a8ebb9-3322-4b10-9461-04448e9f8ca3   42h            42h     daily_weekly_monthly   2025-w02
+
+# Generate migration commands (review before executing)
+kubectl get vs --all-namespaces -l"backup-ns.sh/weekly" -o json | \
+  jq -r '.items[] | 
+    select(.metadata.labels."backup-ns.sh/weekly" | test("^[0-9]{4}-w[0-9]{2}$")) | 
+    "kubectl label vs -n \(.metadata.namespace) \(.metadata.name) backup-ns.sh/weekly=\(.metadata.labels."backup-ns.sh/weekly" | split("-")[1]) --overwrite"'
+
+# outputs e.g.:
+# kubectl label vs -n go-starter-dev data-2024-12-23-001716-teefnb backup-ns.sh/weekly=w52 --overwrite
+# kubectl label vs -n go-starter-dev data-2024-12-30-002012-izgqoi backup-ns.sh/weekly=w53 --overwrite
+# kubectl label vs -n go-starter-dev data-2025-01-01-001709-sivtji backup-ns.sh/weekly=w01 --overwrite
+# kubectl label vs -n go-starter-dev data-2025-01-06-003219-meaukv backup-ns.sh/weekly=w02 --overwrite
+
+# Review and execute the generated commands
+
+# Finally verify changes
+kubectl get vs --all-namespaces -l"backup-ns.sh/weekly" -Lbackup-ns.sh/retain,backup-ns.sh/weekly
+
+# outputs e.g.:
+# NAME                            READYTOUSE   SOURCEPVC   SOURCESNAPSHOTCONTENT   RESTORESIZE   SNAPSHOTCLASS        SNAPSHOTCONTENT                                    CREATIONTIME   AGE     RETAIN                 WEEKLY
+# data-2024-12-23-001716-teefnb   true         data                                10Gi          a3cloud-csi-gce-pd   snapcontent-89b2b720-0ebc-4ad1-8ad5-cf1815deff16   15d            15d     daily_weekly_monthly   w52
+# data-2024-12-30-002012-izgqoi   true         data                                10Gi          a3cloud-csi-gce-pd   snapcontent-3aa08d3a-584e-4b8a-bb3d-1d2d4a1f48bd   8d             8d      daily_weekly_monthly   w53
+# data-2025-01-01-001709-sivtji   true         data                                10Gi          a3cloud-csi-gce-pd   snapcontent-d3075820-6eb2-4fa5-a5f3-afee76887441   6d18h          6d18h   daily_weekly_monthly   w01
+# data-2025-01-06-003219-meaukv   true         data                                10Gi          a3cloud-csi-gce-pd   snapcontent-08a8ebb9-3322-4b10-9461-04448e9f8ca3   42h            42h     daily_weekly_monthly   w02
+
+# Done (see the WEEKLY column)
+```