feat: add minecraft backup method

Minecraft server can now be backed up using the restic-compose-backup.minecraft flag

.gitignore

@@ -20,6 +20,7 @@ venv
 restic_data/
 restic_cache/
 alerts.env
+minecraft/
 
 # build
 build/

docker-compose.yaml

@@ -67,6 +67,17 @@ services:
     volumes:
       - pgdata:/var/lib/postgresql/data
 
+  minecraft:
+    image: itzg/minecraft-server
+    labels:
+      restic-compose-backup.minecraft: true
+      restic-compose-backup.volumes.include: "minecraft"
+    environment:
+      - RCON_PASSWORD=minecraft
+      - EULA=TRUE
+    volumes:
+      - ./minecraft:/data
+
 volumes:
   mysqldata:
   mariadbdata:

src/Dockerfile

@@ -37,8 +37,5 @@ ENV XDG_CACHE_HOME=/cache
 
 # end install
 
-ADD backup.sh /backup.sh
-RUN chmod +x /backup.sh
-
 ENTRYPOINT []
 CMD ["./entrypoint.sh"]

src/crontab

@@ -1 +1,2 @@
-10 2 * * * . /env.sh && /backup.sh > /proc/1/fd/1 2>&1
+10 2 * * * source /env.sh && rcb backup > /proc/1/fd/1
+

src/restic_compose_backup/cli.py

@@ -9,7 +9,7 @@
     restic,
 )
 from restic_compose_backup.config import Config
-from restic_compose_backup.containers import RunningContainers
+from restic_compose_backup.containers import RunningContainers, Container
 from restic_compose_backup import cron, utils
 
 logger = logging.getLogger(__name__)
@@ -94,6 +94,21 @@ def status(config, containers):
     for container in backup_containers:
         logger.info('service: %s', container.service_name)
 
+        if container.minecraft_backup_enabled:
+            instance = container.instance
+            ping = instance.ping()
+            logger.info(
+                ' - %s (is_ready=%s):',
+                instance.container_type,
+                ping == 0
+            )
+            for mount in container.filter_mounts():
+                logger.info(
+                    '   - volume: %s -> %s',
+                    mount.source,
+                    container.get_volume_backup_destination(mount, '/minecraft'),
+                )
+
         if container.volume_backup_enabled:
             for mount in container.filter_mounts():
                 logger.info(

src/restic_compose_backup/config.py

@@ -2,8 +2,8 @@
 
 
 class Config:
-    default_backup_command = ". /env.sh && /backup.sh > /proc/1/fd/1 2>&1"
-    default_crontab_schedule = "0 */4 * * *"
+    default_backup_command = "source /env.sh && rcb backup > /proc/1/fd/1"
+    default_crontab_schedule = "10 2 * * *"
 
     """Bag for config values"""
     def __init__(self, check=True):

src/restic_compose_backup/containers.py

@@ -144,6 +144,7 @@ def backup_enabled(self) -> bool:
         return any([
             self.volume_backup_enabled,
             self.database_backup_enabled,
+            self.minecraft_backup_enabled
         ])
 
     @property
@@ -206,7 +207,7 @@ def filter_mounts(self):
         exclude_bind_mounts = utils.is_true(config.exclude_bind_mounts)
         mounts = list(filter(lambda m: not exclude_bind_mounts or m.type == "volume", self._mounts))
 
-        if not self.volume_backup_enabled:
+        if not self.volume_backup_enabled and not self.minecraft_backup_enabled:
             return filtered
 
         if self._include:

src/restic_compose_backup/containers_minecraft.py

@@ -1,3 +1,6 @@
+import os
+import logging
+
 from pathlib import Path
 
 from restic_compose_backup.containers import Container
@@ -9,6 +12,8 @@
 )
 from restic_compose_backup import utils
 
+logger = logging.getLogger(__name__)
+
 
 class MinecraftContainer(Container):
     container_type = 'minecraft'
@@ -21,16 +26,30 @@ def get_credentials(self) -> dict:
             'port': self.get_config_env('RCON_PORT'),
         }
 
+    def prepare_mc_backup(self) -> bool:
+        creds = self.get_credentials()
+
+        with utils.environment('RCON_PASSWORD', creds['password']):
+            rcon.save_off(creds['host'], creds['port'])
+            rcon.save_all(creds['host'], creds['port'])
+            rcon.sync(creds['host'], creds['port'])
+            return True
+
     def ping(self) -> bool:
         """Check the availability of the service"""
         creds = self.get_credentials()
 
-        logger.debug("[rcon-cli] checking if minecraft server %s is online...", self.service_name)
-        with utils.environment('RCON_PASSWORD', creds['password']):
-            return rcon.is_online(
-                creds['host'],
-                creds['port']
-            )
+        try:
+            logger.debug("[rcon-cli] checking if minecraft server %s is online...", self.service_name)
+            with utils.environment('RCON_PASSWORD', creds['password']):
+                return rcon.is_online(
+                    creds['host'],
+                    creds['port']
+                )
+        except Exception as ex:
+            logger.error('[rcon-cli] unable to contact minecraft server %s', self.service_name)
+            logger.exception(ex)
+            return 1
 
     def backup(self) -> bool:
         config = Config()
@@ -40,15 +59,16 @@ def backup(self) -> bool:
         with utils.environment('RCON_PASSWORD', creds['password']):
             try:
                 # turn off auto-save and sync all data to the disk before backing up worlds
-                prepare_mc_backup()
-                for mount in container.filter_mounts():
-                    backup_data = container.get_volume_backup_destination(mount, '/volumes')
-                        logger.info('Backing up %s', mount.source)
-                        vol_result = restic.backup_files(config.repository, source=backup_data)
-                        logger.debug('Minecraft backup exit code: %s', vol_result)
-                        if vol_result != 0:
-                            logger.error('Minecraft backup exited with non-zero code: %s', vol_result)
-                            errors = True
+                self.prepare_mc_backup()
+
+                for mount in self.filter_mounts():
+                    backup_data = self.get_volume_backup_destination(mount, '/minecraft')
+                    logger.info('Backing up %s', mount.source)
+                    vol_result = restic.backup_files(config.repository, source=backup_data)
+                    logger.debug('Minecraft backup exit code: %s', vol_result)
+                    if vol_result != 0:
+                        logger.error('Minecraft backup exited with non-zero code: %s', vol_result)
+                        errors = True
             except Exception as ex:
                 logger.error('Exception raised during minecraft backup')
                 logger.exception(ex)
@@ -57,13 +77,4 @@ def backup(self) -> bool:
             # always always turn saving back on
             rcon.save_on(creds['host'], creds['port'])
 
-        return errors
-
-
-    def prepare_mc_backup():
-        creds = self.get_credentials()
-
-        with utils.environment('RCON_PASSWORD', creds['password']):
-            rcon.save_off(creds['host'], creds['port'])
-            rcon.save_all(creds['host'], creds['port'])
-            rcon.sync(creds['host'], creds['port'])
+        return errors

src/restic_compose_backup/rcon.py

@@ -8,25 +8,26 @@
     commands,
     containers
 )
+from restic_compose_backup import utils
 
 logger = logging.getLogger(__name__)
 
 def rcon_cli(host, port, cmd: str) -> int:
     exit_code = commands.run([
         "rcon-cli",
-        f"--host {host}",
-        f"--port {port}",
+        f"--host={host}",
+        f"--port={port}",
         cmd
     ])
 
     if exit_code != 0:
-        raise RconException("rcon-cli %s exited with a non-zero exit code: %s", cmd, exit_code)
+        raise RconException(f"rcon-cli {cmd} exited with a non-zero exit code: {exit_code}")
 
     return exit_code
 
 def is_online(host, port) -> int:
     """Check if rcon can be reached"""
-    return rcon_cli(host, port, "version")
+    return rcon_cli(host, port, "help")
 
 def save_off(host, port) -> int:
     """Turn saving off"""