Hotrod Ansible Role

This Ansible role installs and configures the Hotrod binary, Hotrod server and Hotrod agents.

See Hotrod's installation guide, and environment variables.

Licence

This Ansible role is made available under the MIT license. The use of Hotrod is subject to the Panoptix End User License Agreement.

Supported Systems

This role supports Ubuntu 18.04, 20.04 and 22.10

./tasks/preflight.yml will abort the playbook if the target system is not supported.

Usage

See ./exampes for installing different Hotrod components, as well as a test cluster setup.

All examples requires a value for hotrod_download_uri. See downloads.

Variables

Target Version

hotrod_download_uri (Default: none)

The URI of the Hotrod binary release to download, which determines the installed version. See downloads for obtaining this URI.

hotrod_download_uri_sha1 (Default: {{ hotrod_download_uri }}.sha1)

The URI of the SHA1 checksum associated with hotrod_download_uri. No need to change this when performing standard downloads.

Shared Settings

hotrod_system_group (default: hotrod)

The user group to run Hotrod server/agent as. The group is created if it doesn't exist (unless root, but you shouldn't run Hotrod as root).

hotrod_system_user (default: hotrod)

The system user to run Hotrod server/agent as. The user is created if it doesn't exist (unless root, but you shouldn't run Hotrod as root).

Install Options

These variables control what this role installs:

hotrod_install_binary (default: no)

If yes, downloads and installs the Hotrod binary on the target system, as specified by hotrod_download_uri.

hotrod_install_server (default: no)

If yes, installs and configures Hotrod server. Implies hotrod_install_binary: yes.

hotrod_install_agent (default: no)

If yes, installs and configures Hotrod agent. Implies hotrod_install_binary: yes.

Additional Variables

See ./defaults/main.yml for customizing the Hotrod installation. Variables are documented, and most have reasonable defaults.

Uninstall Feature

The hotrod_remove_* variables can be used to remove some or all components. They are provided for easily cleanup on test systems, and as a reference for removing components, but should not be used on production Hotrod clusters.

Note that:

hotrod_remove_* are mutually exclusive with their hotrod_install_* counterparts
hotrod_system_user and hotrod_system_group will only be removed if both values match "hotrod", to avoid undesirable effects when using non-defaults
hotrod_remove_server and hotrod_remove_agent will destroy data directories!