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-contracts-setup/.gitignore

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

nitro-contracts-setup/README.md

@@ -4,9 +4,9 @@
 
 To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
 
-## Deploy Nitro Contracts
+## Setup
 
-The following commands have to be executed in [`nitro-contracts-setup`](./) directory
+The following commands have to be executed in the [`nitro-contracts-setup`](./) directory:
 
 - Copy the `contract-vars-example.yml` vars file
 
@@ -29,22 +29,76 @@ The following commands have to be executed in [`nitro-contracts-setup`](./) dire
   # Custom L1 token to be deployed
   token_name: "LaconicNetworkToken"
   token_symbol: "LNT"
-  intial_token_supply: "129600"
+  initial_token_supply: "129600"
   ```
 
-- To deploy the L1 nitro contracts, execute the `deploy-contracts.yml` Ansible playbook by running the following command:
+## Deploy Contracts
 
-  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 deploy nitro contracts locally, execute the `deploy-contracts.yml` Ansible playbook:
 
   ```bash
-  LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local deploy-contracts.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK
+  LANG=en_US.utf8 ansible-playbook deploy-contracts.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 deploy-contracts.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 deploy-contracts.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 `deploy-contracts.yml` Ansible playbook for remote deployment:
+
+  ```bash
+  LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.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 deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER -kK
+  ```
 
 ## Check Deployment Status
 

nitro-contracts-setup/contract-vars.example.yml

@@ -3,4 +3,4 @@ geth_chain_id: ""
 geth_deployer_pk: ""
 token_name: ""
 token_symbol: ""
-intial_token_supply: ""
+initial_token_supply: ""

nitro-contracts-setup/setup-vars.yml

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

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

@@ -6,7 +6,7 @@ config:
   GETH_DEPLOYER_PK: {{ geth_deployer_pk }}
   TOKEN_NAME: {{ token_name }}
   TOKEN_SYMBOL: {{ token_symbol }}
-  INITIAL_TOKEN_SUPPLY: {{ intial_token_supply }}
+  INITIAL_TOKEN_SUPPLY: {{ initial_token_supply }}
 network:
   ports: {}
 volumes: