Creating a runbook

You can follow the instruction below or watch the video tutorial.

To start creating a runbook, click Create runbook > Add step > Add action. You can use drag and drop to move actions and steps. Do not forget to give a distinctive name to the runbook. While creating a long runbook, click Save from time to time. Once you are finished, click Close.

Steps and actions

A runbook consists of steps that are executed consecutively. A step consists of actions that start simultaneously. An action may consist of:

• An operation to be performed with a cloud server (Failover server, Start server, Stop server, Failback server). To define this operation, you need to choose the operation, the cloud server, and the operation parameters.
• A manual operation that you need to describe verbally. Once the operation is completed, a user must click the confirmation button to allow the runbook to proceed.

• Execution of another runbook. To define this operation, you need to choose the runbook.

  A runbook can include only one execution of a given runbook. For example, if you added the action "execute Runbook A", you can add the action "execute Runbook B", but cannot add another action "execute Runbook A".

Action parameters

All operations with cloud servers have the following parameters:

• Continue if already done (enabled by default)

  This parameter defines the runbook behavior when the required operation is already done (for example, a failover has already been performed or a server is already running). When enabled, the runbook issues a warning and proceeds. When disabled, the operation fails and the runbook fails.

• Continue if failed (disabled by default)

  This parameter defines the runbook behavior when the required operation fails. When enabled, the runbook issues a warning and proceeds. When disabled, the operation fails and the runbook fails.

Completion check

You can add completion checks to the Failover server and Start server actions, to ensure that the server is available and provides the necessary services. If any of the checks fail, the action is considered failed.

• Ping IP address

  The software will ping the production IP address of the cloud server until the server replies or the timeout expires, whichever comes first.

• Connect to port (443 by default)

  The software will try to connect to the cloud server by using its production IP address and the port you specify, until the connection is established or the timeout expires, whichever comes first. This way, you can check if the application that listens on the specified port is running.

The default timeout is 10 minutes. You can change it if you wish.