Clean up ESAP deployment instructions
We have a surprising amount of documentation about how to deploy ESAP (hooray!). For example, I found:
- https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/running%20in%20local%20development
- https://git.astron.nl/astron-sdc/esap-api-gateway/-/tree/master/esap/docker/ska
- https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/running%20in%20Docker%20in%20production
- https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/ESAP-API-build-&-deploy
etc.
However, these aren't all consistent with each other (e.g. some of them tell me that a $HOME/shared
directory is required, while others disagree), are pretty confusingly named (there's nothing SKA-specific about the SKA instructions, for example), and I'm pretty sure that the myriad of docker-compose files aren't all documented (e.g. docker-compose-esap-acc-cd.yml
— maybe there's a wiki page about that somewhere, but I didn't find it).
It feels like it would be worthwhile to take a step back and try to rationalize some of this documentation to provide a set of unambiguous best practices and recommendations