Portal:Cloud VPS/Admin/Runbooks/Runbook template

From Wikitech

This is a template for Cloud VPS runbooks. Replace this paragraph with a general overview of what this runbook covers.

If your runbook requires admin permissions to complete, include this header:

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


Provide a description of the error or incident.


How? Provide a list of steps to gather information to be able to pin-point the issue

Common issues

Add here any new common issues you find.

Related information


Provide links to related tools, tickets of previous incidents, and documentation that may provide context or additional information, this might include links to the affected service main page (if any), diagrams, external links...

Support contacts


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.

Old incidents

Add here any new tasks for incidents you might encounter.

Examples of runbooks