Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.46 KB

File metadata and controls

31 lines (20 loc) · 1.46 KB

Commodore Component: rotating-bucket-backup

This is a Commodore Component to manage S3 bucket backups.

The component creates a backup of an S3 bucket and stores it in another S3 bucket. The component creates a new bucket for each day of the month and stores the backup in the corresponding bucket. It then rotates by overwriting the corresponding bucket on the same day of the month.

This repository is part of Project Syn. For documentation on Project Syn and this component, see syn.tools.

Documentation

The rendered documentation for this component is available on the Commodore Components Hub.

Documentation for this component is written using Asciidoc and Antora. It can be found in the docs folder. We use the Divio documentation structure to organize our documentation.

Run the make docs-serve command in the root of the project, and then browse to http://localhost:2020 to see a preview of the current state of the documentation.

After writing the documentation, please use the make docs-vale command and correct any warnings raised by the tool.

Contributing and license

This library is licensed under BSD-3-Clause. For information about how to contribute, see CONTRIBUTING.