azavea / cac-tripplanner

Clean Air Council Circuit Trip Planner and Travelshed

Clean Air Council Circuit Trip Planner and Travelshed

Development Dependencies

• Vagrant
• Ansible v4 (versions 6+ seem not to work)

Development Installation

1. Make sure you have the development dependencies installed
2. Place GTFS .zip files, OSM files, and elevation .tif files (optional) in the root of the otp_data folder
3. (Optional) Generate a graph file with (takes approx 3 hours) docker-compose run --rm otp otp --build /var/otp in the deployment/graph directory.
4. Copy deployment/ansible/group_vars/development_template to deployment/ansible/group_vars/development
5. Change into the src/ folder and run npm install to install the node modules on the host machine
6. Run vagrant up. You can choose to change the Virtualbox shared folder type for the app VM from its default NFS by:

CAC_APP_SHARED_FOLDER_TYPE=virtualbox vagrant up

7. See the app at http://localhost:8024! See OpenTripPlanner at http://localhost:9090.
8. Running ./scripts/serve-js-dev.sh on the host will rebuild the front-end app on file change (the browser must be reloaded manually to pick up the change). Alternatively, cd /opt/app/src && npm run gulp-development can be run manually in the VM to pick up changes to the static files.

Note that if there is an existing build Graph.obj in otp_data, vagrant provisioning in development mode will not attempt to rebuild the graph, but will use the one already present.

Django migrations are run as part of app provisioning, here, but there may be instances where you need to manually run migrations outside of provisioning, in which case use the command:

vagrant ssh app -c 'cd /opt/app/python/cac_tripplanner && python3 manage.py migrate'

Building AMIs

1. Configure an AWS profile with aws configure --profile gophillygo if you haven't already
2. Make a production group_vars file (similarly to how is described above with development). Make sure production is set to true, and also specify an app_username, which should be set to: ubuntu
3. If building the otp machine, make sure the latest GTFS are in otp_data, then build a graph when them in the development environment provisioning. This will result in a new Graph.obj file being written to otp_data.
4. Install the deployment dependencies, ideally in a virtualenv: python3 -m venv .venv && source .venv/bin/activate && pip install -r python/cac_tripplanner/deployment_requirements.txt
5. Build AMIs by running (within the virtualenv): AWS_PROFILE=gophillygo deployment/cac-stack.py create-ami
6. The previous command builds all AMIs. To only build a single AMI, run the same command, but also specify the --machine-type parameter, which may be set to one of: bastion, otp, or app.

Launching AWS Stacks

1. Copy deployment/default_template.yaml to deployment/default.yaml and edit variables
2. Configure an AWS profile with aws configure --profile gophillygo if you haven't already
3. Create a virtualenv with the deployment dependencies if you haven't already (see Building AMIs, above).
4. In the project directory, for a set of Blue stacks in the Production environment, run: AWS_PROFILE=gophillygo deployment/cac-stack.py launch-stacks --stack-color blue --stack-type prod
5. The previous command will do the following:

• Ensure the VPC stack is up in Production -- it will be launched if it isn't already running
• Ensure the DataPlane stack is up in Production -- it will be launched if it isn't already running
• Ensure the OtpServer Blue stack is up in Production -- it will be launched if it isn't already running
• Ensure the WebServer Blue stack is up in Production -- it will be launched if it isn't already running

4. Note that database migrations are not automatically run. When the DataPlane is first brought up, it is necessary to manually create the app user/db and run migrations.
5. Launching a set of Production stacks with the other color (Green), will use the same VPC and DataPlane stacks, but will create different OtpServer and WebServer stacks (if they don't already exist).

Production Blue/Green deployment

1. Note which color is currently running in production. Use the opposite color in the following steps.
2. Set otp_host in production group_vars to the CloudFront distribution with the desired color.
3. Run create_ami command to build new AMIs.
4. Update default.yaml with new AMI ids.
5. Run launch_stacks command to launch stacks with the desired color.
6. Test new stacks thoroughly.
7. Switch the public DNS record of the site to point to the new WebServer ELB DNS.
8. The stacks of the previous color may be deleted when ready.