search

keephq / keep

The open-source alert management and AIOps platform
https://keephq.dev
Other
7.97k stars 756 forks source link

[➕ Feature]: Runbooks queried by GitHub and GitLab providers #1780

Open Matvey-Kuk opened 3 months ago

Matvey-Kuk commented 3 months ago

We want to introduce "Runbooks" as a content queried from GitHub and GitLab providers. For the beginning, Runbook in Keep will be a "title" and a link to the ".md" file.

Update providers

Introduce "Runbooks" as data type providers could query from the source. Similar to "alerts", or "topology".

Screenshot 2024-09-01 at 18 32 29

For GitHub and Gitlab, I think the "Optional settings" (similar to prometheus) should allow choosing the repo and the path with ".md" files.

Screenshot 2024-09-01 at 18 32 16

Runbooks page

Should represent all runbooks and Incidents those Runbooks are attached to. Just a table.

Update the Incident page

Allow attaching/unattaching of runbooks to the incident.

Matvey-Kuk commented 2 months ago

/bounty 150

algora-pbc[bot] commented 2 months ago

💎 $150 bounty • Keep (YC W23)

Steps to solve:

  1. Start working: Comment /attempt #1780 with your implementation plan
  2. Submit work: Create a pull request including /claim #1780 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to keephq/keep!

Add a bounty • Share on socials

Attempt Started (GMT+0) Solution
🟢 @Mubashirshariq Sep 11, 2024, 9:12:42 AM #2104
Matvey-Kuk commented 2 months ago

@Mubashirshariq thank you for the initiative, please keep us updated on the progress!

Mubashirshariq commented 2 months ago

@Matvey-Kuk sure will start working on this

talboren commented 2 months ago

@Mubashirshariq any progress on this? otherwise, i think i'll grab it up

Mubashirshariq commented 2 months ago

@talboren i have shared the update on slack,work in progress created a db schema for runbooks added the optional settings to GitHub and gitlab for repository and path to md files, now I have started working on runbooks page,will complete it as soon as possible

Matvey-Kuk commented 2 months ago

Check the thread for more details: https://getkeep.slack.com/archives/C04PT44MATS/p1726546439032199

Screenshot 2024-09-19 at 10 50 32
rajesh-jonnalagadda commented 2 months ago

@Matvey-Kuk @talboren Please ignore the UI. this is what we needed right https://www.loom.com/share/ed4a414f213e4c1686470914c00a49c3

algora-pbc[bot] commented 1 month ago

💡 @Mubashirshariq submitted a pull request that claims the bounty. You can visit your bounty board to reward.

Matvey-Kuk commented 1 month ago

Payout for this bounty will be executed via GitHub Sponsors, not via Algora. Please activate https://github.com/sponsors/accounts for your account to receive the payout, sorry for the inconvenience

Matvey-Kuk commented 1 month ago

Thank you @Mubashirshariq !Screenshot 2024-10-29 at 15 53 38

@VladimirFilonov will continue with this issue.