consensys.nimbus
Ansible Role: nimbus
Description
This Ansible role installs, configures, and runs nimbus, which is an Ethereum 2 Client for businesses.
Table of Contents
Supported Platforms
* MacOS
* Debian
* Ubuntu
* Redhat (CentOS/Fedora)
* Amazon
Role Variables
All adjustable variables can be found in the defaults/main.yml file. These variables mainly pertain to configuration options. For more details, check the nimbus documentation.
Name | Default Value | Description |
---|---|---|
nimbus_version |
unset | REQUIRED The version of nimbus to install and run. |
nimbus_user |
nimbus | User for nimbus. |
nimbus_group |
nimbus | Group for nimbus. |
nimbus_base_dir |
/opt/nimbus | Installation path. |
nimbus_config_dir |
/etc/nimbus | Directory for default configuration. |
nimbus_data_dir |
/opt/nimbus/data | Directory for data. |
nimbus_validator_data_dir |
/opt/nimbus/validatorData | Directory for validator data. |
nimbus_log_dir |
/var/log/nimbus | Directory for logs. |
nimbus_log_level |
"info" | Level of logging. |
nimbus_network |
mainnet | Predefined network settings. |
nimbus_jwt_auth_file |
"/etc/jwt-secret.hex" | Path to the JWT file. |
nimbus_execution_urls |
"http://127.0.0.1:8551" | URL for Elc execution. |
nimbus_validator_beaconnodes |
"http://127.0.0.1:5051" | Beacon endpoint for the validator. |
nimbus_default_fee_recipient |
"" | Address for default fee recipient. |
nimbus_keys_dir |
"/config/keys" | Directory for validator keys. |
nimbus_secrets_dir |
"/config/secrets" | Directory for validator secrets. |
nimbus_beacon_enabled |
True | Whether to run the beacon node by default. |
nimbus_validator_enabled |
False | Whether to run in validator mode – remember to add the keys and secrets yourself. |
Keys/Secrets
You need to put your own keys and secrets in the configuration directory you are using, i.e., nimbus_config_dir
.
Example Playbook
- Default setup: To install the role from Galaxy:
ansible-galaxy install consensys.nimbus
Create a requirements.yml file like this:
Make sure to change x.y.z
to the version you want from the nimbus releases page.
---
- hosts: localhost
connection: local
force_handlers: True
roles:
- role: consensys.nimbus
vars:
nimbus_version: vx.y.z
nimbus_git_hash: abcd1203
Run it with ansible-playbook:
ansible-playbook -v /path/to/requirements.yml
- Install via GitHub:
ansible-galaxy install git+https://github.com/consensys/ansible-role-nimbus.git
Create a requirements.yml file like this:
Don't forget to replace x.y.z
with the desired version from the nimbus releases page.
---
- hosts: localhost
connection: local
force_handlers: True
roles:
- role: ansible-role-nimbus
vars:
nimbus_version: vx.y.z
nimbus_git_hash: abcd1203
Run it with ansible-playbook:
ansible-playbook -v /path/to/requirements.yml
License
Apache License
Author Information
Consensys, 2023
Informazioni sul progetto
nimbus is an open-source ethereum 2 client
Installa
ansible-galaxy install consensys.nimbus
Licenza
Unknown
Download
1.3k
Proprietario
Consensys is the software engineering leader of the blockchain space. Our full-stack Ethereum products help developers build next-generation networks.