Separate setup and run sections in READMEs

This commit is contained in:
Adw8 2024-09-09 18:17:50 +05:30
parent e46846c476
commit 1fe219cb1f
4 changed files with 24 additions and 14 deletions

View File

@ -4,7 +4,7 @@
To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
## Setup and Run L2 on Local Host
## Setup
The following commands have to be executed in the [`l2-setup`](./) directory:
@ -40,6 +40,10 @@ The following commands have to be executed in the [`l2-setup`](./) directory:
l1_priv_key: ""
```
## Run L2
### On Local Host
- To setup and run L2 locally, execute the `run-optimism.yml` Ansible playbook:
```bash
@ -64,7 +68,7 @@ The following commands have to be executed in the [`l2-setup`](./) directory:
LANG=en_US.utf8 ansible-playbook run-optimism.yml --extra-vars='{"target_host" : "localhost", "existing_contracts_deployment": true}' --user $USER -kK
```
## Setup and Run on Remote Host
### On Remote Host
To run the playbook on a remote host:
@ -102,8 +106,6 @@ To run the playbook on a remote host:
# }
```
- Copy and edit the `l2-vars.yml` file as described in the [local setup](./README.md#setup-and-run-l2-on-local-host) section
- Execute the `run-optimism.yml` Ansible playbook for remote deployment:
```bash

View File

@ -4,7 +4,7 @@
To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
## Setup and Run Nitro Bridge on Local Host
## Setup
The following commands have to be executed in the [`nitro-bridge-setup`](./) directory:
@ -51,6 +51,10 @@ The following commands have to be executed in the [`nitro-bridge-setup`](./) dir
l1_asset_address: ""
```
## Run Nitro Bridge
### On Local Host
- To setup and run nitro bridge locally, execute the `run-nitro-bridge.yml` Ansible playbook:
```bash
@ -65,7 +69,7 @@ The following commands have to be executed in the [`nitro-bridge-setup`](./) dir
LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' --user $USER -kK
```
## Setup and Run Nitro Bridge on Remote Host
### On Remote Host
To run the playbook on a remote host:
@ -103,8 +107,6 @@ To run the playbook on a remote host:
# }
```
- Copy and edit the `bridge-vars.yml` file as described in the [local setup](./README.md#setup-and-run-nitro-bridge-on-local-host) section
- Execute the `run-nitro-bridge.yml` Ansible playbook for remote deployment:
```bash

View File

@ -4,7 +4,7 @@
To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
## Deploy Nitro Contracts on Local Host
## Setup
The following commands have to be executed in the [`nitro-contracts-setup`](./) directory:
@ -32,6 +32,10 @@ The following commands have to be executed in the [`nitro-contracts-setup`](./)
initial_token_supply: "129600"
```
## Deploy Contracts
### On Local Host
- To deploy nitro contracts locally, execute the `deploy-contracts.yml` Ansible playbook:
```bash
@ -46,7 +50,7 @@ The following commands have to be executed in the [`nitro-contracts-setup`](./)
LANG=en_US.utf8 ansible-playbook deploy-contracts.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}' --user $USER -kK
```
## Deploy Nitro Contracts on Remote Host
### On Remote Host
To run the playbook on a remote host:
@ -84,8 +88,6 @@ To run the playbook on a remote host:
# }
```
- Copy and edit the [`contract-vars.yml`](./contract-vars.yml) file as described in the [local setup](./README.md#deploy-nitro-contracts-on-local-host) section
- Execute the `deploy-contracts.yml` Ansible playbook for remote deployment:
```bash

View File

@ -12,7 +12,7 @@ To run the playbook on a remote host:
- Update / append the [`hosts.ini`](../hosts.ini) file for your remote host with `<deployment_host>` set as `nitro_host`
## Run Nitro Node on Local Host
## Setup
The following commands have to be executed in [`nitro-nodes-setup`](./) directory
@ -64,6 +64,10 @@ The following commands have to be executed in [`nitro-nodes-setup`](./) director
nitro_l2_ext_multiaddr: ""
```
## Run Nitro Node
### On Local Host
- To run a nitro node, execute the `run-nitro-nodes.yml` Ansible playbook by running the following command:
```bash
@ -78,7 +82,7 @@ The following commands have to be executed in [`nitro-nodes-setup`](./) director
LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER -kK
```
## Run Nitro Node on Remote Host
### On Remote Host
To run the playbook on a remote host: