testnet-ops/nitro-nodes-setup
Prathamesh Musale a7af33a45b Add ansible playbooks to setup and run nitro nodes (#2)
Part of [Automate testnet nitro deployments using Ansible](https://www.notion.so/Automate-testnet-nitro-deployments-using-Ansible-0d15579430204b8daba9a8aa31e07568)
- Add playbooks to setup and run L1 and L2 nitro nodes

Co-authored-by: Adw8 <adwaitgharpure@gmail.com>
Reviewed-on: cerc-io/testnet-ops#2
Co-authored-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>
Co-committed-by: Prathamesh Musale <prathamesh@noreply.git.vdb.to>
2024-09-05 07:27:35 +00:00
..
templates Add ansible playbooks to setup and run nitro nodes (#2) 2024-09-05 07:27:35 +00:00
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 ansible playbooks to setup and run nitro nodes (#2) 2024-09-05 07:27:35 +00:00
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 ansible playbooks to setup and run nitro nodes (#2) 2024-09-05 07:27:35 +00:00

nitro-nodes-setup

Setup Ansible

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

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.

    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 file.

    LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' -kK --user $USER
    
    • For skipping container build, run with "skip_container_build" : true in the --extra-vars parameter:

      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

  • 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