garage/doc/book/cookbook/ansible.md
Baptiste Jonglez 3b22da251d
All checks were successful
continuous-integration/drone/pr Build is passing
Add documentation on community Ansible roles
2023-03-01 09:24:13 +01:00

3.1 KiB

+++ title = "Deploying with Ansible" weight = 35 +++

While Ansible is not officially supported to deploy Garage, several community members have published Ansible roles. We list them and compare them below.

Comparison of Ansible roles

Feature ansible-role-garage garage-docker-ansible-deploy
Runtime Systemd Docker
Target OS Any Linux Any Linux
Architecture amd64, arm64, i686 amd64, arm64
Additional software None Traefik
Automatic node connection
Layout management
Manage buckets & keys (basic)
Allow custom Garage config
Facilitate Garage upgrades
Multiple instances on one host

zorun/ansible-role-garage

Source code, Ansible galaxy

This role is voluntarily simple: it relies on the official Garage static binaries and only requires Systemd. As such, it should work on any Linux-based OS.

To make things more flexible, the user has to provide a Garage configuration template. This allows to customize Garage configuration in any way.

Some more features might be added, such as a way to automatically connect nodes to each other or to define a layout.

moan0s/garage-docker-ansible-deploy

Source code, Blog post

This role is based on the Docker image for Garage, and comes with "batteries included": it will additionally install Docker and Traefik. In addition, it is "opinionated" in the sense that it expects a particular deployment structure (one instance per disk, one gateway per host, structured DNS names, etc).

As a result, this role makes it easier to start with Garage on Ansible, but is less flexible.