-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(website): add node runner manuals (#14236)
- Loading branch information
Showing
5 changed files
with
143 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
} |
4 changes: 4 additions & 0 deletions
4
packages/website/pages/docs/manuals/node-runner-manuals/_meta.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
} |
67 changes: 67 additions & 0 deletions
67
...ebsite/pages/docs/manuals/node-runner-manuals/eldfell-l3-node-runner-manual.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
67 changes: 67 additions & 0 deletions
67
...site/pages/docs/manuals/node-runner-manuals/grimsvotn-l2-node-runner-manual.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |