Metadata-Version: 2.1
Name: freezer-api
Version: 17.0.0
Summary: OpenStack Backup and Restore API Service
Home-page: https://docs.openstack.org/freezer/latest/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
License: Apache-2.0
Classifier: Environment :: OpenStack
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.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
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 :: Unix
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: System :: Archiving :: Compression
Classifier: Topic :: System :: Archiving
Requires-Python: >=3.8
License-File: LICENSE
Requires-Dist: elasticsearch<3.0.0,>=2.0.0
Requires-Dist: falcon>=1.0.0
Requires-Dist: jsonschema>=3.2.0
Requires-Dist: keystonemiddleware>=4.17.0
Requires-Dist: Paste>=2.0.2
Requires-Dist: PasteDeploy>=1.5.0
Requires-Dist: oslo.config>=6.8.0
Requires-Dist: oslo.context>=2.22.0
Requires-Dist: oslo.db>=4.44.0
Requires-Dist: oslo.i18n>=3.15.3
Requires-Dist: oslo.log>=3.36.0
Requires-Dist: oslo.middleware>=3.31.0
Requires-Dist: oslo.policy>=4.5.0
Requires-Dist: oslo.serialization>=2.25.0
Requires-Dist: oslo.upgradecheck>=1.3.0
Requires-Dist: SQLAlchemy>=1.2.19
Requires-Dist: alembic>=1.8.0

=====================
OpenStack Freezer-API
=====================

OpenStack Freezer-API is a RESTFUL API to Store information and metadata about
Backups, Jobs, Clients, Sessions. It helps keeping backup/restore jobs
organized and maintain the status of the backups.

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

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

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>`__

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/>`__
- `Source Code Repository <https://opendev.org/openstack/freezer-api>`__

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

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 <https://specs.openstack.org/openstack/freezer-specs/>`__

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

