History

Adw8 d7e657119a Add README steps to deploy nitro contracts on remote machine		2024-09-09 11:51:29 +05:30
..
templates	Add ansible playbooks to setup and run nitro nodes (#2 )	2024-09-05 07:27:35 +00:00
.gitignore	Add README steps to deploy nitro contracts on remote machine	2024-09-09 11:51:29 +05:30
nitro-vars-example.yml	Add ansible playbooks to setup and run nitro nodes (#2 )	2024-09-05 07:27:35 +00:00
README.md	Add README steps to run nitro nodes on remote machine	2024-09-09 11:51:29 +05:30
run-nitro-nodes.yml	Add ansible playbooks to setup and run nitro nodes (#2 )	2024-09-05 07:27:35 +00:00
setup-vars.yml	Add README steps to run nitro nodes on remote machine	2024-09-09 11:51:29 +05:30

README.md

nitro-nodes-setup

Setup Ansible

To get started, follow the installation guide to setup ansible on your machine

Setup Remote Hosts

To run the playbooks on a remote machine, follow these steps:
- In the nitro-nodes-setup directory, create a new file named hosts.ini:
```
cp ../example-hosts.ini hosts.ini
```
- Edit the hosts.ini file to run the playbook on a remote machine
```
[nitro_host]
hostname ansible_host= ansible_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).
- Verify that you are able to connect to the host using the following command
```
ansible all -m ping -i hosts.ini
```

Run a nitro node

The following commands have to be executed in nitro-nodes-setup directory

Copy the nitro-vars-example.yml vars file

cp nitro-vars-example.yml nitro-vars.yml

Edit nitro-vars.yml and fill in the following values

# L1 WS endpoint
nitro_l1_chain_url: ""

# L2 WS endpoint
nitro_l2_chain_url: ""

# Private key for your nitro address
nitro_sc_pk: ""

# Private key of the account on chain that is used for funding channels in Nitro node
nitro_chain_pk: ""

# Contract address of NitroAdjudicator
na_address: ""

# Contract address of VirtualPaymentApp
vpa_address: ""

# Contract address of ConsensusApp
ca_address: ""

# Address of the bridge node
bridge_contract_address: ""

# Multiaddr of the L1 bridge node
nitro_l1_bridge_multiaddr: ""

# Multiaddr of the L2 bridge node
nitro_l2_bridge_multiaddr: ""

# Multiaddr with publically accessible IP address / DNS for your L1 nitro node
# Example: "/ip4/192.168.x.y/tcp/3009"
# Example: "/dns4/example.com/tcp/3009"
nitro_l1_ext_multiaddr: ""

# Multiaddr with publically accessible IP address / DNS for your L2 nitro node
nitro_l2_ext_multiaddr: ""

To run a nitro node, execute the run-nitro-nodes.yml Ansible playbook by running the following command.
- For local deployment, specify the "target_host": localhost in the --extra-vars parameter:
```
LANG=en_US.utf8 ansible-playbook run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' -kK --user $USER
```
- For remote deployment, provide an inventory and specify the "target_host": nitro_host in the --extra-vars parameter:
```
LANG=en_US.utf8 ansible-playbook -i ./hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host"}' -kK --user $USER
```
  NOTE: By default, deployments are created in a out directory. To change this location, update the nitro_directory variable in the setup-vars.yml file.
- For skipping container build, run with "skip_container_build" : true in the --extra-vars parameter:
```
LANG=en_US.utf8 ansible-playbook -i ./hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' -kK --user $USER
```

Check Deployment Status

Run the following command in the directory where the deployments are created

Check L1 nitro node logs:

laconic-so deployment --dir l1-nitro-deployment logs nitro-node -f

Check L2 nitro node logs:

laconic-so deployment --dir l2-nitro-deployment logs nitro-node -f