Split data backup and restore plugin namespaces

Author: marcofortina

docs/plugins/generated.md

@@ -17,15 +17,6 @@ automax plugins list
 Current builtin plugins:
 
 ```text
-backup.directory
-backup.file
-backup.manifest
-backup.prune
-backup.restore
-backup.restore_preview
-backup.restore_verify
-backup.rotate
-backup.verify
 data.archive.tar.check
 data.archive.tar.create
 data.archive.tar.extract
@@ -34,6 +25,13 @@ data.archive.zip.check
 data.archive.zip.create
 data.archive.zip.extract
 data.archive.zip.list
+data.backup.directory.create
+data.backup.file.create
+data.backup.list
+data.backup.manifest.create
+data.backup.prune
+data.backup.rotate
+data.backup.verify
 data.compression.bzip2.check
 data.compression.bzip2.compress
 data.compression.bzip2.decompress
@@ -47,6 +45,9 @@ data.compression.zstd.check
 data.compression.zstd.compress
 data.compression.zstd.decompress
 data.download.url
+data.restore.apply
+data.restore.preview
+data.restore.verify
 data.transfer.download
 data.transfer.rsync
 data.transfer.sync

docs/plugins/index.md

@@ -4,41 +4,31 @@ Per-plugin runbooks only. No combined runbook, no reused runtime smoke flow, and
 
 | File | Plugin/family | Substeps |
 |---|---:|---:|
-| `runbooks/01-os-alternatives.check.yaml` | `os.alternatives` | 4 |
 | `runbooks/02-apparmor.check.yaml` | `security.apparmor` | 8 |
-| `runbooks/03-data-archive.check.yaml` | `data.archive` | 6 |
+| `runbooks/03-data-archive.check.yaml` | `data.archive.tar` | 20 |
 | `runbooks/05-auditd.check.yaml` | `security.audit` | 8 |
 | `runbooks/06-authselect.check.yaml` | `security.authselect` | 1 |
-| `runbooks/07-backup.check.yaml` | `backup` | 9 |
-| `runbooks/10-os-capability.check.yaml` | `os.capability` | 1 |
+| `runbooks/07-data-backup-restore.check.yaml` | `data.backup/data.restore` | 10 |
 | `runbooks/11-cert.check.yaml` | `security.pki.cert` | 11 |
-| `runbooks/12-os-time-chrony.check.yaml` | `os.time.chrony` | 5 |
 | `runbooks/13-system-cron.check.yaml` | `system.cron.entry` | 5 |
 | `runbooks/14-db.check.yaml` | `db` | 5 |
 | `runbooks/15-data-download.check.yaml` | `data.download` | 1 |
-| `runbooks/16-os-env.check.yaml` | `os.env` | 5 |
-| `runbooks/17-facts.check.yaml` | `facts/os` | 6 |
+| `runbooks/17-facts.check.yaml` | `facts` | 6 |
 | `runbooks/19-firewalld.check.yaml` | `network.firewall.firewalld` | 11 |
 | `runbooks/20-fs.check.yaml` | `fs.acl` | 31 |
 | `runbooks/22-group.check.yaml` | `identity.group` | 5 |
-| `runbooks/24-os-hostname.check.yaml` | `os.hostname` | 3 |
-| `runbooks/25-os-hosts.check.yaml` | `os.hosts` | 4 |
 | `runbooks/26-http.check.yaml` | `http` | 3 |
 | `runbooks/27-iptables.check.yaml` | `network.firewall.iptables` | 9 |
 | `runbooks/28-system-journal.check.yaml` | `system.journal` | 2 |
 | `runbooks/29-system-kernel.check.yaml` | `system.kernel.boot_param` | 8 |
-| `runbooks/30-os-limits.check.yaml` | `os.limits` | 1 |
 | `runbooks/31-local.check.yaml` | `local` | 1 |
 | `runbooks/32-system-log.check.yaml` | `system.log` | 2 |
-| `runbooks/33-os-login.check.yaml` | `os.login` | 3 |
 | `runbooks/35-mail.check.yaml` | `mail` | 1 |
 | `runbooks/38-network.check.yaml` | `network.link` | 14 |
 | `runbooks/39-nftables.check.yaml` | `network.firewall.nftables` | 6 |
 | `runbooks/40-pam.check.yaml` | `security.pam` | 14 |
 | `runbooks/41-password.check.yaml` | `security.password` | 1 |
-| `runbooks/42-os-package.check.yaml` | `os.package` | 27 |
 | `runbooks/43-pki.check.yaml` | `security.pki.trust` | 3 |
-| `runbooks/44-os-platform.check.yaml` | `os.platform` | 1 |
 | `runbooks/45-plugin.check.yaml` | `plugin` | 1 |
 | `runbooks/46-system-process.check.yaml` | `system.process` | 5 |
 | `runbooks/47-remote.check.yaml` | `remote` | 1 |
@@ -52,8 +42,6 @@ Per-plugin runbooks only. No combined runbook, no reused runtime smoke flow, and
 | `runbooks/57-system.check.yaml` | `system` | 1 |
 | `runbooks/58-system-service.check.yaml` | `system.systemd` | 12 |
 | `runbooks/59-system-systemd.check.yaml` | `system.systemd` | 4 |
-| `runbooks/60-os-time.check.yaml` | `os.time` | 7 |
-| `runbooks/61-os-tool.check.yaml` | `os.tool` | 2 |
 | `runbooks/62-data-transfer.check.yaml` | `data.transfer` | 4 |
 | `runbooks/63-udev.check.yaml` | `udev` | 7 |
 | `runbooks/64-ufw.check.yaml` | `network.firewall.ufw` | 6 |

examples/runbooks/RUNBOOK_INDEX.md

@@ -0,0 +1,43 @@
+# Check-only plugin catalog. Run with automax run --check, not as a normal runtime job.
+apiVersion: automax.io/v1
+kind: Job
+metadata:
+  name: plugin-smoke-check-data-backup-restore
+tasks:
+- id: data_backup_restore
+  description: Check-mode catalog for data backup and restore plugins.
+  targets: all
+  tags: [all-functions, check, data, backup, restore]
+  steps:
+  - id: catalog
+    substeps:
+    - id: data_backup_directory_create
+      use: data.backup.directory.create
+      with: {src: /tmp/source, dest: /tmp/dest}
+    - id: data_backup_file_create
+      use: data.backup.file.create
+      with: {src: /tmp/source, dest: /tmp/dest}
+    - id: data_backup_list
+      use: data.backup.list
+      with: {path: /tmp/automax-demo}
+    - id: data_backup_manifest_create
+      use: data.backup.manifest.create
+      with: {root: /tmp/automax-demo, dest: /tmp/automax-manifest.txt}
+    - id: data_backup_prune
+      use: data.backup.prune
+      with: {path: /tmp/automax-demo, confirm: true, keep: 1, patterns: ['*.old']}
+    - id: data_backup_rotate
+      use: data.backup.rotate
+      with: {path: /tmp/automax-demo, keep: 1, confirm: true}
+    - id: data_backup_verify
+      use: data.backup.verify
+      with: {path: /tmp/automax-demo}
+    - id: data_restore_apply
+      use: data.restore.apply
+      with: {src: /tmp/source, dest: /tmp/dest, confirm: true}
+    - id: data_restore_preview
+      use: data.restore.preview
+      with: {src: /tmp/source, dest: /tmp/dest}
+    - id: data_restore_verify
+      use: data.restore.verify
+      with: {src: /tmp/source, dest: /tmp/dest}

examples/runbooks/runbooks/07-backup.check.yaml

@@ -138,13 +138,13 @@ def sample_params(plugin: Any) -> dict[str, Any]:
     if plugin.name == "db.health":
         params["engine"] = "sqlite"
         params["connection"] = {"path": "/tmp/automax.sqlite"}
-    if plugin.name in {"backup.prune", "backup.restore", "backup.rotate", "network.firewall.iptables.restore", "storage.lvm.lv.remove", "storage.lvm.pv.remove", "storage.lvm.vg.remove"}:
+    if plugin.name in {"data.backup.prune", "data.restore.apply", "data.backup.rotate", "network.firewall.iptables.restore", "storage.lvm.lv.remove", "storage.lvm.pv.remove", "storage.lvm.vg.remove"}:
         params["confirm"] = True
     if plugin.name == "plugin.requirements":
         params["plugin"] = "data.transfer.rsync"
-    if plugin.name == "backup.directory":
+    if plugin.name == "data.backup.directory.create":
         params["compression"] = "none"
-    if plugin.name == "backup.verify":
+    if plugin.name == "data.backup.verify":
         params["checksum"] = "sha256"
     if plugin.name.startswith("data.compression.") and plugin.name.endswith(".compress"):
         params["dest"] = "/tmp/automax-demo.gz"