You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Nick 2455e0d997
Merge pull request #293 from openaddresses/batch-alarm
1 week ago
.circleci Add python 4 weeks ago
.github Reposition envs 7 months ago
api Update csv-stringify 1 week ago
cloudformation Add UI support 2 weeks ago
docs Update size 1 year ago
task Simplify level-override 1 week ago
.deploy Remove lambda calls 1 year ago
.eslintrc.json Add mjs support for ESLint 4 weeks ago
.gitignore Add final collection tests 1 year ago
LICENSE Generate Borders File 2 months ago Add JSON Schemas for all endpoints 1 year ago
clone Add clone script 2 years ago
codecov.yml Add codecov 2 years ago
docker-compose.yml Add docker-compose file 1 year ago
package-lock.json Update batch-alarms 1 week ago
package.json Update batch-alarms 1 week ago
test Unique test runner 7 months ago

OpenAddresses Batch


Before you are able to deploy infrastructure you must first setup the OpenAddresses Deploy tools

Once these are installed, you can create the production stack via: (Note: it should already exist!)

deploy create production

Or update to the latest GitSha or CloudFormation template via

deploy update production


Whenever you deploy, you will be prompted for the following parameters


On every commit, GitHub actions will build the latest Docker image and push it to the batch ECR. This parameter will be populated automatically by the deploy cli and simply points the stack to use the correspondingly Docker image from ECR.


A read-only Mapbox API token for displaying base maps underneath our address data. (Token should start with pk.)


The bucket in which assets should be saved to. See the S3 Assets section of this document for more information


The branch with which weekly sources should be built from. When deployed into production this is generally master. When testing new features this can be any openaddresses/openaddresses branch.


The AWS RDS database class that powers the backend.


The password to set on the backend database. Passed to the API via docker env vars


API functions that are public currently do not require any auth at all. Internal functions however are protected by a stack-wide shared secret. This secret is an alpha-numeric string that is included in a secret header, to authenticate internal API calls.

This value can be any secure alpha-numeric combination of characters and is safe to change at any time.


This is the secret that Github uses to sign API events that are sent to this API. This shared signature allows us to verify that events are from github. Only the production stack should use this parameter.


The project is divided into several componenets

Component Purpose
cloudformation Deploy Configuration
api Dockerized server for handling all API interactions
api/web Subfolder for UI specific components
cli CLI for manually queueing work to batch
lambda Lambda responsible for instantiating a batch job environement and submitting it
task Docker container for running a batch job

S3 Assets

By default, processed job assets are uploaded to the bucket in the following format


Manual sources (sources that are cached to s3 via the upload tool), are in the following format



API documentation is availiable here


In order to set up an effective dev environment, first obtain a copy of the metastore.

Create a local

./clone prod

Then from the /api directory, run

npm run dev

Now, to build the latest UI, navigate to the /api/web directory in a seperate tab, and run:

npm run build --watch

Note: changes to the website will now to automatically rebuilt, just refresh the page to see them.

Finally, to access the api, navigate to http://localhost:5000 in your web browser.


All data is persisted in an AWS RDS managed postgres database.