OpenStack Swift incremental backup and restore automation tool for file system, MongoDB, MySQL. LVM snapshot and encryption support.
Go to file
Ian Wienand 3ca3e5689a Replace openstack.org git:// URLs with https://
This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.

This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.

This update should result in no functional change.

For more information see the thread at

 http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html

Change-Id: I3e9e47ac41bfd34025d0d016d0b6647d3372c92f
2019-03-24 20:33:32 +00:00
devstack In default mode , disable "debug" 2018-11-02 23:10:34 -04:00
doc Update link address of installation guide 2018-11-28 19:07:54 +08:00
etc Correct errors about freezer-api supporting for V1 and V2 api 2018-11-09 00:21:20 +00:00
freezer Update json module to jsonutils 2019-02-21 14:03:50 +08:00
playbooks/legacy/freezer Replace openstack.org git:// URLs with https:// 2019-03-24 20:33:32 +00:00
releasenotes Update reno for stable/queens 2018-02-08 21:16:24 +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 Update .gitreview for new namespace 2015-10-17 22:10:59 +00:00
.pylintrc update pylint to 1.9.2 2018-09-03 13:10:55 +00:00
.stestr.conf Switch to stestr 2018-07-17 16:48:26 +07:00
.zuul.yaml Make freezer-ubuntu as voting job again 2019-03-14 16:07:11 +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 Clean up docs and specs directories 2018-09-05 15:18:30 +09:00
LICENSE Import pep3134daemon as local module 2015-11-23 11:09:38 +00:00
README.rst Add logs places in README.rst 2018-11-22 18:57:01 -05: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 Update python-freezerclinet version to 2.0.0 2018-11-07 07:09:24 +00:00
requirements.txt Update json module to jsonutils 2019-02-21 14:03:50 +08:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-03 22:23:36 -05:00
setup.py Updated from global requirements 2017-03-03 22:48:35 +00:00
test-requirements.txt Fix openstack-tox-docs failure 2018-09-04 21:04:06 +09:00
tox.ini python 3.6 unit test job 2018-11-06 22:52:20 -08: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 freenode):

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: