Bump version

README.md

@@ -162,9 +162,34 @@ pip install -r docs/requirements.txt
 python src/setup.py build_sphinx
 ```
 
+# Local dev setup
+
+The git repository contains a simple local setup for development
+
+```bash
+# Create an overlay network to link the compose project and stack
+docker network create --driver overlay --attachable global
+# Start the compose project
+docker-compose up -d
+# Deploy the stack
+docker stack deploy -c swarm-stack.yml test
+```
+
+In dev we should ideally start the backup container manually
+```bash
+docker-compose run --rm backup sh
+# pip install the package in the container in editable mode to auto sync changes from host source
+pip3 install -e .
+```
+
 ## Contributing
 
 Contributions are welcome regardless of experience level. Don't hesitate submitting issues, opening partial or completed pull requests.
 
 [restic]: https://restic.net/
 [documentation]: https://restic-compose-backup.readthedocs.io
+
+---
+This project is sponsored by [zetta.io](https://www.zetta.io)
+
+[![Zetta.IO](https://raw.githubusercontent.com/ZettaIO/restic-compose-backup/master/.github/logo.png)](https://www.zetta.io)

docker-compose.yaml

@@ -1,10 +1,16 @@
-version: '3'
+version: '3.7'
 services:
   backup:
     build: ./src
     env_file:
       - restic_compose_backup.env
       - alerts.env
+    labels:
+      restic-compose-backup.volumes: true
+      restic-compose-backup.volumes.include: 'src'
+    networks:
+      - default
+      - global
     volumes:
       # Map in docker socket
       - /var/run/docker.sock:/tmp/docker.sock:ro
@@ -20,7 +26,7 @@ services:
       restic-compose-backup.volumes: true
       restic-compose-backup.volumes.include: "/tests"
     volumes:
-      - ./tests:/srv/tests
+      - ./src/tests:/srv/tests
       - ./.vscode:/srv/code
     environment:
       - SOME_VALUE=test
@@ -65,3 +71,7 @@ volumes:
   mysqldata:
   mariadbdata:
   pgdata:
+
+networks:
+  global:
+    external: true

docs/conf.py

@@ -22,7 +22,7 @@ copyright = '2019, Zetta.IO Technology AS'
 author = 'Zetta.IO Technology AS'
 
 # The full version, including alpha/beta/rc tags
-release = '0.4.0'
+release = '0.5.0'
 
 # -- General configuration ---------------------------------------------------
 

docs/guide/configuration.rst

@@ -166,12 +166,32 @@ a webhook that will post embedded messages to a specific channel.
 
 The url usually looks like this: ``https://discordapp.com/api/webhooks/...```
 
-DOCKER_BASE_URL
+DOCKER_HOST
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~
 
 **Default value**: ``unix://tmp/docker.sock``
 
-The location of the docker socket.
+The socket or host of the docker service.
+
+DOCKER_TLS_VERIFY
+~~~~~~~~~~~~~~~~~
+
+If defined verify the host against a CA certificate.
+Path to certs is defined in ``DOCKER_CERT_PATH``
+and can be copied or mapped into this backup container.
+
+DOCKER_CERT_PATH
+~~~~~~~~~~~~~~~~
+
+A path to a directory containing TLS certificates to use when
+connecting to the Docker host. Combined with ``DOCKER_TLS_VERIFY``
+this can be used to talk to docker through TLS in cases
+were we cannot map in the docker socket.
+
+SWARM_MODE
+~~~~~~~~~~
+
+If defined containers in swarm stacks are also evaluated.
 
 Compose Labels
 --------------

extras/example-conpose-container.json

@@ -0,0 +1,196 @@
+{
+    "Id": "efa5196b4959648e3efcf5ae9f24bc4032849c2665805a5b405216f343b4decd",
+    "Created": "2020-03-05T21:07:34.88927951Z",
+    "Path": "docker-entrypoint.sh",
+    "Args": ["mysqld"],
+    "State": {
+        "Status": "running",
+        "Running": true,
+        "Paused": false,
+        "Restarting": false,
+        "OOMKilled": false,
+        "Dead": false,
+        "Pid": 4887,
+        "ExitCode": 0,
+        "Error": "",
+        "StartedAt": "2020-03-06T01:31:39.728842925Z",
+        "FinishedAt": "2020-03-06T01:31:33.847583199Z"
+    },
+    "Image": "sha256:1fd0e719c4952e22a99e30662fdd7daad53e7e53fbe135d543cc6b82be213951",
+    "ResolvConfPath": "/var/lib/docker/containers/efa5196b4959648e3efcf5ae9f24bc4032849c2665805a5b405216f343b4decd/resolv.conf",
+    "HostnamePath": "/var/lib/docker/containers/efa5196b4959648e3efcf5ae9f24bc4032849c2665805a5b405216f343b4decd/hostname",
+    "HostsPath": "/var/lib/docker/containers/efa5196b4959648e3efcf5ae9f24bc4032849c2665805a5b405216f343b4decd/hosts",
+    "LogPath": "/var/lib/docker/containers/efa5196b4959648e3efcf5ae9f24bc4032849c2665805a5b405216f343b4decd/efa5196b4959648e3efcf5ae9f24bc4032849c2665805a5b405216f343b4decd-json.log",
+    "Name": "/restic-compose-backup_mariadb_1",
+    "RestartCount": 0,
+    "Driver": "overlay2",
+    "Platform": "linux",
+    "MountLabel": "",
+    "ProcessLabel": "",
+    "AppArmorProfile": "",
+    "ExecIDs": null,
+    "HostConfig": {
+        "Binds": ["restic-compose-backup_mariadbdata:/var/lib/mysql:rw"],
+        "ContainerIDFile": "",
+        "LogConfig": {
+            "Type": "json-file",
+            "Config": {}
+        },
+        "NetworkMode": "restic-compose-backup_default",
+        "PortBindings": {},
+        "RestartPolicy": {
+            "Name": "",
+            "MaximumRetryCount": 0
+        },
+        "AutoRemove": false,
+        "VolumeDriver": "",
+        "VolumesFrom": [],
+        "CapAdd": null,
+        "CapDrop": null,
+        "Capabilities": null,
+        "Dns": null,
+        "DnsOptions": null,
+        "DnsSearch": null,
+        "ExtraHosts": null,
+        "GroupAdd": null,
+        "IpcMode": "shareable",
+        "Cgroup": "",
+        "Links": null,
+        "OomScoreAdj": 0,
+        "PidMode": "",
+        "Privileged": false,
+        "PublishAllPorts": false,
+        "ReadonlyRootfs": false,
+        "SecurityOpt": null,
+        "UTSMode": "",
+        "UsernsMode": "",
+        "ShmSize": 67108864,
+        "Runtime": "runc",
+        "ConsoleSize": [0, 0],
+        "Isolation": "",
+        "CpuShares": 0,
+        "Memory": 0,
+        "NanoCpus": 0,
+        "CgroupParent": "",
+        "BlkioWeight": 0,
+        "BlkioWeightDevice": null,
+        "BlkioDeviceReadBps": null,
+        "BlkioDeviceWriteBps": null,
+        "BlkioDeviceReadIOps": null,
+        "BlkioDeviceWriteIOps": null,
+        "CpuPeriod": 0,
+        "CpuQuota": 0,
+        "CpuRealtimePeriod": 0,
+        "CpuRealtimeRuntime": 0,
+        "CpusetCpus": "",
+        "CpusetMems": "",
+        "Devices": null,
+        "DeviceCgroupRules": null,
+        "DeviceRequests": null,
+        "KernelMemory": 0,
+        "KernelMemoryTCP": 0,
+        "MemoryReservation": 0,
+        "MemorySwap": 0,
+        "MemorySwappiness": null,
+        "OomKillDisable": false,
+        "PidsLimit": null,
+        "Ulimits": null,
+        "CpuCount": 0,
+        "CpuPercent": 0,
+        "IOMaximumIOps": 0,
+        "IOMaximumBandwidth": 0,
+        "MaskedPaths": ["/proc/asound", "/proc/acpi", "/proc/kcore", "/proc/keys", "/proc/latency_stats", "/proc/timer_list", "/proc/timer_stats", "/proc/sched_debug", "/proc/scsi", "/sys/firmware"],
+        "ReadonlyPaths": ["/proc/bus", "/proc/fs", "/proc/irq", "/proc/sys", "/proc/sysrq-trigger"]
+    },
+    "GraphDriver": {
+        "Data": {
+            "LowerDir": "/var/lib/docker/overlay2/96e51e6162c0cb4385248375192ec777dd42b3ae7973e402de351f3932c502d0-init/diff:/var/lib/docker/overlay2/38780a41f93b7a20de03f1d76febb885f9213906fb30bad17cb3ad231fb7ce43/diff:/var/lib/docker/overlay2/a2abce521690b1baf6aa61e109a4659cb4272936871bc1afa73271eb8e453449/diff:/var/lib/docker/overlay2/a696286588d1d33b994b7f6e31c176c5f7e67c4f757d730323a7b6591d55f786/diff:/var/lib/docker/overlay2/c4bd8133c0d9547945d38a9998439082ce7b53df7e64737add5a5c824e6f67f2/diff:/var/lib/docker/overlay2/110e275ef21b8c9cc2cd0cce312fed5aabceb056460f637b958dfee56b7b3be8/diff:/var/lib/docker/overlay2/831c8a624e424f298766028e76a8ac08df0c5cf4564f63cae61330a8bce0cf63/diff:/var/lib/docker/overlay2/7ad8ae774951ec40c68b0993ef07ef3d70aa8aed44ea9f1e4d943ca5404cc717/diff:/var/lib/docker/overlay2/19bca9fb61ef1156f8a97313c126a6c06d7fe44a6c49e3affe16f50f2d5e56ff/diff:/var/lib/docker/overlay2/dcd4dda04d06b0a0c7e78517c6209fd67735b3027afda2c85a92de37ff7297d1/diff:/var/lib/docker/overlay2/babf41f5fe1f7b88c17cfce27214a4ad9473b0f8e0f118db948d2acddf4d4798/diff:/var/lib/docker/overlay2/b5f97865010acd5b04b4031d6223cd0b34fab89267891d61256ea16936be52f8/diff:/var/lib/docker/overlay2/6aba0159141ebb6d6783181d154c65046447b7d2bebce65d44c4939ba7943cca/diff:/var/lib/docker/overlay2/c71c34fe0e7e95409a9fc18698f0aee505940fd96aa3718836e2d89f3cfb2d49/diff:/var/lib/docker/overlay2/3be993436e2a6764a6c3c57a2e948f7a57e45ed0ec26cdd3366f4c1106c69869/diff",
+            "MergedDir": "/var/lib/docker/overlay2/96e51e6162c0cb4385248375192ec777dd42b3ae7973e402de351f3932c502d0/merged",
+            "UpperDir": "/var/lib/docker/overlay2/96e51e6162c0cb4385248375192ec777dd42b3ae7973e402de351f3932c502d0/diff",
+            "WorkDir": "/var/lib/docker/overlay2/96e51e6162c0cb4385248375192ec777dd42b3ae7973e402de351f3932c502d0/work"
+        },
+        "Name": "overlay2"
+    },
+    "Mounts": [{
+        "Type": "volume",
+        "Name": "restic-compose-backup_mariadbdata",
+        "Source": "/var/lib/docker/volumes/restic-compose-backup_mariadbdata/_data",
+        "Destination": "/var/lib/mysql",
+        "Driver": "local",
+        "Mode": "rw",
+        "RW": true,
+        "Propagation": ""
+    }],
+    "Config": {
+        "Hostname": "efa5196b4959",
+        "Domainname": "",
+        "User": "",
+        "AttachStdin": false,
+        "AttachStdout": false,
+        "AttachStderr": false,
+        "ExposedPorts": {
+            "3306/tcp": {}
+        },
+        "Tty": false,
+        "OpenStdin": false,
+        "StdinOnce": false,
+        "Env": ["MYSQL_ROOT_PASSWORD=my-secret-pw", "MYSQL_DATABASE=mydb", "MYSQL_USER=myuser", "MYSQL_PASSWORD=mypassword", "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", "GOSU_VERSION=1.10", "GPG_KEYS=177F4010FE56CA3336300305F1656F24C74CD1D8", "MARIADB_MAJOR=10.4", "MARIADB_VERSION=1:10.4.12+maria~bionic"],
+        "Cmd": ["mysqld"],
+        "Image": "mariadb:10",
+        "Volumes": {
+            "/var/lib/mysql": {}
+        },
+        "WorkingDir": "",
+        "Entrypoint": ["docker-entrypoint.sh"],
+        "OnBuild": null,
+        "Labels": {
+            "com.docker.compose.config-hash": "c6ecde85ad111d324a4c97cde3a03898074b026c68ecffc0f7020e5eca9a71d7",
+            "com.docker.compose.container-number": "1",
+            "com.docker.compose.oneoff": "False",
+            "com.docker.compose.project": "restic-compose-backup",
+            "com.docker.compose.project.config_files": "docker-compose.yaml",
+            "com.docker.compose.project.working_dir": "C:\\Users\\efors\\projects\\zetta.io\\projects\\restic-compose-backup",
+            "com.docker.compose.service": "mariadb",
+            "com.docker.compose.version": "1.25.4",
+            "restic-compose-backup.mariadb": "True"
+        }
+    },
+    "NetworkSettings": {
+        "Bridge": "",
+        "SandboxID": "d462bb5dfdd26aba12b8a395ac90262ab00d65408bf60dfa1ade0ab6a1851c70",
+        "HairpinMode": false,
+        "LinkLocalIPv6Address": "",
+        "LinkLocalIPv6PrefixLen": 0,
+        "Ports": {
+            "3306/tcp": null
+        },
+        "SandboxKey": "/var/run/docker/netns/d462bb5dfdd2",
+        "SecondaryIPAddresses": null,
+        "SecondaryIPv6Addresses": null,
+        "EndpointID": "",
+        "Gateway": "",
+        "GlobalIPv6Address": "",
+        "GlobalIPv6PrefixLen": 0,
+        "IPAddress": "",
+        "IPPrefixLen": 0,
+        "IPv6Gateway": "",
+        "MacAddress": "",
+        "Networks": {
+            "restic-compose-backup_default": {
+                "IPAMConfig": null,
+                "Links": null,
+                "Aliases": ["efa5196b4959", "mariadb"],
+                "NetworkID": "8f3349b0debec88f9f48fff02d84cda3feae0a0e8c516e8b42e5777bb03db1cb",
+                "EndpointID": "0b75d3f00aa077fe95156bc80463d33fb21d241a287b33c06769047855c38400",
+                "Gateway": "172.19.0.1",
+                "IPAddress": "172.19.0.3",
+                "IPPrefixLen": 16,
+                "IPv6Gateway": "",
+                "GlobalIPv6Address": "",
+                "GlobalIPv6PrefixLen": 0,
+                "MacAddress": "02:42:ac:13:00:03",
+                "DriverOpts": null
+            }
+        }
+    }
+}

extras/example-stack-container.json

@@ -0,0 +1,207 @@
+{
+    "Id": "56c57903b6da3afd331312b244ddd0324f5b21cbbe5fc30072edf24781d80f76",
+    "Created": "2020-03-06T22:36:17.266061631Z",
+    "Path": "docker-entrypoint.sh",
+    "Args": ["mysqld"],
+    "State": {
+        "Status": "running",
+        "Running": true,
+        "Paused": false,
+        "Restarting": false,
+        "OOMKilled": false,
+        "Dead": false,
+        "Pid": 35967,
+        "ExitCode": 0,
+        "Error": "",
+        "StartedAt": "2020-03-06T22:36:17.636265528Z",
+        "FinishedAt": "0001-01-01T00:00:00Z"
+    },
+    "Image": "sha256:1fd0e719c4952e22a99e30662fdd7daad53e7e53fbe135d543cc6b82be213951",
+    "ResolvConfPath": "/var/lib/docker/containers/56c57903b6da3afd331312b244ddd0324f5b21cbbe5fc30072edf24781d80f76/resolv.conf",
+    "HostnamePath": "/var/lib/docker/containers/56c57903b6da3afd331312b244ddd0324f5b21cbbe5fc30072edf24781d80f76/hostname",
+    "HostsPath": "/var/lib/docker/containers/56c57903b6da3afd331312b244ddd0324f5b21cbbe5fc30072edf24781d80f76/hosts",
+    "LogPath": "/var/lib/docker/containers/56c57903b6da3afd331312b244ddd0324f5b21cbbe5fc30072edf24781d80f76/56c57903b6da3afd331312b244ddd0324f5b21cbbe5fc30072edf24781d80f76-json.log",
+    "Name": "/test_mariadb.1.q4uji32qvw4tkuvwx3pbnbgqq",
+    "RestartCount": 0,
+    "Driver": "overlay2",
+    "Platform": "linux",
+    "MountLabel": "",
+    "ProcessLabel": "",
+    "AppArmorProfile": "",
+    "ExecIDs": null,
+    "HostConfig": {
+        "Binds": null,
+        "ContainerIDFile": "",
+        "LogConfig": {
+            "Type": "json-file",
+            "Config": {}
+        },
+        "NetworkMode": "default",
+        "PortBindings": {},
+        "RestartPolicy": {
+            "Name": "",
+            "MaximumRetryCount": 0
+        },
+        "AutoRemove": false,
+        "VolumeDriver": "",
+        "VolumesFrom": null,
+        "CapAdd": null,
+        "CapDrop": null,
+        "Capabilities": null,
+        "Dns": null,
+        "DnsOptions": null,
+        "DnsSearch": null,
+        "ExtraHosts": null,
+        "GroupAdd": null,
+        "IpcMode": "private",
+        "Cgroup": "",
+        "Links": null,
+        "OomScoreAdj": 0,
+        "PidMode": "",
+        "Privileged": false,
+        "PublishAllPorts": false,
+        "ReadonlyRootfs": false,
+        "SecurityOpt": null,
+        "UTSMode": "",
+        "UsernsMode": "",
+        "ShmSize": 67108864,
+        "Runtime": "runc",
+        "ConsoleSize": [0, 0],
+        "Isolation": "default",
+        "CpuShares": 0,
+        "Memory": 0,
+        "NanoCpus": 0,
+        "CgroupParent": "",
+        "BlkioWeight": 0,
+        "BlkioWeightDevice": null,
+        "BlkioDeviceReadBps": null,
+        "BlkioDeviceWriteBps": null,
+        "BlkioDeviceReadIOps": null,
+        "BlkioDeviceWriteIOps": null,
+        "CpuPeriod": 0,
+        "CpuQuota": 0,
+        "CpuRealtimePeriod": 0,
+        "CpuRealtimeRuntime": 0,
+        "CpusetCpus": "",
+        "CpusetMems": "",
+        "Devices": null,
+        "DeviceCgroupRules": null,
+        "DeviceRequests": null,
+        "KernelMemory": 0,
+        "KernelMemoryTCP": 0,
+        "MemoryReservation": 0,
+        "MemorySwap": 0,
+        "MemorySwappiness": null,
+        "OomKillDisable": false,
+        "PidsLimit": null,
+        "Ulimits": null,
+        "CpuCount": 0,
+        "CpuPercent": 0,
+        "IOMaximumIOps": 0,
+        "IOMaximumBandwidth": 0,
+        "Mounts": [{
+            "Type": "volume",
+            "Source": "test_mariadbdata",
+            "Target": "/var/lib/mysql",
+            "VolumeOptions": {
+                "Labels": {
+                    "com.docker.stack.namespace": "test"
+                }
+            }
+        }],
+        "MaskedPaths": ["/proc/asound", "/proc/acpi", "/proc/kcore", "/proc/keys", "/proc/latency_stats", "/proc/timer_list", "/proc/timer_stats", "/proc/sched_debug", "/proc/scsi", "/sys/firmware"],
+        "ReadonlyPaths": ["/proc/bus", "/proc/fs", "/proc/irq", "/proc/sys", "/proc/sysrq-trigger"]
+    },
+    "GraphDriver": {
+        "Data": {
+            "LowerDir": "/var/lib/docker/overlay2/ba8a39bdb1d2e25d373b6b00c764be3d37353e57cf03981c4c3e5a20ae6a602b-init/diff:/var/lib/docker/overlay2/38780a41f93b7a20de03f1d76febb885f9213906fb30bad17cb3ad231fb7ce43/diff:/var/lib/docker/overlay2/a2abce521690b1baf6aa61e109a4659cb4272936871bc1afa73271eb8e453449/diff:/var/lib/docker/overlay2/a696286588d1d33b994b7f6e31c176c5f7e67c4f757d730323a7b6591d55f786/diff:/var/lib/docker/overlay2/c4bd8133c0d9547945d38a9998439082ce7b53df7e64737add5a5c824e6f67f2/diff:/var/lib/docker/overlay2/110e275ef21b8c9cc2cd0cce312fed5aabceb056460f637b958dfee56b7b3be8/diff:/var/lib/docker/overlay2/831c8a624e424f298766028e76a8ac08df0c5cf4564f63cae61330a8bce0cf63/diff:/var/lib/docker/overlay2/7ad8ae774951ec40c68b0993ef07ef3d70aa8aed44ea9f1e4d943ca5404cc717/diff:/var/lib/docker/overlay2/19bca9fb61ef1156f8a97313c126a6c06d7fe44a6c49e3affe16f50f2d5e56ff/diff:/var/lib/docker/overlay2/dcd4dda04d06b0a0c7e78517c6209fd67735b3027afda2c85a92de37ff7297d1/diff:/var/lib/docker/overlay2/babf41f5fe1f7b88c17cfce27214a4ad9473b0f8e0f118db948d2acddf4d4798/diff:/var/lib/docker/overlay2/b5f97865010acd5b04b4031d6223cd0b34fab89267891d61256ea16936be52f8/diff:/var/lib/docker/overlay2/6aba0159141ebb6d6783181d154c65046447b7d2bebce65d44c4939ba7943cca/diff:/var/lib/docker/overlay2/c71c34fe0e7e95409a9fc18698f0aee505940fd96aa3718836e2d89f3cfb2d49/diff:/var/lib/docker/overlay2/3be993436e2a6764a6c3c57a2e948f7a57e45ed0ec26cdd3366f4c1106c69869/diff",
+            "MergedDir": "/var/lib/docker/overlay2/ba8a39bdb1d2e25d373b6b00c764be3d37353e57cf03981c4c3e5a20ae6a602b/merged",
+            "UpperDir": "/var/lib/docker/overlay2/ba8a39bdb1d2e25d373b6b00c764be3d37353e57cf03981c4c3e5a20ae6a602b/diff",
+            "WorkDir": "/var/lib/docker/overlay2/ba8a39bdb1d2e25d373b6b00c764be3d37353e57cf03981c4c3e5a20ae6a602b/work"
+        },
+        "Name": "overlay2"
+    },
+    "Mounts": [{
+        "Type": "volume",
+        "Name": "test_mariadbdata",
+        "Source": "/var/lib/docker/volumes/test_mariadbdata/_data",
+        "Destination": "/var/lib/mysql",
+        "Driver": "local",
+        "Mode": "z",
+        "RW": true,
+        "Propagation": ""
+    }],
+    "Config": {
+        "Hostname": "56c57903b6da",
+        "Domainname": "",
+        "User": "",
+        "AttachStdin": false,
+        "AttachStdout": false,
+        "AttachStderr": false,
+        "ExposedPorts": {
+            "3306/tcp": {}
+        },
+        "Tty": false,
+        "OpenStdin": false,
+        "StdinOnce": false,
+        "Env": ["MYSQL_DATABASE=mydb", "MYSQL_PASSWORD=mypassword", "MYSQL_ROOT_PASSWORD=my-secret-pw", "MYSQL_USER=myuser", "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", "GOSU_VERSION=1.10", "GPG_KEYS=177F4010FE56CA3336300305F1656F24C74CD1D8", "MARIADB_MAJOR=10.4", "MARIADB_VERSION=1:10.4.12+maria~bionic"],
+        "Cmd": ["mysqld"],
+        "Image": "mariadb:10@sha256:d1ceee944c90ee3b596266de1b0ac25d2f34adbe9c35156b75bcb9a7047c7545",
+        "Volumes": {
+            "/var/lib/mysql": {}
+        },
+        "WorkingDir": "",
+        "Entrypoint": ["docker-entrypoint.sh"],
+        "OnBuild": null,
+        "Labels": {
+            "com.docker.stack.namespace": "test",
+            "com.docker.swarm.node.id": "gj73oe0vgmldlv2pdcj243231",
+            "com.docker.swarm.service.id": "jewh88xvythjkga24wy1thxc2",
+            "com.docker.swarm.service.name": "test_mariadb",
+            "com.docker.swarm.task": "",
+            "com.docker.swarm.task.id": "q4uji32qvw4tkuvwx3pbnbgqq",
+            "com.docker.swarm.task.name": "test_mariadb.1.q4uji32qvw4tkuvwx3pbnbgqq",
+            "restic-compose-backup.mariadb": "true"
+        }
+    },
+    "NetworkSettings": {
+        "Bridge": "",
+        "SandboxID": "5aa81b0859dfd6f6be629eb966ce365f22dc86620359cce3e3d25d5291b539db",
+        "HairpinMode": false,
+        "LinkLocalIPv6Address": "",
+        "LinkLocalIPv6PrefixLen": 0,
+        "Ports": {
+            "3306/tcp": null
+        },
+        "SandboxKey": "/var/run/docker/netns/5aa81b0859df",
+        "SecondaryIPAddresses": null,
+        "SecondaryIPv6Addresses": null,
+        "EndpointID": "",
+        "Gateway": "",
+        "GlobalIPv6Address": "",
+        "GlobalIPv6PrefixLen": 0,
+        "IPAddress": "",
+        "IPPrefixLen": 0,
+        "IPv6Gateway": "",
+        "MacAddress": "",
+        "Networks": {
+            "test_default": {
+                "IPAMConfig": {
+                    "IPv4Address": "10.0.1.3"
+                },
+                "Links": null,
+                "Aliases": ["56c57903b6da"],
+                "NetworkID": "8aweh54u31eq3i47vqdr2aonc",
+                "EndpointID": "5369b4c82a479a3e9dfb3547cb7ac3a0fab888e38ad5c1d0ad02b0e9a9523a64",
+                "Gateway": "",
+                "IPAddress": "10.0.1.3",
+                "IPPrefixLen": 24,
+                "IPv6Gateway": "",
+                "GlobalIPv6Address": "",
+                "GlobalIPv6PrefixLen": 0,
+                "MacAddress": "02:42:0a:00:01:03",
+                "DriverOpts": null
+            }
+        }
+    }
+}

extras/release.md

@@ -13,9 +13,9 @@ When releasing a bugfix version we need to update the
 main image as well.
 
 ```bash
-docker build src --tag zettaio/restic-compose-backup:0.3
+docker build src --tag zettaio/restic-compose-backup:0.5
-docker build src --tag zettaio/restic-compose-backup:0.3.3
+docker build src --tag zettaio/restic-compose-backup:0.5.0
 
-docker push zettaio/restic-compose-backup:0.3
+docker push zettaio/restic-compose-backup:0.5
-docker push zettaio/restic-compose-backup:0.3.3
+docker push zettaio/restic-compose-backup:0.5.0
 ```

restic_compose_backup.env

@@ -1,6 +1,11 @@
 # DON'T COMMIT THIS FILE IF YOU MODIFY IN DEV
 
-DOCKER_BASE_URL=unix://tmp/docker.sock
+# DOCKER_HOST=unix://tmp/docker.sock
+# DOCKER_TLS_VERIFY=1
+# DOCKER_CERT_PATH=''
+
+SWARM_MODE=true
+
 RESTIC_REPOSITORY=/restic_data
 RESTIC_PASSWORD=password
 

src/restic_compose_backup/__init__.py

@@ -1 +1 @@
-__version__ = '0.4.0'
+__version__ = '0.5.0'

src/restic_compose_backup/backup_runner.py

@@ -17,7 +17,7 @@ def run(image: str = None, command: str = None, volumes: dict = None,
         labels=labels,
         # auto_remove=True,  # We remove the container further down
         detach=True,
-        environment=environment,
+        environment=environment + ['BACKUP_PROCESS_CONTAINER=true'],
         volumes=volumes,
         network_mode=f'container:{source_container_id}',  # Reuse original container's network stack.
         working_dir=os.getcwd(),

src/restic_compose_backup/cli.py

@@ -57,6 +57,9 @@ def status(config, containers):
     logger.info("Status for compose project '%s'", containers.project_name)
     logger.info("Repository: '%s'", config.repository)
     logger.info("Backup currently running?: %s", containers.backup_process_running)
+    logger.info("Checking docker availability")
+
+    utils.list_containers()
 
     if containers.stale_backup_process_containers:
         utils.remove_containers(containers.stale_backup_process_containers)
@@ -117,6 +120,7 @@ def backup(config, containers):
     mounts = containers.generate_backup_mounts('/volumes')
     volumes.update(mounts)
 
+    logger.debug('Starting backup container with image %s', containers.this_container.image)
     try:
         result = backup_runner.run(
             image=containers.this_container.image,
@@ -151,12 +155,18 @@ def backup(config, containers):
 
 def start_backup_process(config, containers):
     """The actual backup process running inside the spawned container"""
-    if (not containers.backup_process_container
+    if not utils.is_true(os.environ.get('BACKUP_PROCESS_CONTAINER')):
-       or containers.this_container == containers.backup_process_container is False):
         logger.error(
             "Cannot run backup process in this container. Use backup command instead. "
             "This will spawn a new container with the necessary mounts."
         )
+        alerts.send(
+            subject="Cannot run backup process in this container",
+            body=(
+                "Cannot run backup process in this container. Use backup command instead. "
+                "This will spawn a new container with the necessary mounts."
+            )
+        )
         exit(1)
 
     status(config, containers)

src/restic_compose_backup/config.py

@@ -10,9 +10,9 @@ class Config:
         # Mandatory values
         self.repository = os.environ.get('RESTIC_REPOSITORY')
         self.password = os.environ.get('RESTIC_REPOSITORY')
-        self.docker_base_url = os.environ.get('DOCKER_BASE_URL') or "unix://tmp/docker.sock"
         self.cron_schedule = os.environ.get('CRON_SCHEDULE') or self.default_crontab_schedule
         self.cron_command = os.environ.get('CRON_COMMAND') or self.default_backup_command
+        self.swarm_mode = os.environ.get('SWARM_MODE') or False
 
         # Log
         self.log_level = os.environ.get('LOG_LEVEL')
@@ -32,3 +32,6 @@ class Config:
 
         if not self.password:
             raise ValueError("RESTIC_REPOSITORY env var not set")
+
+
+config = Config()

src/restic_compose_backup/containers.py

@@ -1,9 +1,12 @@
 import os
+import logging
 from pathlib import Path
 from typing import List
 
 from restic_compose_backup import enums, utils
+from restic_compose_backup.config import config
 
+logger = logging.getLogger(__name__)
 
 VOLUME_TYPE_BIND = "bind"
 VOLUME_TYPE_VOLUME = "volume"
@@ -61,6 +64,36 @@ class Container:
         """Image name"""
         return self.get_config('Image')
 
+    @property
+    def name(self) -> str:
+        """Container name"""
+        return self._data['Name'].replace('/', '')
+
+    @property
+    def service_name(self) -> str:
+        """Name of the container/service"""
+        return self.get_label('com.docker.compose.service', default='') or self.get_label('com.docker.swarm.service.name', default='')
+
+    @property
+    def backup_process_label(self) -> str:
+        """str: The unique backup process label for this project"""
+        return f"{enums.LABEL_BACKUP_PROCESS}-{self.project_name}"
+
+    @property
+    def project_name(self) -> str:
+        """str: Name of the compose setup"""
+        return self.get_label('com.docker.compose.project', default='')
+
+    @property
+    def stack_name(self) -> str:
+        """str: Name of the stack is present"""
+        return self.get_label("com.docker.stack.namespace")
+
+    @property
+    def is_oneoff(self) -> bool:
+        """Was this container started with run command?"""
+        return self.get_label('com.docker.compose.oneoff', default='False') == 'True'
+
     @property
     def environment(self) -> list:
         """All configured env vars for the container as a list"""
@@ -148,31 +181,6 @@ class Container:
         """bool: Is the container running?"""
         return self._state.get('Running', False)
 
-    @property
-    def name(self) -> str:
-        """Container name"""
-        return self._data['Name'].replace('/', '')
-
-    @property
-    def service_name(self) -> str:
-        """Name of the container/service"""
-        return self.get_label('com.docker.compose.service', default='')
-
-    @property
-    def backup_process_label(self) -> str:
-        """str: The unique backup process label for this project"""
-        return f"{enums.LABEL_BACKUP_PROCESS}-{self.project_name}"
-
-    @property
-    def project_name(self) -> str:
-        """Name of the compose setup"""
-        return self.get_label('com.docker.compose.project', default='')
-
-    @property
-    def is_oneoff(self) -> bool:
-        """Was this container started with run command?"""
-        return self.get_label('com.docker.compose.oneoff', default='False') == 'True'
-
     def get_config(self, name, default=None):
         """Get value from config dict"""
         return self._config.get(name, default)
@@ -352,10 +360,21 @@ class RunningContainers:
             if container.is_backup_process_container:
                 self.backup_process_container = container
 
-            # Detect containers belonging to the current compose setup
+            # --- Determine what containers should be evaludated
-            if (container.project_name == self.this_container.project_name
+
-               and not container.is_oneoff):
+            # If not swarm mode we need to filter in compose project
-                if container.id != self.this_container.id:
+            if not config.swarm_mode:
+                if container.project_name != self.this_container.project_name:
+                    continue
+
+            # Containers started manually are not included
+            if container.is_oneoff:
+                continue
+
+            # Do not include the backup process container
+            if container == self.backup_process_container:
+                continue
+
             self.containers.append(container)
 
     @property

src/restic_compose_backup/utils.py

@@ -3,7 +3,6 @@ import logging
 from typing import List
 from contextlib import contextmanager
 import docker
-from restic_compose_backup.config import Config
 
 logger = logging.getLogger(__name__)
 
@@ -11,8 +10,18 @@ TRUE_VALUES = ['1', 'true', 'True', True, 1]
 
 
 def docker_client():
-    config = Config()
+    """
-    return docker.DockerClient(base_url=config.docker_base_url)
+    Create a docker client from the following environment variables::
+
+        DOCKER_HOST=unix://tmp/docker.sock
+        DOCKER_TLS_VERIFY=1
+        DOCKER_CERT_PATH=''
+    """
+    # NOTE: Remove this fallback in 1.0
+    if not os.environ.get('DOCKER_HOST'):
+        os.environ['DOCKER_HOST'] = 'unix://tmp/docker.sock'
+
+    return docker.from_env()
 
 
 def list_containers() -> List[dict]:

src/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_namespace_packages
 setup(
     name="restic-compose-backup",
     url="https://github.com/ZettaIO/restic-compose-backup",
-    version="0.4.0",
+    version="0.5.0",
     author="Einar Forselv",
     author_email="eforselv@gmail.com",
     packages=find_namespace_packages(include=['restic_compose_backup']),

src/tests/container.json

@@ -160,7 +160,7 @@
     "OpenStdin": true,
     "StdinOnce": true,
     "Env": [
-      "DOCKER_BASE_URL=unix://tmp/docker.sock",
+      "DOCKER_HOST=unix://tmp/docker.sock",
       "RESTIC_REPOSITORY=/tmp/backup",
       "RESTIC_PASSWORD=password",
       "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"

src/tests/tests.py

@@ -77,7 +77,7 @@ class ResticBackupTests(unittest.TestCase):
         ]
         with mock.patch(list_containers_func, fixtures.containers(containers=containers)):
             result = RunningContainers()
-            self.assertEqual(len(result.containers), 3, msg="Three containers expected")
+            self.assertEqual(len(result.containers), 4, msg="Three containers expected")
             self.assertNotEqual(result.this_container, None, msg="No backup container found")
             web_service = result.get_service('web')
             self.assertNotEqual(web_service, None)

swarm-stack.yml

@@ -0,0 +1,23 @@
+version: '3.7'
+
+services:
+  mariadb:
+    image: mariadb:10
+    labels:
+      restic-compose-backup.mariadb: "true"
+    environment:
+      - MYSQL_ROOT_PASSWORD=my-secret-pw
+      - MYSQL_DATABASE=mydb
+      - MYSQL_USER=myuser
+      - MYSQL_PASSWORD=mypassword
+    networks:
+      - global
+    volumes:
+      - mariadbdata:/var/lib/mysql
+
+volumes:
+  mariadbdata:
+
+networks:
+  global:
+    external: true