Ansible Role: lodestar

Description

Ansible role that will install, configure and runs Lodestar:

Table of Contents

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

Supported Platforms

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

Dependencies

• Docker

Role Variables:

All variables which can be overridden are stored in defaults/main.yml file. By and large these variables are configuration options. Please refer to the Lodestar docs for more information

Name	Default Value	Description
lodestar_version	unset	REQUIRED Version of lodestar to install and run.
lodestar_user	lodestar	lodestar user
lodestar_group	lodestar	lodestar group
lodestar_base_dir	/opt/lodestar	Path to install to
lodestar_config_dir	/etc/lodestar	Path for default configuration
lodestar_data_dir	/opt/lodestar/data	Path for data directory
lodestar_log_dir	/var/log/lodestar	Path for logs directory
lodestar_log_level	"info"	Log level
lodestar_network	mainnet	Predefined network configuration
lodestar_jwt_auth_file	"/etc/jwt-secret.hex"	Path of the JWT file
lodestar_validator_enabled	"False"	Whether to run in validator mode - please note that the secrets and keys need to be copied by you
lodestar_execution_urls	"http://127.0.0.1:8551"	The elc execution url
lodestar_validator_beaconnodes	"http://lodestar-beacon:9596"	The beacon endpoint for the validator to use
lodestar_checkpoint_sync_url	"https://beaconstate-{{lodestar_network}}.chainsafe.io"	Checkpoint sync to speed things up
lodestar_default_fee_recipient	""	The default fee recepient address
lodestar_keystores_dir	"/config/keys"	The keys directory for validators
lodestar_secrets_dir	"/config/secrets"	The secrets directory for validators
lodestar_enable_doppelganger_protection	True	Doppleganger protection enabled by default
lodestar_validator_force	False	Open validators even if there's a lockfile. Use with caution

Keys/Secrets

Please note that you must put your own secrets and keys in the config directory that you are using ie lodestar_config_dir

Example Playbook

1. Default setup: Install the role from galaxy

ansible-galaxy install consensys.lodestar

Create a requirements.yml with the following: Replace x.y.z below with the version you would like to use

---
- hosts: localhost
  connection: local
  force_handlers: True

  roles:
  - role: consensys.lodestar
    vars:
      lodestar_version: x.y.z

Run with ansible-playbook:

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

2. Install via github

ansible-galaxy install git+https://github.com/consensys/ansible-role-lodestar.git

Create a requirements.yml with the following: Replace x.y.z below with the version you would like to use

---
- hosts: localhost
  connection: local
  force_handlers: True

  roles:
  - role: ansible-role-lodestar
    vars:
      lodestar_version: x.y.z

Run with ansible-playbook:

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

License

Apache

Author Information

Consensys, 2023