Add remote host setup for nitro contracts README

This commit is contained in:
Adw8
2024-09-09 12:09:02 +05:30
parent d7e657119a
commit dc6145f37d
5 changed files with 111 additions and 34 deletions
+28 -18
View File
@@ -6,30 +6,40 @@ To get started, follow the [installation](../README.md#installation) guide to se
## Setup Remote Hosts
- To run the playbooks on a remote machine, follow these steps:
To run the playbook on a remote machine, follow these steps:
- In the [`nitro-nodes-setup`](./) directory, create a new file named hosts.ini:
- In the [`nitro-nodes-setup`](./) directory, create a new file named hosts.ini:
```bash
cp ../example-hosts.ini hosts.ini
```
```bash
cp ../example-hosts.ini hosts.ini
```
- Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine
- Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine
```bash
[nitro_host]
hostname ansible_host= ansible_user= ansible_ssh_common_args='-o ForwardAgent=yes'
```
```bash
[nitro_host]
<host_name> ansible_host=<TARGET_IP> ansible_user=<SSH_USER> ansible_ssh_common_args='-o ForwardAgent=yes'
```
- 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).
- 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
- Verify that you are able to connect to the host using the following command
```bash
ansible all -m ping -i hosts.ini
```
```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"
# }
```
## Run a nitro node
@@ -83,7 +93,7 @@ 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.
- To run a nitro node, execute the `run-nitro-nodes.yml` Ansible playbook by running one of the following commands:
- For local deployment, specify the `"target_host": localhost` in the `--extra-vars` parameter: