mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-11-20 06:56:18 -05:00
134 lines
5.3 KiB
Python
134 lines
5.3 KiB
Python
|
|
"""
|
||
|
|
The rsync daemon that serves this WROLPi's library to secondary WROLPis.
|
||
|
|
|
||
|
|
On a Raspberry Pi and on Debian it is the `wrolpi-rsyncd` systemd unit. In Docker the Controller runs it in a helper
|
||
|
|
container made from the api container: the same image, user and volumes (read-only), so the media directory is
|
||
|
|
configured in one place, the api service. Both read `controller/rsyncd.conf`.
|
||
|
|
"""
|
||
|
|
|
||
|
|
import asyncio
|
||
|
|
import hashlib
|
||
|
|
import logging
|
||
|
|
import re
|
||
|
|
from pathlib import Path
|
||
|
|
|
||
|
|
from controller.lib.docker_services import NotFound, _get_client, _get_container_name, can_manage_containers
|
||
|
|
|
||
|
|
logger = logging.getLogger(__name__)
|
||
|
|
|
||
|
|
RSYNCD_CONFIG = Path(__file__).parent.parent / "rsyncd.conf"
|
||
|
|
# Named like a compose service's container, so the Control page can start, stop and restart it.
|
||
|
|
HELPER_NAME = _get_container_name("rsyncd")
|
||
|
|
# What a helper was made from; a helper made from anything else is replaced.
|
||
|
|
SOURCE_LABEL = "wrolpi.rsyncd.source"
|
||
|
|
# The api image starts the API; the helper starts rsync instead. The config arrives in the environment because the
|
||
|
|
# helper shares no directory with the Controller.
|
||
|
|
HELPER_COMMAND = ('printf "%s" "$RSYNCD_CONF" > /tmp/rsyncd.conf'
|
||
|
|
' && exec rsync --daemon --no-detach --config=/tmp/rsyncd.conf')
|
||
|
|
|
||
|
|
|
||
|
|
def read_rsyncd_config() -> str:
|
||
|
|
return RSYNCD_CONFIG.read_text()
|
||
|
|
|
||
|
|
|
||
|
|
def get_rsyncd_port(config: str = None) -> int:
|
||
|
|
"""The port in rsyncd.conf, so the published port cannot differ from the one the daemon listens on."""
|
||
|
|
match = re.search(r"^port\s*=\s*(\d+)\s*$", config or read_rsyncd_config(), re.MULTILINE)
|
||
|
|
if not match:
|
||
|
|
raise RuntimeError(f"No port in {RSYNCD_CONFIG}")
|
||
|
|
return int(match.group(1))
|
||
|
|
|
||
|
|
|
||
|
|
# The api container can be recreated or rebuilt while the Controller runs.
|
||
|
|
CHECK_INTERVAL_SECONDS = 60
|
||
|
|
# Images found to have no rsync (built before it was added), so they are not tried again at every check.
|
||
|
|
_images_without_rsync = set()
|
||
|
|
# The last failure logged, so a failure that lasts is logged once.
|
||
|
|
_last_error = None
|
||
|
|
|
||
|
|
|
||
|
|
def _image_has_rsync(client, image_id: str) -> bool:
|
||
|
|
"""A helper made from an image without rsync exits at once and, restarted by Docker, never stops trying."""
|
||
|
|
if image_id in _images_without_rsync:
|
||
|
|
return False
|
||
|
|
try:
|
||
|
|
client.containers.run(image_id, ["-c", "command -v rsync"], entrypoint="sh", remove=True)
|
||
|
|
return True
|
||
|
|
except Exception as e:
|
||
|
|
if getattr(e, "exit_status", None) is None:
|
||
|
|
# Docker failed, not the command; this says nothing about the image.
|
||
|
|
raise
|
||
|
|
_images_without_rsync.add(image_id)
|
||
|
|
return False
|
||
|
|
|
||
|
|
|
||
|
|
def _failed(error: str) -> dict:
|
||
|
|
global _last_error
|
||
|
|
if error != _last_error:
|
||
|
|
logger.warning("Could not start the rsync daemon container: %s", error)
|
||
|
|
_last_error = error
|
||
|
|
return {"success": False, "error": error}
|
||
|
|
|
||
|
|
|
||
|
|
async def rsync_daemon_loop():
|
||
|
|
"""Docker only: keep the helper matching the api container for as long as the Controller runs."""
|
||
|
|
while True:
|
||
|
|
await asyncio.to_thread(ensure_rsync_daemon)
|
||
|
|
await asyncio.sleep(CHECK_INTERVAL_SECONDS)
|
||
|
|
|
||
|
|
|
||
|
|
def ensure_rsync_daemon() -> dict:
|
||
|
|
"""Docker only: make sure the helper container serves the api container's volumes.
|
||
|
|
|
||
|
|
A helper made from this api container, image and config is left alone (started if it stopped); any other is
|
||
|
|
replaced. Never raises: a WROLPi without the daemon still works, it only cannot be copied by a secondary."""
|
||
|
|
global _last_error
|
||
|
|
if not can_manage_containers():
|
||
|
|
return {"success": False, "error": "Docker management not available"}
|
||
|
|
|
||
|
|
try:
|
||
|
|
client = _get_client()
|
||
|
|
config = read_rsyncd_config()
|
||
|
|
port = get_rsyncd_port(config)
|
||
|
|
api = client.containers.get(_get_container_name("api"))
|
||
|
|
source = hashlib.sha256(f"{api.id}:{api.image.id}:{config}".encode()).hexdigest()
|
||
|
|
|
||
|
|
try:
|
||
|
|
helper = client.containers.get(HELPER_NAME)
|
||
|
|
except NotFound:
|
||
|
|
helper = None
|
||
|
|
if helper is not None:
|
||
|
|
if helper.labels.get(SOURCE_LABEL) == source:
|
||
|
|
if helper.status != "running":
|
||
|
|
logger.info("Starting the rsync daemon container %s", HELPER_NAME)
|
||
|
|
helper.start()
|
||
|
|
_last_error = None
|
||
|
|
return {"success": True, "action": "kept"}
|
||
|
|
|
||
|
|
if not _image_has_rsync(client, api.image.id):
|
||
|
|
# A helper from an older api container is left as it is; it still serves the library.
|
||
|
|
return _failed("The api image has no rsync; rebuild it (docker compose build api)")
|
||
|
|
|
||
|
|
if helper is not None:
|
||
|
|
logger.info("Replacing the rsync daemon container %s", HELPER_NAME)
|
||
|
|
helper.remove(force=True)
|
||
|
|
|
||
|
|
client.containers.run(
|
||
|
|
api.image.id,
|
||
|
|
["-c", HELPER_COMMAND],
|
||
|
|
entrypoint="sh",
|
||
|
|
name=HELPER_NAME,
|
||
|
|
detach=True,
|
||
|
|
user=api.attrs["Config"].get("User") or None,
|
||
|
|
volumes_from=[f"{api.name}:ro"],
|
||
|
|
ports={f"{port}/tcp": port},
|
||
|
|
environment={"RSYNCD_CONF": config},
|
||
|
|
labels={SOURCE_LABEL: source},
|
||
|
|
restart_policy={"Name": "unless-stopped"},
|
||
|
|
)
|
||
|
|
logger.info("Started the rsync daemon container %s on port %s", HELPER_NAME, port)
|
||
|
|
_last_error = None
|
||
|
|
return {"success": True, "action": "created"}
|
||
|
|
except Exception as e:
|
||
|
|
return _failed(str(e))
|