OpenStack Swift incremental backup and restore automation tool for file system, MongoDB, MySQL. LVM snapshot and encryption support.
Go to file
qingszhao 4dec666548 switch documentation job to new PTI
This is a mechanically generated patch to switch the documentation
jobs to use the new PTI versions of the jobs as part of the
python3-first goal.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I44b1074afd79e96a827e65e56dd65de37d12ca98
Story: #2002586
Task: #24296
2018-08-31 02:47:54 +00:00
config-generator Added CLI docs for freezer 2017-09-19 10:46:19 +01:00
devstack Merge "Use dedicate log file for freezer-scheduler" 2018-02-27 15:56:50 +00:00
doc Merge "Drop all qpid related explanations" 2018-08-30 13:00:49 +00:00
etc Drop all qpid related explanations 2018-08-30 10:55:34 +00:00
freezer Merge "Fix KeyError if a deprecated key is given" 2018-07-09 13:27:02 +00:00
playbooks/legacy/freezer Refactor freezer legacy jobs 2018-08-14 12:51:27 -04:00
releasenotes Update reno for stable/queens 2018-02-08 21:16:24 +00:00
specs Adds doc8 check to pep8 2018-07-12 20:13:25 +07:00
.coveragerc Fix freezer for py3 compatibility 2016-02-12 01:39:34 +00:00
.gitignore Switch to stestr 2018-07-17 16:48:26 +07:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:10:59 +00:00
.pylintrc Fix pylint checks 2017-06-07 16:15:01 +01:00
.stestr.conf Switch to stestr 2018-07-17 16:48:26 +07:00
.zuul.yaml switch documentation job to new PTI 2018-08-31 02:47:54 +00:00
CREDITS.rst Adding the freezer logo to the README 2016-03-30 19:17:11 +01:00
FAQ.rst Fix description for backup management 2017-03-28 16:08:29 +08:00
HACKING.rst fix a typo in HACKING.rst 2018-03-23 01:51:32 +08:00
INSTALL.rst Correct file names in README.rst 2018-05-28 15:53:00 +02:00
LICENSE Import pep3134daemon as local module 2015-11-23 11:09:38 +00:00
README.rst add release notes to README.rst 2018-06-20 14:36:16 +08:00
TODO.rst Freezer initial commit 2014-07-22 22:46:31 +01:00
bindep.txt Use bindep to define binary deps 2017-04-04 23:16:37 +00:00
freezer_logo.jpg Adding the freezer logo to the README 2016-03-30 19:17:11 +01:00
lower-constraints.txt Merge "Adds doc8 check to pep8" 2018-08-20 10:48:02 +00:00
requirements.txt switch to cryptography 2018-06-19 10:54:05 -05:00
setup.cfg Update homepage url for freezer 2018-01-10 15:05:14 +08:00
setup.py Updated from global requirements 2017-06-08 16:16:50 +00:00
test-requirements.txt Merge "Adds doc8 check to pep8" 2018-08-20 10:48:02 +00:00
tox.ini Merge "Adds doc8 check to pep8" 2018-08-20 10:48:02 +00: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:

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:

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: