Configure Runner Metadata
Runner metadata lets you associate infrastructure information with runners. This information helps operators identify where a runner is deployed and filter runners in the Runners page.
Digital.ai Release displays this information in the UI and allows you to filter runners based on these values.
Before You Begin
- A Release Runner deployed in Kubernetes using the Helm chart. See Installation Options Reference for Digital.ai Release Runner.
- Access to the runner's Helm values file (
values.yaml).
How Runner Metadata Works
Configure metadata when deploying the runner. When the runner starts, it sends the metadata to Digital.ai Release during registration.
Digital.ai Release stores the metadata and displays it in the Runners page.
The process works as follows:
- Define metadata values in the runner Helm chart configuration.
- The Helm chart passes these values to the runner container as environment variables.
- The runner sends the metadata to Digital.ai Release during registration.
- Digital.ai Release stores the metadata with the runner configuration.
- The UI displays the metadata and allows you to filter runners using these fields.
Configure Runner Metadata
Configure runner metadata when deploying the runner using the Helm chart.
Add the metadata values to your values.yaml file or to a custom Helm values file.
runner:
metadata:
clusterName: "my-cluster"
environment: "production"
dataCenter: "eu-1"
Metadata Fields
| Field | Description |
|---|---|
| clusterName | Name of the Kubernetes cluster where the runner is deployed. |
| environment | Deployment environment, such as development, staging, or production. |
| dataCenter | Identifier for the data center or region where the runner runs. |
| namespace | Kubernetes namespace where the runner runs. The runner detects this value automatically using the Kubernetes downward API. |
After deployment, the runner includes this metadata when it registers with Digital.ai Release.
View Runner Metadata
You can view runner metadata in the Runners page.
- Go to
> Runners. - Locate the runner in the list.
- Click View metadata for the runner.
A dialog opens and shows the infrastructure metadata associated with the runner. For more information, see View Runner Configurations.
Filter Runners Using Metadata
You can filter runners using metadata values.
- Go to Settings > Runners.
- Click Filter.
- Select one or more filter criteria.
Available filters include Status, Runner Type and Infrastructure related attributes.
For more information, see Search & Filter Release Runners.
Runner Type
Digital.ai Release determines the runner type automatically during runner registration based on the authentication token used.
Two runner types are supported:
- Digital.ai runners - runners registered using Digital.ai-managed tokens.
- Customer runners - runners registered using customer-generated tokens.
You cannot configure the runner type during runner deployment.