The Octopus Server has an built-in worker that can deploy packages, execute scripts, and perform tasks that don't need to be performed on a deployment target. This can be useful when you are working with an API, a cloud service, or it doesn't matter where a script runs. The built-in worker is configured by default.
Learn more about the built-in worker.
An external worker is either a Tentacle or an SSH machine that has been registered with the Octopus server as a worker. The setup of a worker is the same as setting up a deployment target as a Windows Tentacle target or an SSH target, except that instead of being added to an environment, a worker is added to a worker pool.
Workers have machine policies, are health checked, and run Calamari, just like deployment targets.
Registering an External Worker
Once the Tentacle or SSH machine has been configured, workers can be added using the UI, the Octopus Deploy REST API, the Octopus.Clients library or with the tentacle executable. Only a user with the
ConfigureServer permission can add or edit workers.
To register a worker in the Octopus Web Portal, navigate to the Infrastructure tab, select Workers and click ADD WORKER.
Tentacle workers can also register with the server using the Tentacle executable (version 3.22.0 or later), for example:
.\Tentacle.exe register-worker --instance MyInstance --server "https://example.com/" --comms-style TentaclePassive --apikey "API-CS0SW5SQJNLUBQCUBPK8LZY3KYO" --workerpool "Default Worker Pool"
TentacleActive instead of
TentaclePassive to register a polling Tentacle worker.
The Tentacle executable can also be used to deregister workers, for example:
.\Tentacle.exe deregister-worker --instance MyInstance --server "https://example.com/" --apikey "API-CS0SW5SQJNLUBQCUBPK8LZY3KYO"
Recommendations for External Workers
We highly recommend setting up external workers on a different machine to the Octopus Server.
We also recommend running external workers as a different user account to the Octopus Server.
It can be advantageous to have workers on the same local network as the server to reduce package transfer times.
Default pools attached to cloud targets allow co-location of workers and targets, this can help make workers specific to your targets as well as making the Octopus Server more secure by using external workers.
Multiple Projects Run Simultaneously on Workers
The built-in worker can run many steps simultaneously. For example, the task cap determines how many deployments can run simultaneously and those deployments could run many steps concurrently on the built-in worker. External workers are the same. External workers will run steps from different projects simultaneously. This means external workers keep the behavior of the built-in worker, including that a step doesn't have exclusive access to the worker, which could allow one project to access the working folder of another project.
In This Section
The following topics are explained further in this section: