Octopus Deploy Documentation

Running a Runbook

Last updated

Unlike a deployment with a pre-defined lifecycle, Runbooks can run on any environment in any order. Runbooks are designed to automate routine maintenance tasks. Maintenance tasks might need to run on Test and Production but not on Development environments.

  1. From the Hello Runbook runbook you created on the previous page, click RUN....

This screen provides the details of the Runbook you are about to run.

![run runbook basic options](images/run-runbook-basic-options.png “width=500”)

  1. Select an environment.
  2. Click RUN.

![run runbook results](images/run-hello-runbook-results.png “width=500”)

Because we didn't define any deployment targets for the target environment, Octopus ran the script directly on the Octopus Server. If you are on Octopus Cloud, Octopus Deploy leased a dynamic worker (a machine that executes tasks on behalf of the Octopus Server) that was then used to execute the hello world script.

The next step will cover how to configure and use variables in runbooks.

Further Reading

For further reading on running a Runbook please see:

Previous     Next

Need support? We're here to help.