diff --git a/README.md b/README.md index e04a510..b2afdeb 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,11 @@ _Likely to change soon._ * PekkoHTTP * Nginx +### Cloud +* AWS Lambda (for [clustering](serverless/alpr_clusters) and [counts](serverless/alpr_counts)) +* AWS S3 +* AWS ECR + ### Frontend * Vue3 * Vuetify (UI component library) diff --git a/serverless/README.md b/serverless/README.md new file mode 100644 index 0000000..c76ed6d --- /dev/null +++ b/serverless/README.md @@ -0,0 +1,3 @@ +# Serverless + +These microservices collect additional data used in DeFlock, such as total ALPR counts and map clusters. diff --git a/serverless/alpr_clusters/READEME.md b/serverless/alpr_clusters/READEME.md new file mode 100644 index 0000000..17c19c7 --- /dev/null +++ b/serverless/alpr_clusters/READEME.md @@ -0,0 +1,6 @@ +# ALPR Clusters + +Generates clusters (the blobs shown on the map when zoomed out far) daily using OSM data. OSM's Overpass API is used to query for all locations of ALPRs, then a clustering algorithm is used. The clustered data is stored in a JSON file in an S3 bucket. + +## Deploying +To build and deploy the Docker image, run `./deploy.sh`. diff --git a/serverless/alpr_counts/READEME.md b/serverless/alpr_counts/READEME.md new file mode 100644 index 0000000..5c54136 --- /dev/null +++ b/serverless/alpr_counts/READEME.md @@ -0,0 +1,6 @@ +# ALPR Counts + +Counts total ALPRs reported in the OSM database, hourly. OSM's Overpass API is used to query for counts of all ALPRs and ALPRs in the United States. The counts are stored in a JSON file in an S3 bucket. + +## Deploying +This Lambda uses a zip file, so from the `/terraform` directory, you can run `terraform apply` after making changes, and it should detect the changes, rebuild the zip, and update the Lambda's function code.