Skip to content

docs: document solution-backup usage and parameters (bacluc-agent/agent-vshn-todo#80) - #4

Open
bacluc-agent wants to merge 1 commit into
projectsyn:masterfrom
bacluc-agent:issue-80-document-usage
Open

bacluc-agent wants to merge 1 commit into
projectsyn:masterfrom
bacluc-agent:issue-80-document-usage

Conversation

@bacluc-agent

Copy link
Copy Markdown

Summary

Documentation-only change (bacluc-agent/agent-vshn-todo#80):

  • Rewrite docs/modules/ROOT/pages/index.adoc: overview of per-namespace opt-in PVC backups via k8up + espejote backed by AppCat ObjectBucket → S3, what the component creates (Argo CD Application with ServerSideApply=true, ServiceAccount/RBAC, espejote ManagedResource rendering ObjectBucket + k8up Schedule per opted-in namespace), prerequisites, and links.
  • New how-to docs/modules/ROOT/pages/how-tos/enable-backups.adoc: both required namespace labels (opt-in + encryption-secret label naming the Secret with the restic password under key password), kubectl label / kubectl create secret examples, verification steps, teardown behaviour.
  • New how-to docs/modules/ROOT/pages/how-tos/customize-backups.adoc: schedule/retention overrides, s3.endpoint with %(region)s, bucket name prefix, namespace settings, all as inventory fragments under parameters: solution_backup:.
  • New explanation docs/modules/ROOT/pages/explanations/how-it-works.adoc: reconciliation model (watchContextResource trigger vs backup_namespaces context), wantsBackup guard, slug computation, naming table, endpoint resolution, teardown.
  • Full rewrite of docs/modules/ROOT/pages/references/parameters.adoc in the established style (per-key type::/default::, prose, example block). Corrects the stale namespace default (syn-solution-backup → ${_instance}).
  • docs/modules/ROOT/partials/nav.adoc: how-tos and explanation entries added, index + Parameters kept, tutorials empty.

Facts are taken from class/defaults.yml, component/main.jsonnet, and the render test inputs/goldens.

Notes

  • Pushed directly to issue-80-document-usage was blocked: the bacluc-agent token has pull-only access to this third-party repo (Permission denied … 403). Fall back to forking per standard outsider flow: branch lives in the bacluc-agent/component-solution-backup fork.
  • Only files under docs/ were changed.

Test evidence

  • make lint_adoc → ✔ 0 errors, 0 warnings and 0 suggestions in 0 files. (repo .vale.ini defines no styles, so vale scans 0 files by design; upstream target passes)
  • make golden-diff-all → exit 0 (components unchanged; render/golden tests unaffected)
  • make docs-serve → Antora site built and preview served successfully (Caddy 200)
  • git diff --check clean; git status --porcelain shows only docs/ files; git diff --stat master touches docs/ only

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant