Document how to back up and restore Pulp 3
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Author: @goosemania (ttereshc)
Redmine Issue: 6711, https://pulp.plan.io/issues/6711
Currently there are no docs about how to back up and restore a Pulp 3 installation.
- Create a page for backup and restore
- It should list all the components which needs to be backed up
- It should mention all the requirements and caveats (e.g. pulp version should be the same for backup+restore procedure, tasks in incomplete state needs to be cancelled, etc)
Details
This should be a conceptual guide. We do not want to document how to backup postgresql in great detail for example. There are so many ways to backup postgresql. Similarly for the filesystem, we can give a simple examples, but there are so many backup tools for files, e.g. cp -a rsync, or rdiff-backup, etc.
To backup
- Stop all pulp services
- Stop postgresql
- Backup MEDIA_ROOT, e.g.
/var/lib/pulp/ - Backup Postgresql
- If using S3 or Azure you'll need to archive that somehow.
Also mention that temporary files are not needed to be included in the backup
To restore
- Stop all pulp services
- Stop postgresql
Restore MEDIA_ROOT (with correct file permissions) - Restore postgresql
- restore S3 or Azure
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing Pulp 3 documentation structure and the documentation covering services, MEDIA_ROOT, PostgreSQL, and remote storage. Use the issue checklist to define the conceptual backup and restore guide, including requirements and caveats without prescribing one backup tool. Done means the guide covers the listed components, temporary files, permissions, and restore sequence.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, azure, postgresql
- Domain
- cloud, databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100