Octopus Deploy Documentation

Lifecycles

Last updated

Lifecycles give you control over the way releases of your software are promoted between your environments. You can also use them to automate deployments and set retention policies.

Lifecycles are managed from the library page by navigating to Library ➜ Lifecyles:

The lifecyles area of the Octopus Web Portal

Octopus automatically creates a default lifecycle for you that contains a phase for each environment that you've created in Octopus Deploy. When you deploy your software it passes through the phases of the lifecycle in order.

Lifecycles enable a number of advanced deployment workflow features:

  • Control the order of promotion: for example, to prevent a release being deployed to production if it hasn't been deployed to staging.
  • Automate deployment to specific environments: for example, automatically deploy to test as soon as a release is created.
  • Retention policies: specify the number of releases to keep depending on how far they have progressed through the lifecycle.

Lifecycles don't apply to Runbooks. Learn more about the differences between Runbooks and Deployments.

Phases

A phase represents a stage in your deployment lifecycle. You deploy to phases in order, and you can choose how releases move between phases. For example, you can configure a lifecycle so that there must be a successful deployment to the Development phase before you can proceed to the Testing phase. You can also have a completely optional phase. This allows you to release to an environment in the next phase without being required to deploy to any in the optional phase.

Phases can also include multiple environments. This can be useful where you have more than one Testing environment.

No phases

When no phases are defined in a lifecycle, Octopus will use a default convention to control which environments may be deployed to, and in which order. The default convention forces releases to be deployed to each environment in the order that they are defined on the environments page.

When you add a new environment to Octopus, it will automatically be included in the list of environments available to the default convention. To prevent Octopus applying the default convention, define your own phases or restrict your lifecycle to specific environments.

Phases with environments

It's possible to add one or multiple environments to a phase. When a phase has environments added to it, this defines which ones can be deployed to during this phase of the lifecycle.

Phases without environments

When a phase is defined without any environments added to it, this phase of the lifecycle will deploy to all the environments that haven't been explicitly added to the lifecycle in previous phases.

Any future environments you define will also be deployed to as part of this phase of the Lifecycle.

Create a new lifecycle

  1. From the Lifecycle page, click on the ADD LIFECYCLE button.
  2. Give the Lifecycle a name and add a description.
  3. Define the Retention Policy.

Retention policies define how long releases are kept for, and how long extracted packages and files are kept on Tentacles. The default for both is to keep all. Learn more about Retention Policies.

  1. Click ADD PHASE to define the phases of the lifecycle.
  2. Give the phase a name.
  3. Click ADD ENVIRONMENT to define which environments can be deployed to during this phase of the lifecycle.

At this point, you can add one or multiple environments, or leave the default Any Environments option selected. Note, if you choose to use Any Environments, this phase of the Lifecycle will deploy to all the environments that haven't been explicitly added to the Lifecycle in previous phases. Any future environments you define will also be deployed to as part of this phase of the Lifecycle.

  1. By default, users must manually queue the deployment to the environment, if you would like the deployment to occur automatically as soon as the release enters the phase, select Deploy automatically....

If you have a project setup with Automatic Release Creation and set your first phase and environment to automatically deploy, pushing a package to the internal library will trigger both a release, and a deployment to that environment.

Tenants and automatic-environments

  1. If tenanted deployments are allowed, attempt to enqueue a new deployment for each tenant connected to the automatic-environment(s), taking the following into consideration: 1a. Filter the tenants by any Tenant filter defined on the Channel for the Release being considered for deployment. 1b. Further filter the tenants based on promotion rules (e.g. deploy to UAT before Production for this tenant)
  2. If untenanted deployments are allowed, attempt to enqueue the untenanted deployment to the automatic-environment(s).
  1. Set the Required to progress option. This determines how many environments must be deployed to before the next phase can be activated. The options are:
  • All must complete.
  • A minimum of x must complete. If choose this option, and, for example, have 5 environments in the phase and choose 2, then 2 of the 5 environments must be deployed to before the next phase can be activated.
  • Optional. This lets you skip a phase when it is reached in the Lifecycle. This allows you to release to environments in the next phase without being required to deploy to any in the optional phase. The standard Lifecycle progression and Automatic Deployment rules apply that determine when an optional phase is deployable. Optional phases may be useful for scenarios such as the provision of a Testing phase that can optionally be deployed to, but isn't crucial to progressing on to Production.

Optional Phase

If you want to be able to deploy to any environment at any time, then simply create a single phase which has Phase Progression set to All must complete and includes all your environments.

  1. Each phase of the Lifecycle can have its own retention policy defined. Set the retention policy for the phase if you don't want it to inherit the retention policy defined for the entire Lifecycle.
  2. Add as many additional phases as you need.
  3. Click SAVE.

After you have defined your lifecycles, they become available to your projects. Projects can be deployed to any environment in their lifecycle.

Default lifecycle

Octopus creates a default lifecycle for you. To view it, navigate to Library ➜ Lifecycles, and it will be in the list named Default Lifecycle:

Default Lifecycle Library view

The phases shown are created implicitly by the default lifecycle. By convention, the default lifecycle will create one phase per environment. They appear in the same order the environments are listed on the environments page. To view the default conventions applied, click on the lifecycle and the information appears in the Phases section :

Default Lifecycle Library view

Update the default lifecycle

The default lifecycle handles most cases for small or straightforward configurations.

When you create a new environment, it's automatically included in the default lifecycle. This also means that if you reorder the environments, the order of the phases will also change to match. These conventions can be helpful, but can sometimes lead to performance problems.

Try to keep the number of environments in Octopus under ten. Having fewer environments keeps the number of phases in the default lifecyle low.

We recommend updating the default lifecycle to define the phases you need. This makes configuring and maintaining your Octopus Server easier.

In the next section, we look at configuring the default lifecycle to add your own phases.

Adding a phase to the default lifecyle

You can define your own phases for the default lifecycle. This helps to prevent having too many phases being added automatically. To add a new phase, in the default lifecycle, Click ADD PHASE. Here, we are creating a phase named Development and adding the Dev environment to the phase:

Add Dev lifecycle phase

This phase has the default option to manually deploy to the environment set. The Required to progress and Retention policy are also set to the default values.

Phase names usually match the environment it contains. While this is a good practice, it's not a rule.

You can repeat this process to create extra phases. In this example, we are creating a phase for Testing, Staging, and Production.

Default lifecycle phases added

This allows you to explicitly configure the default lifecycle for deploying your software.

Examples

In this section, we cover some lifecycle examples and their included phases.

Hotfix lifecycle

A hotfix lifecycle is useful when you have a critical bug-fix that needs to be deployed quickly. In this scenario, lower environments such as Development and Testing are skipped.

It's recommended to follow good deployment practices and validate any changes before pushing to production. To match this, a hotfix lifecycle usually has just two phases, Staging and Production. Software with the bug fix is validated in Staging, and then promoted to Production. Your lifecycle may be different to reflect how you decide to handle hotfixes.

Hotfix lifecycle

Maintenance lifecycle

Octopus 2019.10 introduced Runbooks as an alternative to having a maintenance lifecycle. They allow you to automate routine maintenance and emergency operations tasks.

A Maintenance lifecycle can be used for projects that run maintenance tasks such as backups or software upgrades. This lifecycle can be used for any tasks that you want to run regularly with the same benefits that Octopus provides for your application deployments.

It typically consists of just one phase and one environment, also called Maintenance. You can include this environment in all deployment targets you want to run these tasks against. You can also split them up into the Development, Testing, Staging, and Production environments if you want to run the tasks for targets in those environments at different times.

Maintenance lifecycle

Recommendations

When configuring your lifecycles, here are some tips to consider:

  • Update the default lifecycle to define the phases you need. This makes configuring and maintaining your Octopus Server easier.
  • Keep the number of environments under ten to keep the phases added by the default lifecycle low.
  • Create a lifecycle for any projects which need a different promotion flow between environments. Remember to define phases for the lifecycle.
  • Set specific retention policies for your lifecycles. This will prevent keeping releases and files forever, reducing disk and database usage.

Need support? We're here to help.