-
-
Notifications
You must be signed in to change notification settings - Fork 196
Migrate backing up Plone docs #1919
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 21 commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
fea8c1e
migrate backup plone docs
Manas-Kenge 68df52e
Merge branch '6.0' into migrate-backing-up-plone
Manas-Kenge 7d5c32b
rephrase sentences
Manas-Kenge d728aa1
Merge branch '6.0' into migrate-backing-up-plone
Manas-Kenge 68a4db8
Merge branch '6.0' into migrate-backing-up-plone
stevepiercy cc94877
Merge branch '6.0' into migrate-backing-up-plone
stevepiercy 5669806
Merge branch '6.0' into migrate-backing-up-plone
stevepiercy 5b49675
Merge branch '6.0' into migrate-backing-up-plone
rohnsha0 be2b03d
use one sentence per line
Manas-Kenge abc6ce5
Merge branch '6.0' into migrate-backing-up-plone
Manas-Kenge 030180a
Merge branch '6.0' into migrate-backing-up-plone
Manas-Kenge fb9494c
Merge branch '6.0' into migrate-backing-up-plone
stevepiercy 82e39a6
Remove todo and note
stevepiercy 8dababc
Merge branch '6.0' into migrate-backing-up-plone
stevepiercy 93da5f3
Merge remote-tracking branch 'Manas-Kenge/documentation/migrate-backi…
stevepiercy 5d8fe94
- Complete review
stevepiercy 6d6ba51
Merge branch '6.0' into migrate-backing-up-plone
Manas-Kenge 51e59d5
Merge branch '6.0' into migrate-backing-up-plone
stevepiercy e85a07a
move content
Manas-Kenge 47cc2f5
Merge branch '6.0' into migrate-backing-up-plone
Manas-Kenge efe2d4e
Update preparations.md
stevepiercy 54e2735
Update docs/glossary.md
stevepiercy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| --- | ||
| myst: | ||
| html_meta: | ||
| "description": "How to Back up and restore a Plone site that was installed using buildout" | ||
| "property=og:description": "How to Back up and restore a Plone site that was installed using buildout" | ||
| "property=og:title": "Back up and restore a Plone site" | ||
| "keywords": "Plone 6, admin, install, configuration, upgrade, buildout" | ||
| --- | ||
|
|
||
| (back-up-and-restore-a-plone-buildout-label)= | ||
|
|
||
| # Back up and restore a Plone buildout | ||
|
|
||
| This chapter explains how to back up and restore a Plone site that was installed using buildout. | ||
|
|
||
| (backup-your-plone-site-label)= | ||
|
|
||
| ## Back up your Plone site | ||
|
|
||
| ```{danger} | ||
| Always back up your Plone site before upgrading. | ||
| ``` | ||
|
|
||
| This back up guide assumes the following. | ||
|
|
||
| - You back up your Plone site. | ||
| - You back up your buildout and its caches. | ||
| - You back up your persistent data storage using a strategy that maintains data integrity without taking down your Plone site, that is performed periodically with adequate frequency, and that stores sufficient versions of your data. | ||
| - You've tested the restore process. | ||
|
|
||
|
|
||
| ### Where's my data? | ||
|
|
||
| Your Plone instance installation contains a directory {file}`./var`. | ||
| This directory is located in the same directory as the file {file}`buildout.cfg`. | ||
| It holds the frequently changing data files for the instance. | ||
| {file}`./var` contains the instance's log, process ID, and socket files. | ||
|
|
||
| The following directories contain your instance's content. | ||
|
|
||
|
|
||
| #### {file}`./var/filestorage` | ||
|
|
||
| The Zope Object Database ({term}`ZODB`) file storage is maintained in the directory {file}`./var/filestorage`. | ||
| The default file name is {file}`Data.fs`, although you could have multiple files or renamed it. | ||
| It's typically a large file which contains everything except {term}`blob`s. | ||
|
|
||
| The other files in this directory with the file extensions of `.index`, `.lock`, `.old`, or `.tmp` are ephemeral, and will be recreated by Zope if they're absent. | ||
|
|
||
|
|
||
| #### {file}`./var/blobstorage` | ||
|
|
||
| The directory {file}`./var/blobstorage` contains a deeply nested directory hierarchy that contains the blobs of your database. | ||
| These files may include PDFs, images, videos, office automation files, and other binary objects. | ||
|
|
||
| `filestorage` and `blobstorage` are maintained synchronously. | ||
| `filestorage` has references to blobs in `blobstorage`. | ||
| If the two storages are not synchronized, you'll get errors whenever their data is accessed. | ||
|
|
||
|
|
||
| ### `collective.recipe.backup` | ||
|
|
||
| [`collective.recipe.backup`](https://pypi.org/project/collective.recipe.backup/) is a well-maintained buildout recipe that maintains data integrity for a live Plone database. | ||
|
|
||
| See its `README.md`'s section [Introduction](https://github.com/collective/collective.recipe.backup?tab=readme-ov-file#introduction) for its buildout recipe configuration. | ||
|
|
||
| The recipe supports several options, all of which are documented its `README.md`'s section [Supported options](https://github.com/collective/collective.recipe.backup/blob/master/README.rst#supported-options). | ||
|
|
||
| Perhaps the most useful option is `location`, which sets the destination for backup files. | ||
| Its default value is `var/backups`, inside the buildout directory. | ||
| The backup destination, may be any attached location, including another partition, drive, or network storage. | ||
|
|
||
|
|
||
| #### Operation | ||
|
|
||
| After running buildout to configure `collective.recipe.backup`, you'll find {file}`bin/backup` and {file}`bin/restore` scripts in your buildout directory. | ||
| Since all options are set via buildout, there are few command-line options, and operation is generally through bare commands. | ||
|
|
||
| {file}`bin/restore` will accept a date-time argument, if you keep multiple backups. | ||
| For restore operations, stop Plone before starting your restore, and restart after the restore is complete. | ||
|
|
||
| {file}`bin/backup` is commonly included in a cron table for regular operation. | ||
| You can run backup operations without stopping Plone. | ||
| Make sure you test your backup and restore process before you need it. | ||
|
|
||
|
|
||
| ### Incremental backups | ||
|
|
||
| `collective.recipe.backup` offers both incremental and full backups, and will maintain multiple versions of backups. | ||
| Tune these to meet your needs. | ||
|
|
||
| When you enable incremental backups, the database packing operation will automatically cause the next backup to be a full backup. | ||
|
|
||
| If your backup continuity need is critical, then your incremental backup schedule may need to be frequent. | ||
| Some Plone sites require incremental backups every few minutes. |
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.