infra-role-beacon-node/README.md

# Description

This role provisions a [Nimbus](https://nimbus.status.im/) installation that can act as an ETH2 network bootstrap node.

# Introduction

Each host can run multiple nodes installed as [docker containers](https://github.com/status-im/nimbus/docker).
TCP and UDP ports starting from 9000 will be exposed (e.g. 9000, 9001 and 9002 if you run 3 nodes).

# Installation

Add to your `requirements.yml` file:
```yaml
- name: infra-role-beacon-node
  src: git+git@github.com:status-im/infra-role-beacon-node.git
  scm: git
```

# Configuration

The crucial settings are:
```yaml
beacon_node_network: 'testnet0'
# optional setting for debug mode
beacon_node_log_level: DEBUG
```

# Usage

You can re-create containers on the host using:
```
cd /docker/beacon-node-testnet0-1
docker-compose --compatibility up -d --force-recreate
```
Which will use the `docker-compose.yml` file in that directory.

# Requirements

Due to being part of Status infra this role assumes availability of certain things:

* Docker for running containers
* The `iptables-persistent` module
Initial commit (not tested) 2019-02-13 22:45:53 +00:00			`# Description`

			`This role provisions a [Nimbus](https://nimbus.status.im/) installation that can act as an ETH2 network bootstrap node.`

			`# Introduction`

Support multiple nodes per host; Extract the Nginx site in a separate repo 2019-03-21 21:08:55 +00:00			`Each host can run multiple nodes installed as [docker containers](https://github.com/status-im/nimbus/docker).`
			`TCP and UDP ports starting from 9000 will be exposed (e.g. 9000, 9001 and 9002 if you run 3 nodes).`
Initial commit (not tested) 2019-02-13 22:45:53 +00:00
			`# Installation`

			Add to your `requirements.yml` file:
			```yaml
use git in requirements example Signed-off-by: Jakub Sokołowski <jakub@status.im> 2019-03-23 08:59:44 +00:00			`- name: infra-role-beacon-node`
			`src: git+git@github.com:status-im/infra-role-beacon-node.git`
			`scm: git`
Initial commit (not tested) 2019-02-13 22:45:53 +00:00			```

add example of configuration Signed-off-by: Jakub Sokołowski <jakub@status.im> 2019-03-23 08:58:00 +00:00			`# Configuration`

			`The crucial settings are:`
			```yaml
			`beacon_node_network: 'testnet0'`
			`# optional setting for debug mode`
remove loop for creating multiple containers Signed-off-by: Jakub Sokołowski <jakub@status.im> 2019-05-09 16:07:53 +00:00			`beacon_node_log_level: DEBUG`
add example of configuration Signed-off-by: Jakub Sokołowski <jakub@status.im> 2019-03-23 08:58:00 +00:00			```

use docker-compose for easier container management Signed-off-by: Jakub Sokołowski <jakub@status.im> 2020-02-10 13:12:08 +00:00			`# Usage`

			`You can re-create containers on the host using:`
			```
use docker-compose command to use --compatibility This is required due to following warning: WARNING: Some services (beacon_node) use the 'deploy' key, which will be ignored. Compose does not support 'deploy' configuration - use `docker stack deploy` to deploy to a swarm. Without it the cpu/mem limits are not applied. Signed-off-by: Jakub Sokołowski <jakub@status.im> 2020-03-26 17:45:15 +00:00			`cd /docker/beacon-node-testnet0-1`
			`docker-compose --compatibility up -d --force-recreate`
use docker-compose for easier container management Signed-off-by: Jakub Sokołowski <jakub@status.im> 2020-02-10 13:12:08 +00:00			```
			Which will use the `docker-compose.yml` file in that directory.

Initial commit (not tested) 2019-02-13 22:45:53 +00:00			`# Requirements`

			`Due to being part of Status infra this role assumes availability of certain things:`

			`* Docker for running containers`
			* The `iptables-persistent` module