Skip to content

Commit 52e69a2

Browse files
authored
Merge pull request MicrosoftDocs#1466 from OctopusDeploy/master
Add schema for Octopus Deploy Tentacle Agent
2 parents 58ac030 + cb0e778 commit 52e69a2

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

articles/virtual-machines/windows/extensions-configuration-samples.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,32 @@ For more details about how to configure diagnostics, see [Azure Diagnostics Exte
356356
}
357357
}
358358

359+
### Octopus Deploy Tentacle Agent
360+
361+
For more details about how to configure the Octopus Deploy Tentacle on Azure, see the [Octopus Documentation](https://octopus.com/docs/installation/installing-tentacles/azure-virtual-machines).
362+
363+
{
364+
"publisher": "OctopusDeploy.Tentacle",
365+
"type": "OctopusDeployWindowsTentacle",
366+
"typeHandlerVersion": "2.0",
367+
"autoUpgradeMinorVersion": "true",
368+
"settings": {
369+
"OctopusServerUrl": "(string, required) The url to the Octopus server portal.",
370+
"Environments": [ "(array of strings, required) The environments to which the Tentacle should be added." ],
371+
"Roles": [ "(array of strings, required) The roles to assign to the Tentacle." ],
372+
"CommunicationMode": "(string, required) Whether the Tentacle should wait for connections from the server ('Listen') or should poll the server ('Poll').",
373+
"Port": (int, required) The port to listen on for connections from the server (in 'Listen' mode), or the port on which to connect to the Octopus server ('Poll' mode).,
374+
"PublicHostNameConfiguration": "(string, optional) If in listening mode, how the server should contact the Tentacle. Can be 'PublicIP', 'FQDN', 'ComputerName' or 'Custom'. Defaults to 'PublicIp'.",
375+
"CustomPublicHostName": "(string, optional) If in listening mode, and 'PublicHostNameConfiguration' is set to 'Custom', the address that the server should use for this Tentacle.",
376+
"MachinePolicy": "(string, optional) The Machine Policy to assign to the Tentacle. If not specified, uses the default Machine Policy.",
377+
"Tenants": [ "(array of strings, optional) The tenants to assign to the Tentacle. The tenants feature must be enabled on the Octopus Server." ],
378+
"TenantTags": [ "(array of strings, optional) The tenant tags to assign to the Tentacle, in the format 'TagSet/TagName'. The tenants feature must be enabled on the Octopus Server." ]
379+
},
380+
"protectedSettings": {
381+
"ApiKey": "(string, required) The Api Key to use to connect to the Octopus server."
382+
}
383+
}
384+
359385
In the examples above, replace the version number with the latest version number.
360386

361387
Here is an example of a full VM template with Custom Script Extension.

0 commit comments

Comments
 (0)