Metadata-Version: 2.1
Name: freezer
Version: 17.0.0
Summary: The OpenStack Backup and Restore as a Service Platform
Home-page: https://docs.openstack.org/freezer/latest/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
License: Apache-2.0
Keywords: freezer,backup,openstack,restore,lvm,snapshot,mongodb,mysql
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: POSIX :: BSD :: NetBSD
Classifier: Operating System :: POSIX :: BSD :: OpenBSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: System :: Archiving :: Compression
Classifier: Topic :: System :: Archiving
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pbr>=4.0.0
Requires-Dist: botocore>=1.5.1
Requires-Dist: setuptools!=24.0.0,!=34.0.0,!=34.0.1,!=34.0.2,!=34.0.3,!=34.1.0,!=34.1.1,!=34.2.0,!=34.3.0,!=34.3.1,!=34.3.2,!=36.2.0,>=21.0.0
Requires-Dist: python-swiftclient>=3.2.0
Requires-Dist: python-cinderclient>=3.3.0
Requires-Dist: python-glanceclient>=2.8.0
Requires-Dist: python-keystoneclient>=3.8.0
Requires-Dist: python-novaclient>=9.1.0
Requires-Dist: python-neutronclient>=6.7.0
Requires-Dist: python-freezerclient>=2.0.0
Requires-Dist: oslo.serialization>=5.5.0
Requires-Dist: oslo.utils>=7.3.0
Requires-Dist: oslo.log>=5.3.0
Requires-Dist: oslo.config>=9.4.0
Requires-Dist: oslo.service!=1.28.1,>=1.24.0
Requires-Dist: keystoneauth1>=3.14.0
Requires-Dist: os-brick>=2.2.0
Requires-Dist: cryptography>=2.5
Requires-Dist: PyMySQL>=0.7.6
Requires-Dist: pymongo!=3.1,>=3.0.2
Requires-Dist: paramiko>=2.7.1
Requires-Dist: apscheduler>=3.0.5
Requires-Dist: psutil>=3.2.2

=================
OpenStack Freezer
=================

.. image:: freezer_logo.jpg

Freezer is a Backup and Restore 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:

- `Backup API Reference <https://docs.openstack.org/api-ref/backup/>`__
- `Freezer API <https://opendev.org/openstack/freezer-api>`__

Freezer Horizon plugin:
- `Freezer Web UI <https://opendev.org/openstack/freezer-web-ui>`__

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

- `OpenStack for App Developers <https://www.openstack.org/appdev/>`__
- `Development resources for OpenStack clouds
  <https://developer.openstack.org/>`__

Operators
---------

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

- `OpenStack Freezer <https://docs.openstack.org/freezer/latest/>`__

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:

- `Bug Tracker <https://launchpad.net/freezer>`__

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:

- `Official Freezer Documentation <https://docs.openstack.org/freezer/latest/>`__
- `Official Client Documentation
  <https://docs.openstack.org/python-freezerclient/latest/>`__

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

- `IRC <https://wiki.openstack.org/wiki/IRC>`__

Other Information
-----------------

Release notes for the project can be found at:

- `Release notes
  <https://docs.openstack.org/releasenotes/freezer/>`__

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:

- `Freezer Specs <http://specs.openstack.org/openstack/freezer-specs/>`__

.. _Summit: https://openinfra.org/summit/
.. _Project Team Gathering: https://openinfra.org/ptg/

