{"id":13769798,"url":"https://github.com/openshift/runbooks","last_synced_at":"2025-04-11T09:32:44.805Z","repository":{"id":37724463,"uuid":"327467412","full_name":"openshift/runbooks","owner":"openshift","description":"Runbooks for Alerts on OCP","archived":false,"fork":false,"pushed_at":"2024-04-09T13:07:34.000Z","size":811,"stargazers_count":54,"open_issues_count":6,"forks_count":90,"subscribers_count":51,"default_branch":"master","last_synced_at":"2024-04-09T22:06:24.889Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openshift.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-01-07T01:05:25.000Z","updated_at":"2024-04-12T09:51:40.776Z","dependencies_parsed_at":"2023-10-10T17:45:09.160Z","dependency_job_id":"51894691-295f-4646-8924-b85cddb6eacf","html_url":"https://github.com/openshift/runbooks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Frunbooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Frunbooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Frunbooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openshift%2Frunbooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openshift","download_url":"https://codeload.github.com/openshift/runbooks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248368327,"owners_count":21092336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T17:00:31.629Z","updated_at":"2025-04-11T09:32:39.793Z","avatar_url":"https://github.com/openshift.png","language":"Shell","readme":"# OpenShift Runbooks\n\nA collection of runbooks for alert rules that are shipped with OpenShift.\n\n## How To Use\n\nOpenShift Container Platform is shipping a finely tuned set of alerts to inform\nthe cluster's owner and/or operator of events and bad conditions in the cluster.\nThis repository is a consistently growing collection of runbooks for said\nalerts, that are intended to guide a cluster owner and/or operator through the\nsteps of fixing problems on clusters, which are surfaced by alerts.\n\nGoing forward, alerts in OpenShift will ship a link to the corresponding runbook\nin this repository, to make fixing problems even easier. Link should be passed\nas `runbook_url` field in alert annotations ([example][runbook-link])\n\n## Repository Layout\n\nRunbooks in this repository are grouped by the operator that is responsible for\nshipping the respective alert. This results in a structure as follows:\n\n`root/alerts/operator_repository_name/some_alert.md`\n\nThe root folder contains all information and files required for this repository\nin general, while all runbooks live in their respective subfolder.\n\n## Onboarding\n\nIf your operator has not shipped any runbooks so far, please create a subfolder\nfollowing the repository layout and place an OWNERS file in it. The OWNERS file\nshould be the same as the one in the operator's main repository. Additionally\nadd all runbooks to said folder that you want to contribute.\n\n## Contributing\n\nWe are welcoming *any* contributions! While Red Hat is going to keep adding more\nrunbooks for new alerts as they surface, we would also love to extend existing\nrunbooks with any real world experiences that cluster owners or operators have\nmade.\n\nSteps to your contribution are outlined below:\n* Fork this repository\n* Make your change (We recommend using a branch in your fork.)\n* Submit a Pull Request\n\nOur integrations and bots will walk you through any other required steps, like\nassigning someone to look at your PR, or inform you if tests are failing.\n\n[runbook-link]: https://github.com/openshift/cluster-monitoring-operator/blob/1959ea9461c47eee506a497b21f10b0e2c3701ac/assets/cluster-monitoring-operator/prometheus-rule.yaml#L31-L40\n","funding_links":[],"categories":["Runbook Documents"],"sub_categories":["Linux"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenshift%2Frunbooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenshift%2Frunbooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenshift%2Frunbooks/lists"}