Use self-hosted step runners to execute workflow steps that require access to services within your private environments, such as virtual private clouds (VPCs) or on-premises data centers. By default, Torq steps run on the Torq cloud runner, but steps requiring access to private resources must be executed on a self-hosted runner.
Configuring a Self-Hosted Step Runner
Follow these steps to create and deploy a self-hosted step runner:
It is recommended to allocate at least 2GB RAM and 2 vCPUs for self-hosted step runners. In Kubernetes, these resources should be allocated to the nodes hosting the runner and, in Docker, to the host machine.
Before deploying a self-hosted step runner, ensure the machine has sufficient memory and correct time configuration to meet workload demands.
Navigate to Integrations: In Torq, go to Integrations > Runner. Select Step Runner, and click Add.
Name the Step Runner: Provide a descriptive name that reflects the runner's type (Kubernetes or Docker) and the deployment environment.
Select the Deployment Type: Choose between Kubernetes or Docker.
Generate the Install Command: Click Add. Torq will automatically generate an install command.
Execute the Install Command: Copy the install command and run it in your terminal.
This action deploys the step runner using the generated YAML configuration file, which is automatically downloaded to your system.
When done, the runner is ready to use.
The install command for the runner is valid for 24 hours. If needed, you can regenerate a new install command (see below).
Specify a Step Runner for Step Execution
To use a self-hosted step runner for specific steps:
Add the step to your workflow canvas.
Open the Execution Options section.
Select the self-hosted runner from the Runner dropdown.
Regenerating an Install Command
To reinstall an unhealthy runner or deploy an additional instance:
Go to Integrations > Runner, and select the desired step runner.
Use the three-dot menu to choose Regenerate install command.
Select the deployment platform: Docker or Kubernetes.
Copy the new install command and execute it within 24 hours.
URLs Required for Communication with Torq
To ensure proper functionality, verify that the host where the step runner is deployed has access to the following URLs:
URL | Purpose |
Used to pull the runner image | |
Used to pull configurations (one time) | |
| Used to communicate with the Torq service |
Used to upload logs | |
Used for authentication |
For a complete list of IP addresses used by Google, refer to:
Deployment in Various Environments
Self-hosted step runners can be deployed in a variety of additional environments, including: