cerc-io/laconicd-stack
15
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update instructions to setup and start tmkms service

Browse Source
This commit is contained in:
Shreerang Kale 2025-06-11 12:33:39 +05:30
parent c37e33e5e7
commit 0029ac5247
2 changed files with 46 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/run-first-validator.md
View File

@ -89,27 +89,6 @@
- For integrating TMKMS with laconicd, follow steps below in the machine where the TMKMS service is to be setup (machine 4)
- Copy the example variables file:
```bash
cp ~/cerc/laconicd-stack/playbooks/tmkms/tmkms-vars.example.yml ~/cerc/laconicd-stack/playbooks/tmkms/tmkms-vars.yml
```
- Update `~/cerc/laconicd-stack/playbooks/tmkms/tmkms-vars.yml` with required values:
NOTE: Use the `priv_validator_key.json` file copied from the node setup machine (Machine 2) in [previous step](#setup-node)
```yaml
# Absolute path to the node's private validator key file
priv_validator_key_file_path: "</path/to/priv_validator_key.json>"
# Set the IP address of the machine where the laconicd node is setup
node_ip: "<NODE_PUBLIC_IP_ADDRESS>"
# Set the port of the laconicd node
node_port: "26659"
```
- Export the data directory and TMKMS deployment directory as environment variables:
```bash
@ -223,6 +202,27 @@
- Run these steps in the machine where the TMKMS service is setup (machine 4)
- Copy the example variables file:
```bash
cp ~/cerc/laconicd-stack/playbooks/tmkms/tmkms-vars.example.yml ~/cerc/laconicd-stack/playbooks/tmkms/tmkms-vars.yml
```
- Update `~/cerc/laconicd-stack/playbooks/tmkms/tmkms-vars.yml` with required values:
NOTE: Use the `priv_validator_key.json` file copied from the node setup machine (Machine 2) in [previous step](#setup-node)
```yaml
# Absolute path to the node's private validator key file
priv_validator_key_file_path: "</path/to/priv_validator_key.json>"
# Set the IP address of the machine where the laconicd node is setup
node_ip: "<NODE_PUBLIC_IP_ADDRESS>"
# Set the port of the laconicd node
node_port: "26659"
```
- Run ansible playbook to run the TMKMS:
```bash
@ -232,7 +232,7 @@
- Check logs to ensure that TMKMS is running:
```bash
laconic-so deployment --dir $DATA_DIRECTORY/$TMKMS_DEPLOYMENT_DIR logs tmkms -f
laconic-so deployment --dir $DATA_DIRECTORY/tmkms-deployment logs tmkms -f
```
- Expected example output:

46
docs/run-validator.md
View File

@ -109,6 +109,25 @@
- For integrating TMKMS with laconicd, follow steps below in the machine where the TMKMS service is to be setup (machine 4)
- Export the data directory as environment variable:
```bash
# Parent directory where the deployment directory will live
export DATA_DIRECTORY=
```
- Run ansible playbook to setup the TMKMS service:
```bash
ansible-playbook -i localhost, -c local ~/cerc/laconicd-stack/playbooks/tmkms/setup-tmkms.yml
```
## Run Node
### Start TMKMS
- Run the following steps in the machine where the TMKMS service is setup (Machine 4)
- Copy the example variables file:
```bash
@ -130,25 +149,6 @@
node_port: "26659"
```
- Export the data directory as environment variable:
```bash
# Parent directory where the deployment directory will live
export DATA_DIRECTORY=
```
- Run ansible playbook to setup the TMKMS service:
```bash
ansible-playbook -i localhost, -c local ~/cerc/laconicd-stack/playbooks/tmkms/setup-tmkms.yml
```
## Run Node
### Start TMKMS
- Run the following steps in the machine where the TMKMS service is setup (Machine 4)
- Run ansible playbook to run the TMKMS:
```bash
@ -158,7 +158,7 @@
- Check logs to ensure that TMKMS is running:
```bash
laconic-so deployment --dir $DATA_DIRECTORY/$TMKMS_DEPLOYMENT_DIR logs tmkms -f
laconic-so deployment --dir $DATA_DIRECTORY/tmkms-deployment logs tmkms -f
```
- Expected example output:
@ -174,6 +174,10 @@
- Note the pubkey logged at start for comparing later with validator pubkey on chain
### Start Node
- Run the following steps in the machine where the validator node is setup (machine 2)
- Enable TMKMS in the laconicd node configuration:
```bash
@ -181,8 +185,6 @@
echo "TMKMS_ENABLED=true" >> $DATA_DIRECTORY/$MAINNET_DEPLOYMENT_DIR/config.env
```
### Start Node
- Start the laconicd node:
```bash