Skip to content

Latest commit

 

History

History
97 lines (76 loc) · 4.41 KB

README.md

File metadata and controls

97 lines (76 loc) · 4.41 KB
Raw

analytics.ct.gov Deployment Scripts

This is the main repository for deploying the project. It contains the scripts necessary to deploy analytics.ct.gov to CT’s servers.

Setting up .env and key.json file

  1. Follow the setup instructions on Analytics-reporter setup instructions
  2. Create a file called key.json inside of the tasks\analytics-reporter\ folder and add the API keys that were collected from Google apis as described in Analytics-reporter setup instructions.
  3. Create a file called .env inside of the tasks\analytics-reporter\ folder add the following variables as described in Analytics-reporter setup instructions. 
    export ANALYTICS_REPORT_EMAIL="<service email>"
export ANALYTICS_REPORT_IDS="<report id>"
export ANALYTICS_KEY_PATH="./key.json"

There are three main entry points:

  1. deploy-site.ps1
  2. deploy-reports.ps1
  3. deploy-report-schedules.ps1

deploy-site.ps1

Description

This script is run locally on a Windows machine connected to the VPN. The script clones the analytics.ct.gov repository, builds the project with bundler and jekyll, removing development files. It next opens a winscp connection, syncing the local copy of the website to the server, removing outdated files on the server.

Requirements

  1. ruby 2.4.3
  2. bundler

Usage

.\deploy-site.ps1 -UserName "Username" -Password "Password" -HostIP "HostIP" -HostKey "Hostkey"

deploy-reports.ps1

Description

This script is run locally on a Windows machine connected to the VPN. The script creates a WinSCP connection using the Powershell DLL module. With this session, it uploads the .\tasks folder of the analytics.ct.gov-deployment project. It then closes this WinSCP connection.

Requirements

WinSCPnet.dll

Usage

.\deploy-reports.ps1 -UserName "Username" -Password "Password" -HostIP "HostIP" -HostKey "Hostkey" -ProjectLocation "ProjectLocation" -OutputDirectory "OutputDirectory"

Parameters descriptions

ProjectLocation: the location of keys, env scripts, and reports. Should be one of: \analytics-backend OR E:\???\wwwroot\analytics-backend

OutputDirectory: the location of where the scripts place the reports. Should be one of: \analytics\data OR E:\???\wwwroot\analytics\data

deploy-report-schedules.ps1

Description

This script creates an SSH tunnel to start a Powershell instance and run the .\create_tasks.ps1 script on the server.

Requirements

WinSCPnet.dll

Usage

.\deploy-report-schedules.ps1 -UserName "Username" -HostIP "HostIP" -HostKey "Hostkey" -ProjectLocation "ProjectLocation" -OutputDirectory "OutputDirectory"

Parameters descriptions

ProjectLocation: the location of keys, env scripts, and reports. Should be one of: \analytics-backend OR E:\???\wwwroot\analytics-backend

OutputDirectory: the location of where the scripts place the reports. Should be one of: \analytics\data OR E:\???\wwwroot\analytics\data

Other scripts

tasks\create_tasks.ps1

Description

This script is run on the remote machine. It is invoked by the deploy-reports.ps1 script. It starts by running teardown_tasks.ps1 to clean up previously deployed tasks. It then runs npm install to install all the node dependencies for the analytics reports. It next invokes schtasks several times with the different frequencies. The scheduled task runs a powershell instance that immediately invokes the task.ps1 script with supplied parameters.

Usage

Note: This script is not invoked directly by the user.

.\create_tasks.ps1 -ProjectLocation "ProjectLocation" -OutputDirectory "OutputDirectory"

Requirements (on server)

  1. Powershell
  2. Schtasks
  3. Node, npm, npx

task\tasks.ps1

Description

This script is run on the remote machine. It is invoked by the scheduled tasks (created by “create_tasks.ps1”). This script sources the environment variables for the CT context. It then creates the output directory, if it doesn’t already exist. Finally, it runs the analytics reporter via npx.

Usage

Note: This script is not invoked directly by the user.

.\task.ps1 -ProjectLocation "ProjectLocation" -OutputDirectory "OutputDirectory" -Frequency "Frequency"

Requirements (on server)

  1. Node, npm, npx