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.

You can add deployment tasks to runbooks by creating them or by copying deployment tasks from turnovers or other runbooks. Deployment tasks associated with runbooks won't have component versions or snapshots associated, since these are specific to environment and application, so after the runbook is copied to a turnover, these must be associated to the turnover.

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 and description for the runbook, and then optionally select values for the following fields:
   • Release Type

     Select the release type to which the runbook applies.

   • Applications

     Select specific applications to which the runbook applies.

     Note: Users can copy deployment tasks from any approved runbook, but when you specify a release type or application, they can filter tasks to those related to a specific release type or application.
4. Select the release engineer and other release team members 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.

Related Topics

About Runbooks

Adding Deployment Tasks