restic-compose-backup/restic_volume_backup/containers.py

187 lines
5.6 KiB
Python
Raw Normal View History

2019-04-13 17:04:54 +00:00
import os
import docker
import json
2019-04-15 14:16:06 +00:00
import pprint
2019-04-13 17:04:54 +00:00
from restic_volume_backup import utils
2019-04-13 17:04:54 +00:00
VOLUME_TYPE_BIND = "bind"
VOLUME_TYPE_VOLUME = "volume"
2019-04-13 21:19:34 +00:00
2019-04-13 17:04:54 +00:00
class Container:
def __init__(self, data):
self.id = data.get('Id')
2019-04-13 21:19:34 +00:00
self.state = data.get('State')
2019-04-13 23:34:39 +00:00
self.labels = data.get('Labels', {})
self.names = data.get('Names', [])
2019-04-13 17:04:54 +00:00
self.mounts = [Mount(mnt, container=self) for mnt in data.get('Mounts')]
2019-04-13 23:34:39 +00:00
self.include = self.labels.get('restic-volume-backup.enabled', '').split(',')
self.exlude = self.labels.get('restic-volume-backup.exclude', '').split(',')
2019-04-13 21:19:34 +00:00
@property
def backup_enabled(self):
return self.labels.get('restic-volume-backup.enabled') == 'True'
@property
def is_running(self):
return self.state == 'running'
@property
def service_name(self):
return self.labels['com.docker.compose.service']
@property
def project_name(self):
return self.labels['com.docker.compose.project']
@property
def is_oneoff(self):
return self.labels['com.docker.compose.oneoff'] == 'True'
def filter_mounts(self):
"""Get all mounts for this container matching filters"""
for mount in self.mounts:
if self.include:
for pattern in self.include:
if pattern in mount.source:
yield mount
continue
elif self.exlude:
for pattern in self.exlude:
if pattern in mount.source:
continue
yield mount
else:
yield mount
2019-04-13 17:04:54 +00:00
def to_dict(self):
return {
2019-04-13 21:19:34 +00:00
'Id': self.id,
'Names': self.names,
'State': self.state,
'Labels': self.labels,
'Mounts': [mnt.data for mnt in self.mounts],
'include': self.include,
'exclude': self.exlude,
2019-04-13 17:04:54 +00:00
}
class Mount:
"""Mount wrapper"""
def __init__(self, data, container=None):
2019-04-14 18:55:35 +00:00
self._data = data
2019-04-13 17:04:54 +00:00
self._container = container
@property
def container(self):
return self._container
@property
def type(self):
2019-04-14 18:55:35 +00:00
return self._data.get('Type')
2019-04-13 17:04:54 +00:00
@property
def name(self):
2019-04-14 18:55:35 +00:00
return self._data.get('Name')
2019-04-13 17:04:54 +00:00
@property
def source(self):
2019-04-14 18:55:35 +00:00
return self._data.get('Source')
2019-04-13 17:04:54 +00:00
@property
def destination(self):
2019-04-14 18:55:35 +00:00
return self._data.get('Destination')
2019-04-13 17:04:54 +00:00
def mount_string(self):
if self.type == VOLUME_TYPE_VOLUME:
return "- {}:{}:ro".format(self.name.split('_')[-1], self.destination)
elif self.type == VOLUME_TYPE_BIND:
return "- {}:{}:ro".format(self.source, self.destination)
else:
raise ValueError("Uknown volume type: {}".format(self.type))
def __repr__(self):
return str(self)
def __str__(self):
2019-04-14 18:55:35 +00:00
return str(self._data)
2019-04-13 17:04:54 +00:00
def __hash__(self):
"""Uniquness for a volume"""
if self.type == VOLUME_TYPE_VOLUME:
return hash(self.name)
elif self.type == VOLUME_TYPE_BIND:
return hash(self.source)
else:
raise ValueError("Uknown volume type: {}".format(self.type))
class RunningContainers:
def __init__(self):
all_containers = utils.list_containers()
2019-04-13 17:04:54 +00:00
self.containers = []
2019-04-15 14:16:06 +00:00
self.this_container = None
2019-04-13 17:04:54 +00:00
2019-04-15 14:16:06 +00:00
# Find the container we are running in.
# If we don't have this information we cannot continue
for container_data in all_containers:
if container_data.get('Id').startswith(os.environ['HOSTNAME']):
self.this_container = Container(container_data)
2019-04-13 21:19:34 +00:00
2019-04-15 14:16:06 +00:00
if not self.this_container:
2019-04-13 17:04:54 +00:00
raise ValueError("Cannot find metadata for backup container")
2019-04-15 14:16:06 +00:00
# Gather all containers in the current compose setup
for container_data in all_containers:
# pprint.pprint(container_data, indent=2)
container = Container(container_data)
if container.project_name == self.this_container.project_name:
if container.id != self.this_container.id:
self.containers.append(container)
# for container in self.all_containers:
# # Weed out containers not beloging to this project.
# if container.project_name != self.backup_container.project_name:
# continue
# # Keep only containers with backup enabled
# if not container.backup_enabled:
# continue
# # and not oneoffs (started manually with run or similar)
# if container.is_oneoff:
# continue
# self.containers.append(container)
# def gen_volumes(self, volume_type):
# """Generator yielding volumes of a specific type"""
# for cont in self.containers:
# for mnt in cont.mounts:
# if mnt.type == volume_type:
# yield mnt
# def volume_mounts(self):
# """Docker volumes"""
# return set(mnt for mnt in self.gen_volumes(VOLUME_TYPE_VOLUME))
# def bind_mounts(self):
# """Host mapped volumes"""
# return set(mnt for mnt in self.gen_volumes(VOLUME_TYPE_BIND))
def print_services(self):
print()
print("Backup config for compose project '{}'".format(self.this_container.project_name))
print()
for container in self.containers:
print('service: {}'.format(container.service_name))
mounts = container.filter_mounts()
for mount in mounts:
print(' - {}'.format(mount.source))
print()