Creating Runbooks

If you have a standard set of tasks that are performed for similar turnovers, environments or applications, you can create runbooks that serve as templates for these tasks. As release engineers create turnovers, they can copy tasks from runbooks, and then reorder, remove, or add new tasks as needed.

Users who are assigned to these roles in the Runbooks process app can create and manage runbooks:

To create a runbook:

  1. Click +New.
  2. Search for the project that will store your runbook, and then select the project to open a Submit form. (By default, the Runbooks project is used to store runbooks.)
  3. Provide a name for the runbook, and then select values for these fields as they apply:
    • Environments

      Select specific environments to which the runbook applies.

    • Applications

      Select specific applications to which the runbook applies.

      Note: Users can copy tasks from any approved runbook, but when you specify an environment or application, they can choose to filter tasks to those related to a specific environment or application.
  4. Select the release engineer who will be responsible for the runbook, and then click Submit.
  5. Click the Edit Deployment Tasks button.
  6. Use the form to add new manual and automation tasks, copy tasks from another runbook or turnover, delete tasks, or change the sequence of tasks. Click Close when you are done.
  7. Click Complete to send the runbook to a release manager for review.
  8. Once approved, the runbook is available for turnovers.