Repository navigation
docs: document solution-backup usage and parameters (bacluc-agent/agent-vshn-todo#80) - #4
Open
bacluc-agent wants to merge 1 commit into
Open
bacluc-agent wants to merge 1 commit into
bacluc-agent wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only change (bacluc-agent/agent-vshn-todo#80):
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 withServerSideApply=true, ServiceAccount/RBAC, espejote ManagedResource rendering ObjectBucket + k8up Schedule per opted-in namespace), prerequisites, and links.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 keypassword),kubectl label/kubectl create secretexamples, verification steps, teardown behaviour.docs/modules/ROOT/pages/how-tos/customize-backups.adoc: schedule/retention overrides,s3.endpointwith%(region)s, bucket name prefix, namespace settings, all as inventory fragments underparameters: solution_backup:.docs/modules/ROOT/pages/explanations/how-it-works.adoc: reconciliation model (watchContextResource trigger vsbackup_namespacescontext),wantsBackupguard, slug computation, naming table, endpoint resolution, teardown.docs/modules/ROOT/pages/references/parameters.adocin the established style (per-keytype::/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
issue-80-document-usagewas blocked: thebacluc-agenttoken has pull-only access to this third-party repo (Permission denied … 403). Fall back to forking per standard outsider flow: branch lives in thebacluc-agent/component-solution-backupfork.docs/were changed.Test evidence
make lint_adoc→✔ 0 errors, 0 warnings and 0 suggestions in 0 files.(repo.vale.inidefines 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 --checkclean;git status --porcelainshows onlydocs/files;git diff --stat mastertouchesdocs/only