wso2 / wso2/open-cloud-datacenter

Add PostgreSQL and MS-SQL database backup guides for the tenancy/vm module

Open
#233 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HCL
Stars
19
Forks
15
Avg merge
2d 2h
Merged PRs (30d)
4

Description

Description

The tenancy/vm examples now document how to back up a VM's plain files with restic (#231 / #232), but not how to back up a database running on that VM. Logical/native database backups are portable across hosts and tolerant of same-or-newer restore targets, which a raw data-directory copy (restic) is not — so a database needs its own guide using the engine's native tooling.

This is the database counterpart to the existing VM-data (restic) and cluster (etcd + Velero) backup guides.

Proposal

Add two self-service guides beside the restic one, matching the style of k8s-cluster/examples/BACKUPS.md and vm/examples/BACKUPS.md:

  • modules/tenancy/vm/examples/POSTGRES-BACKUPS.md — logical dumps (pg_dumpall --roles-only + per-database pg_dump -Fc) streamed to the tenant's own S3 bucket under timestamped prefixes; in-guest systemd timer via the vm module's user_data (base64-embedded scripts); restore into a fresh VM (same DC), a single database, and cross-DC DR.
  • modules/tenancy/vm/examples/MSSQL-BACKUPS.md — native BACKUP DATABASE ... TO DISK + aws s3 cp, with server logins exported separately (SID + password hash) and contained-database auth enabled on restore; same install/verify/restore shape.

Each includes a scheduling/retention reference and a production-hardening checklist, and cross-links the restic and cluster guides.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with k8s-cluster/examples/BACKUPS.md and vm/examples/BACKUPS.md, then inspect the tenancy/vm examples and user_data patterns. Add POSTGRES-BACKUPS.md and MSSQL-BACKUPS.md covering installation, verification, scheduling and retention, production hardening, restore scenarios, and cross-links to the existing guides.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, postgresql, sql
Domain
cloud, databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.