LaconicNetwork/lockdrop-simulation
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update instructions to use simplified zenith ansible commands (#8)

Browse Source 
Co-authored-by: Pranav <jadhavpranav89@gmail.com>
Reviewed-on: #8
Co-authored-by: shreerang <shreerang@noreply.git.vdb.to>
Co-committed-by: shreerang <shreerang@noreply.git.vdb.to>
This commit is contained in:
shreerang 2025-09-26 06:37:37 +00:00 committed by nabarun
parent 4461ee1ff0
commit 8244eca2c9
2 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -93,7 +93,7 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan
- Set zenith-stack version to use:
```bash
ZENITH_STACK_VERSION=v0.2.13
ZENITH_STACK_VERSION=v0.2.15
```
Check [releases](https://git.vdb.to/LaconicNetwork/zenith-stack/releases) page for version history.
@ -170,7 +170,7 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan
# Run a playbook to install configure-zenith-vars
# Use the same OUTPUT_DIR used for zenith-ansible
zenith-ansible install-zenith-config-cli.yml -e "cli_install_dir=${OUTPUT_DIR}" -K
zenith-ansible install-config-cli --install-dir "${OUTPUT_DIR}" -K
```
Verify installation:
@ -261,7 +261,7 @@ Now, run required system setup (installs docker and laconic-so):
```bash
# sudo access required for installing docker
zenith-ansible -i ./inventories/development/hosts.yml ./stage1-site.yml -e "mode=system-setup" -K --skip-tags onboarding
zenith-ansible system-setup -i dev -s stage1 -K --skip-tags onboarding
```
If your machine did not have Docker installed before, the above command will install it. On Ubuntu, you will need to activate the `docker` group for your current shell:
@ -275,13 +275,13 @@ This is a one time operation required to be performed after installing docker.
Setup the deployment directories and pull required docker images to generate base genesis file along with other artifacts:
```bash
zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=setup"
zenith-ansible setup -i dev -s tge
```
Setup the deployment directories and pull required docker images to sign the gentx and setup stage 1 validator node:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=setup" --skip-tags onboarding
zenith-ansible setup -i dev -s stage1 --skip-tags onboarding
```
These steps will create following in the [configured](#view-configuration) deployments directory:
@ -303,7 +303,7 @@ rm -rf $ZENITH_STACK_DIR/generated
Following command generates the simulated participants with respective point lockup events. It also creates a base genesis file with treasury initialized with the participants data:
```bash
zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=simulate-lockdrop"
zenith-ansible simulate-lockdrop -i dev -s tge
```
This will generate following files in `zenith-stack/generated`:
@ -336,7 +336,7 @@ Note this private key down as it will be required in next step.
Now run the playbook to sign the gentx and generate final genesis file:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=sign"
zenith-ansible sign -i dev -s stage1
```
Use the private key noted above when prompted.
@ -353,7 +353,7 @@ This will:
Now, we can use this genesis file to run the stage 1 validator node:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=start" --skip-tags onboarding
zenith-ansible start -i dev -s stage1 --skip-tags onboarding
```
After starting the node, verify it's running correctly:
@ -494,13 +494,13 @@ cd $ZENITH_STACK_DIR/ansible
Stop validator deployment:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=stop" --skip-tags onboarding
zenith-ansible stop -i dev -s stage1 --skip-tags onboarding
```
Clean up validator deployment:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=cleanup" --skip-tags onboarding -K
zenith-ansible cleanup -i dev -s stage1 --skip-tags onboarding -K
```
### Python Virtual Environment

20
test-runs/README.md
View File

@ -60,7 +60,7 @@ To reproduce the results from any one of the test runs, follow these steps to ru
- Set zenith-stack version to use:
```bash
ZENITH_STACK_VERSION=v0.2.13
ZENITH_STACK_VERSION=v0.2.15
```
Check [releases](https://git.vdb.to/LaconicNetwork/zenith-stack/releases) page for version history.
@ -139,7 +139,7 @@ To reproduce the results from any one of the test runs, follow these steps to ru
# Run a playbook to install configure-zenith-vars
# Use the same OUTPUT_DIR used for zenith-ansible
zenith-ansible install-zenith-config-cli.yml -e "cli_install_dir=${OUTPUT_DIR}" -K
zenith-ansible install-config-cli --install-dir "${OUTPUT_DIR}" -K
```
Verify installation:
@ -219,7 +219,7 @@ Now, run required system setup (installs docker and laconic-so):
```bash
# sudo access required for installing docker
zenith-ansible -i ./inventories/development/hosts.yml ./stage1-site.yml -e "mode=system-setup" -K --skip-tags onboarding
zenith-ansible system-setup -i dev -s stage1 -K --skip-tags onboarding
```
If your machine did not have Docker installed before, the above command will install it. On Ubuntu, you will need to activate the `docker` group for your current shell:
@ -233,13 +233,13 @@ This is a one time operation required to be performed after installing docker.
Setup the deployment directories and pull required docker images to generate base genesis file along with other artifacts:
```bash
zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=setup"
zenith-ansible setup -i dev -s tge
```
Setup the deployment directories and pull required docker images to sign the gentx and setup stage 1 validator node:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=setup" --skip-tags onboarding
zenith-ansible setup -i dev -s stage1 --skip-tags onboarding
```
These steps will create following in the [configured](#view-configuration) deployments directory:
@ -278,7 +278,7 @@ Since we've placed existing generated data in zenith-stack, following command sk
# Navigate back to ansible directory in zenith-stack
cd $ZENITH_STACK_DIR/ansible
zenith-ansible -i ./inventories/development/hosts.yml tge-site.yml -e "mode=simulate-lockdrop"
zenith-ansible simulate-lockdrop -i dev -s tge
```
This will generate a base genesis file at `<path/to/zenith-stack>/base-genesis-file/genesis.json`.
@ -301,7 +301,7 @@ Note this private key down as it will be required in next step.
Now run the playbook to sign the gentx and generate final genesis file:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=sign"
zenith-ansible sign -i dev -s stage1
```
Use the private key noted above when prompted.
@ -318,7 +318,7 @@ This will:
Now, we can use this genesis file to run the stage 1 validator node:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=start" --skip-tags onboarding
zenith-ansible start -i dev -s stage1 --skip-tags onboarding
```
After starting the node, verify it's running correctly:
@ -450,13 +450,13 @@ cd $ZENITH_STACK_DIR/ansible
Stop validator deployment:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=stop" --skip-tags onboarding
zenith-ansible stop -i dev -s stage1 --skip-tags onboarding
```
Clean up validator deployment:
```bash
zenith-ansible -i ./inventories/development/hosts.yml stage1-site.yml -e "mode=cleanup" --skip-tags onboarding -K
zenith-ansible cleanup -i dev -s stage1 --skip-tags onboarding -K
```
### Python Virtual Environment