Welcome to kb
KB is a simple, crisp, responsive, and searchable, document management solution, which leverages github.
Status:
Purpose
KB was created to integrate with monitoring solutions like Prometheus, which I architect. They will leverage this product to quickly identify Processes, Runbooks, Instructions, Policies, etc, by passing tags to the integrated communication platforms, and allowing the customer to use hot-links to rapidly lookup, identify, and access documents within KB, to improve efficiency.
Features
The Runbooks in /docs are searchable, and links are created to these when alerts fire from Prometheus, to allow quick reference to runbooks during impacts. I have currently setup integrations through -
- Slack
- Discord
- Microsoft Teams
- PagerDuty
Just about any solution could be leveraged by formatting the simple json payload from monitoring products.
Short Example
When an alert comes in, a tag is used to lookup the associated runbook.
Here’s a sample alert that arrived in Slack:
The user is presented with various bits of information about the issue, and three options for action:
- View the firing alert in the
Prometheusmonitoring platform - Perform a search for an associated
Runbookto remediate the issue -
Mutethe alert by creating a custom Silence for the alertgroup
When the user clicks the Runbook link, it performs a search for the associated runbook and presents the customer with options:
This is easily achieved by correlating the alert name to the runbook name.
With repository growth, more complex tag passing options are available, and weighted answers could be generated.
- For instance, you can pass multiple
space separated tagsin the query, to focus on:- Product
- Architecture
- Business unit
- Tech Team
- etc…
Would you like to request a feature or contribute? Open an issue
| Slack |
|---|
 |
Read more:
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.