Add deployer package for frontend app (#123)

* Add script and records for deploying frontend app * Update readme with steps for new deployment * Add troubleshooting section * Move config env update * Add step to commit updated records * Bump record version
2024-02-27 11:52:05 +05:30
parent c731dd308c
commit cc4e5fd627
8 changed files with 193 additions and 4 deletions
@@ -0,0 +1,86 @@
+# deployer
+
+- Install dependencies
+  ```bash
+  yarn
+  ```
+
+- Replace variables in the following files
+  - [records/application-deployment-request.yml](records/application-deployment-request.yml)
+    - `<CURRENT_DATE_TIME>`: Replace with current time which can be generated by command `date -u`
+      ```yml
+      # Example
+      record:
+        ...
+        meta:
+          note: Added by Snowball @ Friday 23 February 2024 06:35:50 AM UTC
+          ...
+      ```
+
+- Update record version in [records/application-record.yml](records/application-record.yml)
+  ```yml
+  record:
+    type: ApplicationRecord
+    version: <NEW_VERSION>
+    ...
+  ```
+
+- Update commit hash in the following places:
+  - [records/application-record.yml](records/application-record.yml)
+    ```yml
+    record:
+      ...
+      repository_ref: <COMMIT_HASH>
+      ...
+    ```
+  - [records/application-deployment-request.yml](records/application-deployment-request.yml)
+    ```yml
+    record:
+      ...
+      meta:
+        ...
+        repository_ref: <COMMIT_HASH>
+    ```
+  - [deploy-frontend.sh](deploy-frontend.sh)
+    ```bash
+    ...
+    RCD_APP_VERSION="0.1.0"
+    REPO_REF="<COMMIT_HASH>"
+    ...
+    ```
+
+- Run script to deploy app
+  ```
+  ./deploy-frontend.sh
+  ```
+
+- Commit the updated [ApplicationRecord](records/application-record.yml) and [ApplicationDeploymentRequest](records/application-deployment-request.yml) files to the repository
+
+## Notes
+
+- Any config env can be updated in [records/application-deployment-request.yml](records/application-deployment-request.yml)
+  ```yml
+  record:
+    ...
+    config:
+      env:
+        LACONIC_HOSTED_CONFIG_app_server_url: https://snowballtools-base-api-001.apps.snowballtools.com
+        ...
+  ```
+  - On changing `LACONIC_HOSTED_CONFIG_app_github_clientid`, the GitHub client ID and secret need to be changed in backend config too
+
+## Troubleshoot
+
+- If deployment fails due to low bond balance
+  - Check balances
+    ```bash
+    # Account balance
+    yarn laconic cns account get
+
+    # Bond balance
+    yarn laconic cns bond get --id 8fcf44b2f326b4b63ac57547777f1c78b7d494e5966e508f09001af53cb440ac
+    ```
+  - Command to refill bond
+    ```bash
+    yarn laconic cns bond refill --id 8fcf44b2f326b4b63ac57547777f1c78b7d494e5966e508f09001af53cb440ac --type aphoton --quantity 10000000
+    ```
@@ -0,0 +1,9 @@
+services:
+  cns:
+    restEndpoint: http://console.laconic.com:1317
+    gqlEndpoint: http://console.laconic.com:9473/api
+    chainId: laconic_9000-1
+    gas: 1000000
+    fees: 200000aphoton
+    userKey: 0524fc22ea0a12e6c5cc4cfe08e73c95dffd0ab5ed72a59f459ed33134fa3b16
+    bondId: 8fcf44b2f326b4b63ac57547777f1c78b7d494e5966e508f09001af53cb440ac
@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Reference: https://git.vdb.to/cerc-io/test-progressive-web-app/src/branch/main/scripts
+
+RECORD_FILE=records/application-record.yml
+CONFIG_FILE=config.yml
+RCD_APP_VERSION="0.1.0"
+REPO_REF="353fd0f6219a955be186b5914e93baa9058b4473"
+
+# Publish ApplicationRecord
+RECORD_ID=$(yarn --silent laconic -c $CONFIG_FILE cns record publish --filename $RECORD_FILE | jq -r '.id')
+echo "ApplicationRecord published"
+echo $RECORD_ID
+
+# Set name to record
+REGISTRY_APP_CRN="crn://snowballtools/applications/snowballtools-base-frontend"
+
+yarn --silent laconic -c $CONFIG_FILE cns name set "$REGISTRY_APP_CRN@${RCD_APP_VERSION}" "$RECORD_ID"
+yarn --silent laconic -c $CONFIG_FILE cns name set "$REGISTRY_APP_CRN@${REPO_REF}" "$RECORD_ID"
+# Set name if latest release
+yarn --silent laconic -c $CONFIG_FILE cns name set "$REGISTRY_APP_CRN" "$RECORD_ID"
+echo "$REGISTRY_APP_CRN set for ApplicationRecord"
+
+# Check if record found for REGISTRY_APP_CRN
+APP_RECORD=$(yarn --silent laconic -c $CONFIG_FILE cns name resolve "$REGISTRY_APP_CRN" | jq '.[0]')
+if [ -z "$APP_RECORD" ] || [ "null" == "$APP_RECORD" ]; then
+  echo "No record found for $REGISTRY_APP_CRN."
+  exit 1
+fi
+
+RECORD_FILE=records/application-deployment-request.yml
+
+DEPLOYMENT_REQUEST_ID=$(yarn --silent laconic -c $CONFIG_FILE cns record publish --filename $RECORD_FILE | jq -r '.id')
+echo "ApplicationDeploymentRequest published"
+echo $DEPLOYMENT_REQUEST_ID
@@ -0,0 +1,9 @@
+{
+  "name": "deployer",
+  "version": "1.0.0",
+  "main": "index.js",
+  "private": true,
+  "devDependencies": {
+    "@cerc-io/laconic-registry-cli": "^0.1.10"
+  }
+}
@@ -0,0 +1,21 @@
+record:
+  type: ApplicationDeploymentRequest
+  version: '1.0.0'
+  name: snowballtools-base-frontend@0.1.0
+  application: crn://snowballtools/applications/snowballtools-base-frontend@0.1.0
+  dns: dashboard
+  config:
+    env:
+      LACONIC_HOSTED_CONFIG_app_server_url: https://snowballtools-base-api-001.apps.snowballtools.com
+      # If GitHub client ID is changed, same ID and corresponding secret has to be set in backend config
+      LACONIC_HOSTED_CONFIG_app_github_clientid: 1ed99146e0d07aa62d44
+      LACONIC_HOSTED_CONFIG_app_github_templaterepo: deep-stack/test-progressive-web-app
+      # New config env after changes for image upload PWA
+      LACONIC_HOSTED_CONFIG_app_github_pwa_templaterepo: deep-stack/test-progressive-web-app
+      LACONIC_HOSTED_CONFIG_app_github_image_upload_templaterepo: deep-stack/image-upload-pwa-example
+      LACONIC_HOSTED_CONFIG_app_wallet_connect_id: eda9ba18042a5ea500f358194611ece2
+  meta:
+    # Set CURRENT_DATE_TIME; Use command date -u
+    note: Added by Snowball @ <CURRENT_DATE_TIME>
+    repository: "https://git.vdb.to/cerc-io/snowballtools-base"
+    repository_ref: 353fd0f6219a955be186b5914e93baa9058b4473
@@ -0,0 +1,10 @@
+record:
+  type: ApplicationRecord
+  version: 0.0.5
+  repository_ref: 353fd0f6219a955be186b5914e93baa9058b4473
+  repository: ["https://git.vdb.to/cerc-io/snowballtools-base"]
+  app_type: webapp
+  # name is set to repo name
+  name: snowballtools-base-frontend
+  # app_version is set from package.json
+  app_version: 0.1.0