From 2ac535b175c14aea021cff888875afc5c0040ede Mon Sep 17 00:00:00 2001 From: Adw8 Date: Tue, 22 Oct 2024 15:36:46 +0530 Subject: [PATCH] Remove steps to execute playbooks locally --- nitro-bridge-setup/README.md | 34 ++++++++-------------------- nitro-bridge-setup/setup-vars.yml | 2 +- nitro-contracts-setup/README.md | 32 +++++++------------------- nitro-contracts-setup/setup-vars.yml | 2 +- nitro-nodes-setup/README.md | 32 +++++++------------------- nitro-nodes-setup/setup-vars.yml | 2 +- service-provider-setup/README.md | 10 +++----- 7 files changed, 31 insertions(+), 83 deletions(-) diff --git a/nitro-bridge-setup/README.md b/nitro-bridge-setup/README.md index 345fce1..092dd4d 100644 --- a/nitro-bridge-setup/README.md +++ b/nitro-bridge-setup/README.md @@ -1,8 +1,10 @@ # nitro-bridge-setup -## Setup Ansible +## Prerequisites -To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine +- Setup Ansible: To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine. + +- Setup user: Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user with passwordless sudo ## Setup @@ -40,33 +42,13 @@ The following commands have to be executed in the [`nitro-bridge-setup`](./) dir ## Run Nitro Bridge -### On Local Host - -- To setup and run nitro bridge locally, execute the `run-nitro-bridge.yml` Ansible playbook: - - ```bash - LANG=en_US.utf8 ansible-playbook run-nitro-bridge.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK - ``` - - 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 - -- For skipping container build, set `"skip_container_build" : true` in the `--extra-vars` parameter: - - ```bash - LANG=en_US.utf8 ansible-playbook run-nitro-bridge.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: +- Edit the [`hosts.ini`](./hosts.ini) file: ```ini [] @@ -78,7 +60,7 @@ To run the playbook on a remote host: - Replace `` with the IP address or hostname of the target machine - Replace `` 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 -k @@ -94,12 +76,14 @@ To run the playbook on a remote host: # } ``` -- Execute the `run-nitro-bridge.yml` Ansible playbook for remote deployment: +- Execute the `run-nitro-bridge.yml` Ansible playbook for deploying nitro bridge: ```bash LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK ``` + 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 + - For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter: ```bash diff --git a/nitro-bridge-setup/setup-vars.yml b/nitro-bridge-setup/setup-vars.yml index d1d497f..ef0a210 100644 --- a/nitro-bridge-setup/setup-vars.yml +++ b/nitro-bridge-setup/setup-vars.yml @@ -1,3 +1,3 @@ -target_host: "localhost" +target_host: "nitro_host" nitro_directory: out skip_container_build: false diff --git a/nitro-contracts-setup/README.md b/nitro-contracts-setup/README.md index 05d103d..7a8fd8e 100644 --- a/nitro-contracts-setup/README.md +++ b/nitro-contracts-setup/README.md @@ -1,8 +1,10 @@ # nitro-contracts-setup -## Setup Ansible +## Prerequisites -To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine +- Setup Ansible: To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine. + +- Setup user: Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user with passwordless sudo ## Setup @@ -34,33 +36,13 @@ The following commands have to be executed in the [`nitro-contracts-setup`](./) ## Deploy Contracts -### On Local Host - -- To deploy nitro contracts locally, execute the `deploy-contracts.yml` Ansible playbook: - - ```bash - LANG=en_US.utf8 ansible-playbook deploy-contracts.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK - ``` - - 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 - -- 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: +- Edit the [`hosts.ini`](./hosts.ini) file: ```ini [] @@ -88,12 +70,14 @@ To run the playbook on a remote host: # } ``` -- Execute the `deploy-contracts.yml` Ansible playbook for remote deployment: +- Execute the `deploy-contracts.yml` Ansible playbook to deploy nitro contracts: ```bash LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK ``` + 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 + - For skipping container build, run with `"skip_container_build" : true` in the `--extra-vars` parameter: ```bash diff --git a/nitro-contracts-setup/setup-vars.yml b/nitro-contracts-setup/setup-vars.yml index d1d497f..ef0a210 100644 --- a/nitro-contracts-setup/setup-vars.yml +++ b/nitro-contracts-setup/setup-vars.yml @@ -1,3 +1,3 @@ -target_host: "localhost" +target_host: "nitro_host" nitro_directory: out skip_container_build: false diff --git a/nitro-nodes-setup/README.md b/nitro-nodes-setup/README.md index 00b5756..c636aae 100644 --- a/nitro-nodes-setup/README.md +++ b/nitro-nodes-setup/README.md @@ -1,8 +1,10 @@ # nitro-nodes-setup -## Setup Ansible +## Prerequisites -To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine +- Setup Ansible: To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine. + +- Setup user: Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user with passwordless sudo ## Setup @@ -52,33 +54,13 @@ The following commands have to be executed in [`nitro-nodes-setup`](./) director ## Run Nitro Node -### 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 run-nitro-nodes.yml --extra-vars='{ "target_host": "localhost"}' --user $USER -kK - ``` - - 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": "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: +- Edit the [`hosts.ini`](./hosts.ini) file: ```ini [] @@ -108,12 +90,14 @@ To run the playbook on a remote host: - 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: +- Execute the `run-nitro-nodes.yml` Ansible playbook to deploy nitro nodes: ```bash LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER -kK ``` + 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 diff --git a/nitro-nodes-setup/setup-vars.yml b/nitro-nodes-setup/setup-vars.yml index d1d497f..ef0a210 100644 --- a/nitro-nodes-setup/setup-vars.yml +++ b/nitro-nodes-setup/setup-vars.yml @@ -1,3 +1,3 @@ -target_host: "localhost" +target_host: "nitro_host" nitro_directory: out skip_container_build: false diff --git a/service-provider-setup/README.md b/service-provider-setup/README.md index bb0a76b..95b6a70 100644 --- a/service-provider-setup/README.md +++ b/service-provider-setup/README.md @@ -1,20 +1,16 @@ # service-provider-setup -## Setup Ansible - -To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine - ## Prerequisites +- Setup Ansible: follow the [installation](../README.md#installation) guide to setup ansible on your machine + - Set up a DigitalOcean Droplet with passwordless SSH access - Buy a domain and configure [nameservers pointing to DigitalOcean](https://docs.digitalocean.com/products/networking/dns/getting-started/dns-registrars/) - Generate a DigitalOcean access token, used for API authentication and managing cloud resources -## Setup a new User - -Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user with passwordless sudo +- Setup a user: Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user with passwordless sudo ## Become a Service Provider