dorestic 0.4.4__tar.gz

dorestic-0.4.4/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Eddie Cornejo
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dorestic-0.4.4/PKG-INFO

@@ -0,0 +1,367 @@
+Metadata-Version: 2.4
+Name: dorestic
+Version: 0.4.4
+Summary: A label-driven backup system for Docker containers using restic
+Author: Eddie Cornejo
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/cornejo/dorestic
+Project-URL: Repository, https://github.com/cornejo/dorestic
+Project-URL: Issues, https://github.com/cornejo/dorestic/issues
+Project-URL: Changelog, https://github.com/cornejo/dorestic/blob/main/CHANGELOG.md
+Project-URL: Funding, https://ko-fi.com/rdacted
+Keywords: backup,docker,restic,containers
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Archiving :: Backup
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: docker<8.0,>=7.0
+Requires-Dist: pyyaml<7.0,>=6.0
+Dynamic: license-file
+
+# dorestic
+
+A label-driven backup system for Docker containers using [restic](https://restic.net/).
+
+Containers opt in to backups by adding labels to their compose file. A host-side
+Python script discovers opted-in containers, runs lifecycle hooks (e.g. database
+dumps), resolves volume mounts to host paths, and spawns a disposable
+`restic/restic:latest` container for each backup scope. The restic container has
+no Docker socket and can only read the specific paths mounted into it.
+
+## Installation
+
+```bash
+uv tool install dorestic
+```
+
+Or directly from a git repository:
+
+```bash
+uv tool install git+https://github.com/USER/dorestic.git
+```
+
+## Quick Start
+
+1. Generate an example config:
+
+   ```bash
+   dorestic --init ~/.config/dorestic/
+   ```
+
+   Edit `~/.config/dorestic/config.yml` and set `repository` and `password_file`.
+
+2. Create the password file:
+
+   ```bash
+   echo -n 'your-restic-password' > /etc/backup/restic-password
+   chmod 600 /etc/backup/restic-password
+   ```
+
+3. Add labels to any container you want backed up:
+
+   ```yaml
+   services:
+     my-db:
+       image: postgres:17
+       volumes:
+         - ./pgdata:/var/lib/postgresql/data
+       labels:
+         backup.enable: "true"
+         backup.container.paths: "/var/lib/postgresql/data"
+         backup.container.on_start: "pg_dumpall -U postgres --clean > /var/lib/postgresql/data/dump.sql"
+         backup.container.on_complete: "rm -f /var/lib/postgresql/data/dump.sql"
+         backup.host.paths: ".@1"
+   ```
+
+4. Run a backup:
+
+   ```bash
+   dorestic
+   ```
+
+5. (Optional) Add to cron:
+
+   ```
+   0 3 * * * dorestic
+   ```
+
+## Configuration
+
+Config is loaded from the first location found:
+
+1. `./config.yml` (current directory)
+2. `$XDG_CONFIG_HOME/dorestic/config.yml` (default: `~/.config/dorestic/config.yml`)
+
+Or pass a path explicitly: `dorestic /path/to/config.yml`
+
+Run `dorestic --init [PATH]` to write an example config with documentation.
+
+```yaml
+repository: /mnt/backup/backup1
+password_file: /etc/backup/restic-password
+
+# restic_image: restic/restic:latest
+# on_start: /path/to/on_start.sh
+# on_complete: /path/to/on_complete.sh
+
+# retention:
+#   daily: 7
+#   weekly: 4
+#   monthly: 12
+
+# host_groups:
+#   - tag: documents
+#     paths: [/mnt/fileserver/share]
+#     exclude: ["*.tmp"]
+```
+
+The password file is mounted read-only into the restic container via
+`RESTIC_PASSWORD_FILE` — the password never appears on the command line or in
+`ps` output.
+
+| Field | Required | Description |
+|---|---|---|
+| `repository` | Yes | Restic repository path |
+| `password_file` | Yes | Path to a file containing the restic password |
+| `restic_image` | No | Docker image for restic (default: `restic/restic:latest`) |
+| `on_start` | No | Command to run before the backup starts. If it exits non-zero, the backup is aborted. |
+| `on_complete` | No | Command to run after the entire backup. Env: `$DORESTIC_EXIT_CODE`, `$DORESTIC_LOGFILE` |
+| `retention` | No | Snapshot retention policy (default: 7 daily, 4 weekly, 12 monthly) |
+| `host_groups` | No | Host-only backup groups (see below) |
+
+## Architecture
+
+```
+Host (dorestic)               Restic container (docker run --rm)
+┌───────────────────────────────┐       ┌────────────────────────────────┐
+│ Load config.yml               │       │ No Docker socket               │
+│ Acquire process lock          │       │ No host filesystem access      │
+│ Discover labeled containers   │       │ Only explicitly mounted paths  │
+│ Run on_start hooks            │ spawn │ Data paths mounted read-only   │
+│ Resolve volume mounts → paths │ ────► │ Password via mounted file      │
+│ docker cp for unmounted paths │       │ Runs restic backup             │
+│ Expand depth-limited paths    │       │ Deleted on completion (--rm)   │
+│ Run on_complete hooks         │       └────────────────────────────────┘
+│ Forget/prune/check            │
+│ Run on_complete callback      │
+└───────────────────────────────┘
+```
+
+The backup script runs on the host and interacts with Docker via the Python SDK.
+For each backup scope, it spawns a fresh `restic/restic:latest` container with
+`docker run --rm`, mounting only the necessary data paths (read-only) and the
+restic repository. The container is automatically removed on completion.
+
+## Labels
+
+Each container can define two backup scopes — **container** (paths inside the
+container, resolved via volume mounts) and **host** (paths relative to the
+compose project directory).
+
+| Label | Required | Description |
+|---|---|---|
+| `backup.enable` | Yes | `"true"` to opt in |
+| `backup.container.paths` | No | Comma-separated container-internal paths to back up |
+| `backup.container.exclude` | No | Comma-separated restic exclude patterns for container scope |
+| `backup.container.on_start` | No | Command run inside the container before container backup. Env: `$DORESTIC_TAG` |
+| `backup.container.on_complete` | No | Command run inside the container after container backup. Env: `$DORESTIC_TAG`, `$DORESTIC_EXIT_CODE` |
+| `backup.container.shell` | No | Shell used for container hooks (default: `sh`) |
+| `backup.host.paths` | No | Comma-separated paths relative to the compose project directory |
+| `backup.host.exclude` | No | Comma-separated restic exclude patterns for host scope |
+| `backup.host.on_start` | No | Command run on the host before host backup. Env: `$DORESTIC_TAG` |
+| `backup.host.on_complete` | No | Command run on the host after host backup. Env: `$DORESTIC_TAG`, `$DORESTIC_EXIT_CODE` |
+| `backup.suppress-mount-warning` | No | `"true"` to silence warnings when container paths fall back to `docker cp` (see below) |
+
+### Container paths
+
+Paths in `backup.container.paths` are resolved to host paths by inspecting the
+container's volume mounts. The longest prefix match is used when multiple mounts
+overlap.
+
+If a path has no matching volume mount, dorestic cannot resolve it to a host
+path directly. Instead, it falls back to `docker cp` to extract the data to a
+temporary staging directory before backing it up. This is slower and uses extra
+disk space, so dorestic logs a warning when it happens. If this is intentional
+(e.g. the container stores data outside any mounted volume), set
+`backup.suppress-mount-warning` to `"true"` to silence the warning.
+
+### Host paths and depth
+
+`backup.host.paths` are resolved relative to the container's compose project
+directory (`com.docker.compose.project.working_dir`). Append `@N` to limit
+depth:
+
+| Value | Meaning |
+|---|---|
+| `.@1` | Top-level files in the compose dir (compose file, .env, etc.) |
+| `.` | Entire compose directory, recursive |
+| `../shared-config@2` | Sibling directory, 2 levels deep |
+
+## Lifecycle
+
+For each container, the two scopes (container and host) are independent:
+
+```
+container.on_start ─→ container backup ─→ container.on_complete
+host.on_start ──────→ host backup ──────→ host.on_complete
+```
+
+- Each scope runs independently — a failing `container.on_start` does not
+  affect the host scope, and vice versa.
+- If `on_start` fails, the backup for that scope is skipped, but `on_complete`
+  still runs with the failure code.
+- `on_complete` failures log a warning but don't affect the backup's exit code.
+- Hooks run inside the target container via `docker exec`, so they have access
+  to that container's tools (e.g. `pg_dumpall` in a postgres image).
+
+## Snapshots
+
+Each container gets up to two tagged restic snapshots per run:
+
+- `<name>:container` — container-internal paths (resolved to host via mounts)
+- `<name>:host` — host/compose directory paths
+
+```bash
+# List all snapshots
+restic snapshots
+
+# List snapshots for a specific container scope
+restic snapshots --tag my-db:container
+
+# List host-scope snapshots
+restic snapshots --tag my-db:host
+
+# Restore a specific scope
+restic restore --tag my-db:container latest --target /tmp/restore/
+```
+
+Retention policy is configurable in `config.yml`. Default: 7 daily, 4 weekly,
+12 monthly. Applied per tag via `--group-by tags`.
+
+## Host Backup Groups
+
+Host-only backup groups (not tied to any container) are configured in the
+`host_groups` section of `config.yml`:
+
+```yaml
+host_groups:
+  - tag: documents
+    paths:
+      - /mnt/fileserver/share
+      - /mnt/fileserver/share-private
+    exclude:
+      - "*.tmp"
+
+  - tag: docker-config
+    paths:
+      - /mnt/fileserver/docker
+    exclude:
+      - "aosp-mirror/mirror"
+    on_start: /config/pre-docker-backup.sh
+    on_complete: /config/notify-documents.sh
+```
+
+| Field | Required | Description |
+|---|---|---|
+| `tag` | Yes | Restic tag for this group's snapshot |
+| `paths` | Yes | List of absolute host paths to back up |
+| `exclude` | No | List of restic exclude patterns |
+| `on_start` | No | Command to run before backup. Env: `$DORESTIC_TAG`. Failure skips the backup. |
+| `on_complete` | No | Command to run after backup. Env: `$DORESTIC_TAG`, `$DORESTIC_EXIT_CODE` |
+
+## Examples
+
+### Database with dump
+
+```yaml
+services:
+  database:
+    image: postgres:17
+    volumes:
+      - ${DB_DATA_LOCATION}:/var/lib/postgresql/data
+    labels:
+      backup.enable: "true"
+      backup.container.paths: "/var/lib/postgresql/data"
+      backup.container.exclude: "*.log"
+      backup.container.on_start: "pg_dumpall -U postgres --clean > /var/lib/postgresql/data/dump.sql"
+      backup.container.on_complete: "rm -f /var/lib/postgresql/data/dump.sql"
+      backup.host.paths: ".@1"
+```
+
+The dump file is created by `on_start`, included in the restic snapshot, then
+cleaned up by `on_complete` — regardless of whether the backup succeeded.
+
+### Application with uploads
+
+```yaml
+services:
+  app:
+    image: myapp:latest
+    volumes:
+      - ${UPLOAD_LOCATION}:/usr/src/app/upload
+    labels:
+      backup.enable: "true"
+      backup.container.paths: "/usr/src/app/upload"
+      backup.container.exclude: "*.tmp,thumbs/"
+      backup.host.paths: ".@1"
+```
+
+### Exclude pattern tips
+
+- Patterns use restic's native `--exclude` syntax, interpreted relative to the
+  backup root(s).
+- Container and host scopes are separate restic invocations — `backup.host.exclude`
+  never affects the container scope or other containers.
+- Do **not** compress or encrypt files before handing them to restic. Restic
+  already does both, and pre-processed data destroys chunk-level deduplication.
+
+## Dependencies
+
+- Python 3.12+
+- `docker` Python SDK
+- `pyyaml`
+- Docker daemon with `restic/restic:latest` image available
+
+## Testing
+
+```bash
+uv run pytest tests/ -v
+```
+
+Tests require a running Docker daemon and the `restic/restic:latest` image.
+Unit tests (no Docker) can be run in isolation:
+
+```bash
+uv run pytest tests/test_unit.py -v
+```
+
+## File Structure
+
+```
+dorestic/
+├── src/dorestic/
+│   ├── __init__.py          # Public API re-exports
+│   ├── __main__.py          # Entry point for python -m dorestic
+│   ├── cli.py               # Argument parsing and --init
+│   ├── models.py            # Dataclasses and constants
+│   ├── config.py            # Config file loading and validation
+│   ├── config.yml.example   # Bundled example config (used by --init)
+│   ├── restic.py            # Restic container invocation
+│   ├── docker.py            # Docker container operations
+│   ├── paths.py             # Path resolution utilities
+│   └── backup.py            # Backup orchestration
+├── tests/
+│   ├── conftest.py          # Fixtures and test infrastructure
+│   ├── test_unit.py         # Pure function tests (no Docker)
+│   ├── test_docker.py       # Docker integration tests
+│   └── test_backup.py       # Backup execution and lifecycle tests
+├── pyproject.toml
+├── pyrightconfig.json
+└── .gitignore
+```