As an ops lead,
I don't want to maintain two separate documentation sources for alarms,
And generate the published documentation from Terraform files only,
So that I can simply update the Terraform file,
And the alarm doc is automatically updated and published.
WHY are we building?
Automate more and reduce maintenance cost by having one source of truth only on alarms, up to date with the latest of latest.
WHAT are we building?
A tool to generate a published alarm document from Terraform files.
The Terraform file would need to be updated with meta information that exists in current alarm documentation but not in Terraform files.
A publishing mechanism (in Google drive, github wiki, html hosted page, etc...).
VALUE created by our solution
Updated documentation that reflects the latest with good solutions for each alarm to help the ops lead.
Acceptance Criteria
[ ] The alarm documentation is automatically created on updating the alarms.
[ ] The solutions for alarms are now stored in Terraform alarms resources, under a metadata field or some hacky comments (to investigate).
[ ] The alarms documentation is automatically published.
QA Steps
[ ] Update the alarm in Terraform files and check if the documentation is automatically updated and published.
Description
As an ops lead, I don't want to maintain two separate documentation sources for alarms, And generate the published documentation from Terraform files only, So that I can simply update the Terraform file, And the alarm doc is automatically updated and published.
WHY are we building?
Automate more and reduce maintenance cost by having one source of truth only on alarms, up to date with the latest of latest.
WHAT are we building?
VALUE created by our solution
Updated documentation that reflects the latest with good solutions for each alarm to help the ops lead.
Acceptance Criteria
metadatafield or some hacky comments (to investigate).QA Steps