add readme to assist with geolocator deployment.

Canadian-Geospatial-Platform · Feb 7, 2024 · 2c3fa75 · 2c3fa75
1 parent 28bdeb6
commit 2c3fa75
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/lambda/geolocator/README.md b/docs/lambda/geolocator/README.md
@@ -0,0 +1,6 @@
+# README
+
+## Deployment quirks
+
+- the lambda name needs to change on every release to be correctly picked up by the cloudformation. this name change should be also reflected in the `geolocator-web-presence` cloudformation.
+- this lambda function references files from an s3 bucket at runtime. Theses files need to be deployed manually when geolocator is updated. The name of the bucket is specified in the `geolocator-web-presence` cloudformation.