Add Agent Panel
Overview
The Add Agent panel enables administrators to register and integrate DataFloem Agent instances responsible for remote execution, local pipeline processing, and distributed resource management.
Agents configured through this panel serve as secure execution nodes deployed across edge or on-premise infrastructure, establishing encrypted API communication with the central platform to handle pipeline workloads.
Access Requirements
To access this page, the user must either have Administrator privileges or the CREATE permission for the Agents module.
The CREATE permission allows users to create new groups. Users without administrator privileges or the required permission cannot access this page.
If you do not have the required permission, ask your administrator to grant it from one of the authorization pages below.
Authorization
Users without the required authorization will receive the following error:
Access Denied
You don't have access to this resource.
Prerequisites
Before registering a new Agent, ensure that:
- The DataFloem Agent runtime service is installed and actively running on the target remote host.
- Network routing, firewall rules, and security groups allow bidirectional communication on the target Agent port.
- You have provisioned a valid API Token generated by or assigned to the target Agent instance.
Form Elements
The fields that need to be configured within the panel are as follows:
| Field | Required? | Description |
|---|---|---|
| Name | Yes | A unique alias identifying this Agent instance across the platform. |
| Description | No | Optional notes describing the Agent's physical/cloud location or execution scope (Maximum 200 characters). |
| Is Active | Yes (Toggle) |
Defines whether the Agent is active immediately upon deployment.
Enabled (on) by default.
|
| Host | Yes | The IP address or fully qualified domain name (FQDN) of the host running the Agent service. |
| Port | Yes |
The network port on which the Agent service is listening for
incoming API requests (e.g., 8080,
9090).
|
| API Token | Yes | The secure bearer token used to authenticate API requests sent to the Agent. |
| Test Connection | Button | Triggers a real-time health check and authentication test to the configured Agent endpoint. |
Test Connection Behavior
-
Clicking the Test Connection button sends a real-time
handshake request to the Agent endpoint using the provided
Host,Port, andAPI Token. - If the Agent responds and the token is authenticated successfully, a green notification banner appears confirming readiness.
- If the endpoint is unreachable or authentication fails, a red error prompt appears. Testing connection status prior to saving is recommended.
Agent Deployment Process
- Click the Add Agent action button on the control panel to open the side drawer.
- Enter a unique Name, fill in the optional Description, and verify the Is Active state.
- Under Connection Parameters, specify the Agent's Host address and communication Port.
- Input the designated API Token required for secure authentication.
- Click Test Connection to verify endpoint availability and credential validity.
- Once validated, click Save to commit the Agent asset to the platform, or click Cancel to abort the operation.
Validation Rules
- Name, Host, Port, and API Token fields cannot be left empty.
- The Description field must strictly observe the 0 - 200 character boundary.
- The Port field must contain a valid numerical integer within the allowed port range (1-65535).