Skip to content

README.md

Latest commit

 

History

History
55 lines (31 loc) · 2.75 KB

README.md

File metadata and controls

55 lines (31 loc) · 2.75 KB
Raw

VZ User & CR3 API

This API provides authenticated access to our CR3 crash report file repository in AWS S3 as well as Auth0 user management operations. It enables users to download CR3 PDFs from the Vision Zero Editor, and it enables admin users to create, modify, and delete VZE user accounts.

Deployment

The API consists of a flask app which is bundled into a docker image and pushed to Docker Hub. It is deployed on AWS ECS as a service inside the VZ clusters. There is a :production and :latest version of the image, and these are built by CI on merger to the production and main branches respectively.

Our endpoints can be found at:

These flask apps are deployed as long-running tasks in ECS and are reverse proxy'd out to the internet by an AWS API gateway via a namespace / VPC link configuration. Specific deployment instructions for the COA deployment are contained in our internal documentation repositories.

Configuration

The API requires certain environment variables to be set. Copy the .env.example file in the api directory to .env and fill in the values.

Local development

Copy the env_template file in this directory to .env. To fill in the missing secret values, see the DEVELOPMENT section of the Vision Zero (VZ) User & CR3 API Secrets item in 1pass.

Use the ./vision-zero helper tool to run the API docker container alongside the rest of local stack. Do this from the root of the repo using the vision-zero helper script:

./vision-zero local-stack-up

You can attach to the API container to stream its logs:

docker attach vision-zero-cr3-user-api-1

The docker compose enables local development by:

  • mounting your local /api directory into the container
  • using the --debug command so that the web server restarts when it detects code changes

When using the VZE, make sure your NEXT_PUBLIC_CR3_API_DOMAIN env var is set to http://localhost:8085 in your env.local file.

You can also individually start and stop the API container with ./vision-zero api-up and ./vision-zero api-down.

Tests

This API has some test coverage. See the testing README for details.

Secrets

Please see the entry "Vision Zero (VZ) User & CR3 API Secrets" in the developers vault in 1PW for information about the secret values.

Testing the API / Is this thing on?

Where ever you have the API running, you can hit it at the root of the domain / and you should get a health message that includes both the current time, but also the age of the process serving the API. This is helpful in confirming a restart has occurred, or that the API is up and running.