Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(website): add node runner manuals #14236

Merged
merged 2 commits into from
Jul 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```