hotosm / OpenMapKitServer

OpenMapKit Server is the lightweight server component of OpenMapKit that handles the collection and aggregation of OpenStreetMap and OpenDataKit data.
http://openmapkit.org
BSD 3-Clause "New" or "Revised" License
4 stars 9 forks source link

Document stack creation, updation and deletion #104

Open arunasank opened 5 years ago

arunasank commented 5 years ago

This will fix the following from #93

Task Description Expected timeline Owner Status
Write up detailed documentation on stack creation/updation/deletion @willemarcel and I are super excited to move away from console-dependent deploys to 🍿-time deploys, which is what we'll have after we set up all our tasks on CloudFormation.! This task will involve writing up detailed documentation for the ✨ new ✨ way to deploy. End Feb @ramyaragupathy

👋 @ramyaragupathy this is a ticket to include the process of creating, updating and deleting stacks using cfn-config.

Besides the commands to create, update and delete stacks, we should include a table of the Stack Parameters and what the value of each represents, and how its value should be determined. This is particularly critical when creating a brand new OpenMapKitServer instance, in which case, we will want to document how to create an S3 bucket and prefix, and that the users.json must be copied over to s3://<UsersS3Bucket>/<OMK_stack_name>/users.json etc.