Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions public/docs/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -2210,6 +2210,14 @@ a[data-youtube] {
display: block;
}

.page-content {
li:has(figure) {
display: flex;
flex-direction: column;
gap: 1rem;
}
}

/* Paging */

.post-paging {
Expand Down
Binary file added public/docs/i/1000/octopus-logo.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/2000/octopus-logo.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/600/octopus-logo.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/docs/i/x/octopus-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/docs/img/octopus-logo.png.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"width":140,"height":140,"updated":"2026-05-18T14:36:41.108Z"}
Original file line number Diff line number Diff line change
Expand Up @@ -17,35 +17,27 @@ With Octopus, you can deploy software to:
- Offline package drop
- Cloud region

Regardless of where youre deploying your software, these machines and services are known as your deployment targets.
Regardless of where you're deploying your software, these machines and services are known as your deployment targets.

## Add deployment target

1. From the left Deploy menu, click **Deployment Targets**.

:::figure
![Deployment Targets page](/docs/img/getting-started/first-deployment/images/deployment-targets-page.png)
:::
:::figure
![Deployment Targets page](/docs/img/getting-started/first-deployment/images/deployment-targets-page.png)
:::

2. Click **Add Deployment Target**.
3. Use the category tabs to filter by deployment target type.
4. Click **Add** on the deployment target you want to add.

### Name

Give your deployment target a descriptive name, for example, `Hello world tutorial target`.

### Environments

We’ll scope this deployment target to one environment. Later, you can add additional targets and scope them to your other environments.
**Name** - Give your deployment target a descriptive name, for example, `Hello world tutorial target`.**Environments** - We'll scope this deployment target to one environment. Later, you can add additional targets and scope them to your other environments.

5. Select **Development** from the **Environments** dropdown list.

### Target Tags

Octopus uses target tags to select which deployment target a project should deploy to. Later, you’ll add the same target tag to your deployment process. You can deploy to multiple targets simply by adding this tag.
**Target Tags** - Octopus uses target tags to select which deployment target a project should deploy to. Later, you'll add the same target tag to your deployment process. You can deploy to multiple targets simply by adding this tag.

6. Add a new target tag by typing it into the field. For this example, well use `tutorial-target`.
6. Add a new target tag by typing it into the field. For this example, we'll use `tutorial-target`.

:::figure
![Deployment target form](/docs/img/getting-started/first-deployment/images/deployment-target-form.png)
Expand All @@ -61,7 +53,7 @@ Fill in the other sections of the deployment target form. If you need guidance,
- [Offline package drop](/docs/infrastructure/deployment-targets/offline-package-drop)
- [Cloud region](/docs/infrastructure/deployment-targets/cloud-regions)

Next, lets [deploy a sample package](/docs/getting-started/first-deployment/deploy-a-package) to your deployment target.
Next, let's [deploy a sample package](/docs/getting-started/first-deployment/deploy-a-package) to your deployment target.

### All guides in this tutorial series

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,19 @@ The **Manual Intervention Required** step lets you add approvals or manual check
3. Select the **Other** category to filter the types of steps.
4. Locate the Manual Intervention Required card and click **Add Step**.

:::figure
![Add Manual Intervention Required step to deployment process](/docs/img/getting-started/first-deployment/images/manual-intervention-step.png)
:::

### Step name

You can leave this as the default *Manual Intervention Required*.

### Instructions

5. Copy the message below and paste it into the **Instructions** field.
:::figure
![Add Manual Intervention Required step to deployment process](/docs/img/getting-started/first-deployment/images/manual-intervention-step.png)
:::

```
Please verify the Production environment is ready before proceeding.
```
**Step name** - You can leave this as the default *Manual Intervention Required*.

### Responsible Teams
5. **Instructions** - Copy the message below and paste it into the **Instructions** field.

6. Select **Octopus Administrators** and **Octopus Managers** from the **Responsible Teams** dropdown list.
```text
Please verify the Production environment is ready before proceeding.
```
### Environments
6. **Responsible Teams** - Select **Octopus Administrators** and **Octopus Managers** from the **Responsible Teams** dropdown list.
7. Select **Run only for specific environments**.
8. Select **Production** from the **Environments** dropdown list.
Expand All @@ -61,7 +53,7 @@ Currently, your deployment process will run manual intervention after the script
1. Create a new release and deploy it through to the Production environment.
You will notice manual intervention doesnt run in the Development or Staging environments. When the deployment reaches Production, it will pause and request approval.
You will notice manual intervention doesn't run in the Development or Staging environments. When the deployment reaches Production, it will pause and request approval.
:::figure
![Manual intervention is required in production](/docs/img/getting-started/first-deployment/images/manual-intervention.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Octopus lets you define variables and scope them for use in different phases of
1. From the *Hello world* project you created earlier, click **Project Variables** in the left menu.
2. Click **Create Variables**.
3. Add `Helloworld.Greeting` in the **Name** column,
4. Add `Hello, Development` in the **Value** column,
4. Add `Hello, Development` in the **Value** column,
5. Click the **Scope** column and select the `Development` environment.
6. Click **Add another value**.
7. Add `Hello, Staging` and scope it to the `Staging` environment.
Expand All @@ -34,47 +34,47 @@ Steps in the deployment process can reference variables.
1. Click **Process** in the left menu.
2. Select the previously created **Run a Script** step.

### Inline Source Code
**Inline Source Code**

3. Based on your selected language, copy the appropriate script from below.
4. Replace the script in the code editor with the new script.

<details data-group="getting-started-first-deployment-define-and-use-variables">
<summary>PowerShell</summary>
<details data-group="getting-started-first-deployment-define-and-use-variables">
<summary>PowerShell</summary>

```powershell
Write-Host $OctopusParameters["Helloworld.Greeting"]
```
```powershell
Write-Host $OctopusParameters["Helloworld.Greeting"]
```

</details>
<details data-group="getting-started-first-deployment-define-and-use-variables">
<summary>Bash</summary>
</details>
<details data-group="getting-started-first-deployment-define-and-use-variables">
<summary>Bash</summary>

```bash
greeting=$(get_octopusvariable "Helloworld.Greeting")
echo $greeting
```
```bash
greeting=$(get_octopusvariable "Helloworld.Greeting")
echo $greeting
```

</details>
</details>

:::div{.hint}
If you are using Octopus Cloud, Bash scripts require you to select the **Hosted Ubuntu** worker pool. The **Default Worker Pool** is running Windows and doesn't have Bash installed.
:::
:::div{.hint}
If you are using Octopus Cloud, Bash scripts require you to select the **Hosted Ubuntu** worker pool. The **Default Worker Pool** is running Windows and doesn't have Bash installed.
:::

5. Click **Save**
6. Click **Create Release**.

:::div{.hint}
A release snapshots everything about your project, including variables and the deployment process. You have to create a new release to see any changes.
:::

As you promote through the environments, you will see the greeting change.

:::figure
![The results of the hello world deployment with variables](/docs/img/getting-started/first-deployment/images/environment-variables.png)
:::

Great job! Next, let's build on your deployment process and [add an approval process using manual interventions](/docs/getting-started/first-deployment/approvals-with-manual-interventions).
Great job! Next, let's build on your deployment process and [add an approval process using manual interventions](/docs/getting-started/first-deployment/approvals-with-manual-interventions).

### All guides in this tutorial series

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ description: Deploy a sample package using Octopus Deploy. Create a deploy packa
navOrder: 80
hideInThisSection: true
---
import Image from "src/components/Image.astro";

Deploying software with Octopus often involves deploying packages, for example, `.zip`, `.nupkg`, `.jar`, `.tar`, etc. In this section, we'll walk you through the steps to deploy a sample hello world package to your deployment target.

:::div{.hint}
To learn about supported formats, versioning, and packaging applications, refer to the [packaging documentation](/docs/packaging-applications).
:::

## Before your start
## Before you start

Please download our sample package:

Expand All @@ -24,13 +25,12 @@ Please download our sample package:

1. From the left Deploy menu, click **Packages**.

:::figure
![Packages page](/docs/img/getting-started/first-deployment/images/packages-page.png)
:::

2. Click **Upload Package**.
3. Select the package you want to upload.
:::figure
![Packages page](/docs/img/getting-started/first-deployment/images/packages-page.png)
:::

1. Click **Upload Package**.
1. Select the package you want to upload.

## Add deploy package step

Expand All @@ -43,42 +43,34 @@ Add a step to the deployment process to push that package to your deployment tar
5. Select the **Package** category to filter the types of steps.
6. Locate the Deploy a Package card and click **Add Step**.

:::figure
![Add Deploy a Package step to deployment process](/docs/img/getting-started/first-deployment/images/deploy-package-step.png)
:::
<Image
src="/docs/img/getting-started/first-deployment/images/deploy-package-step.png"
alt="Add Deploy a Package step to deployment process"
/>

### Step name
7. **Step name:** - You can leave this as the default *Deploy a Package*.
8. **Target tags:** - Select **tutorial-target** from the **Target Tags** dropdown list.

You can leave this as the default *Deploy a Package*.
:::div{.hint}
**Context for target tags**

### Target tags
When configuring your deployment process, you can click a target tag to see the deployment targets and environments the step will run on.

7. Select **tutorial-target** from the **Target Tags** dropdown list.
:::figure
![Target tags popover that shows correlating deployment targets](/docs/img/getting-started/first-deployment/images/target-tags-popover.png)
:::

:::div{.hint}
**Context for target tags**
9. **Package:** - Select **hello-world** from the **Package ID** dropdown list.

When configuring your deployment process, you can click a target tag to see the deployment targets and environments the step will run on.
You can skip the other sections of this page for this tutorial.

:::figure
![Target tags popover that shows correlating deployment targets](/docs/img/getting-started/first-deployment/images/target-tags-popover.png)
:::

### Package

8. Select **hello-world** from the **Package ID** dropdown list.

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

**Save** your deployment process and you can move on to create and deploy a release.

:::figure
![Deploy a package step with target tag and package selected](/docs/img/getting-started/first-deployment/images/deploy-package-step-form.png)
:::
**Save** your deployment process and you can move on to create and deploy a release.

## Release and deploy
:::figure
![Deploy a package step with target tag and package selected](/docs/img/getting-started/first-deployment/images/deploy-package-step-form.png)
:::

1. Create a new release and deploy it to the Development environment.
10. **Release and deploy** - Create a new release and deploy it to the Development environment.

The release will deploy the *hello world* package to the *Hello world tutorial target*.

Expand Down
Loading
Loading