You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Portal:Data Services/Admin/Runbooks/Runbook template

From Wikitech-static
Jump to navigation Jump to search

This is a template for Data Services runbooks.

Overview

Admin permissions header

If your runbook requires admin permissions to complete, include this header (hint, it probably will in this section):

The procedures in this runbook require admin permissions to complete.

Note: if your runbook is intended for general users, and also has some steps that require admin permissions, you should mark those steps with the following template, so folks can easily identify what they are able to do: Requires admin permissions

Error / Incident

What?

Provide a description of the error or incident.

Debugging

How?

Provide a solution, detailed list of steps a person will need to follow to fix the error.

Support contacts

Who?

You may choose to list support contacts, individuals who have knowledge about this topc and who may be able to confirm the accuracy of the runbook or who may can help resolve issues related to the error or incident.

Note: Including the template {{:Help:Cloud Services communication}} may be sufficient.

Related information

Where?

Provide links to related tools, tickets of previous incidents, and documentation that may provide context or additional information.

What else to include

  • Diagrams

Examples