OpenStack Swift incremental backup and restore automation tool for file system, MongoDB, MySQL. LVM snapshot and encryption support.
Go to file
Zuul 5effc13828 Merge "Fix freezer doc error" 2023-02-24 09:03:22 +00:00
devstack Update devstack doc 2019-11-14 17:19:47 -08:00
doc Fix freezer doc error 2023-02-14 02:36:21 +00:00
etc Correct errors about freezer-api supporting for V1 and V2 api 2018-11-09 00:21:20 +00:00
freezer Replace deprecated readfp method with read_file 2022-07-22 17:22:43 +08:00
releasenotes Update master for stable/zed 2022-09-13 12:16:07 +00:00
.coveragerc Fix freezer for py3 compatibility 2016-02-12 01:39:34 +00:00
.gitignore Update .gitignore 2018-11-12 19:01:11 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:26:12 +00:00
.pylintrc Fix CI error 2021-01-28 21:36:03 -08:00
.stestr.conf Switch to stestr 2018-07-17 16:48:26 +07:00
.zuul.yaml Fix deprecated zuul queue syntax and other gate issues 2023-02-23 16:26:54 +01:00
CREDITS.rst Update CREDITS list 2020-06-24 01:54:30 -07:00
FAQ.rst update project FAQ doc 2020-10-29 01:26:38 -07:00
HACKING.rst [doc]Fix inaccurate url links in docs 2020-10-29 09:53:34 +08:00
LICENSE Import pep3134daemon as local module 2015-11-23 11:09:38 +00:00
README.rst Moving IRC network reference to OFTC 2021-07-07 19:45:41 -05:00
bindep.txt Fix deprecated zuul queue syntax and other gate issues 2023-02-23 16:26:54 +01:00
freezer_logo.jpg Adding the freezer logo to the README 2016-03-30 19:17:11 +01:00
requirements.txt Fix CI error 2021-01-28 21:36:03 -08:00
setup.cfg Dropped the python 3.6/3.7 in zed cycle testing runtime 2022-05-15 09:11:59 +08:00
setup.py Updated from global requirements 2017-06-08 16:16:50 +00:00
test-requirements.txt Fix CI error 2021-01-28 21:36:03 -08:00
tox.ini Fix deprecated zuul queue syntax and other gate issues 2023-02-23 16:26:54 +01:00

README.rst

Team and repository tags

image

OpenStack Freezer

image

Freezer is a Backup Restore DR as a Service platform that helps you to automate the data backup and restore process.

The following features are available:

  • Backup file system using point-in-time snapshot
  • Strong encryption supported: AES-256-CFB
  • Backup file system tree directly (without volume snapshot)
  • Backup journalled MongoDB directory tree using lvm snapshot to Swift
  • Backup MySQL with lvm snapshot
  • Restore data from a specific date automatically to file system
  • Low storage consumption as the backup are uploaded as a stream
  • Flexible backup policy (incremental and differential)
  • Data is archived in GNU Tar format for file based incremental
  • Multiple compression algorithm support (zlib, bzip2, xz)
  • Remove old backup automatically according to the provided parameters
  • Multiple storage media support (Swift, local file system, or ssh)
  • Flush kernel buffered memory to disk
  • Multi-platform (Linux, Windows, *BSD, OSX)
  • Manage multiple jobs (I.e., multiple backups on the same node)
  • Synchronize backups and restore on multiple nodes
  • Web user interface integrated with OpenStack Horizon
  • Execute scripts/commands before or after a job execution
  • More ...

To learn how to use Freezer's API, consult the documentation available online at:

Freezer Disaster Recovery: - Freezer DR

Freezer Horizon plugin: - Freezer Web UI

For more information on OpenStack APIs, SDKs and CLIs in general, refer to:

Operators

To learn how to deploy and configure OpenStack Freezer, consult the documentation available online at:

In the unfortunate event that bugs are discovered, they should be reported to the appropriate bug tracker. If you obtained the software from a 3rd party operating system vendor, it is often wise to use their own bug tracker for reporting problems. In all other cases use the master OpenStack bug tracker, available at:

Troubleshooting

When errors occure, these are good places to check:

  • freezer-api log: $HOME/log/freezer-api.log

    /var/log/apache2/freezer-api.log

  • freezer-agent log: $HOME/.freezer/freezer.log
  • freezer-scheduler log:/var/log/freezer/scheduler.log

Developers

Any new code must follow the development guidelines detailed in the HACKING.rst file and OpenStack general development guidelines, and pass all unit tests.

Further developer focused documentation is available at:

Contributors are encouraged to join IRC (#openstack-freezer on OFTC):

Other Information

Release notes for the project can be found at:

During each Summit and Project Team Gathering, we agree on what the whole community wants to focus on for the upcoming release. The plans for freezer can be found at: