forked from cerc-io/testnet-ops
Compare commits
3 Commits
nv-start-b
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| bd1c7bcb3f | |||
| 65be098ce9 | |||
| 2e0fbd82f1 |
14
README.md
14
README.md
@ -36,10 +36,22 @@
|
||||
|
||||
- Reference: <https://udhayakumarc.medium.com/error-ansible-requires-the-locale-encoding-to-be-utf-8-detected-iso8859-1-6da808387f7d>
|
||||
|
||||
- Verify ansible installation by running the following command:
|
||||
|
||||
```bash
|
||||
ansible --version
|
||||
# ansible [core 2.17.2]
|
||||
```
|
||||
|
||||
- Install `sshpass` used for automating SSH password authentication
|
||||
|
||||
```bash
|
||||
sudo apt-get install sshpass
|
||||
```
|
||||
|
||||
## Playbooks
|
||||
|
||||
- [stack-orchestrator-setup](./stack-orchestrator-setup/README.md)
|
||||
- [l2-setup](./l2-setup/README.md)
|
||||
- [nitro-node-setup](./nitro-nodes-setup/README.md)
|
||||
- [nitro-bridge-setup](./nitro-bridge-setup/README.md)
|
||||
- [nitro-contracts-setup](./nitro-contracts-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 with passwordless sudo: Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user
|
||||
|
||||
## 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
|
||||
[<deployment_host>]
|
||||
@ -76,12 +58,12 @@ To run the playbook on a remote host:
|
||||
- Replace `<deployment_host>` with `nitro_host`
|
||||
- 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 `<ssh_user>` with the username of the user that you set up on target machine (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
|
||||
ansible all -m ping -i hosts.ini
|
||||
|
||||
# Expected output:
|
||||
|
||||
@ -94,23 +76,25 @@ 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
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER
|
||||
```
|
||||
|
||||
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
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER -kK
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-bridge.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER
|
||||
```
|
||||
|
||||
## Check Deployment Status
|
||||
|
||||
- Run the following command in the directory where the bridge-deployment is created:
|
||||
Run the following command in the directory where the bridge-deployment is created:
|
||||
|
||||
- Check logs for deployments:
|
||||
- Check logs for deployments:
|
||||
|
||||
```bash
|
||||
# Check the bridge deployment logs, ensure that the node is running
|
||||
|
||||
@ -30,14 +30,6 @@
|
||||
timeout: 300
|
||||
ignore_errors: yes
|
||||
|
||||
- name: Clone repositories required for nitro-stack
|
||||
expect:
|
||||
command: laconic-so --stack {{ ansible_env.HOME }}/cerc/nitro-stack/stack-orchestrator/stacks/bridge setup-repositories --git-ssh --pull
|
||||
responses:
|
||||
"Are you sure you want to continue connecting \\(yes/no/\\[fingerprint\\]\\)\\?": "yes"
|
||||
timeout: 300
|
||||
ignore_errors: yes
|
||||
|
||||
- name: Build containers
|
||||
command: laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/bridge build-containers --force-rebuild
|
||||
when: not skip_container_build
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
target_host: "localhost"
|
||||
target_host: "nitro_host"
|
||||
nitro_directory: out
|
||||
skip_container_build: false
|
||||
|
||||
@ -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 with passwordless sudo: Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user with passwordless sudo
|
||||
|
||||
## Setup
|
||||
|
||||
@ -27,40 +29,20 @@ The following commands have to be executed in the [`nitro-contracts-setup`](./)
|
||||
geth_deployer_pk: ""
|
||||
|
||||
# Custom L1 token to be deployed
|
||||
token_name: "LaconicNetworkToken"
|
||||
token_symbol: "LNT"
|
||||
token_name: "TestToken"
|
||||
token_symbol: "TST"
|
||||
initial_token_supply: "129600"
|
||||
```
|
||||
|
||||
## 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
|
||||
[<deployment_host>]
|
||||
@ -70,12 +52,12 @@ To run the playbook on a remote host:
|
||||
- Replace `<deployment_host>` with `nitro_host`
|
||||
- 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 `<ssh_user>` with the username of the user that you set up on target machine (e.g. dev, ubuntu)
|
||||
|
||||
- Verify that you are able to connect to the host using the following command
|
||||
|
||||
```bash
|
||||
ansible all -m ping -i hosts.ini -k
|
||||
ansible all -m ping -i hosts.ini
|
||||
|
||||
# Expected output:
|
||||
|
||||
@ -88,23 +70,25 @@ 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
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host"}' --user $USER
|
||||
```
|
||||
|
||||
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
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER -kK
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini deploy-contracts.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER
|
||||
```
|
||||
|
||||
## Check Deployment Status
|
||||
|
||||
- Run the following command in the directory where the nitro-contracts-deployment is created:
|
||||
Run the following command in the directory where the nitro-contracts-deployment is created:
|
||||
|
||||
- Check logs for deployments:
|
||||
- Check logs for deployments:
|
||||
|
||||
```bash
|
||||
# Check the L2 nitro contract deployment logs
|
||||
@ -113,9 +97,9 @@ To run the playbook on a remote host:
|
||||
|
||||
## Get Contract Addresses
|
||||
|
||||
- Run the following commands in the directory where the deployments are created:
|
||||
Run the following commands in the directory where the deployments are created:
|
||||
|
||||
- Get addresses of L1 nitro contracts:
|
||||
- Get addresses of L1 nitro contracts:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "cat /app/deployment/nitro-addresses.json"
|
||||
|
||||
@ -14,7 +14,6 @@
|
||||
path: "{{ nitro_directory }}"
|
||||
state: directory
|
||||
|
||||
|
||||
- name: Change owner of nitro-directory
|
||||
file:
|
||||
path: "{{ nitro_directory }}"
|
||||
@ -23,7 +22,7 @@
|
||||
state: directory
|
||||
recurse: yes
|
||||
|
||||
- name: Clone go-nitro stack repo
|
||||
- name: Clone nitro stack repo
|
||||
expect:
|
||||
command: laconic-so fetch-stack git.vdb.to/cerc-io/nitro-stack --git-ssh --pull
|
||||
responses:
|
||||
@ -33,14 +32,14 @@
|
||||
|
||||
- name: Clone repositories required for nitro-stack
|
||||
expect:
|
||||
command: laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/bridge setup-repositories --git-ssh --pull
|
||||
command: laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-contracts setup-repositories --git-ssh --pull
|
||||
responses:
|
||||
"Are you sure you want to continue connecting \\(yes/no/\\[fingerprint\\]\\)\\?": "yes"
|
||||
timeout: 300
|
||||
ignore_errors: yes
|
||||
|
||||
- name: Build containers
|
||||
command: laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/bridge build-containers --force-rebuild
|
||||
command: laconic-so --stack ~/cerc/nitro-stack/stack-orchestrator/stacks/nitro-contracts build-containers --force-rebuild
|
||||
when: not skip_container_build
|
||||
|
||||
- name: Generate spec file for nitro contracts deployment
|
||||
@ -94,7 +93,7 @@
|
||||
msg: "VPA_ADDRESS: {{ vpa_address.stdout }}"
|
||||
|
||||
- name: Export ASSET_ADDRESS
|
||||
shell: laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"{{ geth_chain_id }}\"[0].contracts.Token.address' /app/deployment/nitro-addresses.json"
|
||||
shell: laconic-so deployment --dir nitro-contracts-deployment exec nitro-contracts "jq -r '.\"{{ geth_chain_id }}\"[0].contracts.{{ token_name }}.address' /app/deployment/nitro-addresses.json"
|
||||
args:
|
||||
chdir: "{{ nitro_directory }}"
|
||||
register: asset_address
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
target_host: "localhost"
|
||||
target_host: "nitro_host"
|
||||
nitro_directory: out
|
||||
skip_container_build: false
|
||||
|
||||
@ -1,16 +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 for Remote Host
|
||||
|
||||
To run the playbook on a remote host:
|
||||
|
||||
- Follow steps from [setup remote hosts](../README.md#setup-remote-hosts)
|
||||
|
||||
- Update / append the [`hosts.ini`](../hosts.ini) file for your remote host with `<deployment_host>` set as `nitro_host`
|
||||
- Setup user with passwordless sudo: Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user with passwordless sudo
|
||||
|
||||
## Setup
|
||||
|
||||
@ -60,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
|
||||
[<deployment_host>]
|
||||
@ -96,12 +70,12 @@ To run the playbook on a remote host:
|
||||
- Replace `<deployment_host>` with `nitro_host`
|
||||
- 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 `<ssh_user>` with the username of the user that you set up on target machine (e.g. dev, ubuntu)
|
||||
|
||||
- Verify that you are able to connect to the host using the following command
|
||||
|
||||
```bash
|
||||
ansible all -m ping -i hosts.ini -k
|
||||
ansible all -m ping -i hosts.ini
|
||||
|
||||
# Expected output:
|
||||
|
||||
@ -116,30 +90,31 @@ 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
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host"}' --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](./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": "nitro_host", "skip_container_build": true }' --user $USER -kK
|
||||
LANG=en_US.utf8 ansible-playbook -i hosts.ini run-nitro-nodes.yml --extra-vars='{ "target_host": "nitro_host", "skip_container_build": true }' --user $USER
|
||||
```
|
||||
|
||||
|
||||
## Check Deployment Status
|
||||
|
||||
- Run the following command in the directory where the deployments are created
|
||||
Run the following command in the directory where the deployments are created
|
||||
|
||||
- Check L1 nitro node logs:
|
||||
- Check L1 nitro node logs:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l1-nitro-deployment logs nitro-node -f
|
||||
```
|
||||
|
||||
- Check L2 nitro node logs:
|
||||
- Check L2 nitro node logs:
|
||||
|
||||
```bash
|
||||
laconic-so deployment --dir l2-nitro-deployment logs nitro-node -f
|
||||
|
||||
@ -29,7 +29,7 @@
|
||||
state: directory
|
||||
recurse: yes
|
||||
|
||||
- name: Clone go-nitro stack repo
|
||||
- name: Clone nitro-stack repo
|
||||
expect:
|
||||
command: laconic-so fetch-stack git.vdb.to/cerc-io/nitro-stack --git-ssh --pull
|
||||
responses:
|
||||
@ -37,14 +37,6 @@
|
||||
timeout: 300
|
||||
ignore_errors: yes
|
||||
|
||||
- name: Clone repositories required for nitro-stack
|
||||
expect:
|
||||
command: laconic-so --stack {{ ansible_env.HOME }}/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node setup-repositories --git-ssh --pull
|
||||
responses:
|
||||
"Are you sure you want to continue connecting \\(yes/no/\\[fingerprint\\]\\)\\?": "yes"
|
||||
timeout: 300
|
||||
ignore_errors: yes
|
||||
|
||||
- name: Build containers
|
||||
command: laconic-so --stack {{ ansible_env.HOME }}/cerc/nitro-stack/stack-orchestrator/stacks/nitro-node build-containers --force-rebuild
|
||||
when: not skip_container_build
|
||||
@ -123,3 +115,8 @@
|
||||
get_url:
|
||||
url: https://git.vdb.to/cerc-io/testnet-laconicd-stack/raw/branch/main/ops/stage2/nitro-node-config.yml
|
||||
dest: "{{ nitro_directory }}"
|
||||
|
||||
- name: Fetch required asset addresses
|
||||
get_url:
|
||||
url: https://git.vdb.to/cerc-io/testnet-laconicd-stack/raw/branch/main/ops/stage2/assets.json
|
||||
dest: "{{ nitro_directory }}"
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
target_host: "localhost"
|
||||
target_host: "nitro_host"
|
||||
nitro_directory: out
|
||||
skip_container_build: false
|
||||
|
||||
@ -1,76 +1,18 @@
|
||||
# service-provider-setup
|
||||
|
||||
## Setup Ansible
|
||||
|
||||
To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
|
||||
This setup has been tested on digitalocean droplets running ubuntu 22.04 LTS
|
||||
|
||||
## 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
|
||||
|
||||
- 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:
|
||||
|
||||
```ini
|
||||
[root_host]
|
||||
<host_name> ansible_host=<target_ip> ansible_user=<ssh_user> ansible_ssh_common_args='-o ForwardAgent=yes'
|
||||
```
|
||||
|
||||
- Replace `<host_name>` with the desired `hostname` of the remote machine
|
||||
- Replace `<target_ip>` with the IP address or hostname of the target machine
|
||||
- Replace `<ssh_user>` with `root`
|
||||
|
||||
- Verify that you are able to connect to the host using the following command:
|
||||
|
||||
```bash
|
||||
ansible all -m ping -i hosts.ini
|
||||
|
||||
# Expected output:
|
||||
|
||||
# <host_name> | SUCCESS => {
|
||||
# "ansible_facts": {
|
||||
# "discovered_interpreter_python": "/usr/bin/python3.10"
|
||||
# },
|
||||
# "changed": false,
|
||||
# "ping": "pong"
|
||||
# }
|
||||
```
|
||||
|
||||
- Setup `user-vars.yml` using the example file
|
||||
|
||||
```bash
|
||||
cp vars/user-vars.example.yml vars/user-vars.yml
|
||||
```
|
||||
|
||||
- Edit the `user-vars.yml` file:
|
||||
|
||||
```bash
|
||||
# name of the user you want to setup on the target host
|
||||
username: ""
|
||||
|
||||
# password of the user you want to setup on the target host
|
||||
password: ""
|
||||
|
||||
# path to the ssh key on your machine, eg: "/home/user/.ssh/id_rsa.pub"
|
||||
path_to_ssh_key: ""
|
||||
```
|
||||
|
||||
- Execute the `setup-user.yml` Ansible playbook to create a user with passwordless sudo permissions:
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 ansible-playbook setup-user.yml -i hosts.ini --extra-vars='{ "target_host": "deployment_host" }'
|
||||
```
|
||||
- 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
|
||||
|
||||
@ -84,6 +26,7 @@ To get started, follow the [installation](../README.md#installation) guide to se
|
||||
cp gpg-vars.example.yml gpg-vars.yml
|
||||
cp k8s-vars.example.yml k8s-vars.yml
|
||||
cp container-vars.example.yml container-vars.yml
|
||||
cp laconicd-vars.example.yml laconicd-vars.yml
|
||||
cp webapp-vars.example.yml webapp-vars.yml
|
||||
cd -
|
||||
```
|
||||
@ -93,41 +36,46 @@ To get started, follow the [installation](../README.md#installation) guide to se
|
||||
```bash
|
||||
# vars/dns-vars.yml
|
||||
full_domain: "" # eg: laconic.com
|
||||
subdomain_prefix: "" # eg: lcn-cad
|
||||
service_provider_ip: "" # eg: 23.111.78.179
|
||||
do_api_token: "" # Digital Ocean access token that you generated, eg: dop_v1...
|
||||
do_api_token: "" # DigitalOcean access token that you generated, eg: dop_v1...
|
||||
|
||||
# vars/gpg-vars.yml
|
||||
gpg_user_name: "" # Full name of the user for the GPG key
|
||||
gpg_user_email: "" # Email address associated with the GPG key
|
||||
gpg_passphrase: "" # Passphrase for securing the GPG key
|
||||
gpg_user_name: "" # full name of the user for the GPG key
|
||||
gpg_user_email: "" # email address associated with the GPG key
|
||||
gpg_passphrase: "" # passphrase for securing the GPG key
|
||||
|
||||
# vars/k8s-vars.yml
|
||||
target_host: "deployment_host"
|
||||
org_id: "" # eg: lcn
|
||||
location_id: "" # eg: cad
|
||||
base_domain: "" # eg: laconic
|
||||
support_email: "" # eg: support@laconic.com
|
||||
|
||||
# vars/container-vars.yml
|
||||
container_registry_username: "" # username to login to the container registry
|
||||
container_registry_password: "" # password to login to the container registry
|
||||
|
||||
# vars/laconicd-vars.yml
|
||||
chain_id: "" # chain id to use for the Laconic chain
|
||||
|
||||
# vars/webapp-vars.yml
|
||||
authority_name: "" # eg: my-org-name
|
||||
cpu_reservation: "" # Minimum number of cpu cores to be used, eg: 2
|
||||
memory_reservation: "" # Minimum amount of memory in GB to be used, eg: 4G
|
||||
cpu_limit: "" # Maximum number of cpu cores to be used, eg: 6
|
||||
memory_limit: "" # Maximum amount of memory in GB to be used, eg: 8G
|
||||
authority_name: "" # eg: laconic-authority
|
||||
cpu_reservation: "1" # minimum number of cpu cores to be used, eg: 1
|
||||
memory_reservation: "2G" # minimum amount of memory in GB to be used, eg: 2G
|
||||
cpu_limit: "6" # maximum number of cpu cores to be used, eg: 6
|
||||
memory_limit: "8G" # maximum amount of memory in GB to be used, eg: 8G
|
||||
deployer_gpg_passphrase: "" # passphrase for creating GPG key used by webapp-deployer, eg: SECRET
|
||||
handle_auction_requests: "true" # whether the webapp deployer should handle deployment auction requests, eg: true
|
||||
auction_bid_amount: "500000" # bid amount for deployment auctions in alnt, eg: 500000
|
||||
```
|
||||
|
||||
- Update the [`hosts.ini`](./hosts.ini) file:
|
||||
- Create a new `hosts.ini` file:
|
||||
|
||||
```bash
|
||||
cp ../hosts.example.ini hosts.ini
|
||||
```
|
||||
|
||||
- Edit the [`hosts.ini`](./hosts.ini) file:
|
||||
|
||||
```ini
|
||||
[root_host]
|
||||
<host_name> ansible_host=<target_ip> ansible_user=root ansible_ssh_common_args='-o ForwardAgent=yes'
|
||||
|
||||
[deployment_host]
|
||||
<host_name> ansible_host=<target_ip> ansible_user=<new_username> ansible_ssh_common_args='-o ForwardAgent=yes'
|
||||
```
|
||||
@ -167,8 +115,87 @@ To get started, follow the [installation](../README.md#installation) guide to se
|
||||
|
||||
After the playbook finishes executing, the following services will be deployed (your setup should look similar to the example below):
|
||||
|
||||
- laconicd chain RPC endpoint: http://lcn-daemon.laconic.com:26657
|
||||
- laconic console: http://lcn-daemon.laconic.com:8080/registry
|
||||
- laconicd GQL endpoint: http://lcn-daemon.laconic.com:9473/api
|
||||
- webapp deployer API: https://webapp-deployer-api.pwa.laconic.com
|
||||
- webapp deployer UI: https://webapp-deployer-ui.pwa.laconic.com
|
||||
- laconicd chain RPC endpoint: <http://lcn-daemon.laconic.com:26657>
|
||||
- laconicd GQL endpoint: <http://lcn-daemon.laconic.com:9473/api>
|
||||
- laconic console: <http://lcn-console.laconic.com:8080/registry>
|
||||
- webapp deployer API: <https://webapp-deployer-api.pwa.laconic.com>
|
||||
- webapp deployer UI: <https://webapp-deployer-ui.pwa.laconic.com>
|
||||
|
||||
## Cleanup
|
||||
|
||||
Run the following steps on the target machine to stop the webapp-deployer, container-registry, fixturenet-laconicd and laconic-console-deployment, undeploy k8s, remove GPG keys and DNS records
|
||||
- Stop deployments
|
||||
|
||||
```
|
||||
$ laconic-so deployment --dir webapp-ui stop
|
||||
$ laconic-so deployment --dir webapp-deployer
|
||||
$ laconic-so deployment --dir container-registry stop
|
||||
$ laconic-so deployment --dir laconic-console-deployment stop --delete-volumes
|
||||
$ laconic-so deployment --dir fixturenet-laconicd-deployment stop --delete-volumes
|
||||
```
|
||||
|
||||
- Remove deployment directories
|
||||
```
|
||||
sudo rm -rf webapp-ui
|
||||
sudo rm -rf webapp-deployer
|
||||
sudo rm -rf container-registry
|
||||
sudo rm -rf laconic-console-deployment
|
||||
sudo rm -rf fixturenet-laconicd-deployment
|
||||
```
|
||||
|
||||
- Remove spec files
|
||||
|
||||
```
|
||||
rm webapp-deployer.spec
|
||||
rm container-registry.spec
|
||||
rm laconic-console-spec.yml
|
||||
rm fixturenet-laconicd-spec.yml
|
||||
```
|
||||
|
||||
- Undeploy the k8s
|
||||
|
||||
```
|
||||
$ cd service-provider-template
|
||||
$ export VAULT_KEY=<gpg_passphrase>
|
||||
$ bash .vault/vault-rekey.sh
|
||||
$ ansible-playbook -i hosts site.yml --tags=k8s --limit=<org_id>_<location_id> --user <user> --extra-vars 'k8s_action=destroy'
|
||||
```
|
||||
|
||||
- Remove service-provider-template repo
|
||||
```
|
||||
$ rm -rf service-provider-template
|
||||
```
|
||||
|
||||
- Remove any existing GPG keys
|
||||
```
|
||||
$ rm -rf gpg-keys/
|
||||
$ gpg --list-secret-keys --keyid-format=long
|
||||
/home/dev/.gnupg/pubring.kbx
|
||||
----------------------------
|
||||
sec rsa4096/DA9E3D638930A699 2024-10-15 [SCEA]
|
||||
69A3200727091E72B773BBEBDA9E3D638930A699
|
||||
uid [ultimate] deepstack <support@deepstacksoft.com>
|
||||
ssb rsa3072/2B5D80CF44753EFD 2024-10-15 [SEA]
|
||||
|
||||
sec rsa3072/2449A62C838440AB 2024-10-15 [SC]
|
||||
646A42164F978DC1415C11F12449A62C838440AB
|
||||
uid [ultimate] webapp-deployer-api.deepstack.com
|
||||
ssb rsa3072/67576558A2F2FE91 2024-10-15 [E]
|
||||
|
||||
$ gpg --delete-secret-key 69A3200727091E72B773BBEBDA9E3D638930A699
|
||||
$ gpg --delete-key 69A3200727091E72B773BBEBDA9E3D638930A699
|
||||
$ gpg --delete-secret-key 646A42164F978DC1415C11F12449A62C838440AB
|
||||
$ gpg --delete-key 646A42164F978DC1415C11F12449A62C838440AB
|
||||
```
|
||||
- Remove the user if required
|
||||
|
||||
```bash
|
||||
$ userdel <user>
|
||||
|
||||
# If required, kill process that is using the user
|
||||
# userdel: user <user> is currently used by process 1639
|
||||
# $ kill -9 1639
|
||||
```
|
||||
|
||||
- Remove DNS records using DigitalOcean's API:
|
||||
- <https://docs.digitalocean.com/reference/api/api-try-it-now/#/Domain%20Records/domains_delete_record>
|
||||
|
||||
@ -10,6 +10,7 @@
|
||||
- vars/container-vars.yml
|
||||
- vars/k8s-vars.yml
|
||||
- vars/dns-vars.yml
|
||||
- vars/laconicd-vars.yml
|
||||
|
||||
tasks:
|
||||
- name: Ensure gpg-keys directory exists
|
||||
@ -43,7 +44,7 @@
|
||||
- name: Create laconic config file
|
||||
template:
|
||||
src: "./templates/laconic.yml.j2"
|
||||
dest: "config/laconic.yml"
|
||||
dest: "{{ ansible_env.HOME }}/config/laconic.yml"
|
||||
|
||||
- name: Copy the gpg private key file to config dir
|
||||
copy:
|
||||
@ -65,7 +66,7 @@
|
||||
--laconic-config /home/root/config/laconic.yml \
|
||||
--api-url https://webapp-deployer-api.pwa.{{ full_domain }} \
|
||||
--public-key-file /home/root/config/webapp-deployer-api.{{ full_domain }}.pgp.pub \
|
||||
--lrn lrn://{{ authority_name }}/deployers/webapp-deployer-api.{{ full_domain }} \
|
||||
--lrn lrn://{{ authority_name }}/deployers/webapp-deployer-api.pwa.{{ full_domain }} \
|
||||
--min-required-payment 0
|
||||
register: publish_output
|
||||
|
||||
@ -78,7 +79,7 @@
|
||||
src: "./templates/specs/webapp-deployer.spec.j2"
|
||||
dest: "webapp-deployer.spec"
|
||||
|
||||
- name: Create the deployment directory from the spec file
|
||||
- name: Create deployment directory for webapp-deployer
|
||||
command: >
|
||||
laconic-so --stack webapp-deployer-backend deploy create
|
||||
--deployment-dir webapp-deployer --spec-file webapp-deployer.spec
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
--image cerc/webapp-deployment-status-ui:local --url https://webapp-deployer-ui.pwa.{{ full_domain }}
|
||||
--env-file ~/cerc/webapp-deployment-status-ui/.env
|
||||
|
||||
- name: Push image to container registry
|
||||
- name: Push webapp-ui images to container registry
|
||||
command: laconic-so deployment --dir webapp-ui push-images
|
||||
|
||||
- name: Update config file for webapp ui
|
||||
|
||||
@ -8,6 +8,7 @@
|
||||
- vars/webapp-vars.yml
|
||||
- vars/dns-vars.yml
|
||||
- vars/k8s-vars.yml
|
||||
- vars/laconicd-vars.yml
|
||||
|
||||
tasks:
|
||||
- name: Clone the stack repo
|
||||
|
||||
@ -4,6 +4,9 @@
|
||||
environment:
|
||||
PATH: "{{ ansible_env.PATH }}:/home/{{ansible_user}}/bin"
|
||||
|
||||
vars_files:
|
||||
- vars/laconicd-vars.yml
|
||||
|
||||
tasks:
|
||||
- name: Clone the fixturenet-laconicd-stack repo
|
||||
command: laconic-so fetch-stack git.vdb.to/cerc-io/fixturenet-laconicd-stack --pull
|
||||
@ -15,7 +18,7 @@
|
||||
- name: Build container images
|
||||
command: laconic-so --stack ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd build-containers --force-rebuild
|
||||
|
||||
- name: Generate over spec file for laconicd deployment
|
||||
- name: Generate spec file for laconicd deployment
|
||||
template:
|
||||
src: "./templates/specs/fixturenet-laconicd-spec.yml.j2"
|
||||
dest: "fixturenet-laconicd-spec.yml"
|
||||
@ -29,5 +32,10 @@
|
||||
command: laconic-so --stack ~/cerc/fixturenet-laconicd-stack/stack-orchestrator/stacks/fixturenet-laconicd deploy create --spec-file fixturenet-laconicd-spec.yml --deployment-dir fixturenet-laconicd-deployment
|
||||
when: not deployment_dir.stat.exists
|
||||
|
||||
- name: Create laconicd config
|
||||
template:
|
||||
src: "./templates/configs/laconicd-config.env.j2"
|
||||
dest: "fixturenet-laconicd-deployment/config.env"
|
||||
|
||||
- name: Start the deployment
|
||||
command: laconic-so deployment --dir fixturenet-laconicd-deployment start
|
||||
|
||||
@ -6,6 +6,16 @@
|
||||
- vars/k8s-vars.yml
|
||||
|
||||
tasks:
|
||||
- name: Check if domain exists
|
||||
community.digitalocean.digital_ocean_domain_facts:
|
||||
oauth_token: "{{ do_api_token }}"
|
||||
register: existing_domains
|
||||
|
||||
- name: Fail if domain already exists
|
||||
fail:
|
||||
msg: "Domain {{ full_domain }} already exists."
|
||||
when: full_domain in existing_domains.data | map(attribute='name') | list
|
||||
|
||||
- name: Create a domain
|
||||
community.digitalocean.digital_ocean_domain:
|
||||
state: present
|
||||
@ -48,7 +58,7 @@
|
||||
data: "{{ subdomain_cluster_control }}.{{ full_domain }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: CNAME
|
||||
name: "{{ subdomain_prefix }}.{{ full_domain }}"
|
||||
name: "{{ subdomain_prefix }}"
|
||||
ttl: 43200
|
||||
|
||||
- name: Create CNAME record for laconicd endpoint
|
||||
@ -58,7 +68,7 @@
|
||||
data: "{{ org_id }}-daemon.{{ full_domain }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: CNAME
|
||||
name: "laconicd.{{ full_domain }}"
|
||||
name: "laconicd"
|
||||
ttl: 43200
|
||||
|
||||
- name: Create CNAME record for backend
|
||||
@ -68,7 +78,7 @@
|
||||
data: "{{ org_id }}-daemon.{{ full_domain }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: CNAME
|
||||
name: "{{ org_id }}-backend.{{ full_domain }}"
|
||||
name: "{{ org_id }}-backend"
|
||||
ttl: 43200
|
||||
|
||||
- name: Create CNAME record for console
|
||||
@ -78,47 +88,35 @@
|
||||
data: "{{ org_id }}-daemon.{{ full_domain }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: CNAME
|
||||
name: "{{ org_id }}-console.{{ full_domain }}"
|
||||
name: "{{ org_id }}-console"
|
||||
ttl: 43200
|
||||
|
||||
- name: Create CNAME record for org and location
|
||||
- name: Create wildcard CNAME record for subdomain
|
||||
community.digitalocean.digital_ocean_domain_record:
|
||||
state: present
|
||||
oauth_token: "{{ do_api_token }}"
|
||||
data: "{{ org_id }}-daemon.{{ full_domain }}"
|
||||
name: "*.{{ subdomain_prefix }}"
|
||||
data: "{{ subdomain_prefix }}-cluster-control.{{ full_domain }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: CNAME
|
||||
name: "{{ subdomain_prefix }}"
|
||||
ttl: 43200
|
||||
|
||||
- name: Create wildcard A record for subdomain
|
||||
community.digitalocean.digital_ocean_domain_record:
|
||||
state: present
|
||||
oauth_token: "{{ do_api_token }}"
|
||||
name: "{{ subdomain_cluster_control }}.{{ full_domain }}"
|
||||
data: "{{ service_provider_ip }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: A
|
||||
name: "*.{{ subdomain_prefix }}"
|
||||
ttl: 43200
|
||||
|
||||
- name: Create CNAME record for pwa
|
||||
community.digitalocean.digital_ocean_domain_record:
|
||||
state: present
|
||||
oauth_token: "{{ do_api_token }}"
|
||||
data: "{{ subdomain_cluster_control }}.{{ full_domain }}"
|
||||
name: "pwa"
|
||||
data: "{{ subdomain_prefix }}-cluster-control.{{ full_domain }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: CNAME
|
||||
name: "pwa"
|
||||
ttl: 43200
|
||||
|
||||
- name: Create wildcard A record for pwa
|
||||
- name: Create wildcard CNAME record for pwa
|
||||
community.digitalocean.digital_ocean_domain_record:
|
||||
state: present
|
||||
oauth_token: "{{ do_api_token }}"
|
||||
name: "{{ subdomain_cluster_control }}.{{ full_domain }}"
|
||||
data: "{{ service_provider_ip }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: A
|
||||
name: "*.pwa"
|
||||
data: "{{ subdomain_prefix }}-cluster-control.{{ full_domain }}"
|
||||
domain: "{{ full_domain }}"
|
||||
type: CNAME
|
||||
ttl: 43200
|
||||
|
||||
@ -66,6 +66,7 @@
|
||||
command: gpg-agent --daemon
|
||||
ignore_errors: yes
|
||||
|
||||
# Cache GPG passphrase by signing a dummy string to avoid passphrase prompts in later steps
|
||||
- name: Sign a dummy string using gpg-key
|
||||
shell: echo "This is a dummy string." | gpg --batch --yes --local-user "{{ gpg_key_id }}" --passphrase "{{ vault_passphrase }}" --pinentry-mode loopback --sign -
|
||||
|
||||
@ -124,10 +125,10 @@
|
||||
src: ./templates/k8s.yml.j2
|
||||
dest: "{{ ansible_env.HOME }}/service-provider-template/group_vars/{{ org_id }}_{{ location_id }}/k8s.yml"
|
||||
|
||||
- name: Copy wildcard-pwa-{{ base_domain }}.yaml to the remote VM
|
||||
- name: Copy wildcard template to the remote VM
|
||||
template:
|
||||
src: ./templates/wildcard-pwa-example.yml.j2
|
||||
dest: "{{ ansible_env.HOME }}/service-provider-template/files/manifests/wildcard-pwa-{{ base_domain }}.yaml"
|
||||
dest: "{{ ansible_env.HOME }}/service-provider-template/files/manifests/wildcard-pwa-{{ full_domain | replace('.', '-') }}.yaml"
|
||||
|
||||
- name: Delete old wildcard-pwa file
|
||||
file:
|
||||
|
||||
@ -2,4 +2,5 @@ CERC_LACONICD_USER_KEY={{ALICE_PK}}
|
||||
CERC_LACONICD_BOND_ID={{BOND_ID}}
|
||||
CERC_LACONICD_RPC_ENDPOINT=http://{{ org_id }}-daemon.{{ full_domain }}:26657
|
||||
CERC_LACONICD_GQL_ENDPOINT=http://{{ org_id }}-daemon.{{ full_domain }}:9473/api
|
||||
CERC_LACONICD_CHAIN_ID={{ chain_id }}
|
||||
LACONIC_HOSTED_ENDPOINT=http://{{ org_id }}-daemon.{{ full_domain }}:9473
|
||||
|
||||
@ -0,0 +1 @@
|
||||
CHAINID={{ chain_id }}
|
||||
@ -20,9 +20,11 @@ CHECK_INTERVAL=5
|
||||
FQDN_POLICY="allow"
|
||||
|
||||
# lrn of the webapp deployer
|
||||
LRN="lrn://{{ authority_name }}/deployers/webapp-deployer-api.{{ full_domain }}"
|
||||
LRN="lrn://{{ authority_name }}/deployers/webapp-deployer-api.pwa.{{ full_domain }}"
|
||||
export OPENPGP_PRIVATE_KEY_FILE="webapp-deployer-api.{{ full_domain }}.pgp.key"
|
||||
export OPENPGP_PASSPHRASE="{{ deployer_gpg_passphrase }}"
|
||||
export DEPLOYER_STATE="srv-test/deployments/autodeploy.state"
|
||||
export UNDEPLOYER_STATE="srv-test/deployments/autoundeploy.state"
|
||||
export UPLOAD_DIRECTORY="srv-test/uploads"
|
||||
export HANDLE_AUCTION_REQUESTS={{ handle_auction_requests }}
|
||||
export AUCTION_BID_AMOUNT={{ auction_bid_amount }}
|
||||
|
||||
@ -52,4 +52,4 @@ k8s_manifests:
|
||||
# initiate wildcard cert
|
||||
- name: pwa.{{ full_domain }}
|
||||
type: file
|
||||
source: wildcard-pwa-{{ base_domain }}.yaml
|
||||
source: wildcard-pwa-{{ full_domain | replace('.', '-') }}.yaml
|
||||
|
||||
@ -4,6 +4,6 @@ services:
|
||||
gqlEndpoint: 'http://{{ org_id }}-daemon.{{ full_domain }}:9473/api'
|
||||
userKey: "{{ ALICE_PK }}"
|
||||
bondId: "{{ BOND_ID }}"
|
||||
chainId: lorotestnet-1
|
||||
chainId: {{ chain_id }}
|
||||
gas: 200000
|
||||
fees: 200000alnt
|
||||
|
||||
@ -9,7 +9,7 @@ spec:
|
||||
name: letsencrypt-prod-wild
|
||||
kind: ClusterIssuer
|
||||
group: cert-manager.io
|
||||
commonName: *.pwa.{{ full_domain }}
|
||||
commonName: "*.pwa.{{ full_domain }}"
|
||||
dnsNames:
|
||||
- pwa.{{ full_domain }}
|
||||
- *.pwa.{{ full_domain }}
|
||||
- "pwa.{{ full_domain }}"
|
||||
- "*.pwa.{{ full_domain }}"
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
full_domain: ""
|
||||
subdomain_prefix: ""
|
||||
subdomain_prefix: "{{ org_id }}-{{ location_id }}"
|
||||
subdomain_cluster_control: "{{ subdomain_prefix }}-cluster-control"
|
||||
service_provider_ip: ""
|
||||
do_api_token: ""
|
||||
|
||||
@ -1,8 +1,6 @@
|
||||
target_host: "deployment_host"
|
||||
gpg_key_id: "{{ sec_key_id }}"
|
||||
vault_passphrase: "{{ gpg_passphrase }}"
|
||||
org_id: ""
|
||||
location_id: ""
|
||||
base_domain: ""
|
||||
support_email: ""
|
||||
ansible_ssh_extra_args: '-o StrictHostKeyChecking=no'
|
||||
|
||||
1
service-provider-setup/vars/laconicd-vars.example.yml
Normal file
1
service-provider-setup/vars/laconicd-vars.example.yml
Normal file
@ -0,0 +1 @@
|
||||
chain_id: "laconic_9000-1"
|
||||
@ -1,8 +1,10 @@
|
||||
ALICE_PK: "{{ ALICE_PK }}"
|
||||
BOND_ID: "{{ BOND_ID }}"
|
||||
authority_name: ""
|
||||
cpu_reservation: ""
|
||||
memory_reservation: ""
|
||||
cpu_reservation: "1"
|
||||
memory_reservation: "2G"
|
||||
cpu_limit: "6"
|
||||
memory_limit: "8G"
|
||||
deployer_gpg_passphrase: ""
|
||||
handle_auction_requests: "true"
|
||||
auction_bid_amount: "500000"
|
||||
|
||||
@ -1,8 +1,10 @@
|
||||
# stack-orchestrator-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 with passwordless sudo: Follow steps from [Setup a user](../user-setup/README.md#setup-a-user) to setup a new user with passwordless sudo
|
||||
|
||||
## Setup Stack Orchestrator
|
||||
|
||||
@ -10,18 +12,6 @@ This playbook will install Docker and Stack Orchestrator (laconic-so) on the mac
|
||||
|
||||
Run the following commands in the [`stack-orchestrator-setup`](./) directory.
|
||||
|
||||
### On Local Host
|
||||
|
||||
To setup stack orchestrator and docker locally, execute the `setup-laconic-so.yml` Ansible playbook:
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 ansible-playbook setup-laconic-so.yml --user $USER -kK
|
||||
```
|
||||
|
||||
### On Remote Host
|
||||
|
||||
To run the playbook on a remote host:
|
||||
|
||||
- Create a new `hosts.ini` file:
|
||||
|
||||
```bash
|
||||
@ -37,12 +27,12 @@ To run the playbook on a remote host:
|
||||
|
||||
- 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 `<ssh_user>` with the username of the user that you set up on target machine (e.g. dev, ubuntu)
|
||||
|
||||
- Verify that you are able to connect to the host using the following command
|
||||
|
||||
```bash
|
||||
ansible all -m ping -i hosts.ini -k
|
||||
ansible all -m ping -i hosts.ini
|
||||
|
||||
# Expected output:
|
||||
|
||||
@ -55,28 +45,30 @@ To run the playbook on a remote host:
|
||||
# }
|
||||
```
|
||||
|
||||
- Execute the `setup-laconic-so.yml` Ansible playbook for setting up stack orchestrator and docker on a remote machine:
|
||||
- Execute the `setup-laconic-so.yml` Ansible playbook for setting up stack orchestrator and docker on the target machine:
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 ansible-playbook setup-laconic-so.yml -i hosts.ini --extra-vars='{ "target_host": "deployment_host"}' --user $USER -kK
|
||||
LANG=en_US.utf8 ansible-playbook setup-laconic-so.yml -i hosts.ini --extra-vars='{ "target_host": "deployment_host"}' --user $USER
|
||||
```
|
||||
|
||||
## Verify Installation
|
||||
|
||||
- After the installation is complete, verify if `$HOME/bin` is already included in your PATH by running:
|
||||
Run the following commands on your target machine:
|
||||
|
||||
- After the installation is complete, verify if `$HOME/bin` is already included in the `PATH` by running:
|
||||
|
||||
```bash
|
||||
echo $PATH | grep -q "$HOME/bin" && echo "$HOME/bin is already in PATH" || echo "$HOME/bin is not in PATH"
|
||||
```
|
||||
If the command outputs `"$HOME/bin is not in PATH"`, you'll need to add it to your `PATH`.
|
||||
|
||||
- To add `$HOME/bin` to your PATH, run the following command:
|
||||
- To add `$HOME/bin` to your `PATH`, run the following command:
|
||||
|
||||
```bash
|
||||
export PATH="$HOME/bin:$PATH"
|
||||
```
|
||||
|
||||
- To make this change permanent, add the following line to your shell configuration file (`~/.bashrc` or `~/.zshrc`, depending on your shell):
|
||||
- To make this change permanent, add the following line to your shell configuration file (`~/.bashrc` or `~/.zshrc`, depending on your shell):
|
||||
|
||||
```bash
|
||||
# For bash users
|
||||
|
||||
1
user-setup/.gitignore
vendored
Normal file
1
user-setup/.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
||||
user-vars.yml
|
||||
75
user-setup/README.md
Normal file
75
user-setup/README.md
Normal file
@ -0,0 +1,75 @@
|
||||
# user-setup
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Setup Ansible: follow the [installation](../README.md#installation) guide to setup ansible on your machine.
|
||||
|
||||
- Setup a remote machine with passwordless SSH login for the root user
|
||||
|
||||
- Install `passlib` used for handling encrypted passwords when setting up a user
|
||||
|
||||
```bash
|
||||
pip install passlib
|
||||
```
|
||||
|
||||
## Setup a user
|
||||
|
||||
Execute the following commands in the `user-setup` directory
|
||||
|
||||
- Create a new `hosts.ini` file:
|
||||
|
||||
```bash
|
||||
cp ../hosts.example.ini hosts.ini
|
||||
```
|
||||
|
||||
- Edit the [`hosts.ini`](./hosts.ini) file:
|
||||
|
||||
```ini
|
||||
[deployment_host]
|
||||
<host_name> ansible_host=<target_ip> ansible_user=<ssh_user> ansible_ssh_common_args='-o ForwardAgent=yes'
|
||||
```
|
||||
|
||||
- Replace `<host_name>` with the desired `hostname` of the remote machine
|
||||
- Replace `<target_ip>` with the IP address or hostname of the target machine
|
||||
- Replace `<ssh_user>` with `root`
|
||||
|
||||
- Verify that you are able to connect to the host using the following command:
|
||||
|
||||
```bash
|
||||
ansible all -m ping -i hosts.ini
|
||||
|
||||
# Expected output:
|
||||
|
||||
# <host_name> | SUCCESS => {
|
||||
# "ansible_facts": {
|
||||
# "discovered_interpreter_python": "/usr/bin/python3.10"
|
||||
# },
|
||||
# "changed": false,
|
||||
# "ping": "pong"
|
||||
# }
|
||||
```
|
||||
|
||||
- Setup `user-vars.yml` using the example file
|
||||
|
||||
```bash
|
||||
cp user-vars.example.yml user-vars.yml
|
||||
```
|
||||
|
||||
- Edit the `user-vars.yml` file:
|
||||
|
||||
```bash
|
||||
# name of the user you want to setup on the target host
|
||||
username: ""
|
||||
|
||||
# password of the user you want to setup on the target host
|
||||
password: ""
|
||||
|
||||
# path to the ssh key on your machine, eg: "/home/user/.ssh/id_rsa.pub"
|
||||
path_to_ssh_key: ""
|
||||
```
|
||||
|
||||
- Execute the `setup-user.yml` Ansible playbook to create a user with passwordless sudo permissions:
|
||||
|
||||
```bash
|
||||
LANG=en_US.utf8 ansible-playbook setup-user.yml -i hosts.ini
|
||||
```
|
||||
@ -1,9 +1,9 @@
|
||||
- name: Configure system
|
||||
hosts: root_host
|
||||
hosts: deployment_host
|
||||
become: yes
|
||||
|
||||
vars_files:
|
||||
- vars/user-vars.yml
|
||||
- user-vars.yml
|
||||
|
||||
tasks:
|
||||
- name: Create a user
|
||||
Loading…
Reference in New Issue
Block a user