diff --git a/src/pages/docs/infrastructure/deployment-targets/tentacle/windows/index.mdx b/src/pages/docs/infrastructure/deployment-targets/tentacle/windows/index.mdx index 17f39c35b0..d03cc0dd19 100644 --- a/src/pages/docs/infrastructure/deployment-targets/tentacle/windows/index.mdx +++ b/src/pages/docs/infrastructure/deployment-targets/tentacle/windows/index.mdx @@ -1,85 +1,96 @@ ---- -layout: src/layouts/Default.astro -pubDate: 2023-01-01 -modDate: 2024-04-30 -title: Windows Tentacle -description: How to install Octopus Tentacles on Windows Servers in either listening or polling mode. -navOrder: 10 ---- -import ConfigureListeningTarget from 'src/shared-content/tentacle/configure-listening-target.include.md'; -import ConfigurePollingTarget from 'src/shared-content/tentacle/configure-polling-target.include.md'; -import InstallTentacleManager from 'src/shared-content/tentacle/install-tentacle-manager.include.md'; -import TentacleDownloads from 'src/shared-content/tentacle/tentacle-downloads.include.md'; - -When you deploy software to Windows servers, you need to install Tentacle, a lightweight agent service, on your Windows servers so they can communicate with the Octopus Server. - -When installed, Tentacles: - -- Run as a Windows service called **OctopusDeploy Tentacle**. -- Wait for tasks from Octopus (deploy a package, run a script, etc). -- Report the progress and results back to the Octopus Server. - -Before you install Tentacle, review the software and hardware requirements for: - -- [The latest version of Tentacle](/docs/infrastructure/deployment-targets/tentacle/windows/requirements). -- [Versions prior to Tentacle 3.1](/docs/infrastructure/deployment-targets/tentacle/windows/requirements/legacy-requirements). - -## Communication mode - -Tentacles can be configured to communicate in Listening mode or Polling mode. Listening mode is the recommended communication style. Learn about the differences between the two modes and when you might choose to use Polling mode instead of Listening mode on the [Tentacle communication](/docs/infrastructure/deployment-targets/tentacle/tentacle-communication) page. - - - -## Configure a Listening Tentacle (recommended) - - - - - -1. Select which [environments](/docs/infrastructure/environments) the deployment target will be assigned to. -1. Choose or create at least one [target tag](/docs/infrastructure/deployment-targets/#target-roles) for the deployment target and click **Save**. - -Your deployment target is configured, next you need to preform a [health check and update Calamari](/docs/infrastructure/deployment-targets/machine-policies/#health-check). - -If the Tentacle isn't connecting, try the steps on the [troubleshooting page](/docs/infrastructure/deployment-targets/tentacle/troubleshooting-tentacles). - -### Update your Tentacle firewall - -To allow your Octopus Server to connect to the Tentacle, you'll need to allow access to TCP port **10933** on the Tentacle (or the port you selected during the installation wizard). - -**Intermediary firewalls** - -Don't forget to allow access in any intermediary firewalls between the Octopus Server and your Tentacle (not just the Windows Firewall). For example, if your Tentacle server is hosted in Amazon EC2, you'll also need to modify the AWS security group firewall to tell EC2 to allow the traffic. Similarly, if your Tentacle server is hosted in Microsoft Azure, you'll also need to add an Endpoint to tell Azure to allow the traffic. - -## Configure a Polling Tentacle - -Listening Tentacles are recommended, but there might be situations where you need to configure a Polling Tentacle. You can learn about the difference between Listening Tentacles and Polling Tentacles on the [Tentacle communication](/docs/infrastructure/deployment-targets/tentacle/tentacle-communication) page. - - - - - -Your deployment target is configured, next you need to preform a [health check and update Calamari](/docs/infrastructure/deployment-targets/machine-policies/#health-check). - -If the Tentacle isn't connecting, try the steps on the [troubleshooting page](/docs/infrastructure/deployment-targets/tentacle/troubleshooting-tentacles). - -### Update your Octopus Server firewall - -To allow Tentacle to connect to your Octopus Server, you'll need to allow access to port **10943** on the Octopus Server (or the port you selected during the installation wizard - port 10943 is just the default). You will also need to allow Tentacle to access the HTTP Octopus Web Portal (typically port **80** or **443** - these bindings are selected when you [install the Octopus Server](/docs/installation)). - -If your network rules only allow port **80** and **443** to the Octopus Server, you can either: -- Change the server bindings to either HTTP or HTTPS and use the remaining port for polling Tentacle connections. - - The listening port Octopus Server uses can be [changed from the command line](/docs/octopus-rest-api/octopus.server.exe-command-line/configure) using the `--commsListenPort` option. -Even if you do use port **80** for Polling Tentacles, the communication is still secure. -- Use a reverse proxy to redirect incoming connections to the Tentacle listening port on Octopus Server by differentiating the connection based on Hostname (TLS SNI) or IP Address - - The polling endpoint Tentacle uses can be [changed from the command line](/docs/infrastructure/deployment-targets/tentacle/polling-tentacles-over-port-443/#self-hosted) using the `--server-comms-address` option. - - You can learn about this configuration on the [Polling Tentacles over standard HTTPS port](/docs/infrastructure/deployment-targets/tentacle/polling-tentacles-over-port-443) page. - -Note that the port (or address) used to poll Octopus for jobs is different from the port (or address) used by your team to access the Octopus Deploy web interface; -this is on purpose, and it means you can use different firewall conditions to allow Tentacles to access the Octopus Server by IP address. - -Using polling mode, you won't typically need to make any firewall changes on the Tentacle machine. - -### Intermediary firewalls - -Don't forget to allow access not just in Windows Firewall, but also any intermediary firewalls between the Tentacle and your Octopus Server. For example, if your Octopus Server is hosted in Amazon EC2, you'll also need to modify the AWS security group firewall to tell EC2 to allow the traffic. Similarly if your Octopus Server is hosted in Microsoft Azure you'll also need to add an Endpoint to tell Azure to allow the traffic. +--- +layout: src/layouts/Default.astro +pubDate: 2023-01-01 +modDate: 2024-04-30 +title: Windows Tentacle +description: How to install Octopus Tentacles on Windows Servers in either listening or polling mode. +navOrder: 10 +--- +import ConfigureListeningTarget from 'src/shared-content/tentacle/configure-listening-target.include.md'; +import ConfigurePollingTarget from 'src/shared-content/tentacle/configure-polling-target.include.md'; +import InstallTentacleManager from 'src/shared-content/tentacle/install-tentacle-manager.include.md'; +import TentacleDownloads from 'src/shared-content/tentacle/tentacle-downloads.include.md'; + +When you deploy software to Windows servers, you need to install Tentacle, a lightweight agent service, on your Windows servers so they can communicate with the Octopus Server. + +When installed, Tentacles: + +- Run as a Windows service called **OctopusDeploy Tentacle**. +- Wait for tasks from Octopus (deploy a package, run a script, etc). +- Report the progress and results back to the Octopus Server. + +Before you install Tentacle, review the software and hardware requirements for: + +- [The latest version of Tentacle](/docs/infrastructure/deployment-targets/tentacle/windows/requirements). +- [Versions prior to Tentacle 3.1](/docs/infrastructure/deployment-targets/tentacle/windows/requirements/legacy-requirements). + +## Communication mode + +Tentacles can be configured to communicate in Listening mode or Polling mode. Listening mode is the recommended communication style. Learn about the differences between the two modes and when you might choose to use Polling mode instead of Listening mode on the [Tentacle communication](/docs/infrastructure/deployment-targets/tentacle/tentacle-communication) page. + + + +## Configure a Listening Tentacle (recommended) + + + + + +1. Select which [environments](/docs/infrastructure/environments) the deployment target will be assigned to. +1. Choose or create at least one [target tag](/docs/infrastructure/deployment-targets/#target-roles) for the deployment target and click **Save**. + +Your deployment target is configured, next you need to preform a [health check and update Calamari](/docs/infrastructure/deployment-targets/machine-policies/#health-check). + +If the Tentacle isn't connecting, try the steps on the [troubleshooting page](/docs/infrastructure/deployment-targets/tentacle/troubleshooting-tentacles). + +### Update your Tentacle firewall + +To allow your Octopus Server to connect to the Tentacle, you'll need to allow access to TCP port **10933** on the Tentacle (or the port you selected during the installation wizard). + +**Intermediary firewalls** + +Don't forget to allow access in any intermediary firewalls between the Octopus Server and your Tentacle (not just the Windows Firewall). For example, if your Tentacle server is hosted in Amazon EC2, you'll also need to modify the AWS security group firewall to tell EC2 to allow the traffic. Similarly, if your Tentacle server is hosted in Microsoft Azure, you'll also need to add an Endpoint to tell Azure to allow the traffic. + +## Configure a Polling Tentacle + +Listening Tentacles are recommended, but there might be situations where you need to configure a Polling Tentacle. You can learn about the difference between Listening Tentacles and Polling Tentacles on the [Tentacle communication](/docs/infrastructure/deployment-targets/tentacle/tentacle-communication) page. + + + + + +Your deployment target is configured, next you need to preform a [health check and update Calamari](/docs/infrastructure/deployment-targets/machine-policies/#health-check). + +If the Tentacle isn't connecting, try the steps on the [troubleshooting page](/docs/infrastructure/deployment-targets/tentacle/troubleshooting-tentacles). + +### Update your Octopus Server firewall + +To allow Tentacle to connect to your Octopus Server, you'll need to allow access to port **10943** on the Octopus Server (or the port you selected during the installation wizard - port 10943 is just the default). You will also need to allow Tentacle to access the HTTP Octopus Web Portal (typically port **80** or **443** - these bindings are selected when you [install the Octopus Server](/docs/installation)). + +If your network rules only allow port **80** and **443** to the Octopus Server, you can either: +- Change the server bindings to either HTTP or HTTPS and use the remaining port for polling Tentacle connections. + - The listening port Octopus Server uses can be [changed from the command line](/docs/octopus-rest-api/octopus.server.exe-command-line/configure) using the `--commsListenPort` option. +Even if you do use port **80** for Polling Tentacles, the communication is still secure. +- Use a reverse proxy to redirect incoming connections to the Tentacle listening port on Octopus Server by differentiating the connection based on Hostname (TLS SNI) or IP Address + - The polling endpoint Tentacle uses can be [changed from the command line](/docs/infrastructure/deployment-targets/tentacle/polling-tentacles-over-port-443/#self-hosted) using the `--server-comms-address` option. + - You can learn about this configuration on the [Polling Tentacles over standard HTTPS port](/docs/infrastructure/deployment-targets/tentacle/polling-tentacles-over-port-443) page. + +Note that the port (or address) used to poll Octopus for jobs is different from the port (or address) used by your team to access the Octopus Deploy web interface; +this is on purpose, and it means you can use different firewall conditions to allow Tentacles to access the Octopus Server by IP address. + +Using polling mode, you won't typically need to make any firewall changes on the Tentacle machine. + +### Intermediary firewalls + +Don't forget to allow access not just in Windows Firewall, but also any intermediary firewalls between the Tentacle and your Octopus Server. For example, if your Octopus Server is hosted in Amazon EC2, you'll also need to modify the AWS security group firewall to tell EC2 to allow the traffic. Similarly if your Octopus Server is hosted in Microsoft Azure you'll also need to add an Endpoint to tell Azure to allow the traffic. + +## Windows Server 2008 Limited Support +From Octopus Server release `2024.1` there will be [limited support](https://octopus.com/docs/deprecations#dropping-capability-for-windows-server-2008-workers-and-targets-in-20251) for executing workloads on targets or workers running Windows Server 2008. As the version of [Calamari](https://octopus.com/docs/octopus-rest-api/calamari) shipped with later version of Octopus Server will no longer be compatable with Windows Server 2008, the capability has been made available to pin the version of Calamari used on the target itself. + +To allow this: +1. Download the [most recent version of Calamari](https://download.octopusdeploy.com/calamari/Calamari.Legacy.27.2.4-ci0003.zip) (currently `27.2.4-ci0003`). This is version of Calamari is unlikely to be updated unless there are significant vulnerbilities discovered so it may be missing new capabilities that are released later than `2025.1`. +2. Extract the zip contents to a location on the Tentacle. +3. Set an environment variable `CalamariDirectoryPath` with a value of the extracted location. This variable should be provided in a context that will be available to the Tentacle process. +4. Restart the Tentacle process to ensure that it has access to this new variable. + +The next time a deployment is run, Octopus Server will ignore the embedded Calamari version and instead use the one available on the Tentacle. Warnings will continue to be logged to provide a clear signal that this limited support is considered a temporary stop-gap, as we are likely to drop support entirely for this workaround from `2026.1`.