https://github.com/vshn/component-rotating-bucket-backup

Component for creating rotating S3 bucket backups
https://github.com/vshn/component-rotating-bucket-backup

commodore-component vshn-team-aldebaran

Last synced: 22 days ago
JSON representation

Component for creating rotating S3 bucket backups

• Host: GitHub
• URL: https://github.com/vshn/component-rotating-bucket-backup
• Owner: vshn
• License: bsd-3-clause
• Created: 2024-09-12T09:30:16.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-09-17T16:05:32.000Z (3 months ago)
• Last Synced: 2024-09-18T11:42:04.877Z (3 months ago)
• Topics: commodore-component, vshn-team-aldebaran
• Language: Makefile
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Commodore Component: rotating-bucket-backup

This is a [Commodore][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](https://syn.tools).

## Documentation

The rendered documentation for this component is available on the [Commodore Components Hub](https://hub.syn.tools/rotating-bucket-backup).

Documentation for this component is written using [Asciidoc][asciidoc] and [Antora][antora].

It can be found in the [`docs`](docs) folder.

We use the [Divio documentation structure](https://documentation.divio.com/) 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](LICENSE).

For information about how to contribute, see [CONTRIBUTING](CONTRIBUTING.md).

[commodore]: https://syn.tools/commodore/

[asciidoc]: https://asciidoctor.org/

[antora]: https://antora.org/