Skip to content

Commit

Permalink
feat(website): add node runner manuals (#14236)
Browse files Browse the repository at this point in the history
  • Loading branch information
dionysuzx authored Jul 21, 2023
1 parent 1d7d9b7 commit 76d2127
Show file tree
Hide file tree
Showing 5 changed files with 143 additions and 4 deletions.
6 changes: 3 additions & 3 deletions packages/website/pages/docs/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
"reference": {
"title": "Reference"
},
"manuals": {
"title": "Manuals"
},
"concepts": {
"title": "Concepts"
},
"resources": {
"title": "Resources"
},
"manuals": {
"title": "Manuals"
}
}
3 changes: 2 additions & 1 deletion packages/website/pages/docs/manuals/_meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"contributing-manual": "Contributing manual",
"integration-manual": "Integration manual"
"integration-manual": "Integration manual",
"node-runner-manuals": "Node runner manuals"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"grimsvotn-l2-node-runner-manual": "Grimsvotn L2 node runner manual",
"eldfell-l3-node-runner-manual": "Eldfell L3 node runner manual"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Eldfell L3 node runner manual

## Start node

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 up -d
```

## Stop node

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 down
```

## Update node

```sh
git pull origin main && docker compose -f ./docker-compose.l3.yml --env-file .env.l3 pull
```

## Remove node

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 down -v
```

## View grafana dashboard

```sh
open http://localhost:3001/d/L2ExecutionEngine/l2-execution-engine-overview
```

## View all logs

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f
```

## View execution logs

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f l2_execution_engine
```

## View client driver logs

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f taiko_client_driver
```

## View client proposer logs

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f taiko_client_proposer
```

## View client prover relayer logs

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f taiko_client_prover_relayer
```

## View zkevm prover logs

```sh
docker compose -f ./docker-compose.l3.yml --env-file .env.l3 logs -f zkevm-chain-prover-rpcd
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Grimsvotn L2 node runner manual

## Start node

```sh
docker compose up -d
```

## Stop node

```sh
docker compose down
```

## Update node

```sh
git pull origin main && docker compose pull
```

## Remove node

```sh
docker compose down -v
```

## View grafana dashboard

```sh
open http://localhost:3000/d/L2ExecutionEngine/l2-execution-engine-overview
```

## View all logs

```sh
docker compose logs -f
```

## View execution logs

```sh
docker compose logs -f l2_execution_engine
```

## View client driver logs

```sh
docker compose logs -f taiko_client_driver
```

## View client proposer logs

```sh
docker compose logs -f taiko_client_proposer
```

## View client prover relayer logs

```sh
docker compose logs -f taiko_client_prover_relayer
```

## View zkevm prover logs

```sh
docker compose logs -f zkevm-chain-prover-rpcd
```

0 comments on commit 76d2127

Please sign in to comment.