Runner Basics
Runner Settings
The Runner Settings section allows you to manage and customize your runners. From setting a default runner to editing, updating, sharing, or deleting existing runners, these controls help you keep your runner environment aligned with your organization’s needs. You can also configure notifications to stay informed about runner status or activity.
On the Runners Page, you can click the button beside a particular runner and then pick from these options: set as default, edit, or delete.
Set Runner as Default
Set Runner as Default
The out-of-the-box default Runner Group in each Workspace is the
Blink Cloud Runner Group.To designate a different runner as the default, click the icon and select the “Set as Default” option.
Edit Runner
Edit Runner
Makes changes to a runner, by following these step-by-step instructions
1
Choosing for the Edit Runner option triggers a popup where you can conveniently modify the details of the selected runner.
2
Enhance your chosen Runner by selecting tags from the dynamic dropdown menu. Additionally, you can select the runner as the Default Runner by checking the designated checkbox.
Updating a Runner
Updating a Runner
For the best experience and performance, ensure that you always install the latest version of the runner. Blink runners are automatically updated by default. It is possible to disable auto-updating, and alternatively update runners manually using one of the following options described below.
Disabling Auto-Update of a Runner
Auto-updating is enabled by default. To disable, do as follows:1
On the Blink platform, in the lower-left corner, click your initials > Account Settings > General.
2
Deselect Enable runner auto upgrade. Runners will not be updated as new versions are available.
Option 1: Updating a Runner Manually
A runner can be updated manually from the Runners page. In the Version column, updated runners name and version appear in white, and runners that need to be updated have a warning sign next to their version.1
To manually update a runner, navigate to the Blink Runners page. In the Version column, you’ll see up-to-date runners displayed in white, while those requiring updates appear in yellow. To update a runner, simply click on the version highlighted in yellow. Once the update is complete, the runner’s version will change to white, indicating it is up-to-date.
2
To see the status of the Runner, click > Edit. As the Runner is being updated, the status will change from Connected to Shutting down, and back to Connected.
Option 2: Manual Update via CloudFormation
To update a runner via CloudFormation stack configuration, assuming you have a runner that was deployed via CloudFormation, follow these instructions:1
Open the deployed CloudFormation stack via the AWS console.
2
In the Runner Version parameter, update the value to the new runner version.
3
Redeploy the CloudFormation stack.
Option 3: Updating a Runner via CLI
Kubernetes Manual Update via CLI
To update a Runner via the CLI in the Helm client, use the following command:Docker Manual Update via CLI
To update a Runner via the CLI in the Docker client, use the following command:Sharing Runners
Sharing Runners
Share runners, by following these step-by-step instructions
You can give permission for another Workspace to use a Runner you created, allowing all members of that particular workspace to use the Runner.
1
Click on the three dot menu next to the Runner you would like to share.
2
Select a workspace from the dropdown menu. Members of this workspace can now use the runner.
Delete a Runner
Delete a Runner
Remove runner from your workspace, by following these step-by-step instructions
1
To delete a runner, click on the button next to the desired runner and choose the delete option.
2
- A pop-up named Delete Runner will appear, informing you about potential Workflow failures due to a missing runner. If you don’t choose a different runner, you’ll need to pick one for all Workflow or select a runner for each Workflow individually. After making your selections, you can then click the delete button located in the bottom-right corner.
How to Set up a Runner Notification Workflow
'Runner Notification' Workflow
'Runner Notification' Workflow
Learn how to set up a runner notification workflow, by following these step-by-step instructions.
1
In the Workflow Editor
Configure the event-based trigger by selecting the ‘Blink Runner Notification’ option. Press the continue button in the bottom-right corner.
2
Confirm the Trigger Setup by clicking the apply button in the bottom-right corner and continue to build your desired Workflow.
3
Upon completion of creating your Workflow, proceed to publish and activate it.
Please note that the Workflow has to be published and activated in order to for the ‘Runner Notification Workflow’ feature to work.
4
Proceed by navigating to the Runners Page and select the click the button beside a particular runner and select the Edit Runner option.
5
Access the Notifications tab in the ‘Edit Runner’ popup. Customize your notification preferences—whether via email or via a workflow. You will only be able to choose from the Event-Based Blink Runner Notification Workflow options that have been published and activated
Note It is recommended to use the Notify via Email feature as a backup in case the notification Workflow fails for any reason. In addition, if possible use the Blink Cloud Runner for the runner running the notification Workflow itself.
6
You can receive three types of different notifications:
- Runner Outdated: When the runner version is outdated, and automatic runner updates are disabled.
- Runner update failed: When a runner automatic update fails for any reason, when automatic updates are enabled.
-
Runner Disconnected: For when a Runner has been disconnected for over 10 minutes.
10 minutes is the default time, however if you would like to make the time period longer or shorter please contact support: suppert@blinkops.com