snowballtools-base-mirror/packages/deployer/README.md
Vivian Phung a4d9211ffe
Refactor(README.md) (#217)
This pull request refactors the main `README.md` by removing detailed backend and frontend setup instructions and adding separate `README.md` files for the backend and frontend with their specific setup and deployment instructions. This makes the main `README.md` cleaner and directs users to specific READMEs for backend and frontend setups.

---
2024-06-22 18:07:47 -04:00

1.6 KiB

deployer

  • Install dependencies

    yarn
    
    brew install jq # if you do not have jq installed already
    
  • Run script to deploy app

    • To deploy frontend app to dashboard.staging.apps.snowballtools.com

      ./deploy-frontend.staging.sh
      
    • To deploy frontend app to dashboard.apps.snowballtools.com

      ./deploy-frontend.sh
      
  • Commit the updated ApplicationRecord and ApplicationDeploymentRequest files to the repository

Notes

  • Any config env can be updated in records/application-deployment-request.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

  • Check deployment status in web-app deployer.

  • Check records in registry console app.

  • If deployment fails due to low bond balance

    • Check balances

      # Account balance
      yarn laconic cns account get
      
      # Bond balance
      yarn laconic cns bond get --id 99c0e9aec0ac1b8187faa579be3b54f93fafb6060ac1fd29170b860df605be32
      
    • Command to refill bond

      yarn laconic cns bond refill --id 99c0e9aec0ac1b8187faa579be3b54f93fafb6060ac1fd29170b860df605be32 --type aphoton --quantity 10000000