Edge runners are manageable within CloudBees Unify multiple ways. Users can register or unregister a runner, start or stop runners as needed, and disable auto updates.
Register and/or unregister Edge Runners
List and unregister edge runners for an organization using the CloudBees Unify Public API or the CloudBees Unify interface.
Use the API to perform the following:
-
List edge runners:
GET /organizations/<your_org_id>/edge/runners -
List edge jobs:
GET /organizations/<organization_id>/edge/jobs -
Unregister a runner:
DELETE /organizations/<your_org_id>/edge/runners/<runner_id>
Use the CloudBees Unify interface to:
-
View Edge runners and jobs:
-
Navigate to tab.
-
Select the three-dots menu for the runner you want to manage and choose the appropriate action.
-
-
Unregister runners:
-
Navigate to tab.
-
Select the three-dots menu for the runner you want to manage and choose the appropriate action.
-
|
As a best practice, CloudBees recommends stopping the runner process on the machine before unregistering the runner using the API. Ensure the runner’s assigned job has been completed before stopping. For complete runner cleanup, delete the runner’s working directory on the machine after unregistering it. This removes any cached data or logs associated with the runner. |
For more information on API details, refer to CloudBees Unify Public API.
Enable and/or disable auto-updates
Auto-updates are enabled on runners by default. Disable auto-updates for each runner to prevent updates downloading and updating automatically.
Pre-requisites
-
Access to download the binary from https://downloads.cloudbees.com (outbound traffic to 443 port), so that runner can auto-update.
-
Default update interval is twelve hours (this is a fixed value).
Enable auto-updates
New runners have auto-updates enabled by default. There is no action to be taken.
Disable auto-updates
Auto-updates can be disabled for edge runners as needed.
When you run the --disable-updates option, updates are no longer downloaded or applied automatically.
|
If auto-updates are disabled, you must manually update runners. Runners older than 30 days are not eligible to run workloads. |
To disable auto-updates, do the following;
-
Select desired runner.
-
Enter
runcommand and then--disable-updatesto disable auto-updates.
To re-enable auto-updates, do the following;
-
Select desired runner.
-
Enter
runcommand and remove the--disable-updatesentry. Auto-updates will resume downloading and being applied automatically.
To update a runner manually, do the following;
-
Select desired runner.
-
Stop the runner.
-
Download and verify the newer edge runner binary by following steps 2 and 3 in Set up an Edge runner.
-
Replace the outdated binary with the newer version.
-
Enter the
runcommand to restart the runner.
For more information on run commands, refer to Binary reference - Run.