Add steps to update webapp deployer after code changes

This commit is contained in:
Adw8 2024-10-22 19:02:11 +05:30
parent 2a59e68b98
commit d0a81dacbd
2 changed files with 377 additions and 212 deletions

View File

@ -254,215 +254,3 @@ Instructions to reset / update the deployments
```
* The laconic console can now be viewed at <https://loro-console.laconic.com>
## Connect webapp-deployer with stage2 laconicd chain
Follow the steps given below to connect the webapp-deployer to stage2 laconicd
<details open>
<summary>Update laconic console config</summary>
### Update laconic console config
* Stop webapp deployer backend
```bash
laconic-so deployment --dir webapp-deployer stop
```
* Stop laconic-console and fixturenet-laconicd deployment
```bash
laconic-so deployment --dir fixturenet-laconicd-deployment stop
laconic-so deployment --dir laconic-console-deployment stop
```
* Update `laconic-console-deployment/config.env` with the following config
```bash
# private key to your funded account
CERC_LACONICD_USER_KEY=
# This will be updated later
CERC_LACONICD_BOND_ID=
# RPC endpoint of the chain
CERC_LACONICD_RPC_ENDPOINT=https://laconicd.laconic.com
# GQL endpoint of the chain
CERC_LACONICD_GQL_ENDPOINT=https://laconicd.laconic.com/api
# laconicd chain id
CERC_LACONICD_CHAIN_ID=laconic_9000-2
# Endpoint for the console
LACONIC_HOSTED_ENDPOINT=https://laconicd.laconic.com
```
* Start the `laconic-console-deployment`:
```bash
laconic-so deployment --dir laconic-console-deployment start
```
</details>
<details open>
<summary>Register an authority</summary>
### Register an authority
* Create a bond
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry bond create --type alnt --quantity 100000000000"
# {"bondId":"a742489e5817ef274187611dadb0e4284a49c087608b545ab6bd990905fb61f3"}
```
* Register an authority
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry authority reserve <authority_name>"
```
* Obtain the auction ID
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry authority whois <authority_name>"
# "auction": {
# "id": "73e0b082a198c396009ce748804a9060c674a10045365d262c1584f99d2771c1"
```
* Commit a bid using the auction ID. A reveal file will be generated
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry auction bid commit 73e0b082a198c396009ce748804a9060c674a10045365d262c1584f99d2771c1 5000000 alnt --chain-id laconic_9000-2"
# {"reveal_file":"/app/out/bafyreiewi4osqyvrnljwwcb36fn6sr5iidfpuznqkz52gxc5ztt3jt4zmy.json"}
```
* Reveal a bid using the auction ID and the reveal file generated from the bid commit
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry auction bid reveal 73e0b082a198c396009ce748804a9060c674a10045365d262c1584f99d2771c1 /app/out/bafyreiewi4osqyvrnljwwcb36fn6sr5iidfpuznqkz52gxc5ztt3jt4zmy.json --chain-id laconic_9000-2"
# {"success": true}
```
* Verify status after the auction ends. It should list a completed status and a winner
```
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry auction get 73e0b082a198c396009ce748804a9060c674a10045365d262c1584f99d2771c1"
```
* Set the authority using a bond ID.
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry authority bond set <authority_name> a742489e5817ef274187611dadb0e4284a49c087608b545ab6bd990905fb61f3"
# {"success": true}
```
* Verify the authority has been registered.
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry authority whois <authority_name>"
```
* Stop the laconic-console-deployment
```bash
laconic-so deployment --dir laconic-console-deployment stop
```
* Update `CERC_LACONICD_BOND_ID` in `laconic-console-deployment/config.env` with the bond that was created
```bash
...
CERC_LACONICD_BOND_ID=a742489e5817ef274187611dadb0e4284a49c087608b545ab6bd990905fb61f3
...
```
* Start the `laconic-console-deployment`:
```bash
laconic-so deployment --dir laconic-console-deployment start
```
</details>
<details open>
<summary>Publish record for webapp-deployer</summary>
### Publish record for webapp-deployer
* Update `webapp-deployer/data/config/laconic.yml` with the
```bash
services:
registry:
# laconicd RPC endpoint
rpcEndpoint: 'https://laconicd.laconic.com'
# laconicd GQL endpoint
gqlEndpoint: 'https://laconicd.laconic.com/api'
# Key to your funded account
userKey:
# bondId that you just created
bondId: a742489e5817ef274187611dadb0e4284a49c087608b545ab6bd990905fb61f3
# laconicd chain id
chainId: laconic_9000-2
gas: 200000
fees: 500000alnt
```
* Publish the webapp deployer record using the publish-deployer-to-registry command
```bash
laconic-so publish-deployer-to-registry \
--laconic-config webapp-deployer/data/config/laconic.yml \
--api-url <api-url-for-your-deployer>
--public-key-file <path-to-your-gpg-pub-key> \
--lrn <lrn-for-your-deployer> \
--min-required-payment 0
```
* Update `webapp-deployer/config.env` with the authority that you reserved
```bash
# Name of reserved authority
DEPLOYMENT_RECORD_NAMESPACE="<authority_name>"
```
</details>
<details open>
<summary>Start the deployer</summary>
### Start the deployer
* Start the webapp deployer
```bash
laconic-so deployment --dir webapp-deployer start
```
* Get the most recent pod id:
```bash
kubie ctx default
kubectl get pods
```
* Copy the GPG key file to the webapp-deployer container:
```bash
# Get the webapp-deployer pod id
kubectl get pods --sort-by=.metadata.creationTimestamp -o jsonpath='{.items[-1].metadata.name}'
# laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs
# Copy the GPG key files to the pod
kubectl cp <path-to-your-gpg-private-key> laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs:/app
kubectl cp <path-to-your-gpg-public-key> laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs:/app
```
</details>

View File

@ -0,0 +1,377 @@
## Update webapp deployer after code changes
* Stop the deployer
```bash
cd <path-to-deployments>
laconic-so deployment --dir webapp-deployer stop
laconic-so deployment --dir webapp-ui stop
```
* Fetch and build webapp deployer backend if the source code has changed
```bash
# Update code for webapp-deployer backend
cd ~/cerc/webapp-deployment-status-api
# Pull latest changes, or checkout to the required branch
git pull
# Confirm the latest commit hash
git log
# Rebuild the containers
laconic-so --stack webapp-deployer-backend build-containers --force-rebuild
```
* Fetch and build webapp-ui if the source code has changed
```bash
# Update code for webapp-deployer backend
cd ~/cerc/webapp-deployment-status-ui
# Pull latest changes, or checkout to the required branch
git pull
# Confirm the latest commit hash
git log
# Rebuild the containers
laconic-so build-webapp --source-repo ~/cerc/webapp-deployment-status-ui --force-rebuild
cd <path-to-deployments>
```
* Push images to the container registry
* login to the container registry
```bash
# Set required variables
CONTAINER_REGISTRY_URL=
CONTAINER_REGISTRY_USERNAME=
CONTAINER_REGISTRY_PASSWORD=
# login to container registry
docker login $CONTAINER_REGISTRY_URL --username $CONTAINER_REGISTRY_USERNAME --password $CONTAINER_REGISTRY_PASSWORD
# WARNING! Using --password via the CLI is insecure. Use --password-stdin.
# WARNING! Your password will be stored unencrypted in /home/dev2/.docker/config.json.
# Configure a credential helper to remove this warning. See
# https://docs.docker.com/engine/reference/commandline/login/#credential-stores
# Login Succeeded
```
* Push images to container registry
```bash
laconic-so deployment --dir webapp-deployer push-images
laconic-so deployment --dir webapp-ui push-images
```
* Update `webapp-deployer/data/config/laconic.yml` with the new endpoints
```bash
services:
registry:
rpcEndpoint: 'https://laconicd-sapo.laconic.com'
gqlEndpoint: 'https://laconicd-sapo.laconic.com/api'
userKey: "<userKey>"
bondId: "<bondId"
chainId: laconic-testnet-2
gas: 200000
fees: 200000alnt
```
Note: Same `userKey` and `bondId` can be used since they are carried over from laconicd stage1 to testnet2
* Publish the webapp deployer record on the chain if it doesn't already exist
* Set the following variables
```bash
# Path to the webapp-deployer directory, e.g., /home/dev..
DEPLOYER_DIR=
# API URL of the webapp-deployer
API_URL=
# LRN (logical resource name) of the webapp-deployer
DEPLOYER_LRN=
# Name of the GPG public key file
GPG_PUB_KEY_FILE=
# Path of the GPG public key file
GPG_PUB_KEY_FILE_PATH=
```
* Copy the GPG pub key file used while setting up the webapp-deployer to the `webapp-deployer/data/config` directory. This ensures the Docker container has access to the key during the publish process.
```bash
cp $GPG_PUB_KEY_FILE_PATH webapp-deployer/data/config
```
* Publish the deployer record
```bash
docker run -i -t \
-v $DEPLOYER_DIR/data/config:/home/root/config \
cerc/webapp-deployer-backend:local laconic-so publish-deployer-to-registry \
--laconic-config /home/root/config/laconic.yml \
--api-url $API_URL \
--public-key-file /home/root/config/$GPG_PUB_KEY_FILE \
--lrn $DEPLOYER_LRN \
--min-required-payment 0
```
* Update the webapp deployer config
```bash
# Update the webapp deployer lrn if it has changed
LRN=
# Add the following so the webapp deployer will support auction requests
export HANDLE_AUCTION_REQUESTS=true
# Amount that the webapp deployer will bid on auctions
export AUCTION_BID_AMOUNT=50000
```
* Start the webapp deployer
```bash
laconic-so deployment --dir webapp-deployer start
```
* Copy the GPG key file to the webapp-deployer container
```bash
# Get the webapp-deployer pod id
kubectl get pods --sort-by=.metadata.creationTimestamp -o jsonpath='{.items[-1].metadata.name}'
# laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs
# Copy the GPG key files to the pod
kubectl cp <path-to-your-gpg-private-key> laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs:/app
kubectl cp <path-to-your-gpg-public-key> laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs:/app
```
* Update the webapp ui config
```bash
# URL of the webapp deployer backend
LACONIC_HOSTED_CONFIG_app_api_url=
# URL of the laconic console
LACONIC_HOSTED_CONFIG_app_console_link=https://console-sapo.laconic.com
```
* Start the webapp ui
```bash
laconic-so deployment --dir webapp-ui start
```
## Connect webapp-deployer to testnet2
Follow the steps given below to connect the webapp-deployer to testnet2
<details open>
<summary>Update laconic console config</summary>
### Update laconic console config
* Stop webapp deployer backend
```bash
laconic-so deployment --dir webapp-deployer stop
```
* Stop laconic-console and fixturenet-laconicd deployment
```bash
laconic-so deployment --dir fixturenet-laconicd-deployment stop
laconic-so deployment --dir laconic-console-deployment stop
```
* Update `laconic-console-deployment/config.env` with the following config
```bash
# private key to your funded account
CERC_LACONICD_USER_KEY=
# This will be updated later
CERC_LACONICD_BOND_ID=
# RPC endpoint of the chain
CERC_LACONICD_RPC_ENDPOINT=https://laconicd-sapo.laconic.com
# GQL endpoint of the chain
CERC_LACONICD_GQL_ENDPOINT=https://laconicd-sapo.laconic.com/api
# laconicd chain id
CERC_LACONICD_CHAIN_ID=laconic_9000-2
# Endpoint for the console
LACONIC_HOSTED_ENDPOINT=https://console-sapo.laconic.com
```
* Start the `laconic-console-deployment`
```bash
laconic-so deployment --dir laconic-console-deployment start
```
</details>
<details open>
<summary>Register an authority</summary>
### Register an authority
* Create a bond
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry bond create --type alnt --quantity 100000000000"
# {"bondId":"a742489e5817ef274187611dadb0e4284a49c087608b545ab6bd990905fb61f3"}
```
* Register an authority
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry authority reserve <authority_name>"
```
* Obtain the auction ID
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry authority whois <authority_name>"
# "auction": {
# "id": "73e0b082a198c396009ce748804a9060c674a10045365d262c1584f99d2771c1"
```
* Commit a bid using the auction ID. A reveal file will be generated
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry auction bid commit 73e0b082a198c396009ce748804a9060c674a10045365d262c1584f99d2771c1 5000000 alnt --chain-id laconic_9000-2"
# {"reveal_file":"/app/out/bafyreiewi4osqyvrnljwwcb36fn6sr5iidfpuznqkz52gxc5ztt3jt4zmy.json"}
```
* Reveal a bid using the auction ID and the reveal file generated from the bid commit
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry auction bid reveal 73e0b082a198c396009ce748804a9060c674a10045365d262c1584f99d2771c1 /app/out/bafyreiewi4osqyvrnljwwcb36fn6sr5iidfpuznqkz52gxc5ztt3jt4zmy.json --chain-id laconic_9000-2"
# {"success": true}
```
* Verify status after the auction ends. It should list a completed status and a winner
```
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry auction get 73e0b082a198c396009ce748804a9060c674a10045365d262c1584f99d2771c1"
```
* Set the authority using a bond ID.
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry authority bond set <authority_name> a742489e5817ef274187611dadb0e4284a49c087608b545ab6bd990905fb61f3"
# {"success": true}
```
* Verify the authority has been registered.
```bash
laconic-so deployment --dir laconic-console-deployment exec cli "laconic registry authority whois <authority_name>"
```
* Stop the laconic-console-deployment
```bash
laconic-so deployment --dir laconic-console-deployment stop
```
* Update `CERC_LACONICD_BOND_ID` in `laconic-console-deployment/config.env` with the bond that was created
```bash
...
CERC_LACONICD_BOND_ID=a742489e5817ef274187611dadb0e4284a49c087608b545ab6bd990905fb61f3
...
```
* Start the `laconic-console-deployment`
```bash
laconic-so deployment --dir laconic-console-deployment start
```
</details>
<details open>
<summary>Publish record for webapp-deployer</summary>
### Publish record for webapp-deployer
* Update `webapp-deployer/data/config/laconic.yml` with the
```bash
services:
registry:
# laconicd RPC endpoint
rpcEndpoint: 'https://laconicd-sapo.laconic.com'
# laconicd GQL endpoint
gqlEndpoint: 'https://laconicd-sapo.laconic.com/api'
# Key to your funded account
userKey:
# bondId that you just created
bondId: a742489e5817ef274187611dadb0e4284a49c087608b545ab6bd990905fb61f3
# laconicd chain id
chainId: laconic_9000-2
gas: 200000
fees: 500000alnt
```
* Publish the webapp deployer record using the publish-deployer-to-registry command
```bash
laconic-so publish-deployer-to-registry \
--laconic-config webapp-deployer/data/config/laconic.yml \
--api-url <api-url-for-your-deployer>
--public-key-file <path-to-your-gpg-pub-key> \
--lrn <lrn-for-your-deployer> \
--min-required-payment 0
```
* Update `webapp-deployer/config.env` with the authority that you reserved
```bash
# Name of reserved authority
DEPLOYMENT_RECORD_NAMESPACE="<authority_name>"
```
</details>
<details open>
<summary>Start the deployer</summary>
### Start the deployer
* Start the webapp deployer
```bash
laconic-so deployment --dir webapp-deployer start
```
* Get the most recent pod id
```bash
kubie ctx default
kubectl get pods
```
* Copy the GPG key file to the webapp-deployer container
```bash
# Get the webapp-deployer pod id
kubectl get pods --sort-by=.metadata.creationTimestamp -o jsonpath='{.items[-1].metadata.name}'
# laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs
# Copy the GPG key files to the pod
kubectl cp <path-to-your-gpg-private-key> laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs:/app
kubectl cp <path-to-your-gpg-public-key> laconic-ac473c31db9ac9fd-deployment-674bf7bf9f-529bs:/app
```
</details>