Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Feature request: Atomic backup mode for single snapshot for volumes + databases

Abierto
  • ¿Algo no está bien?
#110 1 comentario 0 reacciones 0 asignados Ver en GitHub

@muebau ya está trabajando en esto.

Desde el 17/3/2026.

  • #111 de @muebau — abierto

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
docker, docker-compose, python
Área
databases, devops, infrastructure

Línea de trabajo

No se nombran archivos ni pruebas, así que empieza por localizar la orquestación de las copias de seguridad y las rutas existentes de los volcados de volúmenes y bases de datos. Compara las llamadas separadas actuales a restic con la rama ATOMIC_BACKUP propuesta y, a continuación, verifica que el modo atómico cree un snapshot, limpie /databases en caso de éxito o error y conserve el comportamiento predeterminado existente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Problem

Currently, volumes and database dumps are backed up as separate restic snapshots. A volume backup produces one snapshot, and each database dump (restic backup --stdin) produces another. This was mentioned also in #106 . This means:

  • A restore requires identifying and matching the correct volume snapshot with the correct database snapshot(s)
  • There is no guarantee they represent the same point in time
  • For applications like Nextcloud — where the data directory and database must be consistent — this creates a real risk of restoring into an inconsistent state

Proposed solution

A new environment variable ATOMIC_BACKUP (true/false, default false).

When enabled, the backup process changes from:

restic backup /volumes              → snapshot 1
restic backup --stdin db1.sql       → snapshot 2
restic backup --stdin db2.sql       → snapshot 3

to:

docker exec db1 dump > /databases/db1/all_databases.sql   (write to disk)
docker exec db2 dump > /databases/db2/mydb.sql            (write to disk)
restic backup /volumes /databases                          → snapshot 1 (everything)
rm -rf /databases                                          (cleanup)

The resulting snapshot contains:

/volumes/{service}/{path}/...            ← volume data
/databases/{service}/all_databases.sql   ← SQL dumps

A single restic restore retrieves everything needed to reconstruct the stack.

Example usage

backup:
  image: ghcr.io/lawndoc/stack-back
  environment:
    ATOMIC_BACKUP: "true"
    # ... other env vars

No changes to container labels needed — the feature is purely opt-in via the backup container's environment.

Behavior details

  • Default off: When ATOMIC_BACKUP is unset or false, existing behavior is fully preserved (separate snapshots, --stdin piping). No breaking changes.
  • Dump to disk: In atomic mode, each database container's dump command is streamed via docker exec to a file on the backup container's filesystem under /databases/.
  • Single restic call: Both /volumes and /databases are passed to one restic backup invocation, producing one snapshot.
  • Cleanup: The /databases/ directory is removed after the backup completes (regardless of success/failure).
  • Error handling: If a database dump fails, the error is logged and tracked, but remaining dumps and the restic backup still run (consistent with current behavior where one DB failure doesn't block others). The process exits with a non-zero code if any step failed.

Why this matters

For any stack where application data and database state must be consistent (Nextcloud, Gitea, WordPress, etc.), atomic snapshots eliminate the gap between volume and database backups and make restores straightforward — one snapshot, one restore, guaranteed consistency.

Lenguaje dominante
Python
Estrellas
181
Forks
13
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de lawndoc/stack-back

Todos los issues de lawndoc/stack-back

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.