Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/status-im/infra-role-nimbus-eth1

Ansible role for nimbus-eth1 client
https://github.com/status-im/infra-role-nimbus-eth1

ansible-role eth1 infra nimbus

Last synced: about 2 months ago
JSON representation

Ansible role for nimbus-eth1 client

Awesome Lists containing this project

README

        

# Description

This role provisions a [nimbus-eth1](https://github.com/status-im/nimbus-eth1) installation that is ETH1 client.

# Ports

The service exposes five ports by default:

* `30303` - DevP2P peering port. Must __ALWAYS__ be public.
* `8545` - Combo HTTP port (JSON RPC, Websocket RPC, Graphql). Must __NEVER__ be public.
* `8550` - Engine API HTTP port. Must __NEVER__ be public.
* `9093` - Prometheus metrics port. Should not be public.

# Installation

Add to your `requirements.yml` file:
```yaml
- name: infra-role-nimbus-eth1
src: [email protected]:status-im/infra-role-nimbus-eth1.git
scm: git
```

# Configuration

The crucial settings are:
```yaml
# branch which should be built
nimbus_eth1_repo_branch: 'master'
# ethereum network to connect to
nimbus_eth1_network: 'mainnet'
# increase maximum number of peers
nimbus_eth1_max_peers: 160
# optional setting for debug mode
nimbus_eth1_log_level: 'DEBUG'
```

# Usage

Assuming the `master` branch was built you can manage the service with:
```sh
systemctl start nimbus-eth1-mainnet-master
systemctl status nimbus-eth1-mainnet-master
systemctl stop nimbus-eth1-mainnet-master
```
You can view logs under:
```sh
tail -f /data/nimbus-eth1-mainnet-master/logs/service.log
```
The service will store all data in the `/data/nimbus-eth1-mainnet-master/data` directory.

# Building

A timer will be installed to build the image:
```sh
systemctl list-timers 'build-nimbus-eth1-*'
```
To rebuild the image:
```sh
systemctl start build-nimbus-eth1-mainnet-master.service
```
To check build logs use:
```sh
journalctl -u build-nimbus-eth1-mainnet-master.service
```