-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2363 from OctopusDeploy/tk/broken-link-fix-2
Fixing links and removing page
- Loading branch information
Showing
3 changed files
with
13 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 8 additions & 72 deletions
80
...loyment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,73 +1,9 @@ | ||
--- | ||
layout: src/layouts/Redirect.astro | ||
title: Redirect | ||
redirect: https://octopus.com/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-an-arm-template-with-dsc | ||
pubDate: 2024-06-25 | ||
navSearch: false | ||
navSitemap: false | ||
navMenu: false | ||
--- | ||
layout: src/layouts/Default.astro | ||
pubDate: 2023-01-01 | ||
modDate: 2023-01-01 | ||
title: Installing the Tentacle VM extension via an ARM template | ||
description: How to install the Tentacle VM extension using an Azure Resource Manager (ARM) template | ||
navOrder: 6 | ||
--- | ||
import AzureVMExtensionDeprecated from 'src/shared-content/deprecated-items/azure-vm-extension-deprecated.include.md'; | ||
|
||
<AzureVMExtensionDeprecated /> | ||
|
||
An Azure Resource Manager (ARM) template is a JSON file that defines a set of Azure resources that can be automatically read and provisioned by Azure. | ||
|
||
Using an ARM template, you can deploy the Tentacle VM extension at the same time you create the virtual machine, or update the resource group to apply the extension later. | ||
|
||
:::div{.hint} | ||
A [fully functioning example](https://azure.microsoft.com/en-gb/resources/templates/octopus-deploy-tentacle-windows/) can be found in the [Azure Quickstart Templates](https://azure.microsoft.com/en-gb/resources/templates/) library. | ||
::: | ||
|
||
Create your ARM template as normal, and add a `resources` element under your `Microsoft.Compute/virtualMachine` resource: | ||
|
||
```json | ||
"resources": [ | ||
{ | ||
"type": "extensions", | ||
"name": "[concat(parameters('vmName'),'/OctopusDeployWindowsTentacle')]", | ||
"apiVersion": "2015-05-01-preview", | ||
"location": "[resourceGroup().location]", | ||
"dependsOn": [ | ||
"[concat('Microsoft.Compute/virtualMachines/', parameters('vmName'))]" | ||
], | ||
"properties": { | ||
"publisher": "OctopusDeploy.Tentacle", | ||
"type": "OctopusDeployWindowsTentacle", | ||
"typeHandlerVersion": "2.0", | ||
"autoUpgradeMinorVersion": "true", | ||
"forceUpdateTag": "1.0", | ||
"settings": { | ||
"OctopusServerUrl": "http://localhost:81", | ||
"Environments": [ | ||
"Development", | ||
"Staging" | ||
], | ||
"Roles": [ | ||
"App Server", | ||
"Web Server" | ||
], | ||
"CommunicationMode": "Listen", | ||
"Port": 10933, | ||
"PublicHostNameConfiguration": "PublicIP" | ||
}, | ||
"protectedSettings": { | ||
"ApiKey": "API-ABCDEF1234567890ABCDEF12345" | ||
} | ||
} | ||
} | ||
] | ||
``` | ||
|
||
## Properties | ||
|
||
* `publisher`: (string) Must be `OctopusDeploy.Tentacle`. | ||
* `type`: (string) Must be `OctopusDeployWindowsTentacle`. | ||
* `typeHandlerVersion`: (string): The major and minor version of the extension to apply. You can find what versions are available [via the Azure CLI](/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/via-the-azure-cli). | ||
* `autoUpgradeMinorVersion`: (string) Indicates whether the extension version should be automatically updated to a newer minor version. Accepts the values `true` or `false`. | ||
* `forceUpdateTag`: (string) Any user defined value that can be modified to force the extension to re-run, even if none of the `settings` or `protectedSettings` have changed. | ||
|
||
Please refer to the [configuration structure](/docs/infrastructure/deployment-targets/tentacle/windows/azure-virtual-machines/configuration-structure) for details regarding the format of the `settings` and `protectedSettings` elements. | ||
|
||
:::div{.hint} | ||
If you need more the ability to customize more of the installation, you might want to consider using the [Azure Desired State Configuration (DSC) extension](https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/dsc-overview) in conjunction with the [OctopusDSC](https://www.powershellgallery.com/packages/OctopusDSC) resource. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters