diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..45ddf0a --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +site/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..070f4ef --- /dev/null +++ b/.travis.yml @@ -0,0 +1,24 @@ +language: python +python: + - 2.7 +cache: pip +install: + - pip install awscli + - pip install mkdocs + - pip install mkdocs-material +script: + - mkdocs build --clean +deploy: + on: + branch: master + repo: 'PagerDuty/incident-response-docs' + provider: s3 + access_key_id: $AWS_ACCESS_KEY_ID + secret_access_key: $AWS_SECRET_ACCESS_KEY + bucket: $AWS_S3_BUCKET + skip_cleanup: true + local_dir: site + acl: public_read +after_deploy: + # Delete any old files from the S3 bucket. + - aws s3 sync site/ s3://$AWS_S3_BUCKET --acl public-read --exclude "*.py*" --delete diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..95efe6e --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2016 PagerDuty, Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a85eea0 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# PagerDuty Incident Response Documentation [![Build Status](https://travis-ci.com/PagerDuty/incident-response-docs.svg?token=zdc1SxQUyY3TG9TLD3Xz&branch=master)](https://travis-ci.com/PagerDuty/incident-response-docs) +This is a public version of the Incident Response process used at PagerDuty. It is also used to prepare new employees for on-call responsibilities, and provides information not only on preparing for an incident, but also what to do during and after. See the [about page](docs/about.md) for more information on what this documentation is and why it exists. + +You can view the documentation [directly](/docs/index.md) in this repository, or rendered as a website at https://response.pagerduty.com. + +[![PagerDuty Incident Response Documentation](screenshot.png)](https://response.pagerduty.com) + +## Development +We use [MkDocs](http://www.mkdocs.org/) to create a static site from this repository. For local development, + +1. [Install MkDocs](http://www.mkdocs.org/#installation). `pip install mkdocs` +1. Install the [MkDocs Material theme](https://github.com/squidfunk/mkdocs-material). `pip install mkdocs-material` +1. To test locally, run `mkdocs serve` from the project directory. + +## Deploying +1. Run `mkdocs build --clean` to produce the static site for upload. +1. Upload the `site` directory to S3 (or wherever you would like it to be hosted). + + aws s3 sync ./site/ s3://[BUCKET_NAME] \ + --acl public-read \ + --exclude "*.py*" \ + --delete + +## License +[Apache 2](http://www.apache.org/licenses/LICENSE-2.0) (See [LICENSE](LICENSE) file) + +## Contributing +Thank you for considering contributing! If you have any questions, just ask - or submit your issue or pull request anyway. The worst that can happen is we'll politely ask you to change something. We appreciate all friendly contributions. + +Here is our preferred process for submitting a pull request, + +1. Fork it ( https://github.com/PagerDuty/incident-response-docs/fork ) +1. Create your feature branch (`git checkout -b my-new-feature`) +1. Commit your changes (`git commit -am 'Add some feature'`) +1. Push to the branch (`git push origin my-new-feature`) +1. Create a new Pull Request. diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 0000000..fa11240 --- /dev/null +++ b/docs/about.md @@ -0,0 +1,29 @@ +This site documents parts of the PagerDuty Incident Response process. It is a cut-down version of our internal documentation, used at PagerDuty for any major incidents, and to prepare new employees for on-call responsibilities. It provides information not only on preparing for an incident, but also what to do during and after. + +Few companies seem to talk about their internal processes for dealing with major incidents. We would like to change that by opening up our documentation to the community, in the hopes that it proves useful to others who may want to formalize their own processes. Additionally, it provides an opportunity for others to suggest improvements, which ends up helping everyone. + +## What is this? + +A collection of pages detailing how to efficiently deal with any major incidents that might arise, along with information on how to go on-call effectively. It provides lessons learned the hard way, along with training material for getting you up to speed quickly. + +## Who is this for? + +It is intended for on-call practitioners and those involved in an operational incident response process, or those wishing to enact a formal incident response process. + +## Why do I need it? + +Incident response is something you hope to never need, but when you do, you want it to go smoothly and seamlessly. Normally the knowledge of how to handle incidents within your company will be built up over time, getting better with each incident. While tools such as [PagerDuty's Major Incidents Application](https://www.pagerduty.com/applications/#major-incidents-application) can help you recover quickly, the process you follow is just as important. This documentation will allow you to learn from the start something which has taken us years to build up. Giving you a head start on how to deal with major incidents in a way which leads to the fastest possible recovery time. + +## What is covered? + +Anything from preparing to [go on-call](/oncall/being_oncall.md), definitions of [severities](/before/severity_levels.md), incident [call etiquette](/before/call_etiquette.md), all the way to how to run a [post-mortem](/after/post_mortem_process.md), and providing our [post-mortem template](/after/post_mortem_template.md). We even include our [security incident response process](/during/security_incident_response.md). + +## What is missing? + +This isn't an exact clone of our internal documentation, but instead has some information removed. Things such as our phone bridge numbers, names of internal tools and systems which are not (yet) open sourced, images of our dashboards, etc. Basically anything that is specific to PagerDuty or is too sensitive to share. + +## License + +This documentation is provided under the Apache License 2.0. In plain English that means you can use and modify this documentation and use it both commercially and for private use. However, you must include any original copyright notices, and the original LICENSE file. + +Whether you are a PagerDuty customer or not, we want you to have the ability to use this documentation internally at your own company. You can view the source code for all of this documentation on our GitHub account, feel free to fork the repository and use it as a base for your own internal documentation. diff --git a/docs/after/post_mortem_process.md b/docs/after/post_mortem_process.md new file mode 100644 index 0000000..bf763cd --- /dev/null +++ b/docs/after/post_mortem_process.md @@ -0,0 +1,91 @@ +For every major incident (SEV-2/1), we need to follow up with a post-mortem. A blame-free, detailed description, of exactly what went wrong in order to cause the incident, along with a list of steps to take in order to prevent a similar incident from occurring again in the future. The incident response process itself should also be included. + +![Post-Mortem](../assets/img/headers/pagerduty_post_mortem.jpg) + +## Owner Designation +The first step is that a post-mortem owner will be designated. This is done by the IC either at the end of a major incident call, or very shortly after. You will be notified directly by the IC if you are the owner for the post-mortem. The owner is responsible for populating the post-mortem page, looking up logs, managing the followup investigation, and keeping all interested parties in the loop. Please use Slack for coordinating followup. A detailed list of the steps is available below, + +## Owner Responsibilities +As owner of a post-mortem, you are responsible for the following, + +* Scheduling the post-mortem meeting (on the shared calendar) and inviting the relevant people (this should be scheduled within 5 business days of the incident). +* Updating the page with all of the necessary content. +* Investigating the incident, pulling in whomever you need from other teams to assist in the investigation. +* Creating follow-up JIRA tickets (_You are only responsible for creating the tickets, not following them up to resolution_). +* Running the post-mortem meeting (_these generally run themselves, but you should get people back on topic if the conversation starts to wander_). +* In cases where we need a public blog post, creating & reviewing it with appropriate parties. + +## Post-Mortem Wiki Page +Once you've been designated as the owner of a post-mortem, you should start updating the page with all the relevant information. + +1. (If not already done by the IC) Create a new post-mortem page for the incident. + +1. Schedule a post-mortem meeting for within 5 business days of the incident. You should schedule this before filling in the page, just so it's on the calendar. + * Create the meeting on the "Incident Post-Mortem Meetings" shared calendar. + +1. Begin populating the page with all of the information you have. + * The timeline should be the main focus to begin with. + * The timeline should include important changes in status/impact, and also key actions taken by responders. + * You should mark the start of the incident in red, and the resolution in green (for when we went into/outof SEV). + * Go through the history in Slack to identify the responders, and add them to the page. + * Identify the Incident Commander and Scribe in this list. + +1. Populate the page with more detailed information. + * For each item in the timeline, identify a metric, or some third-party page where the data came from. This could be a link to a Datadog graph, a SumoLogic search, a Tweet, etc. Anything which shows the data point you're trying to illustrate in the timeline. + +1. Perform an analysis of the incident. + * Capture all available data regarding the incident. What caused it, how many customers were affected, etc. + * Any commands or queries you use to look up data should be posted in the page so others can see how the data was gathered. + * Capture the impact to customers (generally in terms of event submission, delayed processing, and slow notification delivery) + * Identify the underlying cause of the incident (What happened, and why did it happen). + +1. Create any followup action JIRA tickets (or note down topics for discussion if we need to decide on a direction to go before creating tickets), + * Go through the history in Slack to identify any TODO items. + * Label all tickets with their severity level and date tags. + * Any actions which can reduce re-occurrence of the incident. + * (There may be some trade-off here, and that's fine. Sometimes the ROI isn't worth the effort that would go into it). + * Identify any actions which can make our incident response process better. + * Be careful with creating too many tickets. Generally we only want to create things that are P0/P1's. Things that absolutely should be dealt with. + +1. Write the external message that will be sent to customers. This will be reviewed during the post-mortem meeting before it is sent out. + * Avoid using the word "outage" unless it really was a full outage, use the word "incident" instead. Customers generally see "outage" and assume everything was down, when in reality it was likely just some alerts delivered outside of SLA. + * Look at other examples of previous post-mortems to see the kind of thing you should send. + +## Post-Mortem Meeting +These meetings should generally last 15-30 minutes, and are intended to be a wrap up of the post-mortem process. We should discuss what happened, what we could've done better, and any followup actions we need to take. The goal is to suss out any disagreement on the facts, analysis, or recommended actions, and to get some wider awareness of the problems that are causing reliability issues for us. + +You should invite the following people to the post-mortem meeting, + +* Always + * The incident commander. + * Service owners involved in the incident. + * Key engineer(s)/responders involved in the incident. +* Optional + * Customer liaison. (Only SEV-1 incidents) + +A general agenda for the meeting would be something like, + +1. Recap the timeline, to make sure everyone agrees and is on the same page. +1. Recap important points, and any unusual items. +1. Discuss how the problem could've been caught. + * Did it show up in canary? + * Could it have been caught in tests, or loadtest environment? +1. Discuss customer impact. Any comments from customers, etc. +1. Review action items that have been created, discuss if appropriate, or if more are needed, etc. + +## Examples +Here are some examples of post-mortems from other companies as a reference, + +* [Stripe](https://support.stripe.com/questions/outage-postmortem-2015-10-08-utc) +* [LastPass](https://blog.lastpass.com/2015/06/lastpass-security-notice.html/comment-page-2/) +* [AWS](https://aws.amazon.com/message/5467D2/) +* [Twilio](https://www.twilio.com/blog/2013/07/billing-incident-post-mortem-breakdown-analysis-and-root-cause.html) +* [Heroku](https://status.heroku.com/incidents/151) +* [Netflix](http://techblog.netflix.com/2012/10/post-mortem-of-october-222012-aws.html) +* [GOV.UK Rail Accident Investigation](https://www.gov.uk/government/publications/kyle-beck-safety-digest/near-miss-at-kyle-beck-3-august-2016) +* [A List of Post-mortems!](https://github.com/danluu/post-mortems) + +## Useful Resources + +* [Advanced PostMortem Fu and Human Error 101 (Velocity 2011)](http://www.slideshare.net/jallspaw/advanced-postmortem-fu-and-human-error-101-velocity-2011) +* [Blame. Language. Sharing.](http://fractio.nl/2015/10/30/blame-language-sharing/) diff --git a/docs/after/post_mortem_template.md b/docs/after/post_mortem_template.md new file mode 100644 index 0000000..781e410 --- /dev/null +++ b/docs/after/post_mortem_template.md @@ -0,0 +1,79 @@ +This is a standard template we use for post-mortems at PagerDuty. Each section describes the type of information you will want to put in that section. + +--- + +!!! note "Guidelines" + This page is intended to be reviewed during a post-mortem meeting that should be scheduled within 5 business days of any event. + Your first step should be to schedule the post-mortem meeting in the shared calendar for within 5 business days after the incident. + Don't wait until you've filled in the info to schedule the meeting, however make sure the page is completed by the meeting. + +** Post-Mortem Owner:** _Your name goes here._ + +** Meeting Scheduled For:** _Schedule the meeting on the "Incident Post-Mortem Meetings" shared calendar, for within 5 business days after the incident. Put the date/time here._ + +** Call Recording:** _Link to the incident call recording._ + +## Overview +_Include a **short** sentence or two summarizing the root cause, timeline summary, and the impact. E.g. "On the morning of August 99th, we suffered a 1 minute SEV-1 due to a runaway process on our primary database machine. This slowness caused roughly 0.024% of alerts that had begun during this time to be delivered out of SLA."_ + +## What Happened +_Include a short description of what happened._ + +## Root Cause +_Include a description of the root cause. If there were any actions taken that exacerbated the issue, also include them here with the intention of learning from any mistakes made during the resolution process._ + +## Resolution +_Include a description what solved the problem. If there was a temporary fix in place, describe that along with the long-term solution._ + +## Impact +_Be very specific here, include exact numbers._ + +| Time in SEV-1 | ?mins | +| Time in SEV-2 | ?mins | +| Notifications Delivered out of SLA | ??% (?? of ??) | +| Events Dropped / Not Accepted | ??% (?? of ??) _Should usually be 0, but always check_ | +| Accounts Affected | ?? | +| Users Affected | ?? | +| Support Requests Raised | ?? _Include any relevant links to tickets_ | + +## Responders + +* _Who was the IC?_ +* _Who was the scribe?_ +* _Who else was involved?_ +* _Who else was involved?_ + +## Timeline +_Some important times to include: (1) time the root cause began, (2) time of the page, (3) time that the status page was updated (i.e. when the incident became public), (4) time of any significant actions, (5) time the SEV-2/1 ended, (6) links to tools/logs that show how the timestamp was arrived at._ + +| Time (UTC) | Event | Data Link | +| ---------- | ----- | --------- | + +## How'd We Do? + +### What Went Well? + +* _List anything you did well and want to call out. It's OK to not list anything._ + +### What Didn't Go So Well? + +* _List anything you think we didn't do very well. The intent is that we should follow up on all points here to improve our processes._ + +## Action Items +_Each action item should be in the form of a JIRA ticket, and each ticket should have the same set of two tags: “sev1_YYYYMMDD” (such as sev1_20150911) and simply “sev1”. Include action items such as: (1) any fixes required to prevent the root cause in the future, (2) any preparedness tasks that could help mitigate the problem if it came up again, (3) remaining post-mortem steps, such as the internal email, as well as the status-page public post, (4) any improvements to our incident response process._ + +## Messaging + +### Internal Email +_This is a follow-up for employees. It should be sent out right after the post-mortem meeting is over. It only needs a short paragraph summarizing the incident and a link to this wiki page._ + +> Briefly summarize what happened and where the post-mortem page (this page) can be found. + +### External Message +_This is what will be included on the status.pagerduty.com website regarding this incident. What are we telling customers, including an apology? (The apology should be genuine, not rote.)_ + +> Summary + +> What Happened? + +> What Are We Doing About This? diff --git a/docs/assets/css/extra.css b/docs/assets/css/extra.css new file mode 100644 index 0000000..01e30dc --- /dev/null +++ b/docs/assets/css/extra.css @@ -0,0 +1,399 @@ +/* Colfax Font */ +@font-face { + font-family: 'Colfax Regular'; + font-style: normal; + font-weight: 400; + src: local('ColfaxRegular'), url(https://www.pagerduty.com/wp-content/themes/startit-child/fonts/ColfaxWebRegular.woff) format('woff2'); +} + +@font-face { + font-family: 'Colfax Light'; + font-style: normal; + font-weight: 100; + src: local('ColfaxRegular'), url(https://www.pagerduty.com/wp-content/themes/startit-child/fonts/ColfaxWebLight.woff) format('woff2'); +} + +/* Defaults */ +body { + font-weight: 500; + -webkit-font-smoothing: antialiased; +} + +/* Change the colour theme to better match PagerDuty */ + +/* background: pd-green */ +.repo a { + background: #25c151; +} + +@media only screen and (max-width: 959px) { + .palette-primary-green .project { + background: #25c151; + } +} + +/* background: pd-navy */ +.palette-primary-green, +.palette-primary-green .footer, +.palette-primary-green .header, +.palette-primary-green .results .meta, +.palette-primary-green .article table th { + background: #1f293a; +} + +.palette-primary-green .article table th { + background: #555; +} + +/* font: pd-green */ +.palette-primary-green .article h1, +.palette-primary-green .article h2, +.palette-primary-green .drawer .toc a.current, +.palette-primary-green .drawer .toc a:focus, +.palette-primary-green .drawer .toc a:hover, +.palette-primary-green .article a:hover { + color: #25c151; +} + +/* font: pd-navy */ +.palette-primary-green .article a, +.palette-primary-green .article code, +.palette-primary-green .article h1, +.palette-primary-green .article h2 { + color: #1f293a; +} + +/* Selected nav section */ +.palette-primary-green .drawer .anchor a { + border-left: 3px solid #25c151; +} + +/* Hide the page title, already in the navbar */ +.article h1 { + display: none; +} + +/* But show it when printing */ +@media print { + .article h1 { + display: block; + padding-top: 0em; + padding-bottom: 0.1em; + margin-top: 0em; + margin-bottom: 0em; + border-bottom: none; + } + + /* Also add a heading when printing */ + .article h1:before { + background: url(/assets/img/logo.png) 0em -0.07em no-repeat; + background-size: 7em; + display: block; + height: 2em; + width: 100%; + padding-left: 7.2em; + content: 'Incident Response'; + border-bottom: 1px solid #ddd; + margin-bottom: 0.6em; + } +} + + +/* Want the font to be bigger for articles, easier reading. */ +.article { + font-size: 1.45em; +} + +/* Too much whitespace at the top, not enough at bottom */ +.article .wrapper { + padding: 56px 16px 132px !important; +} + +@media only screen and (min-width: 720px) { + .article .wrapper { + padding: 70px 24px 126px !important; + } +} + +/* Get rid of the whitespace when printing, let people set own margins. */ +@media print { + .article .wrapper { + padding: 0em !important; + } +} + +ul, ol { + padding-left: 1em; +} + +/* Expanding border menu */ +.drawer .toc li a { + overflow: hidden; + position: relative; +} + +.drawer .toc li a:before { + display: block; + content: ''; + position: absolute; + height: 2em; + left: 0px; + top: 0.5em; + border-left: 5px solid #25c151; + transform: scaleY(0); + transition: transform 250ms ease-in-out; +} + +.drawer .toc li a:hover:before { + transform: scaleY(1); +} + +/* Don't do it on active menu items */ +.drawer .toc a.current:hover:before, +.drawer .toc li.anchor a:hover:before { + transform: scaleY(0); + display: none; +} + +/* Don't overflow horizontally on nav */ +.drawer .toc ul li a { + white-space: nowrap; + text-overflow: ellipsis; +} + +/* Change the title bar to include the PD logo */ +nav div.mainlogo { + width: 15em; + display: table-cell; +} + +nav div.mainlogo a { + min-height: 3.5em; + margin-bottom: -1.25em; + width: 14.5em; + + background: url(/assets/img/logo.png) 0em 0.1em no-repeat; + background-size: contain; +} + +nav div.mainlogo img { + display: none; +} + +/* Admonition */ +.admonition { + background: #25c151; +} +.admonition.info { + background: #f5a623; +} + +@media print { + .admonition { + padding: 1em 2em !important; + } +} + +/* Typography */ +h4 { + font-weight: bold; + text-decoration: underline; +} + +.project .logo+.name { + font-size: 13px; +} + +span.bad { + color: #f00; +} + +span.good { + color: #008800; +} + +span.code, +code { + font-family: monospace; + color: #00f !important; + border-radius: 2px; + padding: 0.1em; + border: 1px solid #eee; + background: #f4f4f4; +} + +/* Icons */ +.button .icon:hover { + transition: color 250ms ease-in-out; + color: #25c151; +} + +/* Images */ +.article .wrapper { + overflow: hidden; +} + +/* Center all images */ +.article img { + display: block; + margin: 0 auto; +} + +/* Header images */ +.article h1 + p + p img { + max-width: 110%; + margin-left: -2em; +} + +/* Image Captions */ +img + em { + position: relative; + font-size: 0.8em; + margin-right: -2.3em; + padding: 0em 1em; + float: right; + margin-top: -2.1em; + color: #000; + border-top-left-radius: 3px; + background: rgba(255, 255, 255, 0.7); +} + +/* Fixes for smaller screen sizes */ +@media only screen and (max-width: 720px) { + .article h1 + p + p img { + max-width: 120%; + } + + .article h1 + p + p img + em { + margin-right: -1.4em; + margin-top: -2em; + } +} + +/* Hack to hide the header images when printing. */ +@media print { + .article h1 + p + p img { + display: none; + } + + .article h1 + p + p img + em { + display: none; + } +} + +/* Quotes */ +.article blockquote { + border-left: 3px solid #555; + background: #f9f9f9; + padding: 1em; + padding-left: 16px; + margin-top: 1em; + color: #333; + font-style: italic; +} + +.article blockquote p { + margin: 0em; + padding: 0.5em 0em; +} + +/* Horizontal Rules */ +.article hr { + margin-top: 2em; + border-top: 2px solid #f4f4f4; +} + +/* Don't care about copyright notice for this project, Apache License. */ +aside.copyright { + display: none; +} + +/* Custom tables */ +table.custom-table td ul { + margin-top: -0.8em; + padding-top: 0px; + padding-left: 0px; +} + +table.custom-table td.warning { + font-weight: bold; + text-align: center; + color: #f00; + background: #f4f4f4; +} + +table.custom-table td.sev-1 { + background: #ffe7e7; + color: #f00; + font-weight: bold; +} + +table.custom-table td.sev-2 { + background: #ffd; + color: rgb(255,153,0); + font-weight: bold; +} + +table.custom-table td.sev-3 { + background: #e0f0ff; + color: rgb(51,102,255); + font-weight: bold; +} + +table.custom-table td.sev-4 { + background: #f0f0f0; + color: rgb(128,128,128); + font-weight: bold; +} + +table.custom-table td.sev-5 { + background: #ddfade; + color: rgb(0,128,0); + font-weight: bold; +} + +table.custom-table td.centered { + text-align: center; +} + +/* Embeds */ +iframe { + display: block; + margin: 0 auto; + margin-top: 1em; +} + +/* Contact summary table */ +#contact-summary { + margin-bottom: -2em; + background: #fff; + color: #000; +} + +/* Super horrible hack to get the training PDF images correct */ +#national-incident-management-system-nims ~ p img { + display: inline; +} +#national-incident-management-system-nims ~ p:nth-of-type(6) { + text-align: center; +} + +/* 404 Page */ +#error { + text-align: center; + padding: 0em 5em; +} + +#error h1 { + display: block; + font-size: 2.5em; + padding-bottom: 1em; + margin-bottom: 1em; + margin-top: 1em; + border-bottom: 1px solid #eee; +} + +#error p { + font-style: italic; + color: #555; +} diff --git a/docs/assets/img/cover.png b/docs/assets/img/cover.png new file mode 100644 index 0000000..6325795 Binary files /dev/null and b/docs/assets/img/cover.png differ diff --git a/docs/assets/img/headers/gene_kranz.jpg b/docs/assets/img/headers/gene_kranz.jpg new file mode 100644 index 0000000..773fb29 Binary files /dev/null and b/docs/assets/img/headers/gene_kranz.jpg differ diff --git a/docs/assets/img/headers/incident_command_support.jpg b/docs/assets/img/headers/incident_command_support.jpg new file mode 100644 index 0000000..eed6180 Binary files /dev/null and b/docs/assets/img/headers/incident_command_support.jpg differ diff --git a/docs/assets/img/headers/incident_response.jpg b/docs/assets/img/headers/incident_response.jpg new file mode 100644 index 0000000..e45fc8a Binary files /dev/null and b/docs/assets/img/headers/incident_response.jpg differ diff --git a/docs/assets/img/headers/obama_phone.jpg b/docs/assets/img/headers/obama_phone.jpg new file mode 100644 index 0000000..79b4a77 Binary files /dev/null and b/docs/assets/img/headers/obama_phone.jpg differ diff --git a/docs/assets/img/headers/pagerduty_ir.jpg b/docs/assets/img/headers/pagerduty_ir.jpg new file mode 100644 index 0000000..00b6114 Binary files /dev/null and b/docs/assets/img/headers/pagerduty_ir.jpg differ diff --git a/docs/assets/img/headers/pagerduty_post_mortem.jpg b/docs/assets/img/headers/pagerduty_post_mortem.jpg new file mode 100644 index 0000000..7561025 Binary files /dev/null and b/docs/assets/img/headers/pagerduty_post_mortem.jpg differ diff --git a/docs/assets/img/headers/typewriter.jpg b/docs/assets/img/headers/typewriter.jpg new file mode 100644 index 0000000..37dfbbc Binary files /dev/null and b/docs/assets/img/headers/typewriter.jpg differ diff --git a/docs/assets/img/icon.png b/docs/assets/img/icon.png new file mode 100644 index 0000000..13c222a Binary files /dev/null and b/docs/assets/img/icon.png differ diff --git a/docs/assets/img/logo.png b/docs/assets/img/logo.png new file mode 100644 index 0000000..a679d2a Binary files /dev/null and b/docs/assets/img/logo.png differ diff --git a/docs/assets/img/misc/ack.png b/docs/assets/img/misc/ack.png new file mode 100644 index 0000000..e83bd50 Binary files /dev/null and b/docs/assets/img/misc/ack.png differ diff --git a/docs/assets/img/misc/alert_fatigue.png b/docs/assets/img/misc/alert_fatigue.png new file mode 100644 index 0000000..6a3c823 Binary files /dev/null and b/docs/assets/img/misc/alert_fatigue.png differ diff --git a/docs/assets/img/misc/communicate.png b/docs/assets/img/misc/communicate.png new file mode 100644 index 0000000..c708c51 Binary files /dev/null and b/docs/assets/img/misc/communicate.png differ diff --git a/docs/assets/img/misc/escalation.png b/docs/assets/img/misc/escalation.png new file mode 100644 index 0000000..c8595be Binary files /dev/null and b/docs/assets/img/misc/escalation.png differ diff --git a/docs/assets/img/misc/incident_response_roles.png b/docs/assets/img/misc/incident_response_roles.png new file mode 100644 index 0000000..a250b42 Binary files /dev/null and b/docs/assets/img/misc/incident_response_roles.png differ diff --git a/docs/assets/img/misc/mobile_alerts.png b/docs/assets/img/misc/mobile_alerts.png new file mode 100644 index 0000000..225b77c Binary files /dev/null and b/docs/assets/img/misc/mobile_alerts.png differ diff --git a/docs/assets/img/misc/oncall_burnout.png b/docs/assets/img/misc/oncall_burnout.png new file mode 100644 index 0000000..fe39e67 Binary files /dev/null and b/docs/assets/img/misc/oncall_burnout.png differ diff --git a/docs/assets/img/misc/schedule.png b/docs/assets/img/misc/schedule.png new file mode 100644 index 0000000..b7d1f7a Binary files /dev/null and b/docs/assets/img/misc/schedule.png differ diff --git a/docs/assets/img/misc/triage.png b/docs/assets/img/misc/triage.png new file mode 100644 index 0000000..223fe68 Binary files /dev/null and b/docs/assets/img/misc/triage.png differ diff --git a/docs/assets/img/screenshots/high_business_hours.png b/docs/assets/img/screenshots/high_business_hours.png new file mode 100644 index 0000000..fe06d21 Binary files /dev/null and b/docs/assets/img/screenshots/high_business_hours.png differ diff --git a/docs/assets/img/screenshots/high_urgency.png b/docs/assets/img/screenshots/high_urgency.png new file mode 100644 index 0000000..5efa9f9 Binary files /dev/null and b/docs/assets/img/screenshots/high_urgency.png differ diff --git a/docs/assets/img/screenshots/low_urgency.png b/docs/assets/img/screenshots/low_urgency.png new file mode 100644 index 0000000..15c54f3 Binary files /dev/null and b/docs/assets/img/screenshots/low_urgency.png differ diff --git a/docs/assets/img/screenshots/suppressed.png b/docs/assets/img/screenshots/suppressed.png new file mode 100644 index 0000000..dc9910b Binary files /dev/null and b/docs/assets/img/screenshots/suppressed.png differ diff --git a/docs/assets/img/thumbnails/nims_core.png b/docs/assets/img/thumbnails/nims_core.png new file mode 100644 index 0000000..48bce4c Binary files /dev/null and b/docs/assets/img/thumbnails/nims_core.png differ diff --git a/docs/assets/img/thumbnails/nims_training.png b/docs/assets/img/thumbnails/nims_training.png new file mode 100644 index 0000000..0025545 Binary files /dev/null and b/docs/assets/img/thumbnails/nims_training.png differ diff --git a/docs/before/call_etiquette.md b/docs/before/call_etiquette.md new file mode 100644 index 0000000..e376956 --- /dev/null +++ b/docs/before/call_etiquette.md @@ -0,0 +1,50 @@ +You've just joined an incident call, and you've never been on one before. You have no idea what's going on, or what you're supposed to be doing. This page will help you through your first time on an incident call, and will provide a reference for future calls you may be a part of. + +![Obama phone](../assets/img/headers/obama_phone.jpg) +*Credit: [Official White House Photo](https://commons.wikimedia.org/wiki/File:Barack_Obama_on_phone_with_Benjamin_Netanyahu_2009-06-08.jpg) by Pete Souza* + +## First Steps + +* If you intend on participating on the incident call you should join both the call, and Slack. +* Make sure you are in a quiet environment in order to participate on the call. Background noise should be kept to a minimum. +* Keep your microphone muted until you have something to say. +* Identify yourself when you join the call; State your name and the system you are the expert for. +* Speak up and speak clearly. +* Be direct and factual. +* Keep conversations/discussions short and to the point. +* Bring any concerns to the Incident Commander (IC) on the call. +* Respect time constraints given by the Incident Commander. + +## Lingo +**Use clear terminology, and avoid using acronyms or abbreviations during a call. Clear and accurate communication is more important than quick communication.** + +![Communication](../assets/img/misc/communicate.png) + +Standard radio [voice procedure](https://en.wikipedia.org/wiki/Voice_procedure#Words_in_voice_procedure) does not need to be followed on calls. However, you should familiarize yourself with the terms, as you may hear them on a call (or need to use them yourself). The ones in more active use on major incident calls are, + +* **Ack/Rog** - "I have received and understood" +* **Say Again** - "Repeat your last message" +* **Standby** - "Please wait a moment for the next response" +* **Wilco** - "Will comply" + +Do not invent new abbreviations, and always favor being explicit of implicit. It is better to make things clearer than to try and save time by abbreviating, only to have a misunderstanding because others didn't know the abbreviation. + +## The Commander +The Incident Commander (IC) is the leader of the incident response process, and are responsible for bringing the incident to resolution. They will announce themselves at the start of the call, and will generally be doing most of the talking. + +* Follow all instructions from the incident commander, without exception. +* Do not perform any actions unless the incident commander has told you to do so. +* The commander will typically poll for any strong objections before performing a large action. This is you time to raise any objections if you have them. +* Once the commander has made a decision, that decision is final and should be followed, even if you disagreed during the poll. +* Answer any questions the commander asks you in a clear and concise way. + * Answering that you "don't know" something is perfectly acceptable. Do not try to guess. +* The commander may ask you to investigate something and get back to them in X minutes. Make sure you are ready with an answer within that time. + * Answering that you need more time is perfectly acceptable, but you need to give the commander an estimate of how much time. + +## Problems? + +#### There's no incident commander on the call! I don't know what to do! +Ask on the call if an IC is present. If you have no response, type `!ic page` in Slack. This will page the primary and backup IC to the call. + +#### I can join the call or Slack, but not both, what should I do? +You're welcome to join only one of the channels, however you should not actively participate in the incident response if so, as it causes disjoined communication. Liaise with someone who is both in Slack and on the call to provide any input you may have so that they can raise it. diff --git a/docs/before/different_roles.md b/docs/before/different_roles.md new file mode 100644 index 0000000..73be681 --- /dev/null +++ b/docs/before/different_roles.md @@ -0,0 +1,131 @@ +There are several main roles for our incident response teams at PagerDuty. Certain roles only have one person per incident (e.g. IC), whereas other roles can have multiple people (e.g. Subject Matter Expert, SME). It's all about coming together as a team, working the problem, and getting a solution quickly. + +Here is a rough outline of our role hierarchy, with each role discussed in more detail on the rest of this page. + +![Incident Response Structure](../assets/img/misc/incident_response_roles.png) + +--- + +## Incident Commander (IC) + +### What is it? +An Incident Commander acts as the single source of truth of what is currently happening and what is going to happen during an major incident. They come in all shapes, sizes, and colors. + +### Why have one? +As any software system grows in size and complexity, things break and cause incidents. The Incident Commander is needed to help drive major incidents to resolution. + +### What are the responsibilities? +1. Help prepare for major incidents, + * Setup communications channels for major incidents. + * Funnel people to these communications channels when there is a major incident. + * Train team members on how to communicate during major incidents and train other Incident Commanders. +1. Drive major incidents to resolution, + * Get everyone on the same communication channel. + * Collect information from team members for their services/area of ownership status. + * Collect proposed repair actions, then recommend repair actions to be taken. + * Delegate all repair actions, the Incident Commander is NOT a resolver. + * Be the single authority on system status +1. Post Mortem, + * Creating the initial template right after the incident so people can put in their thoughts while fresh. + * Assigning the post-mortem after the event is over, this can be done after the call. + * Work with Team Leads/Managers on scheduling preventive actions. + +### Who are they? +Anyone on the Incident Commander on-call schedule. Trainees are typically on the Incident Commander Shadow schedule. + +### How can I become one? +Take a look at our [Incident Commander training guide](/training/incident_commander.md). + +--- + +## Deputy + +### What is it? +A Deputy is a direct support role for the Incident Commander. This is not a shadow where the person just observes, the Deputy is expected to perform important tasks during an incident. + +### Why have one? +It's important for the IC to focus on the problem at hand, rather than worrying about documenting the steps or monitoring timers. The deputy helps to support the IC and keep them focussed on the incident. + +### What are the responsibilities? +The Deputy is expected to: + +1. Bring up issues to the Incident Commander that may otherwise not be addressed (keeping an eye on timers that have been started, circling back around to missed items from a roll call, etc). +1. Be a "hot standby" Incident Commander, should the primary need to either transition to a SME, or otherwise have to step away from the IC role. +1. Page SME's or other on-call engineers as instructed by the Incident Commander. +1. Manage the incident call, and be prepared to remove people from the call if instructed by the Incident Commander. +1. Liaise with stakeholders and provide status updates on Slack as necessary. + +### Who are they? +Any Incident Commander can act as a deputy. Deputies need to be trained as an Incident Commander as they may be required to take over command. + +### How can I become one? +Take a look at our [Deputy training guide](/training/deputy.md). Deputies also need to be [trained as an Incident Commander](/training/incident_commander.md). + +--- + +## Scribe + +### What is it? +A Scribe documents the timeline of an incident as it progresses, and makes sure all important decisions and data are captured for later review. + +### Why have one? +The incident commander will need to focus on the problem at hand, and the subject matter experts will need to focus on resolving the incident. It is important to capture a timeline of events as they happen so that they can be reviewed during the post-mortem to determine how well we performed, and so we can accurate determine any additional impact that we might not have noticed at the time. + +### What are the responsibilities? +The Scribe is expected to: + +1. Ensure the incident call is being recorded. +1. Note in Slack important data, events, and actions, as they happen. Specifically: + * Key actions as they are taken (Example: "prod-server-387723 is being restarted to attempt to remove the stuck lock") + * Status reports when one is provided by the IC (Example: "We are in SEV-1, service A is currently not processing events due to a stuck lock, X is restarting the app stack, next checkin in 3 minutes") + * Any key callouts either during the call or at the ending review (Example: "Note: (Bob B) We should have a better way to determine stuck locks.") + +### Who are they? +Anyone can act as a scribe during an incident, and are chosen by the Incident Commander at the start of the call. Typically the Deputy will act as the Scribe, but that doesn't necessarily need to happen, and for larger incidents may not be possible. + +### How can I become one? +Follow our [Scribe training guide](/training/scribe.md), and then notify the Incident Commanders that you would like to be considered for scribing for the next incident. + +--- + +## Subject Matter Expert + +### What is it? +Follow our Scribe training guide, and then notify the Incident Commanders in #incident-commanders that you would like to be considered for scribing for the next incident. + +### Why have one? +The IC and deputy are not all-knowing super beings. When there is a problem with a service, an expert in that service is needed to be able to quickly help identify and fix issues. + +### What are the responsibilities? +1. Being able to diagnose common problems with the service. +1. Being able to rapidly fix issues found during an incident. +1. Concise communication skills, specifically for CAN reports: + * Condition: What is the current state of the service? Is it healthy or not? + * Actions: What actions need to be taken if the service is not in a healthy state? + * Needs: What support does the resolver need to perform an action? + +### Who are they? +Anyone who is considered a "domain expert" can act as a resolver for an incident. Typically the service's primary on-call will act as the SME for that service. + +### How can I become one? +Take a look at our [Subject Matter Expert training guide](/training/subject_matter_expert.md). You should also discuss with your team and service owner to determine what the requirements are for your particular service. + +--- + +## Customer Liaison + +### What is it? +A person responsible for interacting with customers, either directly, or via our public communication channels. Typically a member of the Customer Support team. + +### Why have one? +All of the other roles will be actively working on identifying the cause and resolving the issue, we need a role which is focused purely on the customer interaction side of things so that it can be done properly, with the due care and attention it needs. + +### What are the responsibilities? +1. Post any publicly facing messages regarding the incident (Twitter, StatusPage, etc). +1. Notify the IC of any customers reporting that they are affected by the incident. + +### Who are they? +Any member of the Support Team can act as a customer liaison. + +### How can I become one? +Discuss with the Support Team about becoming our next customer liaison. diff --git a/docs/before/severity_levels.md b/docs/before/severity_levels.md new file mode 100644 index 0000000..b02770b --- /dev/null +++ b/docs/before/severity_levels.md @@ -0,0 +1,89 @@ +The first step in any incident response process is to determine what actually constitutes an incident. Generally this is done by using "SEV" definitions, with lower numbered severities being more urgent. Operational issues can be classified at one of these severity levels, and in general you are able to take more risky moves to resolve a higher severity issue. Anything above a SEV-3 is considered a "major incident" and gets a more intensive response than a normal incident. + +!!! note "Always Assume The Worst" + If you are unsure which level an incident is (e.g. not sure if SEV-2 or SEV-1), **treat it as the higher one**. During an incident is not the time to discuss or litigate severities, just assume the highest and review during a post-mortem. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SeverityDescriptionWhat To Do
SEV-1 +
    +
  • The system is in a critical state and is actively impacting a large number of customers.
    • +
  • Functionality has been severely impaired for a long time, breaking SLA.
    • +
  • Customer-data-exposing security vulnerability has come to our attention.
    • +
+ 		See During an Incident.
SEV-2 +
    +
  • Functionality is severely impaired.
    • +
+ 		See During an Incident.
Anything above this line is considered a "Major Incident". A call is triggered for all major incidents.
SEV-3 +
    +
  • Partial loss of functionality, only affecting minority of customers.
    • +
  • Something that has the likelihood of becoming a SEV-2 if nothing is done.
    • +
  • No redundancy in a service (failure of 1 more node will cause outage).
    • +
+ 		+
    +
  • Work on issue as your top priority.
    • +
  • Liaise with engineers of affected systems to identify cause.
    • +
  • If related to recent deployment, rollback.
    • +
  • Monitor status and notice if/when it escalates.
    • +
  • Mention on Slack if you think it has the potential to escalate.
    • +
+
SEV-4 +
    +
  • Performance issues (delays, etc). Tasks that require non-immediate attention.
    • +
  • Job failure (not impacting alerting).
    • +
+ 		+
    +
  • Work on the issue as your first priority (above "normal" tasks).
    • +
  • Monitor status and notice if/when it escalates.
    • +
+
SEV-5 +
    +
  • Normal bugs which aren't impacting system use, cosmetic issues, etc.
    • +
+ 		+
    +
  • Create a JIRA ticket and assign to owner of affected system.
    • +
+
+ +!!! note "Be Specific" + These severity descriptions have been changed from the PagerDuty internal definitions to be more generic. For your own documentation, you are encouraged to make your definitions very specific, usually referring to a % of users/accounts affected. You will usually want your severity definitions to be metric driven. diff --git a/docs/during/during_an_incident.md b/docs/during/during_an_incident.md new file mode 100644 index 0000000..49a711e --- /dev/null +++ b/docs/during/during_an_incident.md @@ -0,0 +1,111 @@ +Information on what to do during a major incident. See our [severity level descriptions](/before/severity_levels.md) for what constitutes a major incident. + +!!! note "Documentation" + For your own internal documentation, you should make sure that this page has all of the necessary information prominently displayed. Such as: phone bridge numbers, Slack rooms, important chat commands, etc. Here is an example, + + + + + + + + + + + + + + + + + +
#incident-chathttps://a-voip-provider.com/incident-call+1 555 BIG FIRE (+1 555 244 3473) / PIN: 123456
Need an IC? Do !ic page in Slack
For executive summary updates only, join #executive-summary-updates.
+ +!!! info "Security Incident?" + If this is a security incident, you should follow the [Security Incident Response](/during/security_incident_response.md) process. + +## Don't Panic! + +1. Join the incident call and chat (see links above). + * Anyone is free to join the call or chat to observe and follow along with the incident. + * If you wish to participate however, you should join both. If you can't join the call for some reason, you should have a dedicated proxy for the call. Disjointed discussions in the chat room are ultimately distracting. + +1. Follow along with the call/chat, add any comments you feel are appropriate, but keep the discussion relevant to the problem at hand. + * If you are not an SME, try to filter any discussion through the primary SME for your service. Too many people discussing at once get become overwhelming, so we should try to maintain a hierarchical structure to the call if possible. + +1. Follow instructions from the Incident Commander. + * **Is there no IC on the call?** + * Manually page them via Slack, with `!ic page` in Slack. This will page the primary and backup IC's at the same time. + * Never hesitate to page the IC. It's much better to have them and not need them than the other way around. + +## Steps for Incident Commander +Resolve the incident as quickly and as safely as possible, use the Deputy to assist you. Delegate any tasks to relevant experts at your discretion. + +1. Announce on the call and in Slack that you are the incident commander, who you have designated as deputy (usually the backup IC), and scribe. + +1. Identify if there is an obvious cause to the incident (recent deployment, spike in traffic, etc.), delegate investigation to relevant experts, + * Use the service experts on the call to assist in the analysis. They should be able to quickly provide confirmation of the cause, but not always. It's the call of the IC on how to proceed in cases where the cause is not positively known. Confer with service owners and use their knowledge to help you. + +1. Identify investigation & repair actions (roll back, rate-limit services, etc) and delegate actions to relevant service experts. Typically something like this (obviously not an exhaustive list), + * **Bad Deployment:** Roll it back. + * **Web Application Stuck/Crashed:** Do a rolling restart. + * **Event Flood:** Validate automatic throttling is sufficient, adjust manually if not. + * **Data Center Outage:** Validate automation has removed bad data center. Force it to do so if not. + * **Degraded Service Behavior without load:** Gather forensic data (heap dumps, etc), and consider doing a rolling restart. + +1. Listen for prompts from your Deputy regarding severity escalations, decide whether we need to announce publicly, and instruct customer liaison accordingly. + * Announcing publicly is at your discretion as IC. If you are unsure, then announce publicly ("If in doubt, tweet it out"). + +1. Once incident has recovered or is actively recovering, you can announce that the incident is over and that the call is ending. This usually indicates there's no more productive work to be done for the incident right now. + * Move the remaining, non-time-critical discussion to Slack. + * Follow up to ensure the customer liaison wraps up the incident publicly. + * Identify any post-incident clean-up work. + * You may need to perform debriefing/analysis of the underlying root cause. + +1. (After call ends) Create the post-mortem page from the template, and assign an owner to the post-mortem for the incident. + +1. (After call ends) Send out an internal email explaining that we had a major incident, provide a link to the post-mortem. + +## Steps for Deputy +You are there to support the IC in whatever they need. + +1. Monitor the status, and notify the IC if/when the incident escalates in severity level, + * OfficerURL can help you to monitor the status on Slack, + * `!status` - Will tell you the current status. + * `!status stalk` - Will continually monitor the status and report it to the room every 30s. + +1. Be prepared to page other people as directed by the Incident Commander. + +1. Provide regular status updates in Slack (roughly every 30mins) to the executive team, giving an executive summary of the current status. Keep it short and to the point, and use @here. + +1. Follow instructions from the Incident Commander. + +## Steps for Scribe +You are there to document the key information from the incident in Slack. + +1. Update the Slack room with who the IC is, who the Deputy is, and that you're the scribe (if not already done). + * e.g. "IC: Bob Boberson, Deputy: Deputy Deputyson, Scribe: Writer McWriterson" + +1. You should add notes to Slack when significant actions are taken, or findings are determined. You don't need to wait for the IC to direct this - use your own judgment. + * You should also add `TODO` notes to the Slack room that indicate follow-ups slated for later. + +1. Follow instructions from the Incident Commander. + +## Steps for Subject Matter Experts +You are there to support the incident commander in identifying the cause of the incident, suggesting and evaluation repair actions, and following through on the repair actions. + +1. Investigate the incident by analyzing any graphs or logs at your disposal. Announce all findings to the incident commander. + * If you are unsure of the cause, that's fine, state that you are investigating and provide regular updates to the IC. + +1. Announce all suggestions for resolution to the incident commander, it is their decision on how to proceed, do not follow any actions unless told to do so! + +1. Follow instructions from the incident commander. + +1. (Optional) Once the call is over and post-mortem is created, add any notes you think are relevant to the post-mortem page. + +## Steps for Customer Liaison +Be on stand-by to post public facing messages regarding the incident. + +1. You will typically be required to update the status page and to send Tweets from our various accounts at certain times during the call. + +1. Follow instructions from the Incident Commander. diff --git a/docs/during/security_incident_response.md b/docs/during/security_incident_response.md new file mode 100644 index 0000000..f370a2a --- /dev/null +++ b/docs/during/security_incident_response.md @@ -0,0 +1,141 @@ +!!! note "Incident Commander Required" + As with all major incidents at PagerDuty, security ones will also involve an Incident Commander, who will delegate the tasks to relevant resolvers. Tasks may be performed in parallel as assigned by the IC. Page one at the earliest possible opportunity. + +## Checklist +Details for each of these items are available in the next section. + +1. Stop the attack in progress. +1. Cut off the attack vector. +1. Assemble the response team. +1. Isolate affected instances. +1. Identify timeline of attack. +1. Identify compromised data. +1. Assess risk to other systems. +1. Assess risk of re-attack. +1. Apply additional mitigations, additions to monitoring, etc. +1. Forensic analysis of compromised systems. +1. Internal communication. +1. Involve law enforcement. +1. Reach out to external parties that may have been used as vector for attack. +1. External communication. + +--- + +## Attack Mitigation +Stop the attack as quickly as you can, via any means necessary. Shut down servers, network isolate them, turn off a data center if you have to. Some common things to try, + +* Shutdown the instance from the provider console (do not delete or terminate if you can help it, as we'll need to do forensics). +* If you happen to be logged into the box you can try to, + * Re-instate our default iptables rules to restrict traffic. + * `kill -9` any active session you think is an attacker. + * Change root password, and update /etc/shadow to lock out all other users. + * `sudo shutdown now` + +## Cut Off Attack Vector +Identify the likely attack vectors and path/fix them so they cannot be re-exploited immediately after stopping the attack. + +* If you suspect a third-party provider is compromised, delete all accounts except your own (and those of others who are physically present) and immediately rotate your password and MFA tokens. +* If you suspect a service application was an attack vector, disable any relevant code paths, or shut down the service entirely. + +## Assemble Response Team +Identify the key responders for the security incident, and keep them all in the loop. Set up a secure method of communicating all information associated with the incident. Details on the incident (or even the fact that an incident has occurred) should be kept private to the responders under you are confident the attack is not being triggered internally. + +* The security and site-reliability teams should usually be involved. +* A representative for any affected services should be involved. +* An Incident Commander (IC) should be appointed, who will also appoint the usual incident command roles. The incident command team will be responsible for keeping documentation of actions taken, and for notifying internal stakeholders as appropriate. +* Do not communicate with anyone not on the response team about the incident until forensics has been performed. The attack could be happening internally. +* Give the project an innocuous codename that can be used for chats/documents so if anyone overhears they don't realize it's a security incident. (e.g. sapphire-unicorn). +* Prefix all emails, and chat topics with "Attorney Work Project". + +## Isolate Affected Instances +Any instances which were affected by the attack should be immediately isolated from any other instances. As soon as possible, an image of the system should be taken and put into a read-only cold storage for later forensic analysis. + +* Blacklist the IP addresses for any affected instances from all other hosts. +* Turn off and shutdown the instances immediately if you didn't do that to stop the attack. +* Take a disk image for any disks attached to the instances, and ship them to an off-site cold storage location. You should make sure these images are read-only and cannot be tampered with. + +## Identify Timeline of Attack +Work with all tools at your disposal to identify the timeline of the attack, along with exactly what the attacker did. + +* Any reconnaissance the attacker performed on the system before the attack started. +* When the attacker gained access to the system. +* What actions the attacker performed on the system, and when. +* Identify how long the attacker had access to the system before they were detected, and before they were kicked out. +* Identify any queries the attacker ran on databases. +* Try to identify if the attacker still has access to the system via another back door. Monitor logs for unusual activity, etc. + +## Compromised Data +Using forensic analysis of log files, time-series graphs, and any other information/tools at your disposal, attempt to identify what information was compromised (if any), + +* Identify any data that was compromised during the attack. + * Was any data exfiltrated from a database? + * What keys were on the system that are now considering compromised? + * Was the attacker able to identify other components of the system (map out the network, etc). +* Find exactly what customer data has been compromised, if any. + +## Assess Risk +Based on the data that was compromised, assess the risk to other systems. + +* Does the attacker have enough information to find another way in? +* Were any passwords or keys stored on the host? If so, they should be considered compromised, regardless of how they were stored. +* Any user accounts that were used in the initial attack should rotate all of their keys and passwords on every other system they have an account. + +## Apply Additional Mitigations +Start applying mitigations to other parts of your system. + +* Rotate any compromised data. +* Identify any new alerting which is needed to notify of a similar breach. +* Block any IP addresses associated with the attack. +* Identify any keys/credentials that are compromised and revoke their access immediately. + +## Forensic Analysis +Once you are confident the systems are secured, and enough monitoring is in place to detect another attack, you can move onto the forensic analysis stage. + +* Take any read-only images you created, any access logs you have, and comb through them for more information about the attack. +* Identify exactly what happened, how it happened, and how to prevent it in future. +* Keep track of all IP addresses involved in the attack. +* Monitor logs for any attempt to regain access to the system by the attacker. + +## Internal Communication +**Delegate to:** VP or Director of Engineering + +Communicate internally only once you are confident (via forensic analysis) that the attack was not sourced internally. + +* Don't go into too much detail. +* Overview the timeline. +* Discuss mitigation steps taken. +* Follow up with more information once it is known. + +## Liaise With Law Enforcement / External Actors +**Delegate to:** VP or Director of Engineering + +Work with law enforcement to identify the source of the attack, letting any system owners know that systems under their control may be compromised, etc. + +* Contact local law enforcement. +* Contact FBI. +* Contact operators for any systems used in the attack, their systems may also have been compromised. +* Contact security companies to help in assessing risk and any PR next steps. + +## External Communication +**Delegate to:** Marketing Team + +Once you have validated all of the information you have is accurate, have a timeline of events, and know exactly what information was compromised, how it was compromised, and sure that it won't happen again. Only then should you prepare and release a public statement to customers informing them of the compromised information and any steps they need to take. + +* Include the date in the title of any announcement, so that it's never confused for a potential new breach. +* Don't say "We take security very seriously". It makes everyone cringe when they read it. +* Be honest, accept responsibility, and present the facts, along with exactly how we plan to prevent such things in future. +* Be as detailed as possible with the timeline. +* Be as detailed as possible in what information was compromised, and how it affects customers. If we were storing something we shouldn't have been, be honest about it. It'll come out later and it'll be much worse. +* Don't name and shame any external parties that might have caused the compromise. It's bad form. (Unless they've already publicly disclosed, in which case we can link to their disclosure). +* Release the external communication as soon as possible, preferably within a few days of the compromise. The longer we wait, the worse it will be. +* Figure out if there is a way to get in touch with customers' internal security teams before the general public notice is sent. + +--- + +## Additional Reading + +* [Computer Security Incident Handling Guide](http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-61r2.pdf) (NIST) +* [Incident Handler's Handbook](https://www.sans.org/reading-room/whitepapers/incident/incident-handlers-handbook-33901) (SANS) +* [Responding to IT Security Incidents](https://technet.microsoft.com/en-us/library/cc700825.aspx) (Microsoft) +* [Defining Incident Management Processes for CSIRTs: A Work in Progress](http://resources.sei.cmu.edu/library/asset-view.cfm?assetid=7153) (CMU) +* [Creating and Managing Computer Security Incident Handling Teams (CSIRTS)](https://www.first.org/conference/2008/papers/killcrece-georgia-slides.pdf) (CERT) diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..72ff885 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,52 @@ +This documentation covers parts of the PagerDuty Incident Response process. It is a cut-down version of our internal documentation, used at PagerDuty for any major incidents, and to prepare new employees for on-call responsibilities. It provides information not only on preparing for an incident, but also what to do during and after. It is intended to be used by on-call practitioners and those involved in an operational incident response process (or those wishing to enact a formal incident response process). See the [about page](about.md) for more information on what this documentation is and why it exists. + +![Incident Response at PagerDuty](./assets/img/headers/pagerduty_ir.jpg) + +## Being On-Call + +If you've never been on-call before, you might be wondering what it's all about. These pages describe what the expectations of being on-call are, along with some resources to help you. + +* [Being On-Call](oncall/being_oncall.md) - _A guide to being on-call, both what your responsibilities are, and what they are not._ +* [Alerting Principles](oncall/alerting_principles.md) - _The principles we use to determine what things page an engineer, and what time of day they page._ + +## Before an Incident + +Reading material for things you probably want to know before an incident occurs. You likely don't want to be reading these during an actual incident. + +* [Severity Levels](before/severity_levels.md) - _Information on our severity level classification. What constitutes a SEV-3? What's a "Major Incident"?, etc._ +* [Different Roles for Incidents](before/different_roles.md) - _Information on the roles during an incident; Incident Commander, Scribe, etc._ +* [Incident Call Etiquette](before/call_etiquette.md) - _Our etiquette guidelines for incident calls, before you find yourself in one._ + +## During an Incident + +Information and processes during a major incident. + +* [During an Incident](during/during_an_incident.md) - _Information on what to do during an incident, and how to constructively contribute._ +* [Security Incident Response](during/security_incident_response.md) - _Security incidents are handled differently to normal operational incidents._ + +## After an Incident + +Our followup processes, how we make sure we don't repeat mistakes and are always improving. + +* [Post-Mortem Process](after/post_mortem_process.md) - _Information on our post-mortem process; what's involved and how to write or run a post-mortem._ +* [Post-Mortem Template](after/post_mortem_template.md) - _The template we use for writing our post-mortems for major incidents._ + +## Training + +So, you want to learn about incident response? You've come to the right place. + +* [Training Overview](training/overview.md) - _An overview of our training guides and additional training material from third-parties._ +* [Incident Commander Training](training/incident_commander.md) - _A guide to becoming our next Incident Commander._ +* [Deputy Training](training/deputy.md) - _How to be a deputy and back up the Incident Commander._ +* [Scribe Training](training/scribe.md) - _A guide to scribing._ +* [Subject Matter Expert Training](training/subject_matter_expert.md) - _A guide on responsibilities and behavior for all participants in a major incident._ +* [Glossary of Incident Response Terms](training/glossary.md) - _A collection of terms that you may hear being used, along with their definition._ + +## Additional Reading + +Useful material and resources from external parties that are relevant to incident response. + +* [Incident Management for Operations](http://shop.oreilly.com/product/0636920036159.do) (O'Reilly) +* [Incident Response](http://shop.oreilly.com/product/9780596001308.do) (O'Reilly) +* [Debriefing Facilitation Guide](http://extfiles.etsy.com/DebriefingFacilitationGuide.pdf) (Etsy) +* [US National Incident Management System (NIMS)](https://www.fema.gov/national-incident-management-system) (FEMA) diff --git a/docs/oncall/alerting_principles.md b/docs/oncall/alerting_principles.md new file mode 100644 index 0000000..05e6a3a --- /dev/null +++ b/docs/oncall/alerting_principles.md @@ -0,0 +1,35 @@ +We manage how we get alerted based on a simple principle, **an alert is something which requires a human to perform an action**. Anything else is a notification, which is something that we cannot control, and for which we cannot make any action to affect it. Notifications are useful, but they shouldn't be waking people up under any circumstance. + +!!! warning "High Priority Alerts" + Anything that wakes up a human in the middle of the night should be **immediately human actionable**. If it is none of those things, then we need to adjust the alert to not page at those times. + +| Priority | Alerts | Response | +| -------- | ------ | -------- | +| High | High-Priority PagerDuty Alert 24/7/365. | Requires **immediate human action**. | +| Medium | High-Priority PagerDuty Alert during **business hours only**. | Requires human action within 24 hours. | +| Low | Low-Priority PagerDuty Alert 24/7/365. | Requires human action at some point. | +| Notification | Suppressed PagerDuty Event. | No response required. Informational only. | + +If you're setting up a new alert/notification, consider the chart above for how you want to alert people. Be mindful of not creating new high-priority alerts if they don't require an immediate response, for example. + +## Examples + +#### "Production service is failing for 75% of requests, automation is unable to resolve."_ +This would be a **High** priority page, requiring immediate human action to resolve. + +![High Urgency](../assets/img/screenshots/high_urgency.png) + +#### "Production server disk space is filling, expected to be full in 48 hours. Log rotation is insufficient to resolve." +This would be a **Medium** priority page, requiring human action soon, but not immediately. + +![Medium Urgency](../assets/img/screenshots/high_business_hours.png) + +#### "An SSL certificate is due to expire in one week." +This would be a **Low** priority page, requiring human action some time soon. + +![Low Urgency](../assets/img/screenshots/low_urgency.png) + +#### "A deployment was successful." +This would be a **Notification**, and should be sent as a suppressed event. It provides useful context should an incident occur, but does not require notifying a human. + +![Notification](../assets/img/screenshots/suppressed.png) diff --git a/docs/oncall/being_oncall.md b/docs/oncall/being_oncall.md new file mode 100644 index 0000000..c3c8c09 --- /dev/null +++ b/docs/oncall/being_oncall.md @@ -0,0 +1,93 @@ +A summary of expectations and helpful information for being on-call. + +![Alert Fatigue](../assets/img/misc/alert_fatigue.png) + +## What is On-Call? +Being on-call means that you are able to be contacted at any time in order to investigate and fix issues that may arise for the system you are responsible for. For example, if you are on-call for your service at PagerDuty, should any alarms be triggered for that service, you will receive a "page" (an alert on your mobile device, email, phone call, or SMS, etc.) giving you details on what has broken and how to fix it. You will be expected to take whatever actions are necessary in order to resolve the issue and return your service to a normal state. + +On-call responsibilities extend beyond normal office hours, and if you are on-call you are expected to be able to respond to issues, even at 2am. This sounds horrible (and it can be), but this is what our customers go through, and is the problem that the PagerDuty product itself is trying to fix! + +## Responsibilities + +1. **Prepare** + * Have your laptop and Internet with you (office, home, a MiFi dongle, a phone with a tethering plan, etc). + * Have a way to charge your MiFi. + * Team alert escalation happens within 5 minutes, set/stagger your notification timeouts (push, SMS, phone...) accordingly. + * Make sure PagerDuty texts and calls can [bypass your "Do Not Disturb" settings](https://support.pagerduty.com/hc/en-us/articles/202828870-Phone-numbers-notifications-are-sent-from). + * Be prepared (environment is set up, a current working copy of the necessary repos is local and functioning, you have configured and tested environments on workstations, your credentials for third-party services are current and so on...) + * Read our Incident Response documentation (that's this!) to understand how we handle serious incidents, what the different roles and methods of communication are, etc. + * Be aware of your upcoming on-call time (primary, backup) and arrange swaps around travel, vacations, appointments etc. + +1. **Triage** + * Acknowledge and act on alerts whenever you can (see the first "Not responsibilities" point below) + * Determine the urgency of the problem: + * Is it something that should be worked on right now or escalated into a major incident? ("production server on fire" situations. Security alerts) - do so. + * Is it some tactical work that doesn't have to happen during the night? (for example, disk utilization high watermark, but there's plenty of space left and the trend is not indicating impending doom) - snooze the alert until a more suitable time (working hours, the next morning...) and get back to fixing it then. + * Check Slack for current activity. Often (but not always) actions that could potentially cause alerts will be announced there. + * Does the alert and your initial investigation indicate a general problem or an issue with a specific service that the relevant team should look into? If it does not look like a problem you are the expert for, then escalate to another team. + +1. **Fix** + * You are empowered to dive into any problem and act to fix it. + * Involve other team members as necessary: do not hesitate to escalate if you cannot figure out the cause within a reasonable timeframe or if the service / alert is something you have not tackled before. + * If the issue is not very time sensitive and you have other priority work, create a JIRA ticket to keep a track of it (with an appropriate severity). + +1. **Improve** + * If a particular issue keeps happening; if an issue alerts often but turns out to be a preventable non-issue – perhaps improving this should be a longer-term task. + * Disks that fill up, logs that should be rotated, noisy alerts... + * If information is difficult / impossible to find, write it down. Constantly refactor and improve our knowledge base and documentation. Add redundant links and pointers if your mental model of the wiki / codebase does not match the way it is currently organized. + +1. **Support** + * When your on-call "shift" ends, let the next on-call know about issues that have not been resolved yet and other experiences of note. + * If you are making a change that impacts the schedule (adding / removing yourself, for example), let others know since many of us make arrangements around the on-call schedule well in advance. + * Support each other: when doing activities that might generate plenty of pages, it is courteous to "take the page" away from the on-call by notifying them and scheduling an override for the duration. + +## Not Responsibilities + +1. No expectation to be the first to acknowledge _all_ of the alerts during the on-call period. + * Commute (and other necessary distractions) are facts of life, and sometimes it is not possible to receive or act on an before it escalates. That's what we have the backup on-call and schedule for. + +1. No expectation to fix all issues by yourself. + * No one knows everything. Your whole team is here to help. There is no shame, and much to be learned, by escalating issues you are not certain about. Our motto is "Never hesitate to escalate". + * Service owners will always know more about how their stuff works. Especially if our and their documentation is lacking, double-checking with the relevant team avoids mistakes. Measure twice, cut once – and it's often best to let the subject matter expert do the cutting. + +## Recommendations +If your team is starting it's own on-call rotation, here are some scheduling recommendations from the Operations team. + +* Always have a backup schedule. Yes, this means two people being on-call at the same time, however it takes a lot of the stress off of the primary if they know they have a specific backup they can contact, rather than trying to chose a random member of the team. + * A backup shift should generally come directly after a primary shift. It gives chance for the previous primary to pass on additional context which may have come up during their shift. It also helps to prevent people from sitting on issues with the intent of letting the next shift fix it. + +* The third-level of your escalation (after backup schedule) should probably be your entire team. This should hopefully never happen (it's happened once in the history of the Operations team), but when it does, it's useful to be able to just get the next available person. + +![Escalation](../assets/img/misc/escalation.png) + +* Team managers can (and should) be part of your normal rotation. It gives a better insight into what has been going on. + +* New members of the team should shadow your on-call rotation during the first few weeks. They should get all alerts, and should follow along with what you are doing. (All new employees shadow the Operations team for one week of on-call, but it's useful to have new team members shadow your team rotations also. Just not at the same time). + +* We recommend you set your escalation timeout to 5 minutes. This should be plenty of time for someone to acknowledge the incident if they're able to. If they're not able to within 5 minutes, then they're probably not in a good position to respond to the incident anyway. + +* When going off-call, you should provide a quick summary to the next on-call about any issues that may come up during their shift. A service has been flapping, an issue is likely to re-occur, etc. If you want to be formal, this can be a written report via email, but generally a verbal summary is sufficient. + +### Notification Method Recommendations +You are free to set up your notification rules as you see fit, to match how you would like to best respond to incidents. If you're not sure how to configure them, the Operations team has some recommendations, + +![Mobile Alerts](../assets/img/misc/mobile_alerts.png) + +* Use Push Notification and Email as your first method of notification. Most of us have phones with us at all times, so this is a prudent first method and is usually sufficient. +* Use Phone and/or SMS notification each minute after, until the escalation time. If Push didn't work, then it's likely you need something stronger, like a phone call. Keep calling every minute until it's too late. If you don't pick up by the 3rd time, then it's unlikely you are able to respond, and the incident will get escalated away from you. + +## Etiquette + +* If the current on-call comes into the office at 12pm looking tired, it's not because they're lazy. They probably got paged in the night. Cut them some slack and be nice. + +* Don't acknowledge an incident out from under someone else. If you didn't get paged for the incident, then you shouldn't be acknowledging it. Add a comment with your notes instead. + +![Acknowledging](../assets/img/misc/ack.png) + +* If you are testing something, or performing an action that you know will cause a page, it's customary to "take the pager" for the time during which you will be testing. Notify the person on-call that you are taking the pager for the next hour while you test. + +* "Never hesitate to escalate" - Never feel ashamed to rope in someone else if you're not sure how to resolve an issue. Likewise, never look down on someone else if they ask you for help. + +* Always consider covering an hour or so of someone else's on-call time if they request it and you are able. We all have lives which might get in the way of on-call time, and one day it might be you who needs to swap their on-call time in order to have a night out with your friend from out of town. + +* If an issue comes up during your on-call shift for which you got paged, you are responsible for resolving it. Even if it takes 3 hours and there's only 1 hour left of your shift. You can hand over to the next on-call if they agree, but you should never assume that's possible. diff --git a/docs/training/deputy.md b/docs/training/deputy.md new file mode 100644 index 0000000..2988961 --- /dev/null +++ b/docs/training/deputy.md @@ -0,0 +1,57 @@ +So you want to be a deputy? You've come to the right place! + +![Deputy](../assets/img/headers/incident_command_support.jpg) +*Credit: [oregondot @ Flickr](https://www.flickr.com/photos/oregondot/8743801731/in/album-72157633494644719/)* + +## Purpose +The purpose of the Deputy is to support the IC by keeping track of timers, notifying the IC of important information, and paging other people as directed by the IC. + +It's important for the IC to focus on the problem at hand, rather than worrying about monitoring timers. The deputy is there to help support the IC and keep them focussed on the incident. + +As a Deputy, you will be expected to take over command from the IC if they request it. + +**You should not be performing any remediations, checking graphs, or investigating logs**. Those tasks will be delegated to the resolvers by the IC. + +## Prerequisites +Before you can be a Deputy, it is expected that you meet the following criteria. Don't worry if you don't meet them all yet, you can still continue with training! + +* Be trained as an [Incident Commander](/training/incident_commander.md). + +## Responsibilities +Read up on our [Different Roles for Incidents](/before/different_roles.md) to see what is expected from a Deputy, as well as what we expect from the other roles you'll be interacting with. + +## Training Process +The training process for a Deputy is quite simple. + +* Follow our [Incident Commander Training](/training/incident_commander.md). +* Read this page. + +## Incident Call Procedures and Lingo +The [Steps for Deputy](/during/during_an_incident.md) provide a detailed description of what you should be doing during an incident. + +Here are some examples of phrases and patterns you should use during incident calls. + +### Keep Track of Responders +As you listen to the call, you should keep track of the responders to the call as you hear them speak. Make a note on a piece of paper, or use the `!ic responders` to see who they are. The IC may ask you who is on-call for a particular system, and you should know the answer, and be able to page them. + +> Do we have a representative from [X] on the call? + +> (pause) + +> Deputy, can you go ahead and page the [X] on-call please. + +You can page them however you see fit, phone call, etc. + +### Provide Executive Status Updates +Provide regular status updates on Slack (roughly every 30mins), giving an executive summary of the current status during SEV-1 incidents. Keep it short and to the point, and use @here. Mention the current state, the actions in progress, customer impact, and expected time remaining. It's OK to miss out some of those if the information isn't known. + +> @here: We are in SEV-1 due to X. Current actions in progress are to do Y. Expecting 3mins to complete that action. Once action is complete, system should recover on it's own within 5minutes. + +### Alert IC to Timers +You are expected to keep track of how long the incident has been running for, and provide callouts to the IC every 10 minutes so they can take actions such as increasing the severity, or asking Support to Tweet out. This is as simple as telling the IC on the call, + +> IC, be advised the incident is now at the 10 minute mark. + +Similarly, when the IC asks for someone to get back to them in X minutes, you are expected to keep track of that. You should remind the IC when that time has been reached. + +> IC, be advised the timer for [TEAM]'s investigation is up. diff --git a/docs/training/glossary.md b/docs/training/glossary.md new file mode 100644 index 0000000..d197a4c --- /dev/null +++ b/docs/training/glossary.md @@ -0,0 +1,14 @@ +Ever wonder what all of those strange words you sometimes see in our documentation mean? This page is here to help. + +| Term | Description | +| ---- | ----------- | +| **IC / Incident Commander** | The incident commander is the person responsible for bringing any major incident to resolution. They are the highest ranking individual on any major incident call, regardless of their day-to-day rank. Their decisions made as commander are final. [More info](../before/different_roles.md). | +| **Deputy** | Typically the backup IC. The deputy's job is to support the IC during the call, providing them with any help they need. [More info](../before/different_roles.md). | +| **Scribe** | The scribe's job is to keep a log of all activities performed during the call in a written chat log on Slack. [More info](../before/different_roles.md). | +| **Resolver** | A person on the incident call who is able to help resolve issues within a particular system. Also referred to as an SME (see below). [More info](../before/different_roles.md). | +| **SME** | "Subject Matter Expert", someone who is an expert in a particular service or subject who can provide information to the IC, and perform resolution actions for a particular system. [More info](../before/different_roles.md). | +| **CAN Report** | CAN stands for "Conditions" "Actions" "Needs", if an IC asks you for a CAN report, you should provide the current state of your service (condition), what actions need to be taken to return it to a healthy state (actions), and what support you need in order to perform the actions (needs). | +| **Sev / Severity** | How severe the incident is. The "sev" of an incident determines the type of response we give. The higher the severity, the higher the likelihood of making risky actions to resolve the situation. [More info](../before/severity_levels.md). | +| **Span of Control** | Refers to the number of direct reports you have. For example, if the IC has 10 people as direct reports on a call, they have a large span of control. We aim to make the span of control as minimal as we can while still being productive. | +| **Grenade Thrower** | Someone who joins the call at a late time in the game, and provides information that completely derails the current thinking. They then leave almost immediately. | +| **Executive Swoop** | When an executive comes on the call and drops some sort of bombshell. A version of grenade throwing. | diff --git a/docs/training/incident_commander.md b/docs/training/incident_commander.md new file mode 100644 index 0000000..e3f88e7 --- /dev/null +++ b/docs/training/incident_commander.md @@ -0,0 +1,263 @@ +So you want to be an incident commander? You've come to the right place! You don't need to be a senior team member to become an IC, anyone can do it providing you have the requisite knowledge (yes, even an intern)! + +![Gene Kranz](../assets/img/headers/gene_kranz.jpg) +*Credit: [NASA](https://en.wikipedia.org/wiki/File:Eugene_F._Kranz_at_his_console_at_the_NASA_Mission_Control_Center.jpg)* + +## Purpose +If you could boil down the definition of an Incident Commander to one sentence, it would be, + +> Take whatever actions are necessary to protect PagerDuty systems and customers. + +The purpose of the Incident Commander is to be the decision maker during an major incident; Delegating tasks and listening to input from subject matter experts in order to bring the incident to resolution. + +The Incident Commander becomes the highest ranking individual on any major incident call, regardless of their day-to-day rank. Their decisions made as commander are final. + +Your job as an IC is to listen to the call and to watch the incident Slack room in order to provide clear coordination, recruiting others to gather context/details. **You should not be performing any actions or remediations, checking graphs, or investigating logs.** Those tasks should be delegated. + +## Prerequisites +Before you can be an Incident Commander, it is expected that you meet the following criteria. Don't worry if you don't meet them all yet, you can still continue with training! + +* Has **excellent knowledge of PagerDuty systems** and is able to quickly evaluate good vs bad options, and quickly identify what's actually going on. +* Been at PagerDuty for at least 6 months and has a **solid understanding of the incident notification pipeline and web stack**. +* Excellent verbal and written **communication skills**. +* Has **knowledge of obscure PagerDuty terms**. +* Has gravitas and is **willing to kick people off a call** to remove distractions, even if it's the CEO. + +## Responsibilities +Read up on our [Different Roles for Incidents](/before/different_roles.md) to see what is expected from an Incident Commander, as well as what we expect from the other roles you'll be interacting with. + +## Qualities +Some qualities we expect from an effective leader include being able to: + +* Take command. +* Motivate responders. +* Communicate clear directions. +* Size up the situation and make rapid decisions. +* Assess the effectiveness of tactics/strategies. +* Be flexible and modify your plans as necessary. + +As a leader, you should try to: + +* Be proficient in your job. +* Make sound and timely decisions. +* Ensure tasks are understood. +* Be prepared to step out of a tactical role to assume a leadership role. + +## Training Process +The process is fairly loose for now. Here's a list of things you can do to train though, + +* Read the rest of this page, particularly the sections below. + +* Participate in [Failure Friday](https://www.pagerduty.com/blog/failure-friday-at-pagerduty/) (FF). + * Shadow a FF to see how it's run. + * Be the scribe for multiple FF's. + * Be the incident commander for multiple FF's. + +* Play a game of "[Keep Talking and Nobody Explodes](http://www.keeptalkinggame.com/)" with other people in the office. + * For a more realistic experience, play it with someone in a different office over Hangouts. + +* Shadow a current incident commander for at least a full week shift. + * Get alerted when they do, join in on the same calls. + * Sit in on an active incident call, follow along with the chat, and follow along with what the Incident Commander is doing. + * **Do not actively participate in the call, keep your questions until the end.** + +* Reverse shadow a current incident commander for at least a full week shift. + * You should be the one to respond to incidents, and you will take point on calls, however the current IC will be there to take over should you not know how to proceed. + +## Graduation +What's the difference between an IC in training, and an IC? (This isn't the set up to a joke). Simple, an IC puts themselves on the schedule. + +## Handling Incidents +Every incident is different (we're hopefully not repeating the same issue multiple times!), but there's a common process you can apply to each one. + +1. **Identify the symptoms.** + * Identify what the symptoms are, how big the issue is, and whether it's escalating/flapping/static. + +1. **Size-up the situation.** + * Gather as much information as you can, as quickly as you can (remember the incident is still happening while you're doing this). + * Get the facts, the possibilities of what can happen, and the probability of those things happening. + +1. **Stabilize the incident.** + * Identify actions you can use to proceed. + * Gather support for the plan (See "Polling During a Decision" below). + * Delegate remediation actions to your SME's. + +1. **Provide regular updates.** + * Maintain a cadence, and provide regular updates to everyone on the call. + * What's happening, what are we doing about it, etc. + +## Deputy +The deputy for an incident is generally the backup Incident Commander. However, as an Incident Commander, you may appoint one or more Deputies. Note that Deputy Incident Commanders must be as qualified as the Incident Commander, and that if a Deputy is assigned, he or she must be fully qualified to assume the Incident Commander’s position if required. + +## Communication Responsibilities +Sharing information during an incident is a critical process. As an Incident Commander (or Deputy), you should be prepared to brief others as necessary. You will also be required to communicate your intentions and decisions clearly so that there is no ambiguity in your commands. + +When given information from a responder, you should clearly acknowledge that you have received and understood their message, so that the responder can be confident in moving on to other tasks. + +After an incident, you should communicate with other training Incident Commanders on any debrief actions you feel are necessary. + +## Incident Call Procedures and Lingo +The [Steps for Incident Commander](/during/during_an_incident.md) provide a detailed description of what you should be doing during an incident. + +Additionally, aside from following the [usual incident call etiquette](/before/call_etiquette.md), there a few extra etiquette guidelines you should follow as IC: + +* Always announce when you join the call if you are the on-call IC. +* Don't let discussions get out of hand. Keep conversations short. +* Note objections from others, but your call is final. +* If anyone is being actively disruptive to your call, kick them off. +* Announce the end of the call. + +Here are some examples of phrases and patterns you should use during incident calls. + +### Start of Call Announcement +At the start of any major incident call, the incident commander should announce the following, + +> This is [NAME], I am the Incident Commander for this call. + +This establishes to everyone on the call what your name is, and that you are now the commander. You should state "Incident Commander" and not "IC", as newcomers may not be familiar with the terminology yet. The word "commander" makes it very clear that you're in charge. + +### Start of Incident, IC Not Present +If you are trained to be an IC and have joined a call, even if you aren't the IC on-call, you should do the following, + +> Is there an IC on the call? + +> (pause) + +> Hearing no response, this is [NAME], and I am now the Incident Commander for this call. + +If the on-call IC joins later, you may hand over to them at your discretion (see below for the hand-off procedure) + +### Checking if SME's are Present +During a call, you will want to know who is available from the various teams in order to resolve the incident. Etiquette dictates that people should announce themselves, but someones you may be joining late to the call. If you need a representative from a team, just ask on the call. Your deputy can page one if no one answers. + +> Do we have a representative from [X] on the call? + +> (pause) + +> Deputy, can you go ahead and page the [X] on-call please. + +### Assigning Tasks +When you need to give out an assignment or task, give it to a person directly, never say "can someone do..." as this leads to the [bystander effect](https://en.wikipedia.org/wiki/Bystander_effect). Instead, all actions should be assigned to a specific person, and time-boxed with a specific number of minutes. + +> IC: Bob, please investigate the high latency on web app boxes. I'll come back to you for an answer in 3 minutes. + +> Bob: Understood + +Keep track of how many minutes you assigned, and check in with that person after that time. You can get help from your deputy to help track the timings. + +### Polling During a Decision +If a decision needs to be made, it comes down to the IC. Once the IC makes a decision, it is final. But it's important that no one can come later and object to the plan, saying things like "I knew that would happen". An IC will use very specific language to be sure that doesn't happen. + +> The proposal is to [EXPLAIN PROPOSAL] + +> Are there any strong objections to this plan? + +> (pause) + +> Hearing no objects, we are proceeding with this proposal. + +If you were to ask "Does everyone agree?", you'd get people speaking over each other, you'd have quiet people not speaking up, etc. Asking for any STRONG objections gives people the chance to object, but only if they feel strongly on the matter. + +### Status Updates +It's important to maintain a cadence during a major incident call. Whenever there is a lull in the proceedings, usually because you're waiting for someone to get back to you, you can fill the gap by explaining the current situation and the actions that are outstanding. This makes sure everyone is on the same page. + +> While we wait for [X], here's an update of our current situation. + +> We are currently in a SEV-1 situation, we believe to be caused by [X]. There's an open question to [Y] who will be getting back to us in 2 minutes. In the meantime, we have Tweeted out that we are experiencing issues. Our next Tweet will be in 10 minutes if the incident is still ongoing at that time. + +> Are there any additional actions or proposals from anyone else at this time? + +### Transfer of Command +Transfer of command, involves (as the name suggests) transferring command to another Incident Commander. There are multiple reasons why a transfer of command might take place, + +* Commander has become fatigued and is unable to continue. +* Incident complexity changes. +* Change of command is necessary for effectiveness or efficiency. +* Personal emergencies arise (e.g., Incident Commander has a family emergency). + +Never feel like you are not doing your job properly by handing over. Handovers are encouraged. In order to handover, out of band from the main call (via Slack for example), notify the other IC that you wish to transfer command. Update them with anything you feel appropriate. Then announce on the call, + +> Everyone on the call, be advised, at this time I am handing over command to [X]. + +The new IC should then announce on the call as if they were joining a new call (see above), so that everyone is aware of the new commander. + +Note that the arrival of a more qualified person does NOT necessarily mean a change in incident command. + +### Maintaining Order +Often times on a call people will be talking over one another, or an argument on the correct way to proceed may break out. As Incident Commander it's important that order is maintained on a call. The Incident Commander has the power to remove someone from the call if necessary (even if it's the CEO). But often times you just need to remind people to speak one at a time. Sometimes the discussion can be healthy even if it starts as an argument, but you shouldn't let it go on for too long. + +> (noise) + +> Ok everyone, can we all speak one at a time please. So far I'm hearing two options to proceed: 1) [X], 2) [Y]. + +> Are there any other proposals someone would like to make at this time? + +> ...etc + +### Getting Straight Answers +You may ask a question as IC and receive an answer that doesn't actually answer your question. This is generally when you ask for a yes/no answer but get a more detailed explanation. This can often times be because the person doesn't understand the call etiquette. But if it continues, you need to take action in order to proceed. + +> IC: Is this going to disable the service for everyone? + +> SME: Well... for some people it.... + +> IC: Stop. I need a yes/no answer. Is this going to disable the service for everyone? + +> SME: Well... it might not do... + +> IC: Stop. I'm going to ask again, and the only two words I want to hear from you are "yes" or "no. If this going to disable the service for everyone? + +> SME: Well.. like I was saying.. + +> IC: Stop. Leave the call. Backup IC can you please page the backup on-call for [service] so that we can get an answer. + +### Executive Swoop +You may get someone who would be senior to you during peacetime come on the call and start overriding your decisions as IC. This is unacceptable behaviour during wartime, as the IC is in command. While this is rare, you can get things back on track with the following, + +> Executive: No, I don't want us doing that. Everyone stop. We need to rollback instead. + +> IC: Hold please. [EXECUTIVE], do you wish to take over command? + +> Executive: Yes/No + +> (If yes) IC: Understood. Everyone on the call, be advised, at this time I am handling over command to [EXECUTIVE]. They are now the incident commander for this call. + +> (If no) IC: In that case, please cause no further interruptions or I will remove you from the call. + +This makes it clear to the executive that they have the option of being in charge and making decisions, but in order to do so they must continue as an Incident Commander. If they refuse, then remind them that you are in charge and disruptive interruptions will not be tolerated. If they continue, remove them from the call. + +### End of Call Sign-Off +At the end of an incident, you should announce to everyone on the call that you are ending the call at this time, and provide information on where followup discussion can take place. It's also customary to thank everyone. + +> Ok everyone, we're ending the call at this time. Please continue any followup discussion on Slack. Thanks everyone. + +## Examples From Pop Culture +PagerDuty employees have access to all previous incident calls, and can listen to them at their discretion. We can't release these calls, so for everyone else, here are some short examples from popular culture to show the techniques at work. + +--- + + +Here's a clip from the movie Apollo 13, where Gene Kranz (Flight Director / Incident Commander) shows some great examples of Incident Command. Here are some things to note: + +* Walks into the room, and immediately obvious that he's the IC. Calms the noise, and makes sure everyone is paying attention. +* Provides a status update so people are aware of the situation. +* Projector breaks, doesn't get sidetracked on fixing it, just moves on to something else. +* Provides a proposal for how to proceed and elicits feedback. + * Listens to the feedback calmly. + * When counter-proposal is raised, states that he agrees and why. +* Allows a discussion to happen, listens to all points. When discussion gets out of hand, re-asserts command of the situation. + * Explains his decision, and why. +* Explains his full plan and decision, so everyone is on the same page. + +--- + + +Another clip from Apollo 13. Things to note: + +* Summarizes the situation, and states the facts. +* Listens to the feedback from various people. +* When a trusted SME provides information counter to what everyone else is saying, asks for additional clarification ("What do you mean, everything?") +* Wise cracking remarks are not acknowledged by the IC ("You can't run a vacuum cleaner on 12 amps!") +* "That's the deal?".. "That's the deal". +* Once decision is made, moves on to the next discussion. +* Delegates tasks. diff --git a/docs/training/overview.md b/docs/training/overview.md new file mode 100644 index 0000000..2f112f5 --- /dev/null +++ b/docs/training/overview.md @@ -0,0 +1,22 @@ +Learning about the PagerDuty major incident response process is an important part of being an effective on-call engineer at PagerDuty. This section goes over our training material for the various roles that are involved in our incident response, along with some additional information and training material from government agencies. + +## Training Guides +Our training guides are split up by role, however you are encouraged to read through the training guides even for roles you don't belong to, as it can give you some good insight into how those people will be behaving during major incidents. + +* [Incident Commander Training](/training/incident_commander.md) - The "IC" is the person who drives a major incident to resolution. They're the person who will be directing everyone else. +* [Deputy Training](/training/deputy.md) - The Deputy is someone who supports the Incident Commander and can take over for them if necessary. +* [Scribe Training](/training/scribe.md) - This is intended for individuals who will be acting as a scribe during an incident. +* [SME / Resolver Training](/training/subject_matter_expert.md) - This is relevant to everyone at PagerDuty who are on-call for any team. + +## National Incident Management System (NIMS) +Our incident response process is loosely based on the [US National Incident Management System (NIMS)](https://www.fema.gov/national-incident-management-system), which is described as, + + _A systematic, proactive approach to guide departments and agencies at all levels of government, nongovernmental organizations, and the private sector to work together seamlessly and manage incidents involving all threats and hazards—regardless of cause, size, location, or complexity—in order to reduce loss of life, property and harm to the environment._ + +While it might not initially seem that this would be applicable to an IT operations environment, we've found that many of the lessons learned from major incidents in these situations can be directly applied to our industry too. The principles are the same and span many different environments. + +[![NIMS](../assets/img/thumbnails/nims_core.png)](https://www.fema.gov/pdf/emergency/nims/NIMS_core.pdf) [![NIMS Training](../assets/img/thumbnails/nims_training.png)](https://www.fema.gov/pdf/emergency/nims/nims_training_program.pdf) + +If you want to learn more about NIMS, we recommend the [ICS-100](https://training.fema.gov/is/courseoverview.aspx?code=IS-100.b) and [ICS-700](https://training.fema.gov/is/courseoverview.aspx?code=IS-700.a) online training courses, which go over NIMS and the Incident Command System (You can also take an online examination after training in order to get a certificate from FEMA). There is also a wealth of [additional training material and courses from FEMA](https://training.fema.gov/nims/) on NIMS, which I would encourage you to look at. + +Also take a look at the [Additional Reading](/#additional-reading) section on the home page. diff --git a/docs/training/scribe.md b/docs/training/scribe.md new file mode 100644 index 0000000..b00fc31 --- /dev/null +++ b/docs/training/scribe.md @@ -0,0 +1,75 @@ +So you want to be a scribe? You've come to the right place! You don't need to be a senior team member to become a deputy or scribe, anyone can do it providing you have the requisite knowledge! + +![Typewriter](../assets/img/headers/typewriter.jpg) +*Credit: [Holly Chaffin](http://www.publicdomainpictures.net/view-image.php?image=49706&picture=antique-typewriter-keys)* + +## Purpose +The purpose of the Scribe is to maintain a timeline of key events during an incident. Documenting actions, and keeping track of any followup items that will need to be addressed. + +It's important for the rest of the command staff to be able to focus on the problem at hand, rather than worrying about documenting the steps. + +Your job as is to listen to the call and to watch the incident Slack room, keeping track of context and actions that need to be performed, documenting these in Slack as you go. **You should not be performing any remediations, checking graphs, or investigating logs.** Those tasks will be delegated to the subject matter experts (SME's) by the Incident Commander. + + +## Prerequisites +Before you can be a Scribe, it is expected that you meet the following criteria. Don't worry if you don't meet them all yet, you can still continue with training! + +* Excellent verbal and written **communication skills**. +* Has **knowledge of obscure PagerDuty terms**. + +## Responsibilities +Read up on our [Different Roles for Incidents](/before/different_roles.md) to see what is expected from a Scribe, as well as what we expect from the other roles you'll be interacting with. + +## Training Process +There is no formal training process for this role, reading this page should be sufficient for most tasks. Here's a list of things you can do to train though, + +* Read the rest of this page, particularly the sections below. + +* Participate in [Failure Friday](https://www.pagerduty.com/blog/failure-friday-at-pagerduty/) (FF). + * Shadow a FF to see how it's run. + * Be the scribe for multiple FF's. + +## Scribing +Scribing is more art than science. The objective is to keep an accurate record of important events that occurred on the call, so that we can look back at the timeline to see what happened. But what exactly is important? There's no overwhelming answer, and it really comes down the judgement and experience. But here are some general things you most definitely want to capture as scribe. + +* The result of any polling decisions. + * ✘ This is not "9 people voted yay, 3 voted nay". + * ✓ It is "Polled for if we should do rolling restart. is proceeding with restart." +* Any followup items that are called out as "We should do this..", "Why didn't this?..", etc. + * ✘ This is not "Why isn't the Support representative on the call?" + * ✓ This is "TODO: Why didn't we get paged for this earlier?" + +## Incident Call Procedures and Lingo +The [Steps for Scribe](/during/during_an_incident.md) provide a detailed description of what you should be doing during an incident. + +Here are some examples of phrases and patterns you should use during incident calls. + +### Status Stalking +At the start of any major incident call, you should start our status stalking bot, so that it will post to the room an update automatically. + +> !status stalk + +This will provide the update and allow the IC to see the status without having to keep asking. + +### Note Important Actions +During a call, you will hear lots of discussion happening, you should not be documenting all of this in the chat room. You only want to document things which will be important for the final timeline. It's not always obvious what this might be, and it's usually a matter of judgement. You generally want to note any actions the IC has asked someone to perform, along with the result of any polling decisions. + +> Polled for decision on whether to perform rolling restart. We are proceeding with restart. to execute. + +Some actions might seem important at the time, but end up not being. That's OK. It's better to have more info than not enough, but don't go overboard. + +### Note Followup Actions +Sometimes during the call, someone will either mention something we "should fix", or the IC will specifically ask you to note a followup item. You can do this in Slack by simply prefixing with "TODO", this will make it easier to search for later. + +> TODO: Why did we not get paged for the fall in traffic on cluster? + +The post-mortem owner will find these after and raise tasks for them. + +### End of Call Notification +When the IC ends the call, you should post a message into Slack to let everyone know the call is over, and that they should continue discussion elsewhere. + +> Call is over, thanks everyone. Follow up in Slack. + +Don't forget to also stop the status stalking. + +> !status unstalk diff --git a/docs/training/subject_matter_expert.md b/docs/training/subject_matter_expert.md new file mode 100644 index 0000000..5b11dac --- /dev/null +++ b/docs/training/subject_matter_expert.md @@ -0,0 +1,54 @@ +If you are on-call for any team at PagerDuty, you may be paged for a major incident and will be expected to respond as a subject matter expert (SME) for your service. This page details everything you need to know in order to be prepared for that responsibility. If you are interested in becoming an Incident Commander, take a look at the [Incident Commander Training page](/training/incident_commander.md). + +![Incident Response](../assets/img/headers/incident_response.jpg) +*Credit: [oregondot @ Flickr](https://www.flickr.com/photos/oregondot/8743809853/in/album-72157633494644719/)* + +## On-Call Expectations +If you are on-call for your team, there are certain expectations of you as that on-call. This applies to both the primary and secondary on-calls. Getting paged about a SEV-3 or SEV-4 in your system comes with different expectations than getting paged with a major SEV-2. + +### Before Going On-Call + +1. Be prepared, by having already familiarized yourself with our incident response policies and procedures. In particular, + 1. [Different Roles for Incidents](/before/different_roles.md) - You will be acting as a "Resolver" or "SME". But you should familiarize yourself with the other roles and what they will be doing. + 1. [Incident Call Etiquette](/before/call_etiquette.md) - How to behave during an incident call. + 1. [During an Incident](/during/during_an_incident.md) - What to do during an incident. You are specifically interested in the "Resolver" steps, but you should familiarize yourself with the entire document. + 1. [Glossary](/training/glossary.md) - Familiarize yourself with the terminology that may be used during the call. +1. Make sure you have set up your alerting methods, and that PagerDuty can bypass your "Do Not Disturb" settings. +1. Check you can join the incident call. You may need to install a browser plugin. You don't want to be doing that the first time you get paged. +1. Be aware of your upcoming on-call time and arrange swaps around travel, vacations, appointments, etc. +1. If you are an Incident Commander, make sure you are not on-call for your team at the same time as being on-call as Incident Commander. + +### During On-Call Period + +1. Have your laptop and Internet with you at all times during your on-call period (office, home, a MiFi, a phone with a tethering plan, etc). +1. If you have important appointments, you need to get someone else on your team to cover that time slot in advance. +1. When you receive an alert for a major incident, you are expected to join the incident call and Slack as quickly as possible (within minutes). + 1. You will be asked questions or given actions by the Incident Commander. Answer questions concisely, and follow all actions given (even if you disagree with them). + +## Response Mobilization +When an incident occurs, you must be mobilized or assigned to become part of the incident response. In other words, until you are mobilized to the incident via a page or being directly asked by someone else on the incident, you remain in your everyday role. After being mobilized, your first task is to check in and receive an assignment. While it's tempting to see an incident happening and want to jump in and help, when resources show up that have not been requested, the management of the incident can be compromised. + +## "Never Hesitate to Escalate" +If you're not sure about something, it is perfectly acceptable to bring in other SMEs from your team that you believe know a given system better than you. Don't let your ego keep you from bringing in additional help. Our motto is "Never hesitate to escalate", you will never be looked down upon for escalating something because you didn't know how to handle it. + +## Blameless +There will be incidents. Some will be caused by you, some will be caused by others... some will just happen. Our entire incident response process is completely blameless. Blaming people is counter productive and just distracts from the problem at hand. No matter how an incident started, they all need to get solved as quickly as possible. + +## Wartime vs Peacetime +Behavior during a major incident is very different to any other alert you may have received in the past. We call a major incident "wartime", and make a distinction between that and normal everyday operations ("peacetime"). + +### Peacetime +The organizational structure is generally based on seniority. The more senior members of a team will lead discussions, and managers or team leads will have the final say. Decisions are made after careful consideration of all options, and to minimize potential risk to customers. + +### Wartime +Wartime is different, and you will notice on our major incident calls that there's a different organizational structure. + +* The Incident Commander is in charge. No matter their rank during peacetime, they are now the highest ranked individual on the call, higher than the CEO. +* Primary responders (folks acting as primary on-call for a team/service) are the highest ranked individuals for that service. +* Decisions will be made by the IC after consideration of the information presented. Once that decision is made, it is final. +* Riskier decisions can be made by the IC than would normally be considered during peacetime. + * For example, the IC may decide to drop events for a particular customer in order to maintain the integrity of the system for everyone else. +* The IC may go against a consensus decision. If a poll is done, and 9/10 people agree but 1 disagrees. The IC may choose the disagreement option despite a majority vote. + * Even if you disagree, the IC's decision is final. During the call is not the time to argue with them. +* The IC may use language or behave in a way you find rude. This is wartime, and they need to do whatever it takes to resolve the situation, so sometimes rudeness occurs. This is never anything personal, and something you should be prepared to experience if you've never been in a wartime situation before. +* You may be asked to leave the call by the IC, or you may even be forceable kicked off a call. It is at the IC's discretion to do this if they feel you are not providing useful input. Again, this is nothing personal and you should remember that wartime is different than peacetime. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ce441a5 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,64 @@ +# Project Information +site_name: PagerDuty Incident Response Documentation +site_description: A collection of information about the PagerDuty incident response process. Not only how to prepare new employees for on-call responsibilities, but also how to handle major incidents, both in preparation and after-work. +site_author: PagerDuty, Inc. +site_favicon: 'assets/img/icon.png' +site_url: https://response.pagerduty.com + +# Repository +repo_name: 'GitHub' +repo_url: https://github.com/pagerduty/incident-response-docs + +# Copyright +copyright: 'Copyright © PagerDuty, Inc.' + +# Theme +theme: 'material' +theme_dir: 'theme' +extra_css: ['assets/css/extra.css'] +extra: + logo: 'assets/img/icon.png' + cover: 'assets/img/cover.png' + palette: + primary: 'green' + accent: 'blue grey' + font: + text: 'Colfax Regular' + code: 'Roboto Mono' + author: + github: 'PagerDuty' + twitter: 'PagerDuty' + +# Contents +pages: + - Home: 'index.md' + - On-Call: + - Being On-Call: 'oncall/being_oncall.md' + - Alerting Principles: 'oncall/alerting_principles.md' + - Before an Incident: + - Severity Levels: 'before/severity_levels.md' + - Different Roles: 'before/different_roles.md' + - Call Etiquette: 'before/call_etiquette.md' + - During an Incident: + - During An Incident: 'during/during_an_incident.md' + - Security Incident: 'during/security_incident_response.md' + - After an Incident: + - Post-Mortem Process: 'after/post_mortem_process.md' + - Post-Mortem Template: 'after/post_mortem_template.md' + - Training: + - Overview: 'training/overview.md' + - Incident Commander: 'training/incident_commander.md' + - Deputy: 'training/deputy.md' + - Scribe: 'training/scribe.md' + - Subject Matter Expert: 'training/subject_matter_expert.md' + - Glossary: 'training/glossary.md' + - About: 'about.md' + +# Analytics +google_analytics: ['UA-8759953-1', 'auto'] + +# Extensions +markdown_extensions: + - toc(permalink=#) + - sane_lists: + - admonition: diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..2bff657 Binary files /dev/null and b/screenshot.png differ diff --git a/theme/404.html b/theme/404.html new file mode 100644 index 0000000..6feaf62 --- /dev/null +++ b/theme/404.html @@ -0,0 +1,15 @@ +{% extends "base.html" %} + +{# mkdocs-material doesn't use content as a block, so cheating and using footer here, as that does use a block #} +{% block footer %} + +
+

Sorry! We couldn't find that page.

+

Looks like our well-trained server monkeys dropped the ball. Rest assured they will be dealt with. In the meantime, you probably want to head home. +

+ +
+ {% include "footer.html" %} +
+ +{% endblock %} diff --git a/theme/base.html b/theme/base.html new file mode 100644 index 0000000..a16269d --- /dev/null +++ b/theme/base.html @@ -0,0 +1,196 @@ + + + + + + + + + {% set title = page_title ~ ' - ' ~ site_name if page_title else site_name %} + {{ title }} + + + {% if site_author %}{% endif %} + + + + {% if page_description %}{% endif %} + + + + + + + + + {% if canonical_url %}{% endif %} + + + {% set favicon = favicon | default("assets/images/favicon-e565ddfa3b.ico", true) %} + + + + + + + + {% if config.extra.logo %}{% endif %} + + + + + + + + + + + + + + + + + + + + {% if config.extra.palette %} + + {% endif %} + {% if config.extra.font != "none" %} + {% set text = config.extra.get("font", {}).text | default("Ubuntu") %} + {% set code = config.extra.get("font", {}).code | default("Ubuntu Mono") %} + {% set font = text + ':400,700|' + code | replace(' ', '+') %} + + + {% endif %} + {% for path in extra_css %} + + {% endfor %} + + + + {% block extrahead %}{% endblock %} + + {% set palette = config.extra.get("palette", {}) %} + {% set primary = palette.primary | replace(' ', '-') | lower %} + {% set accent = palette.accent | replace(' ', '-') | lower %} + + {% if repo_name == "GitHub" and repo_url %} + {% set repo_id = repo_url | replace("https://github.com/", "") %} + {% if repo_id[-1:] == "/" %} + {% set repo_id = repo_id[:-1] %} + {% endif %} + {% endif %} +
+
+
+ + + +
+ {% include "header.html" %} +
+
+ {% set h1 = "\x3ch1 id=" in content %} +
+ {% include "drawer.html" %} +
+
+
+ {% if not h1 %} +

{{ page_title | default(site_name, true)}}

+ {% endif %} + {{ content }} + + {% block footer %} +
+ {% include "footer.html" %} +
+ {% endblock %} +
+
+
+
+
+
+
+
+
+
+
+ + + {% for path in extra_javascript %} + + {% endfor %} + {% if google_analytics %} + + {% endif %} + + diff --git a/theme/drawer.html b/theme/drawer.html new file mode 100644 index 0000000..f22a5c9 --- /dev/null +++ b/theme/drawer.html @@ -0,0 +1,59 @@ + diff --git a/theme/header.html b/theme/header.html new file mode 100644 index 0000000..f64db37 --- /dev/null +++ b/theme/header.html @@ -0,0 +1,63 @@ +