First Deployment

👋 Welcome to Octopus Deploy!

This tutorial series will help you complete your first deployment in Octopus Deploy. We’ll walk you through the steps to deploy a sample hello world package to one or more of your servers.

Before you start

To follow this tutorial, you will need an Octopus Deploy instance. If you haven’t already, set up an instance using one of these methods:

• Octopus Cloud ➜ we host Octopus Deploy for you.
• Self-hosted on a Windows Server ➜ you host Octopus Deploy on your infrastructure by downloading our MSI and installing it onto a Windows Server with a SQL Server backend. Read the installation requirements.
• Self-hosted as a Docker container ➜ you run Octopus Deploy in a docker container. Read the installation instructions.

Log in to Octopus

1. Log in to your Octopus instance and click New Project.

Add project

Projects let you manage software applications and services, each with their own deployment process.

2. Give your project a descriptive name, for example, Hello world deployment.

Octopus lets you store your deployment process, settings, and non-sensitive variables in either Octopus or a Git repository.

3. For this example, keep the default Octopus option selected.
4. Leave the rest as is and click Create Project.

Add environments

You’ll need an environment to deploy to.

Environments are how you organize your infrastructure into groups representing the different stages of your deployment pipeline. For example, Development, Staging, and Production.

5. Keep the default environments and click Create Environments.

Create deployment process

The next step is creating your deployment process. This is where you define the steps that Octopus uses to deploy your software.

For this deployment, we will configure one step to print Hello World.

1. In the “Welcome to your Project” dialog, click Thanks, got it.

Octopus lands you in the process step template library.

2. In the Featured category, locate the Run a Script card and click Add Step.

Step Name

You can leave this as the default Run a Script.

Script Source

You can source script files via 3 methods:

• Inline script (default)
• Git repository
• Package

3. Select Inline script as your script source.

Inline Source Code

4. Select an appropriate script language.
5. Copy the script below and paste it into the source code editor.

Write-Host "Hello, World!"

Execution Location

6. If you’re using Octopus Cloud, select Run once on a worker.
7. If you’re using a self-hosted Octopus instance, select Run once on the Octopus Server.

Worker Pool

8. If you’re using Octopus Cloud, keep the default Runs on a worker from a specific worker pool option selected.

You can skip the other sections of this page for this tutorial.

Save your step and you can move on to create and deploy a release.

Release and deploy

Create release

A release is a snapshot of the deployment process and the associated assets (packages, scripts, variables) as they exist when the release is created.

1. Click the Create Release button.
2. Click Save.

Execute deployment

Deployments typically occur in a defined environment order (for example, Development ➜ Staging ➜ Production), starting with the first one. Later you can configure Lifecycles with complex promotion rules to accurately reflect how you want to release software.

1. Click the Deploy to Development… button to deploy to the development environment.
2. Review the preview summary and when you’re ready, click Deploy.

The Task Log will show you in real-time the tasks Octopus is taking to run your Hello World script.

You successfully completed your first deployment! 🎉

Up next, we’ll introduce you to the power of variables.

All guides in this tutorial series

1. First deployment (this page)
2. Define and use variables
3. Approvals with manual interventions
4. Add deployment targets
5. Deploy a sample package

Further Reading

• Deployment Examples

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Thursday, November 14, 2024