From 96a20c968baadb9067bb9d68e990b8e2a45f906c Mon Sep 17 00:00:00 2001 From: Adw8 Date: Tue, 3 Sep 2024 18:08:45 +0530 Subject: [PATCH] Rename directory --- {nitro-node-setup => nitro-nodes-setup}/README.md | 10 ++++++---- .../nitro-vars-example.yml | 0 .../run-nitro-node.yml | 0 {nitro-node-setup => nitro-nodes-setup}/setup-vars.yml | 0 .../templates/configs/l1-nitro-config.env.j2 | 0 .../templates/configs/l2-nitro-config.env.j2 | 0 .../templates/specs/l1-nitro-spec.yml.j2 | 0 .../templates/specs/l2-nitro-spec.yml.j2 | 0 8 files changed, 6 insertions(+), 4 deletions(-) rename {nitro-node-setup => nitro-nodes-setup}/README.md (78%) rename {nitro-node-setup => nitro-nodes-setup}/nitro-vars-example.yml (100%) rename {nitro-node-setup => nitro-nodes-setup}/run-nitro-node.yml (100%) rename {nitro-node-setup => nitro-nodes-setup}/setup-vars.yml (100%) rename {nitro-node-setup => nitro-nodes-setup}/templates/configs/l1-nitro-config.env.j2 (100%) rename {nitro-node-setup => nitro-nodes-setup}/templates/configs/l2-nitro-config.env.j2 (100%) rename {nitro-node-setup => nitro-nodes-setup}/templates/specs/l1-nitro-spec.yml.j2 (100%) rename {nitro-node-setup => nitro-nodes-setup}/templates/specs/l2-nitro-spec.yml.j2 (100%) diff --git a/nitro-node-setup/README.md b/nitro-nodes-setup/README.md similarity index 78% rename from nitro-node-setup/README.md rename to nitro-nodes-setup/README.md index 33ce7aa..c9f4415 100644 --- a/nitro-node-setup/README.md +++ b/nitro-nodes-setup/README.md @@ -1,4 +1,4 @@ -# nitro-node-setup +# nitro-nodes-setup ## Setup Ansible @@ -6,7 +6,7 @@ To get started, follow the [installation](../../README.md#installation) guide to ## Run a nitro node -The following commands have to be executed in [`nitro-node-setup`](./) directory +The following commands have to be executed in [`nitro-nodes-setup`](./) directory - Copy the `nitro-vars-example.yml` vars file @@ -44,13 +44,15 @@ The following commands have to be executed in [`nitro-node-setup`](./) directory # Multi address of the bridge node nitro_bridge_multiaddr "" - # Multi address of your nitro node + # Multiaddr with publically accessible IP address / DNS for your nitro node + # Example: "/ip4/192.168.x.y/tcp/3009" + # Example: "/dns4/example.com/tcp/3009" nitro_node_multiaddr: "" ``` - To run a nitro node, execute the `run-nitro-node.yml` Ansible playbook by running the following command. - NOTE: By default, deployments are created in the `nitro-node-setup/out` directory. To change this location, update the `nitro_directory` variable in the [setup-vars.yml](./setup-vars.yml) file. + 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. ```bash LANG=en_US.utf8 ansible-playbook -i localhost, --connection=local run-nitro-node.yml --extra-vars='{ "target_host": "localhost"}' --user $USER diff --git a/nitro-node-setup/nitro-vars-example.yml b/nitro-nodes-setup/nitro-vars-example.yml similarity index 100% rename from nitro-node-setup/nitro-vars-example.yml rename to nitro-nodes-setup/nitro-vars-example.yml diff --git a/nitro-node-setup/run-nitro-node.yml b/nitro-nodes-setup/run-nitro-node.yml similarity index 100% rename from nitro-node-setup/run-nitro-node.yml rename to nitro-nodes-setup/run-nitro-node.yml diff --git a/nitro-node-setup/setup-vars.yml b/nitro-nodes-setup/setup-vars.yml similarity index 100% rename from nitro-node-setup/setup-vars.yml rename to nitro-nodes-setup/setup-vars.yml diff --git a/nitro-node-setup/templates/configs/l1-nitro-config.env.j2 b/nitro-nodes-setup/templates/configs/l1-nitro-config.env.j2 similarity index 100% rename from nitro-node-setup/templates/configs/l1-nitro-config.env.j2 rename to nitro-nodes-setup/templates/configs/l1-nitro-config.env.j2 diff --git a/nitro-node-setup/templates/configs/l2-nitro-config.env.j2 b/nitro-nodes-setup/templates/configs/l2-nitro-config.env.j2 similarity index 100% rename from nitro-node-setup/templates/configs/l2-nitro-config.env.j2 rename to nitro-nodes-setup/templates/configs/l2-nitro-config.env.j2 diff --git a/nitro-node-setup/templates/specs/l1-nitro-spec.yml.j2 b/nitro-nodes-setup/templates/specs/l1-nitro-spec.yml.j2 similarity index 100% rename from nitro-node-setup/templates/specs/l1-nitro-spec.yml.j2 rename to nitro-nodes-setup/templates/specs/l1-nitro-spec.yml.j2 diff --git a/nitro-node-setup/templates/specs/l2-nitro-spec.yml.j2 b/nitro-nodes-setup/templates/specs/l2-nitro-spec.yml.j2 similarity index 100% rename from nitro-node-setup/templates/specs/l2-nitro-spec.yml.j2 rename to nitro-nodes-setup/templates/specs/l2-nitro-spec.yml.j2