Create a Runbook

Learn how to create a runbook.

Cutover Documentation Team avatar
Written by Cutover Documentation Team
Updated over a week ago

A runbook consists of a series of tasks that are created, organized, and executed in order to carry out a specific function. In this article, we'll cover how you can create a runbook.

Overview


A runbook consists of a series of tasks that are created, organized, and executed in order to carry out a specific function. To create a runbook in Cutover, you will need to have the Workspace Runbook Creator or Folder Runbook Creator role type at minimum.

When creating a runbook, you will first need to select a runbook type. A runbook type is a runbook that has a default set of configurations for a specific type of execution. For example, a recovery plan runbook type will have a different configuration than a failover runbook type, as they both have different execution methods.

Once a runbook type has been selected, you are free to create your runbook.

Runbook types

Some of the options we have available are:

Normal runbook: This our standard runbook. Use this to orchestrate your activities using our standard configuration.

Dynamic runbook: Use this to runbook type to allow you the ability to edit at any time, including during a live run, without the need to pause or stop the runbook.

Incident runbook: Use this runbook type to orchestrate incident activities dynamically. This is typically used to manage a live incident and once created the run can start straight away or when scheduled.

Recovery Plan runbook: Use this runbook type to create a repeatable failover process
​Validation runbook: Use this runbook type which allows additional configuration to support testing activities

Note: You may see other runbooks types that are not mentioned in this article, these are custom runbooks types for your organisation.

Create a runbook


To create a runbook, follow the steps below:

  1. Click +Create Runbook on the top right-hand corner of your workspace.

  2. Select a runbook type. Next, optionally select a template from which your runbook will be created from.

  3. Select a default start time or start date. Once finished, your runbook will be created.

Create a runbook from a template

To create a runbook from a template, follow the steps below:

  1. Click Templates in your workspace.

  2. Select the template you wish to create a runbook from by clicking Create.

  3. Select whether to create the template in your existing folder or choose a new folder destination.

  4. Decide whether to duplicate the template's tasks and streams, teams, and runbook users.

  5. Click Next.

  6. Select whether to add the start time for the runbook late or enter the planned start date.

  7. Click +Create.

To note, you will be able to create a runbook from approved and rejected templates β€” you can filter through approved, rejected, and draft templates in the Templates tab:

When you attempt to create a runbook from a template that has not been approved, a warning message will appear:

Learn more about templates


Did this answer your question?