Add instructions to run Ansible playbooks on remote machines (#5)

Part of [Automate testnet nitro deployments using Ansible](https://www.notion.so/Automate-testnet-nitro-deployments-using-Ansible-0d15579430204b8daba9a8aa31e07568)

Co-authored-by: Adw8 <adwaitgharpure@gmail.com>
Reviewed-on: cerc-io/testnet-ops#5
Co-authored-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>
Co-committed-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>

nitro-bridge-setup/.gitignore

@@ -0,0 +1,3 @@
+out
+bridge-vars.yml
+hosts.ini

nitro-bridge-setup/README.md

@@ -4,17 +4,19 @@
 
 To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
 
-## Run Nitro Bridge
+## Setup
 
-- Copy the `bridge-vars-example.yml` vars file
+The following commands have to be executed in the [`nitro-bridge-setup`](./) directory:
+
+- Copy the `bridge-vars.example.yml` vars file:
 
   ```bash
-  cp bridge-vars-example.yml bridge-vars.yml
+  cp bridge-vars.example.yml bridge-vars.yml
   ```
 
-- Edit [`bridge-vars.yml`](./bridge-vars.yml) and fill in the following values
+- Edit [`bridge-vars.yml`](./bridge-vars.yml) with the required values:
 
-  ```bash
+  ```yaml
   # L1 WS endpoint
   nitro_l1_chain_url: ""
 
@@ -38,7 +40,7 @@ To get started, follow the [installation](../README.md#installation) guide to se
   # Custom L2 token to be deployed
   token_name: "LaconicNetworkToken"
   token_symbol: "LNT"
-  intial_token_supply: "129600"
+  initial_token_supply: "129600"
 
   # Addresses of the deployed nitro contracts
   na_address: ""
@@ -49,19 +51,73 @@ To get started, follow the [installation](../README.md#installation) guide to se
   l1_asset_address: ""
   ```
 
-- To run the nitro bridge, execute the `run-nitro-bridge.yml` Ansible playbook by running the following command:
+## Run Nitro Bridge
 
-  NOTE: By default, deployments are created in the `nitro-nodes-setup/out` directory. To change this location, update the `nitro_directory` variable in the [setup-vars.yml](./setup-vars.yml) file.
+### On Local Host
+
+- To setup and run nitro bridge locally, execute the `run-nitro-bridge.yml` Ansible playbook:
 
   ```bash
-  LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK
+  LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost"}'  --user $USER -kK
   ```
 
-  - For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter:
+  NOTE: By default, deployments are created in an `out` directory. To change this location, update the `nitro_directory` variable in the [setup-vars.yml](./setup-vars.yml) file
 
-    ```bash
-    LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost", "skip_container_build": true }' --user $USER -kK
-    ```
+- For skipping container build, set `"skip_container_build" : true` in the `--extra-vars` parameter:
+
+  ```bash
+  LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{"target_host" : "localhost", "skip_container_build": true}'  --user $USER -kK
+  ```
+
+### On Remote Host
+
+To run the playbook on a remote host:
+
+- Create a new `hosts.ini` file:
+
+   ```bash
+   cp ../hosts.example.ini hosts.ini
+   ```
+
+- Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine:
+
+  ```ini
+  [<deployment_host>]
+  <host_name> ansible_host=<target_ip> ansible_user=<ssh_user> ansible_ssh_common_args='-o ForwardAgent=yes'
+  ```
+
+  - Replace `<deployment_host>` with `nitro_host`
+  - Replace `<host_name>` with the alias of your choice
+  - Replace `<target_ip>` with the IP address or hostname of the target machine
+  - Replace `<ssh_user>` with the SSH username (e.g., dev, ubuntu)
+
+- Verify that you are able to connect to the host using the following command
+
+  ```bash
+  ansible all -m ping -i hosts.ini -k
+
+  # Expected output:
+
+  # <host_name> | SUCCESS => {
+  #  "ansible_facts": {
+  #      "discovered_interpreter_python": "/usr/bin/python3.10"
+  #  },
+  #  "changed": false,
+  #  "ping": "pong"
+  # }
+  ```
+
+- Execute the `run-nitro-bridge.yml` Ansible playbook for remote deployment:
+
+  ```bash
+  LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host"}'  --user $USER -kK
+  ```
+
+- For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter:
+
+  ```bash
+  LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER -kK
+  ```
 
 ## Check Deployment Status
 

nitro-bridge-setup/bridge-vars.example.yml

@@ -7,7 +7,7 @@ optimism_url: ""
 optimism_deployer_pk: ""
 token_name: "LaconicNetworkToken"
 token_symbol: "LNT"
-intial_token_supply: "129600"
+initial_token_supply: "129600"
 na_address: ""
 vpa_address: ""
 ca_address: ""

nitro-bridge-setup/setup-vars.yml

@@ -1,3 +1,3 @@
 target_host: "localhost"
-nitro_directory: ./out
+nitro_directory: out
 skip_container_build: false

nitro-bridge-setup/templates/specs/bridge-nitro-spec.yml.j2

@@ -10,11 +10,11 @@ config:
   OPTIMISM_DEPLOYER_PK: {{ optimism_deployer_pk }}
   TOKEN_NAME: {{ token_name }}
   TOKEN_SYMBOL: {{ token_symbol }}
-  INITIAL_TOKEN_SUPPLY: {{ token_symbol }}
-  NA_ADDRESS: {{ na_address }}
-  VPA_ADDRESS: {{ vpa_address }}
-  CA_ADDRESS: {{ ca_address }}
-  L1_ASSET_ADDRESS: {{ l1_asset_address }}
+  INITIAL_TOKEN_SUPPLY: {{ initial_token_supply }}
+  NA_ADDRESS: "{{ na_address }}"
+  VPA_ADDRESS: "{{ vpa_address }}"
+  CA_ADDRESS: "{{ ca_address }}"
+  L1_ASSET_ADDRESS: "{{ l1_asset_address }}"
 network:
   ports:
     nitro-bridge: