Document Release & Deploy Process

[Mr0grog]

We need to actually document our release and deployment processes. We should:

• Briefly describe them in this repo. (Projects have a release branch that auto-builds & publishes Docker images; we deploy them manually and store Kubernetes, etc. configs in -ops.) (PR: Remove deployment plan from architecture overview #140) (Update: ultimately decided to just delete this info, since it’s too easy to get out of sync with web-monitoring-ops.)

• In -ops, explain:

  • How we update configs and use Docker image tags
  • Where we publish/pull Docker images from (https://hub.docker.com/u/envirodgi)
  • How we deploy other stuff (the manually-managed folder)
  • Proposed changes: Reorganize Documentation and Write a Real README web-monitoring-ops#27

• In code repos, explain how release branch works.

  • -ui (Describe release process web-monitoring-ui#420)
  • -db (Describe release process web-monitoring-db#617)
  • -processing (Describe release process web-monitoring-processing#496)
  • ❌ -versionista-scraper (not really applicable)

[SYU15]

Thanks for creating this issue! Agreed this would be very helpful. Also could we maybe include a list of people who have deployment credentials so we know who to go to if there are production issues?

Seems like this documentation is out of date: https://github.com/edgi-govdata-archiving/web-monitoring/blob/master/ARCHITECTURE.md#deployment-plan. Is this where you were planning on adding it? Otherwise perhaps it can be removed to avoid confusion.

[Mr0grog]

Seems like this documentation is out of date: /ARCHITECTURE.md@master#deployment-plan

Oh geez, yeah, that’s super out of date. We’ve been running everything on AWS and mostly on Kubernetes for a while now.

That might be the right place to put this stuff, but maybe it needs to be a separate doc. Haven’t thought it through — made this issue to dump a quick outline down before I forgot it.

[Mr0grog]

Added a PR to update the architecture doc in #140.

[Mr0grog]

This is done!