<!-- vale Canonical.007-Headings-sentence-case = NO -->

# Backup Operators

<!-- vale Canonical.007-Headings-sentence-case = YES -->

Backup operators are a collection of [charms](https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/#charm) that provide a highly integrated, low-operations backup solution for charms running in machine environments.

Backup operators deliver file-level backups using the [Bacula](https://www.bacula.org/) system and leverage the `backup` relation to automatically define what and how to back up for all supported backup target charms in the Juju ecosystem. This significantly reduces the operational cost of setting up backups in complex systems.

For Site Reliability Engineers, backup operators offer a turnkey, out-of-the-box backup solution.

## In this documentation

|                               |                                                                                                                                                                                                                                                                                                                                       |
|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Get started**               | [Deploy the Bacula server charm for the first time](https://canonical.com/juju/docs/backup-charms/latest/tutorial/index.html.md#tutorial)                                                                                                                                                                                                                             |
| **Deployment and operations** | [Integrate and configure backup-integrator](https://canonical.com/juju/docs/backup-charms/latest/how-to/integrate-with-backup-integrator-charm/index.html.md#how-to-integrate-with-backup-integrator-charm) | [Manage, schedule, and trigger backup using Baculum](https://canonical.com/juju/docs/backup-charms/latest/how-to/use-baculum/index.html.md#how-to-use-baculum) | [Upgrade](https://canonical.com/juju/docs/backup-charms/latest/how-to/upgrade/index.html.md#how-to-upgrade) |
| **Design**                    | [Bacula and backup charms architecture](https://canonical.com/juju/docs/backup-charms/latest/reference/architecture/index.html.md#reference-architecture)                                                                                                                                                                                                                           |
| **Security**                  | [Overview](https://canonical.com/juju/docs/backup-charms/latest/explanation/security/index.html.md#explanation-security)                                                                                                                                                                                                                                                          |

## How this documentation is organized

This documentation uses the
[Diátaxis documentation structure](https://diataxis.fr/).

* The [Tutorial](https://canonical.com/juju/docs/backup-charms/latest/tutorial/index.html.md#tutorial) takes you step-by-step through a basic deployment of backup charms.
* The [How-to guides](https://canonical.com/juju/docs/backup-charms/latest/how-to/index.html.md#how-to) assume you have basic familiarity with the backup charms. Learn more about setting up, using, maintaining, and contributing to this project.
* [Reference](https://canonical.com/juju/docs/backup-charms/latest/reference/index.html.md#reference) provides a guide to actions, configurations, relations, charm architecture, and other technical details.
* [Explanation](https://canonical.com/juju/docs/backup-charms/latest/explanation/index.html.md#explanation) provides additional context and deeper understanding of key concepts, such as security.

## Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source approach
to the documentation as the code. As such, we welcome community contributions, suggestions, and
constructive feedback on our documentation.
See [How to contribute](https://canonical.com/juju/docs/backup-charms/latest/how-to/contribute/index.html.md#how-to-contribute) for more information.

If there’s a particular area of documentation that you’d like to see that’s missing, please
[file a bug](https://github.com/canonical/backup-operators/issues).

## Project and community

The backup operators are a member of the Ubuntu family. It’s an open-source project that warmly welcomes community
projects, contributions, suggestions, fixes, and constructive feedback.

- [Code of conduct](https://ubuntu.com/community/code-of-conduct)
- [Get support](https://discourse.charmhub.io/)
- [Join our online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
- [Contribute](https://github.com/canonical/backup-operators/blob/main/CONTRIBUTING.md)

Thinking about using the backup operators for your next project?
[Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!
