diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..670154e3538863b2d9891fd5483160fbdfc89164 --- /dev/null +++ b/LICENSE @@ -0,0 +1,116 @@ +CC0 1.0 Universal + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator and +subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later +claims of infringement build upon, modify, incorporate in other works, reuse +and redistribute as freely as possible in any form whatsoever and for any +purposes, including without limitation commercial purposes. These owners may +contribute to the Commons to promote the ideal of a free culture and the +further production of creative, cultural and scientific works, or to gain +reputation or greater distribution for their Work in part through the use and +efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with a +Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or her +Copyright and Related Rights in the Work and the meaning and intended legal +effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not limited +to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, communicate, + and translate a Work; + + ii. moral rights retained by the original author(s) and/or performer(s); + + iii. publicity and privacy rights pertaining to a person's image or likeness + depicted in a Work; + + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + + v. rights protecting the extraction, dissemination, use and reuse of data in + a Work; + + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation thereof, + including any amended or successor version of such directive); and + + vii. other similar, equivalent or corresponding rights throughout the world + based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of +action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time +extensions), (iii) in any current or future medium and for any number of +copies, and (iv) for any purpose whatsoever, including without limitation +commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes +the Waiver for the benefit of each member of the public at large and to the +detriment of Affirmer's heirs and successors, fully intending that such Waiver +shall not be subject to revocation, rescission, cancellation, termination, or +any other legal or equitable action to disrupt the quiet enjoyment of the Work +by the public as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account +Affirmer's express Statement of Purpose. In addition, to the extent the Waiver +is so judged Affirmer hereby grants to each affected person a royalty-free, +non transferable, non sublicensable, non exclusive, irrevocable and +unconditional license to exercise Affirmer's Copyright and Related Rights in +the Work (i) in all territories worldwide, (ii) for the maximum duration +provided by applicable law or treaty (including future time extensions), (iii) +in any current or future medium and for any number of copies, and (iv) for any +purpose whatsoever, including without limitation commercial, advertising or +promotional purposes (the "License"). The License shall be deemed effective as +of the date CC0 was applied by Affirmer to the Work. Should any part of the +License for any reason be judged legally invalid or ineffective under +applicable law, such partial invalidity or ineffectiveness shall not +invalidate the remainder of the License, and in such case Affirmer hereby +affirms that he or she will not (i) exercise any of his or her remaining +Copyright and Related Rights in the Work or (ii) assert any associated claims +and causes of action with respect to the Work, in either case contrary to +Affirmer's express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + + b. Affirmer offers the Work as-is and makes no representations or warranties + of any kind concerning the Work, express, implied, statutory or otherwise, + including without limitation warranties of title, merchantability, fitness + for a particular purpose, non infringement, or the absence of latent or + other defects, accuracy, or the present or absence of errors, whether or not + discoverable, all to the greatest extent permissible under applicable law. + + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without limitation + any person's Copyright and Related Rights in the Work. Further, Affirmer + disclaims responsibility for obtaining any necessary consents, permissions + or other rights required for any use of the Work. + + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to this + CC0 or use of the Work. + +For more information, please see +<http://creativecommons.org/publicdomain/zero/1.0/> diff --git a/README.md b/README.md index 34b279eb3ab3d545f55a1968e36f72f731cd6cb2..776ca921e9d6424c440a3dfa6dbf28e01d0befa3 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ -# postmortem-templates \ No newline at end of file +# Postmortem Templates + +This is a collection of postmortem templates derived from different sources such as the [Site Reliability Engineering](https://landing.google.com/sre/) book, [The Practice of Cloud System Administration](http://the-cloud-book.com/) book and other online resources. + +## Template List +* [Template from Site Reliability Engineering book](templates/postmortem-template-srebook.md) +* [Template from The Practice of Cloud System Administration book](templates/postmortem-template-thecloudbook.md) +* [Template from Google Developers Blog post](templates/postmortem-template-google-api-infra.md) + +## Load templates automatically + +It is possible to automatically load the postmortem templates without copy pasting it from the files or writing the structure every time you want to author an incident report. + +### Vim +You can add the following line into your `.vimrc` file: + + au BufNewFile postmortem-*.md 0r ~/postmortem-templates/templates/postmortem-template-srebook.md + +### Emacs +You can add the following line into your `.emacs` file: + + (add-hook 'text-mode-hook (lambda () (when (and (string-prefix-p "postmortem-" (buffer-name)) (= (point-max) (point-min))) (insert-file-contents "~/postmortem-templates/templates/postmortem-template-srebook.md")))) + + +In both cases the filename pattern is `postmortem-*`. For example, if you create a file named `postmortem-api-outage-2017-05-29.md` it will load automatically the predefined template into that file. You can replace both the postmortem template and pattern to match your. + +### Postmortem resources +* [A collection of post-mortems](https://github.com/danluu/post-mortems) +* [Blameless PostMortems and a Just Culture](https://codeascraft.com/2012/05/22/blameless-postmortems/) +* [A Tale of Postmortems](https://blog.box.com/blog/a-tale-of-postmortems/) +* [Building a Blameless Post-Mortem Culture with Jason Hand](http://runasradio.com/Shows/Show/486) +* [The infinite hows](https://www.oreilly.com/ideas/the-infinite-hows) +* [Failure is Always An Option: How a Blameless Culture Leads to Better Results](https://victorops.com/blog/blameless-culture/) +* [How to write an Incident Report / Postmortem](https://sysadmincasts.com/episodes/20-how-to-write-an-incident-report-postmortem) +* [SysAdvent - Day 1 - Why You Need a Postmortem Process](https://sysadvent.blogspot.com/2016/12/day-1-why-you-need-postmortem-process.html) +* [Etsy’s Debriefing Facilitation Guide for Blameless Postmortems](https://codeascraft.com/2016/11/17/debriefing-facilitation-guide/) +* [Writing Your First Postmortem](https://medium.com/production-ready/writing-your-first-postmortem-8053c678b90f) +* [Site Reliability Engineering resources](https://github.com/dastergon/awesome-sre) diff --git a/templates/postmortem-template-google-api-infra.md b/templates/postmortem-template-google-api-infra.md new file mode 100644 index 0000000000000000000000000000000000000000..c91c50da6bcb5eb99ac175c95a1723ce40ecaafc --- /dev/null +++ b/templates/postmortem-template-google-api-infra.md @@ -0,0 +1,14 @@ +> Sample template from [Google Devlopers Blog: "Google API infrastructure outage incident report"](https://developers.googleblog.com/2013/05/google-api-infrastructure-outage_3.html). + +# Title + +## Issue Summary + +## Timeline(all times in Pacific Time) + +## Root Cause + +## Resolution and recovery + +## Corrective and Preventative Measures + diff --git a/templates/postmortem-template-srebook.md b/templates/postmortem-template-srebook.md new file mode 100644 index 0000000000000000000000000000000000000000..fae0d029b9f19a0d226fec6c0370af85ae4ea1bb --- /dev/null +++ b/templates/postmortem-template-srebook.md @@ -0,0 +1,35 @@ +> Template from: Betsy Beyer, Chris Jones, Jennifer Petoff, and Niall Richard Murphy. [“Site Reliability Engineering.â€](https://landing.google.com/sre/book/chapters/postmortem.html). + +# Title (incident #) + +### Date + +### Authors + +### Status + +### Summary + +### Impact + +### Root Causes + +### Trigger + +### Resolution + +### Detection + +## Action Items + +## Lessons Learned + +### What went well + +### What went wrong + +### Where we got lucky + +## Timeline + +## Supporting information diff --git a/templates/postmortem-template-thecloudbook.md b/templates/postmortem-template-thecloudbook.md new file mode 100644 index 0000000000000000000000000000000000000000..0da9b8620b36ebe0b2383f6dc926f5c68196ece5 --- /dev/null +++ b/templates/postmortem-template-thecloudbook.md @@ -0,0 +1,30 @@ +> Sample template from: Thomas A. Limoncelli. [“The Practice of Cloud System Administration: Designing and Operating Large Distributed Systems, Volume 2.â€](http://the-cloud-book.com/). + +# Title + +### Report Status + +### Executive Summary + +### Outage Description + +### Affected users + +### Start Date/Time + +### End Date/Time + +### Duration + +## Timeline + +## Contributing Conditions Analysis + +### What went well? + +### What could have gone better? + +## Recommendations + +### Names of people involved +