feat: overriding BACKUP_NAME and set RESTIC_HOSTNAME (#274)

Author: DerRockWolf

charts/minecraft/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v1
 name: minecraft
-version: 4.26.4
+version: 5.0.0
 appVersion: SeeValues
 home: https://minecraft.net/
 description: Minecraft server

charts/minecraft/templates/deployment.yaml

@@ -352,7 +352,7 @@ spec:
         env:
         - name: SRC_DIR
           value: "/data"
-{{- template "minecraft.envMap" list "BACKUP_NAME" .Values.minecraftServer.worldSaveName  }}
+{{- template "minecraft.envMap" list "BACKUP_NAME" (.Values.mcbackup.backupName | default .Values.minecraftServer.worldSaveName)  }}
 {{- template "minecraft.envMap" list "INITIAL_DELAY" .Values.mcbackup.initialDelay  }}
 {{- template "minecraft.envMap" list "BACKUP_INTERVAL" .Values.mcbackup.backupInterval  }}
 {{- template "minecraft.envMap" list "PRUNE_BACKUPS_DAYS" .Values.mcbackup.pruneBackupsDays  }}
@@ -388,6 +388,7 @@ spec:
 {{- template "minecraft.envMap" list "RESTIC_REPOSITORY" .Values.mcbackup.resticRepository  }}
 {{- template "minecraft.envMap" list "RESTIC_ADDITIONAL_TAGS" .Values.mcbackup.resticAdditionalTags  }}
 {{- template "minecraft.envMap" list "PRUNE_RESTIC_RETENTION" .Values.mcbackup.pruneResticRetention  }}
+{{- template "minecraft.envMap" list "RESTIC_HOSTNAME" (required "mcbackup.resticHostname is required" .Values.mcbackup.resticHostname) }}
         {{-   range $key, $value := .Values.mcbackup.resticEnvs }}
         {{-     if kindIs "map" $value }}
         {{-       if hasKey $value "valueFrom" }}

charts/minecraft/values.yaml

@@ -483,6 +483,10 @@ mcbackup:
   #  wait 2 minutes before starting
   initialDelay: 2m
 
+  # Sets `BACKUP_NAME`, defaults to `minecraftServer.worldSaveName`
+  # WARN: When using restic and sharing the `mcbackup.resticRepository` across multiple minecraft server deployments: either `mcbackup.backupName` or `mcbackup.resticHostname` must be unique!
+  backupName:
+
   # ***set to 0 or smaller, script will run once and exit.  DO NOT SET TO 0 or smaller, this will cause K8s to kill your pod!***
   # backupInterval="1.5d" -> backup every one and a half days (36 hours)
   # backupInterval="2h 30m" -> backup every two and a half hours
@@ -538,6 +542,10 @@ mcbackup:
   resticAdditionalTags: "mc_backups"
   # see https://restic.readthedocs.io/en/latest/060_forget.html
   pruneResticRetention: "--keep-daily 7 --keep-weekly 5 --keep-monthly 12 --keep-yearly 75"
+  # Sets `RESTIC_HOSTNAME`
+  # Required because the container hostname changes on every recreate of the pod which prevents restic from pruning snapshots from previous pods/hostnames
+  # WARN: When using restic and sharing the `mcbackup.resticRepository` across multiple minecraft server deployments: either `mcbackup.backupName` or `mcbackup.resticHostname` must be unique!
+  resticHostname:
 
   # At least one of RESTIC_PASSWORD* env variables need to be defined, see https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html
   resticEnvs: