Tentacle VM extension configuration structure

The VM extension is deprecated and no longer supported. All customers using the VM extension should migrate to DSC.

These files are required to install the extension via the Azure CLI or via PowerShell.

Public settings

The schema for the public configuration file is:

{
  "OctopusServerUrl": "https://octopus.example.com",
  "Environments": [
    "Test",
    "Production"
  ],
  "Roles": [
    "web-server",
    "app-server"
  ],
  "Tenants": [
    "Acme Corp"
  ],
  "TenantTags": [
    "Tenant type/External",
    "Upgrade ring/Early adopter"
  ],
  "MachinePolicy": "Transient machines",
  "CommunicationMode": "Listen",
  "Port": 10933,
  "PublicHostNameConfiguration": "PublicIP|FQDN|ComputerName|Custom",
  "CustomPublicHostName": "web01.example.com"
}

OctopusServerUrl: (string) The url to the Octopus Server portal.
Environments: (array of string) The environments to which the Tentacle should be added.
Roles: (array of string) The target tags to assign to the Tentacle.
CommunicationMode: (string) Whether the Tentacle should wait for connections from the server (Listen) or should poll the server (Poll).
Tenants: (array of string) The tenants to assign to the Tentacle.
TenantTags: (array of strings) The tenant tags in canonical name format to assign to the Tentacle.
MachinePolicy: (string) The name of a machine policy to apply to the Tentacle.
Port: The port on which to listen for connections from the server (in Listen mode), or the port on which to connect to the Octopus Server (Poll mode).
PublicHostNameConfiguration: If in listening mode, how the server should contact the Tentacle. Can be one of the following:
- PublicIP - looks up the public IP address using api.ipify.org.
- FQDN - concatenates the local hostname with the (active directory) domain name. Useful for domain joined computers.
- ComputerName - uses the local hostname.
- Custom - allows you to specify a custom value, using the CustomPublicHostName property.
CustomPublicHostName: If in listening mode, and PublicHostNameConfiguration is set to Custom, the address that the server should use for this Tentacle.

In Listen mode, the extension will automatically add a Windows Firewall rule to allow inbound traffic, but you will still need to ensure that endpoints / NSG rules are added to allow network traffic from the Octopus Server to the Tentacle. The Tentacle will also need to be able to reach the Octopus Server portal to register the Tentacle. Once registered, this is no longer required.

Private settings

The schema for the private configuration file is:

{
  "ApiKey": "API-YOUR-KEY"
}

ApiKey: (string) The Api Key to use to connect to the Octopus Server.

The private configuration will be encrypted by Azure, and is only decryptable on the Azure VM using a special certificate installed by the Azure VM Agent.

Help us continuously improve

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

Send feedback

Page updated on Thursday, June 27, 2024

Edit on GitHub