Register and configure agents
Airflow 3
This feature is only available for Airflow 3.x Deployments.Remote Execution Agents execute Airflow tasks in your Kubernetes infrastructure. This guide covers registering agents with your Astro Deployment and installing the Helm chart.
Prerequisites
- Astro Deployment configured for Remote Execution mode. See Create a Deployment.
- Kubernetes 1.30 or later
- Helm 3 or later
- Deployment API token with Deployment Admin role to pull the base Astro Remote Execution Agent Image
Step 1: Create agent token
The agent token authenticates your agent to the Astro orchestration plane. Create this token before installing the Helm chart.
Save the token value in a secure location immediately after creation. You cannot retrieve it again. The limit is 50 agent tokens per Deployment.
Astro UI
Astro API
Step 2: Install Helm chart
Astronomer recommends pulling both the Remote Execution Agent image and the Sentinel image and storing them in your private registry. Sentinel provides advanced monitoring and reporting for Remote Execution Agents, starting from version 1.2.0. The Agent base images are minimal, so you might need to add packages for your pipelines to function properly. Use either an Organization API token with the Org Owner role or a Deployment API token with the Deployment Admin role to authenticate.
Download values file
- In the Astro UI, go to the Remote Agents tab
- Toggle to the Agents view
- Click Register a Remote Agent
- Click Download to get the
values.yamlfile
Configure required values
Update the following values in values.yaml. All other values have working defaults.
You must configure these values before installing the Helm chart:
agentToken,agentTokenSecretName, oragentTokenFile- See Agent token configurationimagePullSecretNameorimagePullSecretData- See Image pull secret configurationnamespace- Kubernetes namespace for agent deploymentresourceNamePrefix- Name prefix for Kubernetes resourcessecretBackend- Must be configured before agents can execute tasks. See Configure secrets backendxcomBackend- Must be configured before agents can execute tasks. See Configure XCom backend
See the Helm chart comments and Helm chart configuration reference for descriptions of values.
Pull agent image for private registries
If self-hosting the image, log in to the image registry with your Deployment API token:
Sentinel image available with 1.2.0 and later
Starting with Remote Execution Agent 1.2.0, a Sentinel image is published alongside the agent images to provide enhanced monitoring for Remote Execution Agents. The Sentinel image must be pulled separately and is not deployed by default. To use Sentinel, explicitly enable and configure the service in your values.yaml file.
After you log in, you can pull the Remote Execution Agent and optionally the Sentinel image directly. To find the latest version and image path, refer to the Remote Execution Agent release notes for all currently hosted images and Remote Execution Agent image reference for their full URLs. For example:
Configure scope for registry proxies
If you use JFrog Artifactory or a similar registry management tool to mirror or proxy images.astronomer.cloud, you need to configure specific include patterns instead of using the default **/* pattern.
The Deployment API token has limited scope and cannot fetch manifests for all repositories. Configure your remote registry to include only these specific paths:
baseimages/astro-remote-execution-agentbaseimages/astro-remote-execution-sentinel
Without these specific patterns, you might encounter 403 Forbidden errors when JFrog attempts to crawl all repositories in the registry.
Pull the Remote Execution Agent image, apply customizations that your dags require, and push it to your private registry. Then update the values.yaml file to reference your customized image.
Step 3: Optionally set allowed IP ranges
Restrict Deployment access to specific IP address ranges for additional security or network isolation between environments.
Step 4: Verify agent heartbeat
Confirm the agent is connected and healthy.
Check agent status
In the Astro UI, go to the Remote Agents tab. A healthy agent shows:
- Health status: Healthy
- Last heartbeat: Within the past minute
You can also verify locally that all agent client deployment Pods are running with kubectl get pods -n <namespace>. For more in-depth validation, check pod logs for heartbeat activity.
Temporarily remove any configured allowed IP ranges if the agent is not starting up and reporting Healthy.
Configure dag bundles
After verifying agent health, configure how agents access DAG code. See Configure DAG sources.
HTTP/HTTPS proxy server support
Starting with Remote Execution Agent 1.3.2, the agents support running behind an HTTP(S) proxy server. Configure proxy settings using the HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables.
For Remote Execution Agent versions earlier than 1.3.2, proxy servers are not supported. If your Kubernetes environment automatically adds a proxy configuration to Pods, the agents will fail to establish an outbound connection to the orchestration plane. You might see errors similar to these in worker logs:
"exc_type":"ReadError","exc_value":"[Errno 104] Connection reset by peer""exc_type":"HTTPStatusError","exc_value":"Client error '400 Bad Request' for url ...
Workaround: Remove the proxy configuration from the agent Pods, or upgrade to Agent 1.3.2 or later.
Agent token configuration
Provide the agent token using one of these methods:
agentToken
Store the token directly in values.yaml:
Storing tokens directly in values files exposes them in version control. Use agentTokenSecretName or agentTokenFile for better security.
agentTokenSecretName
Reference an existing Kubernetes secret containing the token:
In values.yaml:
agentTokenFile
Mount a file containing the token. The agent reads the token at runtime:
Image pull secret configuration
Configure image pull secrets to authenticate with your container registry. The configuration differs depending on whether you pull images directly from Astronomer’s registry or from a self-hosted registry.
The image pull secret requires an Astro API token, not an agent token. Use either an Organization API token with the Org Owner role or a Deployment API token with the Deployment Admin role. The agent token created in Step 1 authenticates the agent to the Astro orchestration plane and cannot be used for pulling images.
Astronomer registry
Self-hosted registry
Use this configuration when pulling images directly from images.astronomer.cloud.
imagePullSecretName
Reference an existing Kubernetes secret in your namespace:
In values.yaml:
imagePullSecretData
Alternatively, provide Docker config JSON directly. The Helm chart creates a secret named image-pull-secret:
Manage Remote Execution Agents
You can take the following actions on your registered Remote Execution Agents:
- Cordon: Cordoning a Remote Execution Agent marks it as unavailable for scheduling new tasks, while allowing it to continue running and complete any tasks already in progress.
This allows you to gracefully remove the Agent from service without interrupting current workloads. For example, you can cordon an Agent to delete or perform maintenance, such as an upgrade, on the Agent or underlying infrastructure.
A cordoned Agent will not receive new work, but it remains active until all running tasks have finished. Once ready to reintroduce the Agent to the task pool, it can be uncordoned to resume normal operation.
-
Uncordon: Uncordoning a Remote Execution Agent re-enables it to receive new tasks and resume normal scheduling.
-
Delete: Deletes the Remote Execution Agent from the Deployment.
Remote Execution Agent maintenance policy
Each Remote Execution Agent minor version is maintained for 6 months from the release month.
See Agent maintenance policy for more details about versioning, support, and upgrade recommendations.
Next steps
After registering agents, configure the required components:
- Configure secrets backend - Required for agent operation
- Configure XCom backend - Required for passing data between tasks
- Configure DAG sources - Required for accessing DAG code