Skip to content

Latest commit

 

History

History
109 lines (76 loc) · 3.03 KB

README.md

File metadata and controls

109 lines (76 loc) · 3.03 KB
Raw

docker-compose

The docker-compose project runs a local optimism stack.

prerequisites

  • docker
  • docker-compose
  • make

Starting and stopping the project

The base docker-compose.yml file will start the required components for a full stack.

Supplementing the base configuration is an additional metric enabling file, docker-compose-metrics.yml. Adding this configuration to the stack will enable metric emission for l2geth and start grafana (for metrics visualisation) and influxdb (for metric collection) instances.

Also available for testing is the rpc-proxy service in the docker-compose-rpc-proxy.yml file. It can be used to restrict what RPC methods are allowed to the Sequencer.

The base stack can be started and stopped with a command like this (there is no need to specify the default docker-compose.yml)

docker-compose \
    up --build --detach

Note: This generates a large amount of log data which docker stores by default. See Disk Usage.

To start the stack with monitoring enabled, just add the metric composition file.

docker-compose \
    -f docker-compose.yml \
    -f docker-compose-metrics.yml \
    up --build --detach

Optionally, run a verifier along the rest of the stack. Run a replica with the same command by switching the service name!

docker-compose up --scale \
    verifier=1 \
    --build --detach

A Makefile has been provided for convience. The following targets are available.

  • make up
  • make down
  • make up-metrics
  • make down-metrics

Authentication

Influxdb has authentication disabled.

Grafana requires a login. The defaults are:

user: admin
password: optimism

Data persistance

Grafana data is not currently saved. Any modifications or additions will be lost on container restart.

InfluxDB is persisting data to a Docker volume.

Stopping the project removing the containers will not clear this volume

To remove the influxdb and grafana data, run a commands like

docker volume rm ops_influxdb_data
docker volume rm ops_grafana_data

Accessing Grafana dashboards

After starting up the project Grafana should be listening on http://localhost:3000.

Access this link and authenticate as admin (see #Authentication)

From the Dashboard list, select "Geth dashboard".

Disk Usage

The logs generated are in the gigabytes per day range, so you need to be wary of disk exhaustion when running for long periods.

One way to solve this is to configure /etc/docker/daemon.json like this:

{
  "log-driver": "json-file",
  "log-opts": {
    "max-size": "10m",
    "max-file": "3"
  }
}

This configures log rotation with a limit of 10MB per file and storing a maximum of three files (per container). More details on docker logging configuration.

You can also decrease logging by increasing polling intervals:

DATA_TRANSPORT_LAYER__POLLING_INTERVAL=100
ROLLUP_POLL_INTERVAL_FLAG=500ms