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

Portal:Cloud VPS/Admin/Runbooks/Runbook template

From Wikitech-static
< Portal:Cloud VPS‎ | Admin‎ | Runbooks
Revision as of 14:19, 23 June 2021 by imported>SRodlund (SRodlund moved page User:SRodlund/Runbooks planning/runbook template to Portal:Cloud VPS/Admin/Runbooks/Runbook template: Moving to main)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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