Ansible Role: Teku

Description

This Ansible role installs, configures, and runs Teku, which is a Java client for Ethereum 2 designed for enterprises.

Table of Contents

• Supported Platforms
• Dependencies
• Role Variables
• Example Playbook
• License
• Author Information

Supported Platforms

* MacOS
* Debian
* Ubuntu
* Redhat (CentOS/Fedora)
* Amazon

Dependencies

You need JDK version 11 or higher.

Role Variables:

All customizable variables are found in the defaults/main.yml file. These variables typically represent different configuration options. For more details, please refer to the Teku documentation.

Configuration Without Defaults

Here are some variables that don't have default values but can be configured when running Teku:

Standalone Mode

Teku can be set to run in two modes:

1. Monolith Mode (both beacon and validator run in the same process)
2. Standalone Mode (beacon and validator run in separate processes)

In Standalone Mode, the beacon service runs in its own process, and the validator service runs separately. The systemd service name for the beacon service is teku, and teku-validator is used for the validator service. The default setting in this Ansible role is Monolith Mode, but you can switch it to Standalone Mode using the variable teku_standalone_validator.

Example Playbook

1. Default Setup:

   • Install the role from Galaxy:

     ansible-galaxy install pegasyseng.teku
     

   • Create a requirements.yml file and replace x.y.z with your desired Teku version from the Teku releases page:

     ---
     - hosts: localhost
       connection: local
       force_handlers: True
     
       roles:
       - role: pegasyseng.teku
         vars:
           teku_version: x.y.z
     

   • Run the playbook:

     ansible-playbook -v /path/to/requirements.yml
     

2. Install via GitHub:

   ansible-galaxy install git+https://github.com/pegasyseng/ansible-role-teku.git
   

   • Create a requirements.yml file as above and replace x.y.z with your desired Teku version.
   • Run the playbook:

     ansible-playbook -v /path/to/requirements.yml
     

License

Apache

Author Information

PegaSysEng, 2020