Skip to content

Commit

Permalink
Merge branch 'main' into Update-dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-fenton-octopus committed Jan 7, 2025
2 parents 57cd6d9 + 126da8d commit 959a5b1
Show file tree
Hide file tree
Showing 27 changed files with 260 additions and 474 deletions.
2 changes: 2 additions & 0 deletions dictionary-octopus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ emptytitle
entra
environmentids
eprintfn
esac
expressjs
externalgroups
externalusers
Expand Down Expand Up @@ -421,6 +422,7 @@ tfvar
tfvars
TFVC
thepassword
timespan
tlsv1
tmpfs
Toolsets
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/deployments/azure/cloud-services
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure
pubDate: 2023-01-01
navSearch: false
navSitemap: false
navMenu: false
---
---
10 changes: 10 additions & 0 deletions src/pages/docs/deployments/azure/cloud-services/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure
pubDate: 2023-01-01
navSearch: false
navSitemap: false
navMenu: false
hideInThisSectionHeader: true
---
188 changes: 0 additions & 188 deletions src/pages/docs/deployments/azure/cloud-services/index.mdx

This file was deleted.

9 changes: 9 additions & 0 deletions src/pages/docs/deployments/azure/cloud-services/vip-swap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure
pubDate: 2023-01-01
navSearch: false
navSitemap: false
navMenu: false
---
72 changes: 0 additions & 72 deletions src/pages/docs/deployments/azure/cloud-services/vip-swap.mdx

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/deployments/azure/cloud-services
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure
pubDate: 2023-01-01
navSearch: false
navSitemap: false
Expand Down
11 changes: 11 additions & 0 deletions src/pages/docs/deployments/custom-scripts/run-a-script-step.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,17 @@ If the package reference was _not_ configured to be extracted, then the un-extra

These locations were designed to be convenient for use from custom scripts, as the relative path can be predicted, e.g. `./Acme` or `./Acme.zip`. If the absolute path is required the variables above may be used.

#### Docker image package variables
In the scenario where your package reference is a Docker image some additional variables will be contributed. These variables are (assuming a package-reference named `Acme`):

| Variable name and description | Example |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|
| `Octopus.Action.Package[Acme].Image` <br/>The fully qualified image name | *index.docker.io/Acme:1.4.0* |
| `Octopus.Action.Package[Acme].Registry` <br/>The URI of the registry from the feed where the image was acquired from | *index.docker.io* |
| `Octopus.Action.Package[Acme].Version` <br/>The version of the image included in the release | *1.4.0* |
| `Octopus.Action.Package[Acme].Feed.UserName` <br/>The username from the feed where the image was acquired from (if the feed is configured to use credentials) | *Alice* |
| `Octopus.Action.Package[Acme].Feed.Password` <br/>The password from the feed where the image was acquired from (if the feed is configured to use credentials) | *Password01!* |

## Older versions

Scripts sourced from your Projects Git Repository was added in Octopus **2024.1**. In Octopus versions prior, the Git Repository source is not available.
10 changes: 5 additions & 5 deletions src/pages/docs/deployments/terraform/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2023-01-01
modDate: 2024-12-23
title: Terraform
description: Terraform deployments
navOrder: 100
Expand All @@ -16,7 +16,7 @@ Octopus Deploy provides first-class support for deploying Terraform templates.

The `Plan to apply a Terraform template` will generate a plan for the result of running `apply` on a template, while `Plan a Terraform destroy` will generate a plan for the result of running `destroy` on the template.

Similarly, the `Apply a Terraform template` step can be used to create or update a resources from a Terraform template, while the `Destroy Terraform resources` step can be used to destroy existing Terraform resources.
Similarly, the `Apply a Terraform template` step can be used to create or update resources from a Terraform template, while the `Destroy Terraform resources` step can be used to destroy existing Terraform resources.

The built-in Octopus Terraform steps are created to help you follow a pipeline using the following process:

Expand All @@ -31,12 +31,12 @@ The built-in Octopus Terraform steps are created to help you follow a pipeline u
All Terraform steps execute on a worker. By default, that will be the built-in worker in the Octopus Server. Learn about [workers](/docs/infrastructure/workers) and the different configuration options.

:::div{.warning}
If the Terraform tool is updated above version `0.11`, you are using an Octopus version prior to **2020.5.0**, and you are using the **Source Code** option within a Terraform step, you will receive syntax warnings within Octopus. You can update the Terraform tool to a version higher than `0.11` without issue in an Octopus version prior to **2020.5.0** only if you use the **File inside a package** option within the terraform step.
If the Terraform tool is updated above version `0.11`, you are using an Octopus version prior to **2020.5.0**, and you are using the **Source Code** option within a Terraform step, you will receive syntax warnings within Octopus. You can update the Terraform tool to a version higher than `0.11` without issue in an Octopus version prior to **2020.5.0** only if you use the **File inside a package** option within the Terraform step.
:::

## Special variables

Setting the variable `Octopus.Action.Terraform.CustomTerraformExecutable` to the absolute path of a custom Terraform executable will result in the step using that executable instead of the one shipped with Octopus. You can use this variable to force the Terraform steps to use a specific version of Terraform, or to use the x64 version if you wish.
Setting the variable `Octopus.Action.Terraform.CustomTerraformExecutable` to the absolute path of a custom Terraform executable will result in the step using that executable instead of the one shipped with Octopus. You can use this variable to force the Terraform steps to use a specific version of Terraform or to use the x64 version if you wish.

For example, setting `Octopus.Action.Terraform.CustomTerraformExecutable` to `C:\Apps\terraform.exe` will cause the steps to execute `C:\Apps\terraform.exe` rather than the built in copy of Terraform.

Expand All @@ -48,7 +48,7 @@ The Terraform steps have some unique messages that may be displayed in the outpu

### Terraform-Configuration-UntestedTerraformCLIVersion

The Terraform steps in Octopus Deploy are tested against a range of versions of the Terraform CLI from 0.11.15 to 1.0.0. As new versions of Terraform are released, testing will be expanded to include these versions to ensure that they are compatible with the Terraform steps in Octopus. In the meantime, if the Terraform CLI version used in a step is outside the tested range a message will be displayed in the output indicating this. The Terraform step will likely continue to run successfully even if the CLI version being used has not been tested in Octopus. If the step succeeds, then the message will be informational only, and there is no action that needs to be taken. If the step resulted in an error, then the message will be a warning; however, the error may not be related to the version of Terraform being used.
The Terraform steps in Octopus Deploy are tested against a range of versions of the Terraform CLI. If the Terraform CLI version used in a step is outside the tested range, a message will be displayed in the output indicating this. The Terraform step will likely continue to run successfully even if the CLI version being used has not been tested in Octopus. If the step succeeds, then the message will be informational only, and there is no action that needs to be taken. If the step resulted in an error, then the message will be a warning; however, the error may not be related to the version of Terraform being used.

## Learn more

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure/cloud-service-targets
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure
pubDate: 2023-01-01
navSearch: false
navSitemap: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure/cloud-service-targets
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure
pubDate: 2023-01-01
navSearch: false
navSitemap: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,55 +1,9 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-06-27
title: Azure Cloud Service targets
description: Azure Cloud Service deployment targets allow you to reference existing classic Cloud Services in your Azure subscription, that you can then reference by target tag during deployments.
navOrder: 100
---

Azure Cloud Service deployment targets allow you to reference existing classic Cloud Services in your Azure subscription, that you can then reference by [target tag](/docs/infrastructure/deployment-targets/target-tags) during deployments.

:::div{.warning}
Microsoft [announced](https://blogs.msdn.microsoft.com/appserviceteam/2018/03/12/deprecating-service-management-apis-support-for-azure-app-services/) that from June 30th 2018 they are retiring support for Azure Service Management API (which indicates Cloud Services). Microsoft stated that _"Cloud Services is similar to Service Fabric in degree of control versus ease of use, but it's now a legacy service and Service Fabric is recommended for new development"_ ([source](https://docs.microsoft.com/en-us/azure/app-service/choose-web-site-cloud-service-vm)).

Support for this feature will be deprecated in Octopus Server from the `2024.1` release.
:::

## Requirements

You can read more about all the PaaS targets [in our blog](https://octopus.com/blog/paas-targets).

- You will need an [Azure Management Certificate account](/docs/infrastructure/accounts/azure/#azure-management-certificate) that references your Azure subscription.

- Once your Azure account is setup, you will then need an existing Azure Cloud Service (classic) setup within your Azure subscription. To learn more about App Services, the Azure team provide [useful documentation on App Services](https://docs.microsoft.com/en-us/azure/cloud-services/) that can help you get started. If you are dynamically creating the cloud services during your deployment, check our section about [creating Cloud Service targets by scripts using service messages](#creating-cloud-service-targets-by-scripts).

## Creating Cloud Service targets

Once you have a Cloud Service setup within your Azure subscription, you are then ready to map that to an Octopus deployment target.

To create an Azure Cloud Service target within Octopus:

- Go to **Infrastructure ➜ Deployment Targets ➜ Add Deployment Target**.
- Select **Azure Cloud Service** from the list of available targets and click _Next_.
- Fill out the necessary fields, being sure to provide a unique target tag that clearly identifies your Azure Cloud Service target.

:::figure
![](/docs/infrastructure/deployment-targets/azure/cloud-service-targets/create-azure-cloud-service-target.png)
:::

- After clicking _Save_, your deployment target will be added and go through a health check to ensure Octopus can connect to it.
- If all goes well, you should see your newly created target in your **Deployment Targets** list, with a status of _Healthy_.

### Creating Cloud Service targets by scripts

Azure Cloud Service targets can also be created via a PowerShell cmdlet within a Deployment Process, this can be especially handy if you are also creating the Azure Cloud Service via a script.

See [Creating Resources by script](/docs/infrastructure/deployment-targets/dynamic-infrastructure) for more information on creating Azure Cloud Services via a script.

## Deploying to Cloud Service targets

See our [documentation about this topic](/docs/deployments/azure/cloud-services)

## Troubleshooting

If your Azure Cloud Service target is not completing a health check successfully, you may need to check that your Octopus Server can communicate with Azure. It may be worth checking that your Azure Account is able to complete a _Save and Test_ to ensure Octopus can communicate with Azure and the management certificate referenced by the account is valid. If your Octopus Server is behind a proxy or firewall, you will need to consult with your Systems Administrator to ensure it is able to communicate with Azure.
layout: src/layouts/Redirect.astro
title: Redirect
redirect: https://octopus.com/docs/infrastructure/deployment-targets/azure
pubDate: 2023-01-01
navSearch: false
navSitemap: false
navMenu: false
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-06-27
modDate: 2024-12-12
title: Azure targets
description: Configure your Azure infrastructure
navOrder: 40
Expand All @@ -16,8 +16,11 @@ The currently supported Azure targets are:

- [Azure Service Fabric Clusters](/docs/infrastructure/deployment-targets/azure/service-fabric-cluster-targets).
- [Azure Web Apps](/docs/infrastructure/deployment-targets/azure/web-app-targets) (also works for Azure Functions).
- [Azure Cloud Services](/docs/infrastructure/deployment-targets/azure/cloud-service-targets).
- Azure Kubernetes Service via the [Kubernetes Agent](/docs/kubernetes/targets/kubernetes-agent) and [Kubernetes API](/docs/kubernetes/targets/kubernetes-api) deployment targets.
- Azure VM via [Tentacle using Desired State Configuration (DSC)](/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template-with-dsc).

:::div{.warning}
Regarding Azure Cloud Services, Microsoft [announced](https://blogs.msdn.microsoft.com/appserviceteam/2018/03/12/deprecating-service-management-apis-support-for-azure-app-services/) that from June 30th 2018 they are retiring support for Azure Service Management API (which indicates Cloud Services). Microsoft stated that _"Cloud Services is similar to Service Fabric in degree of control versus ease of use, but it's now a legacy service and Service Fabric is recommended for new development"_ ([source](https://docs.microsoft.com/en-us/azure/app-service/choose-web-site-cloud-service-vm)).
Azure Cloud Services are no longer supported in Octopus Deploy as of `2025.1`.

Microsoft has deprecated these Azure services, and as of October 1st 2024 shut down existing Cloud Service deployments. ([Source](https://learn.microsoft.com/en-us/azure/cloud-services/cloud-services-choose-me))
:::
Loading

0 comments on commit 959a5b1

Please sign in to comment.