Provide an ordered and annotated config.yaml #334
Conversation
configs/config.annotated.yaml
Outdated
|
|
||
| #oncall-api: https://oncall.dummy.com # oncall url | ||
|
|
||
| ## TODO |
There was a problem hiding this comment.
I currently have a poor understanding of the purpose of these 'applications'. I'll remove the TODO for now and hope to add a comment in the future
| # # Every $n users, stop inserting into mysql to avoid crashing it. Comment these out to disable. | ||
| # user_add_pause_interval: 500 | ||
| # user_add_pause_duration: 1 | ||
|
|
There was a problem hiding this comment.
Should have a iris-owa-sync (outlook web access) block comment here
configs/config.annotated.yaml
Outdated
|
|
||
| ## Vendors provides a way to add support for new notification mechanisms | ||
| vendors: [] | ||
| #- type: iris_slack |
There was a problem hiding this comment.
Should likely have the smtp example listed first (it seems missing)
There was a problem hiding this comment.
I haven't seen any smtp configuration examples in the code base - did I miss something?
There was a problem hiding this comment.
Just took a quick look at the code and extracted the parameters.
configs/config.annotated.yaml
Outdated
| # port: 8086 | ||
| # database: iris | ||
|
|
||
| enable_gmail_oneclick: True |
There was a problem hiding this comment.
Please change this default from True to False, and add a comment linking to https://developers.google.com/gmail/markup/reference/one-click-action
This functionality lets you claim incidents by clicking the link in gmail, which is very handy if you use g suite.
| # name: email | ||
| # smtp_server: 'smtp1.example.com' | ||
| # smtp_gateway: 'smtp2.example.com' | ||
| # from: '[email protected]' |
There was a problem hiding this comment.
Can you add, double commented out, autoscale: False and tasks_per_mx: 4, with a comment describing how, if enabled, these will make a pool of persistent connections per each MX record for the given smtp_gateway?
There was a problem hiding this comment.
Not entirely sure if I understand the double commented out correctly, but I've followed your instructions as literally as I could.
|
Any reason not to just replace |
|
Easier to keep everything in sync if there is only one file to manage :) |
|
Closing in favor of #336 |
I found the config.yaml very, very hard to read.
Here's a copy of config.dev.yaml, with the following changes:
Perhaps this belongs elsewhere. Just let me know.