consensys.checkpointz
Ansible Role: Checkpointz
Description
This Ansible role installs, configures, and runs Checkpointz in Docker. Checkpointz is a provider for syncing checkpoints from the Ethereum beacon chain.
Table of Contents
Supported Platforms
- MacOS
- Debian
- Ubuntu
- Red Hat (CentOS/Fedora)
- Amazon
Requirements
- Latest version of Docker
Role Variables:
You can modify the following variables in the defaults/main.yml file. If you see an ENV variable name, it means you can change its default setting, which will be applied when the role runs. For more details, refer to the Checkpointz documentation.
Name | Default Value | Description |
---|---|---|
checkpointz_upstream_nodes |
[] | List of upstream beacon nodes to use. Each node is a JSON object with "name", "address", and "dataProvider". See config |
checkpointz_version |
"latest" | Version of Checkpointz to install. Check available versions in the Checkpointz README. Omit the 'v'. For example, use 1.4.0. |
checkpointz_user |
"checkpointz" | User account created to run the application. |
checkpointz_group |
"checkpointz" | Group created for running the application. |
checkpointz_container_name |
"checkpointz" | Name of the Docker-Compose container. |
checkpointz_base_dir |
"/opt/checkpointz" | Directory on the host for storing config.yaml and docker-compose.yaml. |
checkpointz_listen_addr |
5555 | Address the app listens on. |
checkpointz_logging |
"debug" | Logging level. |
checkpointz_metrics_addr |
9090 | Address for metrics. |
checkpointz_mode |
"full" | Sync mode: either Full or Light. |
checkpointz_caches_blocks_max_items |
200 | Maximum number of block items Checkpointz can store (minimum 3). |
checkpointz_caches_states_max_items |
5 | Maximum number of state items Checkpointz can store. |
checkpointz_historical_epoch_count |
20 | Number of historical epoch boundaries Checkpointz will fetch and serve. |
checkpointz_frontend_brand_image_url |
"" | URL for the brand image shown on the frontend. |
checkpointz_frontend_brand_name |
"" | Name of the brand displayed on the frontend. |
checkpointz_frontend_public_url |
"" | Public URL where the frontend will be accessible. |
Example Playbook
Default setup: To install the role from Galaxy:
ansible-galaxy install consensys.checkpointz
Create a
requirements.yml
file with the following content, replacingx.y.z
with the desired version from the Checkpointz releases:--- - hosts: localhost connection: local force_handlers: True roles: - role: consensys.checkpointz vars: checkpointz_version: x.y.z
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-checkpointz.git
Create the
requirements.yml
file similar to the previous section, replacingx.y.z
with the chosen version:--- - hosts: localhost connection: local force_handlers: True roles: - role: ansible-role-checkpointz vars: checkpointz_version: x.y.z
Run with ansible-playbook:
ansible-playbook -v /path/to/requirements.yml
License
Apache
Author Information
Consensys, 2022
An Ethereum beacon chain checkpoint sync provider
ansible-galaxy install consensys.checkpointz