Files
freezer/doc/source/install/get_started.rst
Dmitriy Rabotyagov 6256e29e3b [doc] Remove freezer-dr reference
Since freezer-dr has been retired [1] we remove all references to this
part of Freezer service from documentation.

[1] https://review.opendev.org/q/topic:%22freezer/retire_dr%22

Change-Id: Ide1d4ac7ad81e8ac89bdfe039838023ce621878c
2025-01-10 19:13:03 +01:00

41 lines
1.1 KiB
ReStructuredText

Backup/Restore service overview
===============================
The Backup/Restore service provides an easy way to backup and restore
your OpenStack workloads to different storage.
The Backup and restore service consists of the following components:
- freezer-api
- freezer-agent
- freezer-scheduler
The service features a RESTful API, which can be used to maintain the status of
your jobs, backups and metadata.
This chapter assumes a working setup of OpenStack following the base
Installation Guide.
Concepts and definitions
========================
``freezer-api`` service
Accepts and responds to end user API calls.
``freezer-api`` service documentation can be found here:
`Freezer API <https://docs.openstack.org/freezer-api/latest/>`_
``freezer-scheduler`` service
Does API calls to ``freezer-api`` to schedule, fetch, update or Delete backup
jobs.
``freezer-agent`` service
Python application run on the same node like ``freezer-scheduler`` and it
gets called by ``freezer-scheduler`` to execute backups/restore operations.
*hostname* is _probably_ going to be the host fqdn.
*backup_id* defined as UUID of a backup.