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

Difference between revisions of "User:SRodlund/Runbooks planning/runbook template"

From Wikitech-static
Jump to navigation Jump to search
imported>SRodlund
(Created page with "This is a template for Cloud VPS runbooks.")
 
imported>SRodlund
Line 1: Line 1:
This is a template for Cloud VPS runbooks.
This is a template for Cloud VPS runbooks.
{{Cloud VPS nav}}
=== Overview ===
=== Admin header ===
If your runbook requires admin permissions to complete, include this header:
{{Remark|The procedures in this runbook require admin permissions to complete.|reminder}}
=== 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 <nowiki>{{:Help:Cloud Services communication}}</nowiki> may be sufficient.
=== Related information ===
Where?
Provide links to related tools, tickets, and documentation that may provide context or additional information.
=== What else to include ===
* Diagrams
=== Examples ===
* https://wikitech.wikimedia.org/wiki/Portal:Cloud_VPS/Admin/Runbooks/Cloud_VPS_alert_Puppet_failure_on
* https://wikitech.wikimedia.org/wiki/Portal:Cloud_VPS/Admin/Runbooks/Check_for_VMs_leaked_by_the_nova-fullstack_test

Revision as of 19:25, 11 June 2021

This is a template for Cloud VPS runbooks.

Overview

Admin header

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

The procedures in this runbook require admin permissions to complete.

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, and documentation that may provide context or additional information.

What else to include

  • Diagrams

Examples