chaoss
Update docs for running in production
This is an issue to track changes that need to be made to the "how to run augur in production" section of the docs
Changes to potentially add/mention/include (unless specified by a maintainer, do one of these per pull request):
- https://github.com/chaoss/augur/pull/3221
- https://github.com/chaoss/augur/issues/3231#issuecomment-3179446607
- Mention https://github.com/oss-aspen/infra-ansible/ ?
- mention https://github.com/chaoss/augur-utilities/ ?
- document all the environment variables in use (maybe in the README?)
- mention that the shm-size set in docker should be increased and should correlate with whats set in the postgres config for shared memory size
- https://github.com/chaoss/augur/pull/3337 the worker counts need updating to values that better match the system that augur is installed on
- recommendations to tune postgres based on your server
yeah i think it is still open - I just briefly checked the docs and it seems like they still need updating to mention many of the things above, and potentially also including testing to make sure the current instructions (which seem to use the makefile method) still work.
i think @raisuraj2004 had a decent start on this in #3260 as well (although i havent fully reviewed it). maybe you can both collaborate on this for hacktoberfest?
hey!
I'd like to take up this issue, it'll be my first contribution. I plan to add a new how_to_run_augur_in_production.md file in the docs/ folder and raise a PR documenting the AUGUR_RESET_LOGS environment variable.
You're welcome to take this on! Make sure you take a look at the previous linked attempts at this to help you (both as an outline of what you may want to do, and also to see if you would do anything differently).
Feel free to reach out in the #wg-augur-8knot channel on slack (see here for join link) if you want to chat or run into issues!
hey,
Created a PR for the how_to_run_augur_in_production.md file in the docs/ folder: #3311.
Please let me know if any changes are required.