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: #5
Co-authored-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>
Co-committed-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>

nitro-nodes-setup/.gitignore

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

nitro-nodes-setup/README.md

@@ -4,14 +4,22 @@
 
 To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
 
-## Run a nitro node
+## Setup for Remote Host
+
+To run the playbook on a remote host:
+
+- Follow steps from [setup remote hosts](../README.md#setup-remote-hosts)
+
+- Update / append the [`hosts.ini`](../hosts.ini) file for your remote host with `<deployment_host>` set as `nitro_host`
+
+## Setup
 
 The following commands have to be executed in [`nitro-nodes-setup`](./) directory
 
 - Copy the `nitro-vars-example.yml` vars file
 
   ```bash
-  cp nitro-vars-example.yml nitro-vars.yml
+  cp nitro-vars.example.yml nitro-vars.yml
   ```
 
 - Edit [`nitro-vars.yml`](./nitro-vars.yml) and fill in the following values
@@ -56,19 +64,76 @@ The following commands have to be executed in [`nitro-nodes-setup`](./) director
   nitro_l2_ext_multiaddr: ""
   ```
 
-- To run a nitro node, execute the `run-nitro-nodes.yml` Ansible playbook by running the following command.
+## Run Nitro Node
 
-  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 run a nitro node, execute the `run-nitro-nodes.yml` Ansible playbook by running the following command:
 
   ```bash
-  LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' -kK --user $USER
+  LANG=en_US.utf8 ansible-playbook run-nitro-nodes.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 a `out` directory. To change this location, update the `nitro_directory` variable in the [setup-vars.yml](./setup-vars.yml) file
+
+- 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-nodes.yml --extra-vars='{ "target_host": "nitro_host", "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"
+  # }
+  ```
+
+- Copy and edit the [`nitro-vars.yml`](./nitro-vars.yml) file as described in the [local setup](./README.md#run-nitro-node-on-local-host) section
+
+- Execute the `run-nitro-nodes.yml` Ansible playbook for remote deployment:
+
+  ```bash
+  LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.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-nodes.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER -kK
+  ```
 
-    ```bash
-    LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost", "skip_container_build": true }' -kK --user $USER
-    ```
 
 ## Check Deployment Status
 

nitro-nodes-setup/setup-vars.yml

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

nitro-nodes-setup/templates/configs/l1-nitro-config.env.j2

@@ -1,8 +1,8 @@
 NITRO_CHAIN_URL={{ nitro_l1_chain_url }}
 NITRO_SC_PK={{ nitro_sc_pk }}
 NITRO_CHAIN_PK={{ nitro_chain_pk }}
-NA_ADDRESS={{ na_address }}
-VPA_ADDRESS={{ vpa_address }}
-CA_ADDRESS={{ ca_address }}
+NA_ADDRESS="{{ na_address }}"
+VPA_ADDRESS="{{ vpa_address }}"
+CA_ADDRESS="{{ ca_address }}"
 NITRO_BOOTPEERS={{ nitro_l1_bridge_multiaddr }}
 NITRO_EXT_MULTIADDR={{ nitro_l1_ext_multiaddr }}

nitro-nodes-setup/templates/configs/l2-nitro-config.env.j2

@@ -1,10 +1,10 @@
 NITRO_CHAIN_URL={{ nitro_l2_chain_url }}
 NITRO_SC_PK={{ nitro_sc_pk }}
 NITRO_CHAIN_PK={{ nitro_chain_pk }}
-NA_ADDRESS={{ na_address }}
-VPA_ADDRESS={{ vpa_address }}
-CA_ADDRESS={{ ca_address }}
-BRIDGE_ADDRESS={{ bridge_contract_address }}
+NA_ADDRESS="{{ na_address }}"
+VPA_ADDRESS="{{ vpa_address }}"
+CA_ADDRESS="{{ ca_address }}"
+BRIDGE_ADDRESS="{{ bridge_contract_address }}"
 NITRO_BOOTPEERS={{ nitro_l2_bridge_multiaddr }}
 NITRO_EXT_MULTIADDR={{ nitro_l2_ext_multiaddr }}
 NITRO_L2=true