hackoregon / civic-devops

Master collection point for issues, procedures, and code to manage the HackOregon Civic platform
MIT License
11 stars 4 forks source link

Add Civic Sandbox to the CF cluster, and vet all documentation that it works for a new container #146

Closed MikeTheCanuck closed 5 years ago

MikeTheCanuck commented 6 years ago

Final API container to bring online is a new one that's being called "Civic Sandbox". There's no giant rush to get this online, but it needs to be there before Demo Day.

This will be our final opportunity to ensure that we have full documentation to clarify how to bring a new ECS service online. Anyone that works on this WILL write down any step they perform, any file or console they touch, before any changes are pubished to AWS. Don't care if you feel like you're in a rush, or want to look like a hero; the only heroes we need at this point are those who are comfortable taking copious notes.

I mean this. We lost months of head start because last year's ECS wrangler didn't leave behind useable documentation for this purpose. I will not allow us to exit this season leaving the same smoking crater for our future team (no matter how much we might dream of using sexier tooling to replace what we're doing) - let alone for the rest of the world who might wish to leverage our architecture for their own purposes. Working code is a start; useable documentation is the difference we will make for this world.

Goals

DingoEatingFuzz commented 6 years ago

If everything goes according to plan, the Civic Sandbox will only be a single API end point that references API endpoints in the existing django services.

Since this is the case, I think we'd be better off leaving it as a single lambda function.

Despite not being a fit for vetting our django documentation, this lambda infrastructure could and should still be documented and migrated to Cloud Formation.