ceems.ansible.litestream role – Litestream replicator

Note

This role is part of the ceems.ansible collection (version 1.0.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install ceems.ansible.

To use it in a playbook, specify: ceems.ansible.litestream.

Entry point main – Litestream replicator

Synopsis

Parameters

Parameter

Comments

litestream_binary_install_dir

string

Advanced

Directory to install litestream binary

Default: "/usr/local/bin"

litestream_binary_local_dir

string

Enables the use of local packages instead of those distributed on github.

The parameter may be set to a directory where the litestream binary is stored on the host where ansible is run.

This overrides the litestream_version parameter

litestream_binary_url

string

URL of the Litestream binaries .tar.gz file

Default: "https://github.com/{{ _litestream_repo }}/releases/download/v{{ litestream_version }}/litestream-{{ litestream_version }}.linux-{{ go_arch }}.tar.gz"

litestream_cli_args

list / elements=string

Advanced

Additional CLI arguments that will be passed to Litestream

litestream_config

dictionary / required

Litstream config.

More details on Litestream config in docs

litestream_create_system_user_group

string

Advanced

Create system user and group for litestream

Default: true

litestream_env_vars

dictionary

Advanced

Environment variables will be passed to Litestream

litestream_skip_install

boolean

Litestream installation tasks gets skipped when set to true.

Choices:

  • false ← (default)

  • true

litestream_system_group

string

Advanced

System group for litestream

Default: "root"

litestream_system_user

string

Advanced

Litestream user

Default: "root"

litestream_version

string

Litestream package version. Also accepts latest as parameter.

Default: "0.5.2"

Authors

  • Mahendra Paipuri