Environment Agent
Terminology
- Agent: A lightweight process that runs in a target environment, acting as the intermediary between DCM and the Service Providers deployed in that environment. It registers the environment to DCM, consumes resource operation requests from a messaging system, and routes them to the appropriate Service Provider.
- Embedded SP: SP code shipped within the agent binary (K8s Container, ACM Cluster, KubeVirt), enabled via configuration. Embedded SPs register internally at agent startup without a REST call.
- External SP: A standalone SP process that registers to the agent via the
REST API (
POST /api/v1/providers). Also referred to as “bring your own” SP. - Environment: A set of infrastructures that is ready to receive workload
from DCM (e.g.,
dev,staging,prod-eu-west-1).
Summary
This enhancement aims at adding the notion of environment by adding a layer between the SP and DCM: an agent would run on each environment usable by DCM and the agent would register the environment to DCM.
The agent supports a hybrid SP model: it ships with embedded SP code for known service types (K8s Container, ACM Cluster, KubeVirt), enabled via configuration, and also accepts external (“bring your own”) SPs that register via REST API. Only one SP — embedded or external — may serve a given service type per agent; duplicate registrations are rejected.
This enhancement also proposes to change the way the creation request is submitted to the agent (or currently, to the SP): instead of sending a direct request to the agent, DCM will send the request to a bus that will in turn be consumed by the relevant agent to create the requested resource.
Motivation
When deploying resources in general, one of the main criterion taken into account is the type of environment in which the resource will be deployed: DEV, INT, VAL, PROD, etc
Currently, in DCM, a resource’s creation request is routed to a given Service Provider (SP) by a policy on the base of several criteria. Once the SP is selected, DCM will send a request to the selected SP to request the creation of the resource.
There is currently no way for a policy to determine in which environment an SP is running and hence a user cannot explicitly set the targeted environment constraint when requesting the creation of a resource.
Furthermore, with the current way of submitting creation requests, the administrator has to make sure the ports are open for DCM to reach the SP. Changing how creation requests are consumed by giving the initiative to the agent would solve this problem: the agent pulls work from a messaging system, removing the need for DCM-to-environment inbound connectivity for creation requests. The agent still requires outbound connectivity to DCM for registration and heartbeats. This approach also aligns with the way K8s/OCP consume creation requests, where manifests are pulled by the application creating the resource.
Goals
- Define how the agent registers to DCM
- Define what information the agent gives to DCM while registering
- Define how agents and DCM are communicating
- Define how agents and Service Providers interact with each other
- Define how embedded SPs integrate with the agent alongside external SPs (hybrid model)
- Define the service type uniqueness constraint (one SP per service type)
- Define how Service Providers register to the agent, allowing the agent to dynamically build and maintain its list of supported service types
- Define how the agent monitors Service Provider health using the three-state health model (Ready, Unhealthy, Unavailable) and updates DCM when the supported service types change as a result
- Define how the agent reports its own health to DCM via periodic heartbeats
Non-Goals
- Defining how to use the information registered by the agent to DCM
- Define how agent will provision application (vs simple service type)
- Update other enhancement files to reflect the changes introduced by the present document; this will be done in subsequent PRs.
Proposal
Overview
For each environment that can be used by DCM, an agent must be spawned. The agent will self register to DCM. When doing so, it will provide, amongst other information, the environment on which it’s running and the service types it can serve.
When starting, the agent will also create a specific topic in the messaging system in order for DCM to communicate with the agent. The topic name is deterministic — either derived from the agent’s name or provided via configuration — ensuring that after a restart the agent reuses the same topic. If the topic already exists, the agent reuses it. The topic name is unique per environment and is shared with DCM upon registration. In the current single-agent model, one agent consumes from the topic. In a future HA model, multiple agent replicas for the same environment could consume from the same topic as competing consumers.
The agent supports a hybrid SP model combining embedded and external SPs:
- Embedded SPs: The agent ships with SP code for K8s Container, ACM Cluster, and KubeVirt. These are enabled via configuration and register internally at agent startup — no REST call is needed. The embedded SP code lives in dedicated packages within the agent codebase.
- External SPs (“bring your own”): Standalone SP processes register to the
agent via the REST API (
POST /api/v1/providers), following the contract defined in the SP Registration Flow.
Only one SP — embedded or external — may serve a given service type per agent. If an SP attempts to register for a service type that is already served, the registration is rejected (see SP Registration to Agent). Future iterations may support multiple SPs per service type with selection strategies (e.g., affinity-based, capacity-based).
The agent dynamically builds its list of supported service types based on the SPs registered to it (both embedded and external). When the list changes (SP registration or health-driven removal), the agent updates DCM accordingly.
An agent must have at least one SP (embedded or external) registered and healthy before self registering to DCM. Each service type advertised to DCM must be backed by a healthy SP.
DCM will send the creation request to the specific topic that was created by the agent.
The agent will then consume the message, validate it and then pass it to the relevant SP.
The agent monitors the health of its registered SPs using the three-state model (Ready, Unhealthy, Unavailable). The health monitoring mechanism differs by SP type:
- Embedded SPs: Health is determined in-process — the agent directly checks the embedded SP’s internal state without a network call.
- External SPs: Health is determined by polling the SP’s
GET /healthendpoint, as defined in the Service Provider Health Check enhancement.
The agent differentiates its behavior based on the SP health state:
- Unhealthy: The agent keeps the service type in its advertised list to DCM but stops routing requests to the SP. Incoming requests for that service type are held in a dedicated retry topic until the SP recovers or becomes unavailable.
- Unavailable: The agent removes the service type from its advertised list, updates DCM, and rejects any held requests for that service type.
The agent exposes the health status of each registered SP. On
Kubernetes/OpenShift deployments, the agent additionally surfaces this
information as custom pod conditions on its own pod, allowing administrators to
quickly identify which SPs are causing issues via oc describe pod.
The agent reports its own liveness to DCM via periodic REST heartbeats. DCM tracks the last heartbeat timestamp and marks the agent as unavailable if no heartbeat is received within a configurable threshold.
The status monitoring will not be impacted: the SP will be the one managing the resource and the current flow will remain the same; the agent is only an intermediary.
Architecture
%%{init: {'flowchart': {'rankSpacing': 80, 'nodeSpacing': 10, 'curve': 'linear'}}}%%
flowchart TD
classDef dcm fill:#2d2d2d,color:#ffffff,stroke:#81c784,stroke-width:2px
classDef messaging fill:#2d2d2d,color:#ffffff,stroke:#ffb74d,stroke-width:2px
classDef agent fill:#2d2d2d,color:#ffffff,stroke:#f48fb1,stroke-width:2px
classDef embedded fill:#2d2d2d,color:#ffffff,stroke:#ce93d8,stroke-width:2px
classDef external fill:#2d2d2d,color:#ffffff,stroke:#90caf9,stroke-width:2px
classDef clusterEnvironment fill:#FFFFFF,stroke:#bdbdbd,stroke-width:2px
DCM["**DCM**<br/>Control Plane"]:::dcm
MS["**Messaging System**<br/>Subject-based routing"]:::messaging
subgraph Target_Environment["Target Environment"]
direction LR
EXT_SP["**External SP**<br/>Service Type Z<br/>(bring your own)"]:::external
subgraph Agent_Process["Agent Process"]
direction TB
AG["**Agent**<br/>Routes creation requests to SP"]:::agent
EMB_SP["**Embedded SPs**<br/>K8s Container · ACM Cluster · KubeVirt<br/>(enabled via config)"]:::embedded
EMB_SP ---|In-process| AG
end
EXT_SP -. "Registration (REST)" .-> AG
AG -->|Creation Request| EXT_SP
AG -.->|"Health Check (polling)"| EXT_SP
end
DCM -->|Creation Request| MS
MS -->|Creation Request| AG
AG -. Registration .-> DCM
AG -. Heartbeat .-> DCM
AG -->|Health Warning| MS
MS -->|Health Warning| DCM
EXT_SP -->|Status| MS
EMB_SP -->|Status| MS
MS -->|Status| DCM
class Target_Environment clusterEnvironment
Flow Description
- The agent is spawned in an environment
- At startup, the agent registers its configured embedded SPs internally (K8s Container, ACM Cluster, KubeVirt — each enabled via configuration)
- External SPs register to the agent via REST API; the agent rejects registration if the service type is already served (by an embedded or another external SP)
- Only one SP (embedded or external) may serve a given service type
- The agent creates a specific topic in the bus system
- Once at least one SP is registered and healthy, the agent self-registers to DCM and begins sending periodic heartbeats
- DCM sends creation request to the specific topic
- The agent consumes the messages sent to the topic
- The agent routes the creation request to the SP serving the requested service type
- The agent monitors each registered SP’s health: in-process for embedded SPs,
via
/healthendpoint polling for external SPs. When the SP for a service type becomes unhealthy, the agent publishes a health warning through the messaging system - The status monitoring remains unchanged: each SP manages its resource lifecycle and reports status through the messaging system
API
Agent Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/providers | SP registration — reuses the SP Registration Flow contract |
| GET | /api/v1/providers | List all registered SPs (embedded and external) |
| GET | /api/v1/providers/{provider_id} | Get a specific registered SP by ID |
POST /api/v1/providers — SP Registration (External SPs only)
Reuses the contract defined in the SP Registration Flow enhancement. The agent applies the same idempotency semantics (name as natural key, create-or-update behavior).
Only one SP may serve a given service type. If the requested service type is
already served by another SP (embedded or external), the agent rejects the
registration with 409 Conflict:
{
"error": "service type 'vm' is already served by provider 'vm-provider'"
}Embedded SPs register internally at startup and do not use this endpoint.
GET /api/v1/providers — List Registered SPs
Returns the list of all SPs registered to the agent, including both embedded and external SPs. Each entry includes the provider ID, name, service type, whether the SP is embedded or external, and its current health status (Ready, Unhealthy, or Unavailable).
Example response (fields shown are illustrative and may not be exhaustive):
{
"providers": [
{
"provider_id": "sp-container-001",
"name": "k8s-container",
"service_type": "container",
"type": "embedded",
"status": "Ready",
"last_check": "2026-06-05T10:30:00Z"
},
{
"provider_id": "sp-db-001",
"name": "db-provider",
"service_type": "database",
"type": "external",
"status": "Unhealthy",
"last_check": "2026-06-05T10:30:00Z"
}
]
}GET /api/v1/providers/{provider_id} — Get a Specific SP
Returns the details of a single registered SP identified by its provider ID,
including its current health status. Returns 404 Not Found if no SP with the
given ID is registered.
DCM Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/agents | Agent registration |
| PUT | /api/v1/agents/{agent_id}/heartbeat | Agent heartbeat |
POST /api/v1/agents — Agent Registration
Register a new agent to DCM.
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Unique agent name |
| environment | string | yes | Freeform environment identifier (e.g., "dev", "staging", "prod-eu-west-1") |
| service_types | string[] | yes | List of service types the agent can serve. Must be non-empty on initial registration (prerequisite: at least one healthy SP, embedded or external). May be empty on subsequent re-registrations when SPs become unavailable (an Unhealthy SP does not trigger service type removal — see SP Health Monitoring). |
| resources_available | object | no | Available resources in the environment — sourced from K8s node info or manual configuration (see below) |
| cost | enum | yes | Cost tier: low | medium-low | medium | medium-high | high |
| topic_name | string | yes | Deterministic topic name for the agent’s messaging channel |
Response: 201 Created with {agent_id}
resources_available Structure
The resources_available field is optional. When provided, it follows a similar
structure to the SP registration metadata defined in the
SP Registration Flow, but
represents the aggregate available resources across the environment rather than
a single SP’s capacity.
Example:
{
"total_cpu": 200,
"total_memory": "1TB",
"total_storage": "2TB",
"total_node": 100
}PUT /api/v1/agents/{agent_id}/heartbeat — Agent Heartbeat
| Field | Type | Required | Description |
|---|---|---|---|
| timestamp | string (ISO 8601) | yes | Agent’s current timestamp |
| consumer_lag | integer | yes | Number of pending messages on the agent’s topic |
Response: 200 OK
SP Registration to Agent
Service Providers register to the agent rather than to DCM directly. The agent supports two registration mechanisms and dynamically maintains its list of supported service types based on registered SPs.
Service type uniqueness constraint: Only one SP — embedded or external — may serve a given service type per agent. The first SP to register for a service type claims the slot. Subsequent registration attempts for the same service type are rejected.
Persistence: The agent persists SP registrations to local storage so that slot ownership survives restarts. On startup, the agent loads persisted registrations before registering embedded SPs or accepting external ones. This ensures that an external SP registered during a prior session retains its service type slot across agent restarts.
Embedded SP Registration
Embedded SPs are not active by default. An administrator must explicitly enable each embedded SP in the agent’s configuration file. At startup, the agent registers only the embedded SPs that are explicitly enabled in its configuration. Each embedded SP’s code lives in a dedicated package within the agent codebase. The embedded SP code reaches the agent’s registration logic directly — no REST call is involved.
If the agent restarts with a configuration change that newly enables an embedded SP for a service type already occupied by an external SP (registered during a prior session and still holding its slot), the embedded SP registration for that service type is skipped. The agent logs a warning and continues starting normally — this is not a fatal error. The external SP retains its slot until it is explicitly deregistered or its lease expires.
Because embedded SPs register at startup before external SPs can connect, they effectively take priority on a clean agent state.
External SP Registration
External SPs register via the REST API (POST /api/v1/providers), following the
contract defined in the
SP Registration Flow
enhancement. The agent applies the same idempotency semantics (name as natural
key, create-or-update behavior).
If the requested service type is already served by another SP (embedded or
external), the agent rejects the registration with 409 Conflict and a message
identifying the conflicting provider, so the administrator can take action if
necessary.
External SPs periodically re-register with the agent to renew their lease. If an external SP fails to re-register before its lease expires, the agent removes its registration and frees the service type slot.
DCM Notification on Service Type Change
When the list of supported service types changes as a result of an SP
registration (embedded or external) and the agent is already registered to DCM,
the agent updates DCM via a POST /api/v1/agents request with the full updated
registration payload. If the agent has not yet registered to DCM (i.e., this is
the first SP registering), the agent does not notify DCM yet; instead, the SP
registration satisfies the prerequisite for the agent to proceed with its
initial registration to DCM (see
Agent Registration Flow).
SP Registration Flow
The following diagram illustrates the complete SP registration flow, including embedded SP startup, external SP registration, conflict handling, and DCM notification:
sequenceDiagram
autonumber
participant SP as External SP
participant AG as Agent
participant DCM as DCM<br/>(Control Plane)
participant DB as Database
Note over AG: Agent starts:<br/>register only explicitly<br/>enabled embedded SPs
AG->>AG: Register explicitly enabled<br/>embedded SPs internally<br/>(K8s Container, ACM Cluster, KubeVirt<br/>— only if enabled in config)
Note over SP: External SP starts and<br/>registers to the agent
SP->>AG: POST /api/v1/providers<br/>{name, service_type, endpoint}
activate AG
alt Service type already served by another SP
AG-->>SP: 409 Conflict<br/>{error: "service type X already<br/>served by provider Y"}
else Service type available
AG->>AG: Store SP registration<br/>Add service type to supported list
alt Service type list changed AND agent already registered to DCM
AG->>DCM: POST /api/v1/agents<br/>{name, environment, service_types,<br/>resources_available, cost, topic_name}
activate DCM
DCM->>DB: Update agent registration
activate DB
DB-->>DCM: Registration updated
deactivate DB
DCM-->>AG: 200 OK
deactivate DCM
else Service type list changed AND agent not yet registered to DCM
Note over AG: Prerequisite for initial<br/>agent registration is now met<br/>(see Agent Registration Flow)
end
AG-->>SP: 201 Created<br/>{provider_id}
end
deactivate AG
Note over SP,AG: External SP periodically<br/>re-registers to maintain its lease
Flow Description
- At startup, the agent registers only the embedded SPs that are explicitly enabled in its configuration. Embedded SPs are not active by default — an administrator must opt in via the agent’s configuration file. Each enabled embedded SP claims a service type slot. If a slot is already occupied (e.g., by an external SP that persisted from a prior session), the agent logs a warning and continues without registering that embedded SP
- An external SP starts and registers to the agent via
POST /api/v1/providers, providing:- Name
- Service type it serves
- Endpoint (URL where the agent can reach the SP)
- The agent checks whether the requested service type is already served:
- If already served: the agent rejects the registration with
409 Conflictand a message identifying the conflicting provider - If available: the agent stores the SP registration and adds the service type to its supported list
- If already served: the agent rejects the registration with
- If the service type list changed (new service type added), the agent notifies
the DCM Control Plane by sending
POST /api/v1/agentswith the full updated agent registration (name, environment, supported service types, available resources, cost, topic name); the DCM Control Plane updates the agent record in the database and responds with200 OK. If the agent is not yet registered to the DCM Control Plane, this step is deferred — the SP registration instead satisfies the prerequisite for the agent’s initial registration (see Agent Registration Flow) - The agent acknowledges the SP registration
- External SPs periodically re-register with the agent to renew their lease; the agent handles this idempotently (create or update)
Agent Registration Flow
sequenceDiagram
autonumber
participant AG as Agent
participant MS as Messaging System
participant DCM as DCM<br/>(Control Plane)
participant DB as Database
Note over AG: Agent starts in<br/>target environment
AG->>MS: Create main topic (deterministic name)
MS-->>AG: Topic created<br/>{topic_name}
AG->>MS: Create retry topic (internal)
MS-->>AG: Topic created<br/>{topic_name}.retry
AG->>MS: Create cancel topic (internal)
MS-->>AG: Topic created<br/>{topic_name}.cancel
Note over AG: Prerequisite:<br/>At least 1 SP (embedded or<br/>external) must be registered<br/>and healthy<br/>(see SP Registration to Agent)
AG->>DCM: POST /api/v1/agents<br/>{name, environment, service_types,<br/>resources_available, cost, topic_name}
activate DCM
DCM->>DB: Store agent registration<br/>{name, environment, service_types,<br/>resources_available, cost, topic_name}
activate DB
DB-->>DCM: Registration stored
deactivate DB
DCM-->>AG: 201 Created<br/>{agent_id}
deactivate DCM
Flow Description
- The agent starts and serves a specific environment
- The agent creates three topics in the messaging system:
- A main topic (using a deterministic name) to establish a dedicated communication channel with DCM. This topic name is advertised to DCM during registration.
- A retry topic (
{topic_name}.retry) used internally by the agent to hold requests when the SP for a service type is Unhealthy (see Retry Topic). This topic is not advertised to DCM. - A cancel topic (
{topic_name}.cancel) used by DCM to signal that a creation request has been re-routed to a different agent and should be ignored (see Cancel Topic). This topic is not advertised to DCM.
- The agent checks whether at least one SP (embedded or external) is registered
and healthy:
- If at least one SP is registered and healthy: the agent proceeds to register to DCM
- Else: the agent waits until at least one SP is registered and healthy
- The agent registers itself with DCM via a REST API call, providing:
- Name
- Environment
- Supported service types
- Available resources
- Cost tier
- Topic name
- DCM persists the registration in the database
- DCM acknowledges the registration
Re-Registration on Restart
When the agent restarts, it uses the same POST /api/v1/agents endpoint with
the same payload. The agent does not persist its agent_id; it relies on DCM’s
idempotent registration, which uses the agent name as the natural key (same
pattern as SP registration defined in the
SP Registration Flow): if the
name already exists and no agent_id is provided (or the same agent_id is
provided), DCM updates the existing entry, returns the same agent_id, and
resets the heartbeat tracker. The agent then uses the returned agent_id for
subsequent heartbeats and updates.
Ensuring that each agent uses a unique name is an operational responsibility.
Note that the (name, topic_name) pair is not unique: in a future HA model,
multiple agent replicas for the same environment may share the same topic name.
Resource Creation Flow
sequenceDiagram
autonumber
participant DCM as DCM<br/>(Control Plane)
participant MS as Messaging System
participant AG as Agent
participant EMB as Embedded SP
participant EXT as External SP
DCM->>MS: PUBLISH CloudEvent (creation request)<br/>topic: {agent_topic_name}<br/>{resource_id, service_type, spec}
MS->>AG: PUSH message
activate AG
AG->>AG: Validate requested service type<br/>is supported by a registered SP
alt Service type not supported
AG->>MS: PUBLISH CloudEvent<br/>{error: "unsupported service type"}
MS->>DCM: PUSH error message
else Service type supported but SP is Unhealthy
AG->>MS: PUBLISH CloudEvent (hold request)<br/>topic: {agent_topic_name}.retry<br/>{resource_id, service_type, spec}
AG->>MS: PUBLISH CloudEvent<br/>topic: dcm.agents.responses<br/>{resource_id, status: QUEUED,<br/>reason: "SP unhealthy — held for retry"}
MS->>DCM: PUSH queued response
else Service type supported and SP is Ready
alt SP is embedded
AG->>EMB: In-process call<br/>{service_type, spec}
activate EMB
alt Creation fails
EMB-->>AG: Error
deactivate EMB
AG->>MS: PUBLISH CloudEvent<br/>{error: "creation failed", details}
MS->>DCM: PUSH error message
else Creation succeeds
EMB-->>AG: Success<br/>{instance_id, status: PROVISIONING}
AG->>MS: PUBLISH CloudEvent<br/>{resource_id, status: PROVISIONING}
MS->>DCM: PUSH creation acknowledged
Note over EMB: SP manages resource lifecycle<br/>and reports status through<br/>the existing status reporting flow
end
else SP is external
AG->>EXT: POST {sp_endpoint}/api/v1/{service_type}<br/>{spec}
activate EXT
alt Creation fails
EXT-->>AG: Error response
deactivate EXT
AG->>MS: PUBLISH CloudEvent<br/>{error: "creation failed", details}
MS->>DCM: PUSH error message
else Creation succeeds
EXT-->>AG: Success response<br/>{instance_id, status: PROVISIONING}
AG->>MS: PUBLISH CloudEvent<br/>{resource_id, status: PROVISIONING}
MS->>DCM: PUSH creation acknowledged
Note over EXT: SP manages resource lifecycle<br/>and reports status through<br/>the existing status reporting flow
end
end
end
deactivate AG
Flow Description
- DCM publishes a creation request CloudEvent to the agent’s dedicated topic in the messaging system, including the resource ID, service type, and spec
- The agent consumes the message
- The agent validates that the requested service type is supported by a registered SP (embedded or external)
- If the service type is not supported:
- The agent publishes an error CloudEvent back to the messaging system
- DCM consumes the error message
- If the service type is supported but the SP is Unhealthy:
- The agent publishes the original request CloudEvent to the retry topic
(
{agent_topic_name}.retry) for durable holding - The agent publishes a “queued” CloudEvent to
dcm.agents.responseswith{resource_id, service_type, status: "QUEUED"}, informing DCM that the request is held for retry - The request will be processed when the SP recovers, or rejected if the SP becomes Unavailable (see Retry Topic)
- The agent publishes the original request CloudEvent to the retry topic
(
- If the service type is supported and the SP is Ready:
- The agent forwards the creation request to the SP via REST API (for external SPs) or in-process call (for embedded SPs)
- If the SP returns an immediate error: the agent publishes an error CloudEvent back to the messaging system for DCM to consume
- If the SP accepts the request: the agent publishes a CloudEvent acknowledging the creation is in progress. The SP takes over resource lifecycle management and reports status changes through the existing status reporting flow (SP → Messaging System → DCM)
Service Type Uniqueness
Each service type is served by exactly one SP (embedded or external). There is no SP selection strategy in the current version. Future iterations may support multiple SPs per service type with selection strategies (e.g., affinity-based, capacity-based).
Retry Policy
When the agent forwards a creation request to an SP and the SP returns an error, the agent applies a configurable retry policy. When retries are exhausted, the agent publishes an error CloudEvent to the messaging system with the resource ID (provided by DCM in the original creation request), allowing DCM to track the failure.
Retry Topic
When the SP for a given service type is Unhealthy, the agent cannot route
requests but the service type remains advertised to DCM (to avoid registration
flapping). Instead of rejecting the request, the agent publishes it to a
dedicated retry topic ({agent_topic_name}.retry) for durable holding, and
responds to DCM with a “queued” CloudEvent.
The retry topic is created by the agent at startup alongside the main topic (see Agent Registration Flow). It is internal to the agent and is not advertised to DCM.
Message format: The original CloudEvent is published to the retry topic as-is (passthrough, no wrapping).
Consumption is event-driven. The agent reads the retry topic only when an SP health state changes — not periodically:
- SP transitions to Ready: The agent consumes the retry topic. For each message whose service type now has a Ready SP, the agent processes the request (forwards to the SP, responds to DCM with success or error). Messages for service types whose SP is still Unhealthy are re-published to the retry topic.
- SP transitions to Unavailable: The agent consumes the retry topic. For each message whose service type’s SP is Unavailable, the agent rejects the request with an error CloudEvent to DCM. Messages for other service types are re-published to the retry topic.
- No health state change: The retry topic is not consumed.
Creation/Deletion dedup: If both a creation request and a deletion request for the same resource ID are present in the retry topic, both messages are removed — they cancel out since the resource was never created. The agent logs the cancellation and acknowledges the deletion to DCM. The creation request is silently dropped since it was never started.
Ordering: Requests are processed in arrival order per service type. Requests for different service types are independent.
Durability: Messages in the retry topic survive agent crashes, guaranteed by the messaging system’s persistence layer. On restart, the agent re-reads both the main topic and the retry topic.
In-Flight Request Handling
When the agent restarts, unconsumed messages on both the main topic and the retry topic are consumed once the agent is back up (guaranteed by the messaging system’s persistence layer).
- SP is Unhealthy: The agent publishes the request to the retry topic and responds to DCM with a “queued” CloudEvent. The request is processed when the SP recovers, or rejected when the SP for that service type becomes Unavailable (see Retry Topic).
- SP is Unavailable: The agent responds with an error CloudEvent for each incoming request targeting that service type. Additionally, the agent drains the retry topic, rejecting any held requests for that service type with error CloudEvents.
Cancel Topic
When DCM re-evaluates a creation request and routes it to a different agent,
SPRM publishes a dcm.request.cancel CloudEvent to the original agent’s cancel
topic ({agent_topic_name}.cancel). This prevents the original agent from
processing stale creation requests that remain on its main topic (e.g.,
re-published CloudEvents from the pending request timeout retry mechanism).
The cancel topic is created by the agent at startup alongside the main topic and
the retry topic (see Agent Registration Flow). It is
internal to the agent and is not advertised to DCM. The topic name follows the
convention {agent_topic_name}.cancel.
Deny list. The agent maintains an in-memory set of resource_id values from
consumed cancel CloudEvents. When processing creation requests from the main
topic, the agent checks each resource_id against the deny list. If a match is
found, the agent drops the creation request without forwarding it to the SP.
Startup behavior. On startup, the agent drains the cancel topic first to populate the deny list, then proceeds to consume the main topic and the retry topic. This ordering ensures that stale creation requests are filtered before they reach the SP.
Continuous consumption. While running, the agent continuously consumes from
the cancel topic to keep the deny list current. If a cancel CloudEvent arrives
for a resource_id that is already queued in the retry topic, the agent removes
the creation request from the retry topic and publishes a cancellation
acknowledgment to dcm.agents.responses. If a cancel CloudEvent arrives for a
resource_id that is already being provisioned by the SP (the agent has already
forwarded the request and received a success response), the agent rejects the
cancellation by publishing a dcm.agent.cancel-rejected CloudEvent to
dcm.agents.responses with {resource_id, agent_name, reason}. SPRM then sends
a deletion request to this agent to remove the resource, since the re-evaluated
agent is the authoritative owner of the resource_id (see
SP Resource Manager — Cancel on Re-evaluation).
Deny list lifecycle. Entries remain in memory for the lifetime of the agent process. The deny list is expected to be small — entries are only added when DCM re-evaluates a request to a different agent, which is an exceptional path. On agent restart, the deny list is rebuilt from the cancel topic.
Double-crash risk. If the agent crashes after consuming a cancel message
(acknowledged) but before dropping the matching creation from the main topic,
the cancel message is no longer on the cancel topic and the deny list is lost.
On the next restart, the agent may process the stale creation request. This is
an accepted risk: the SP’s idempotent creation behavior is the final safety net,
and the re-evaluated agent’s SP will reject the duplicate resource_id (see
SP Resource Manager — SP Idempotency Requirement).
Resource Deletion Flow
sequenceDiagram
autonumber
participant DCM as DCM<br/>(Control Plane)
participant MS as Messaging System
participant AG as Agent
participant EMB as Embedded SP
participant EXT as External SP
DCM->>MS: PUBLISH CloudEvent (deletion request)<br/>topic: {agent_topic_name}<br/>{resource_id, service_type}
MS->>AG: PUSH message
activate AG
AG->>AG: Validate requested service type<br/>is supported by a registered SP
alt Service type not supported
AG->>MS: PUBLISH CloudEvent<br/>{error: "unsupported service type"}
MS->>DCM: PUSH error message
else Service type supported but SP is Unhealthy
AG->>MS: PUBLISH CloudEvent (hold request)<br/>topic: {agent_topic_name}.retry<br/>{resource_id, service_type}
AG->>MS: PUBLISH CloudEvent<br/>topic: dcm.agents.responses<br/>{resource_id, status: QUEUED,<br/>reason: "SP unhealthy — held for retry"}
MS->>DCM: PUSH queued response
else Service type supported and SP is Ready
alt SP is embedded
AG->>EMB: In-process call<br/>{service_type, resource_id}
activate EMB
alt Deletion fails
EMB-->>AG: Error
deactivate EMB
AG->>MS: PUBLISH CloudEvent<br/>{error: "deletion failed",<br/>resource_id, details}
MS->>DCM: PUSH error message
else Deletion succeeds
EMB-->>AG: Success<br/>{resource_id, status: DELETING}
AG->>MS: PUBLISH CloudEvent<br/>{resource_id, status: DELETING}
MS->>DCM: PUSH deletion acknowledged
Note over EMB: SP manages resource deletion<br/>and reports final status through<br/>the existing status reporting flow
end
else SP is external
AG->>EXT: DELETE {sp_endpoint}/api/v1/{service_type}/{resource_id}
activate EXT
alt Deletion fails
EXT-->>AG: Error response
deactivate EXT
AG->>MS: PUBLISH CloudEvent<br/>{error: "deletion failed",<br/>resource_id, details}
MS->>DCM: PUSH error message
else Deletion succeeds
EXT-->>AG: Success response<br/>{resource_id, status: DELETING}
AG->>MS: PUBLISH CloudEvent<br/>{resource_id, status: DELETING}
MS->>DCM: PUSH deletion acknowledged
Note over EXT: SP manages resource deletion<br/>and reports final status through<br/>the existing status reporting flow
end
end
end
deactivate AG
Flow Description
- DCM publishes a deletion request CloudEvent to the agent’s dedicated topic in the messaging system, including the resource ID and service type
- The agent consumes the message
- The agent validates that the requested service type is supported by a registered SP (embedded or external)
- If the service type is not supported:
- The agent publishes an error CloudEvent back to the messaging system
- DCM consumes the error message
- If the service type is supported but the SP is Unhealthy:
- The agent publishes the original request to the retry topic for durable holding
- The agent publishes a “queued” CloudEvent to
dcm.agents.responses, informing DCM that the request is held for retry - The request will be processed when the SP recovers, or rejected if the SP becomes Unavailable (see Retry Topic)
- If the service type is supported and the SP is Ready:
- The agent forwards the deletion request to the SP via a REST
DELETEcall (for external SPs) or in-process call (for embedded SPs) - If the SP returns an immediate error: the agent publishes an error CloudEvent back to the messaging system for DCM to consume
- If the SP accepts the request: the agent publishes a CloudEvent acknowledging the deletion is in progress. The SP manages the actual resource deletion and reports the final status through the existing status reporting flow (SP → Messaging System → DCM)
- The agent forwards the deletion request to the SP via a REST
The retry policy and in-flight request handling described in the Resource Creation Flow apply equally to deletion requests.
Health
Agent Health
The agent reports its own liveness to DCM via periodic REST heartbeats. Since the messaging system is used for resource operations (creation requests, status updates), the heartbeat uses the existing REST channel that the agent already uses for registration.
The agent self-reports the number of pending messages on its topic as
consumer_lag in each heartbeat. DCM compares this value against a global
consumer_lag_threshold. When consumer_lag exceeds the threshold, DCM marks
the agent as Congested and stops routing new requests to it. When
consumer_lag drops below the threshold on a subsequent heartbeat, DCM clears
the Congested state.
DCM tracks the last heartbeat timestamp for each agent. If no heartbeat is received within a configurable threshold, DCM marks the agent as Unavailable.
On startup, the agent registers to DCM (as described in Agent Registration Flow). If the agent restarts, it re-registers to DCM; DCM handles this idempotently, resetting the heartbeat tracker.
sequenceDiagram
autonumber
participant AG as Agent
participant DCM as DCM<br/>(Control Plane)
participant DB as Database
loop Every {heartbeat_interval} seconds
AG->>DCM: PUT /api/v1/agents/{agent_id}/heartbeat<br/>{timestamp, consumer_lag}
activate DCM
DCM->>DB: Update heartbeat timestamp and lag
DCM->>DCM: Check consumer_lag against threshold
alt consumer_lag >= consumer_lag_threshold
DCM->>DB: Mark agent as Congested
else consumer_lag < consumer_lag_threshold
DCM->>DB: Clear Congested state (if set)
end
DB-->>DCM: Updated
DCM-->>AG: 200 OK
deactivate DCM
end
Note over DCM: No heartbeat received<br/>within {threshold} seconds
DCM->>DB: Mark agent as Unavailable
activate DB
DB-->>DCM: Updated
deactivate DB
Flow Description
- The agent periodically sends a heartbeat to DCM via a REST
PUTcall, including its currentconsumer_lag - DCM updates the agent’s last heartbeat timestamp and consumer lag in the database
- If
consumer_lagexceedsconsumer_lag_threshold, DCM marks the agent as Congested and stops routing new requests to it. When the lag drops below the threshold, DCM clears the Congested state - If DCM does not receive a heartbeat within the configured threshold, it marks the agent as Unavailable
- When the agent restarts, its initial registration to DCM resets the heartbeat tracker and the agent status
SP Health Monitoring
The agent monitors the health of its registered Service Providers using the three-state health model defined in the Service Provider Health Check enhancement. The monitoring mechanism differs by SP type:
- Embedded SPs: Health is determined in-process — the agent directly checks the embedded SP’s internal state without a network call.
- External SPs: Health is determined by polling the SP’s
GET /healthendpoint.
| State | Condition |
|---|---|
| Ready | SP responds with 200 OK and status: "healthy" (external), or internal check passes (embedded) |
| Unhealthy | SP responds with 200 OK and status: "unhealthy" (external), or internal check reports unhealthy (embedded) |
| Unavailable | SP does not respond or returns an error after exceeding the failure threshold (external), or internal check reports unavailable (embedded) |
With the agent layer, the responsibility for monitoring SP health shifts from DCM to the agent. The agent is the natural point to perform health checks on its registered SPs, as it already maintains the list of SP registrations.
The agent only routes requests to SPs in the Ready state. An SP in the Unhealthy or Unavailable state is not eligible for routing, even though an Unhealthy SP may be technically reachable. When the SP for a service type is Unhealthy, incoming requests are held in the retry topic rather than rejected (see Retry Topic).
Since each service type is served by exactly one SP, the agent’s behavior is determined by that SP’s health state:
When the SP becomes Unhealthy:
- The agent keeps the service type in its advertised list (no update sent to DCM to remove it)
- The agent stops routing new requests for that service type — incoming requests are held in the retry topic and a “queued” CloudEvent is sent to DCM
- The agent publishes a health warning CloudEvent to
dcm.agents.healthwith typeservice-type-degraded
When the SP becomes Unavailable:
- The agent removes the service type from its advertised list
- The agent sends a
POST /api/v1/agentsrequest to DCM with the updated registration (service types list without the affected type) - The agent drains the retry topic: all held requests for that service type are rejected with error CloudEvents to DCM
- The agent publishes a health warning CloudEvent to
dcm.agents.healthwith typeservice-type-unavailable
When a previously unhealthy or unavailable SP recovers (returns to Ready state):
- If the service type was removed (Unavailable case): the agent re-adds it to
its list and sends a
POST /api/v1/agentsto DCM with the updated registration - The agent processes held requests from the retry topic for that service type (see Retry Topic)
Agent Status
The agent exposes the health status of all registered SPs. The mechanism for exposing this information is left to the implementation (e.g., a REST endpoint, metrics, logs).
Pod Conditions (Kubernetes / OpenShift)
On Kubernetes or OpenShift deployments, the agent additionally exposes the
health status of each registered SP as custom pod conditions on its own pod.
This complements the provider endpoints and allows administrators to inspect the
agent’s pod (e.g., via oc describe pod) and immediately see which SPs are
healthy, unhealthy, or unavailable without having to query the agent’s REST API.
Each registered SP is represented as a separate pod condition, using the SP’s
provider ID as the condition type. The condition’s status field reflects
whether the SP is healthy (True) or not (False), and the reason and
message fields provide additional context.
Example output from oc describe pod <agent-pod>:
Conditions:
Type Status Reason Message
sp-vm-001/vm True Ready SP vm-provider serving service type vm is healthy
sp-db-001/database False Unhealthy SP db-provider serving service type database is unhealthyImplementation Detail
The agent uses
Pod Readiness Gates
to surface per-SP health as custom pod conditions. The agent’s pod spec declares
a readiness gate for each expected condition type, and the agent application
patches its own pod’s status.conditions via the Kubernetes API using
in-cluster authentication (rest.InClusterConfig() or equivalent). This
requires RBAC permissions on the pods/status subresource for the agent’s
service account.
sequenceDiagram
autonumber
participant AG as Agent
participant SP as External SP
participant MS as Messaging System
participant DCM as DCM<br/>(Control Plane)
participant DB as Database
Note over AG: Embedded SPs: health<br/>checked in-process
loop Every {health_check_interval} seconds (external SPs)
AG->>SP: GET /health
alt Healthy
SP-->>AG: 200 OK<br/>{status: "healthy"}
AG->>AG: Reset failure counter<br/>Mark SP as Ready
else Unhealthy
SP-->>AG: 200 OK<br/>{status: "unhealthy"}
AG->>AG: Mark SP as Unhealthy
else No response / error
SP-->>AG: Timeout / Error
AG->>AG: Increment failure counter
Note over AG: If counter >= threshold:<br/>Mark SP as Unavailable
end
end
alt SP for service type X becomes Unhealthy
Note over AG: Keep service type X<br/>in advertised list.<br/>Hold incoming requests<br/>in retry topic.
AG->>MS: PUBLISH CloudEvent<br/>topic: dcm.agents.health<br/>{type: "service-type-degraded",<br/>agent_id, service_type, reason,<br/>affected_provider}
MS->>DCM: PUSH health warning
else SP for service type X becomes Unavailable
AG->>DCM: POST /api/v1/agents<br/>{updated service_types without X}
activate DCM
DCM->>DB: Update agent registration
DB-->>DCM: Updated
DCM-->>AG: 200 OK
deactivate DCM
Note over AG: Drain retry topic:<br/>reject held requests for<br/>service type X
AG->>MS: PUBLISH CloudEvent(s)<br/>topic: dcm.agents.responses<br/>{error: "SP unavailable"}<br/>for each held request
AG->>MS: PUBLISH CloudEvent<br/>topic: dcm.agents.health<br/>{type: "service-type-unavailable",<br/>agent_id, service_type, reason,<br/>affected_provider}
MS->>DCM: PUSH health warning
else Previously unhealthy/unavailable SP recovers to Ready
Note over AG: Re-add service type if removed.<br/>Process held requests<br/>from retry topic.
opt Service type was removed (Unavailable case)
AG->>DCM: POST /api/v1/agents<br/>{updated service_types with X}
activate DCM
DCM->>DB: Update agent registration
DB-->>DCM: Updated
DCM-->>AG: 200 OK
deactivate DCM
end
AG->>SP: Forward held requests from retry topic
SP-->>AG: Responses
AG->>MS: PUBLISH CloudEvent(s)<br/>topic: dcm.agents.responses<br/>{success/error for each}
end
Flow Description
- The agent monitors each registered SP’s health:
- Embedded SPs: health checked in-process (no network call)
- External SPs: health checked by periodically polling
GET /health
- Based on the result, the agent updates the SP’s health state:
- Healthy → Ready (failure counter reset)
- Unhealthy → Unhealthy
- Timeout or error (external) / internal failure (embedded) → increment failure counter; if counter exceeds threshold → Unavailable
- When the SP for a service type becomes Unhealthy:
- The agent keeps the service type in its advertised list (no update sent to DCM)
- Incoming requests for that service type are held in the retry topic (see Retry Topic)
- The agent publishes a
service-type-degradedhealth warning CloudEvent to thedcm.agents.healthtopic
- When the SP for a service type becomes Unavailable:
- The agent removes the service type from its advertised list
- The agent sends a
POST /api/v1/agentsto DCM with the updated registration - The agent drains the retry topic: all held requests for that service type are rejected with error CloudEvents to DCM
- The agent publishes a
service-type-unavailablehealth warning CloudEvent to thedcm.agents.healthtopic
- When a previously unhealthy or unavailable SP recovers:
- If the service type was removed (Unavailable case): the agent re-adds it to
its list and sends a
POST /api/v1/agentsto DCM with the updated registration - The agent processes held requests from the retry topic for that service type
- If the service type was removed (Unavailable case): the agent re-adds it to
its list and sends a
- The agent exposes the health status of all registered SPs (both embedded and external). On Kubernetes/OpenShift deployments, the agent additionally surfaces this information as custom pod conditions on its own pod (see Pod Conditions)
CloudEvent Message Definitions
All messages exchanged through the messaging system use the CloudEvents v1.0 specification, following the conventions established in the Service Provider Status Reporting enhancement.
All agent-originated CloudEvents include agent_name and topic_name in the
data payload for correlation, in addition to the source envelope attribute.
This allows DCM to identify both the resource and the originating agent when
consuming from the shared dcm.agents.responses subject.
The spec field in creation request data follows the schema defined by the
target service type (see
SP Resource Manager,
Placement Manager).
| Message | type | source | subject | data |
|---|---|---|---|---|
| Creation Request | dcm.request.create | dcm/control-plane | {agent_topic_name} | {resource_id, service_type, spec} |
| Deletion Request | dcm.request.delete | dcm/control-plane | {agent_topic_name} | {resource_id, service_type} |
| Cancel Request | dcm.request.cancel | dcm/control-plane | {agent_topic_name}.cancel | {resource_id, service_type} |
| Creation Acknowledged | dcm.agent.creation-acknowledged | dcm/agents/{agent_id} | dcm.agents.responses | {resource_id, agent_name, topic_name, status: "PROVISIONING"} |
| Deletion Acknowledged | dcm.agent.deletion-acknowledged | dcm/agents/{agent_id} | dcm.agents.responses | {resource_id, agent_name, topic_name, status: "DELETING"} |
| Cancel Rejected | dcm.agent.cancel-rejected | dcm/agents/{agent_id} | dcm.agents.responses | {resource_id, agent_name, topic_name, reason} |
| Request Queued | dcm.agent.request-queued | dcm/agents/{agent_id} | dcm.agents.responses | {resource_id, agent_name, topic_name, service_type, status: "QUEUED"} |
| Error | dcm.agent.error | dcm/agents/{agent_id} | dcm.agents.responses | {resource_id, agent_name, topic_name, error, details} |
| Health Degraded | dcm.agent.health.service-type-degraded | dcm/agents/{agent_id} | dcm.agents.health | {agent_id, agent_name, topic_name, service_type, reason, affected_provider} |
| Health Unavailable | dcm.agent.health.service-type-unavailable | dcm/agents/{agent_id} | dcm.agents.health | {agent_id, agent_name, topic_name, service_type, reason, affected_provider} |
Assumptions
- A messaging system (e.g., NATS) is deployed and accessible to both DCM and the agent
- The agent has outbound network connectivity to DCM’s REST API (for registration and heartbeats)
- External SPs have network connectivity to the agent’s REST API (for registration and health checks)
- The agent has access to local persistent storage for persisting SP registrations across restarts
- For Kubernetes/OpenShift deployments: the agent’s service account has RBAC
permissions for the
pods/statussubresource
Risks and Mitigations
| Risk | Mitigation |
|---|---|
| Agent is a single point of failure per environment | Deferred to HA iteration. Agent restart recovers state from local storage: persisted SP registrations are loaded at startup, embedded SPs register internally, and external SPs renew their leases via periodic re-registration. |
| Messaging system failure blocks creation requests | Dependent on chosen bus technology’s delivery guarantees. Stated as an assumption. |
| Message loss with at-most-once semantics | Rely on bus capabilities (e.g., JetStream for NATS). Specific delivery guarantee is a deployment decision. |
| Agent crashes after consuming message but before responding | SPRM detects stale PENDING records via periodic sweep and re-publishes the creation CloudEvent (configurable timeout and retry count). After retries are exhausted, Placement Manager re-evaluates to a different agent. A cancel CloudEvent is sent to the old agent’s cancel topic to prevent stale processing. SP idempotent creation is the final safety net (see SP Idempotency Requirement). |
| Split-brain: agent loses DCM connectivity but keeps processing | On reconnection, the agent re-registers to DCM. During the split, DCM marks the agent as unavailable and stops routing new requests to its topic. In-flight messages are processed normally. Duplicate creation risk if DCM re-routes to another agent is mitigated by SP idempotent creation and the cancel topic mechanism. |
| Cancel topic double-crash: agent acknowledges cancel then crashes before filtering the stale creation | Accepted risk. On next restart the deny list is empty and the stale creation may be processed. SP idempotent creation prevents duplicate resources. The re-evaluated agent’s SP rejects the duplicate resource_id. |
| Unauthenticated external SP registration | Deferred to AuthN/Z iteration. Network isolation is the interim mitigation. |
| Embedded SP crash takes down the agent | Embedded SPs run in-process; a panic/crash affects the entire agent. Mitigation: embedded SP code is well-tested and isolated in dedicated packages. Process-level restart recovers state via re-registration. |
Drawbacks
- Adds operational complexity: a new binary (the agent) must be deployed, configured, and monitored per environment
- Adds latency to the creation path: DCM → messaging system → agent → SP, versus the current DCM → SP direct call
- Fragments health monitoring responsibility: DCM monitors agent health via heartbeats, while the agent monitors SP health directly (in-process for embedded SPs, via polling for external SPs)
- Requires messaging system infrastructure accessible to both DCM and all target environments
- Embedding SP code (K8s Container, ACM Cluster, KubeVirt) increases agent binary size and couples the agent release cycle to the embedded SPs for updates
Alternatives
Alternative 1: Watch / Reconcile Pattern
Description
Instead of using a messaging system for creation requests, DCM would expose resource requests through its own API. The agent would poll DCM’s API or be notified by DCM of new events, discover pending resource requests targeting its environment, and reconcile them by forwarding the creation request to the relevant SP and reporting the result back to DCM. This mimics the Kubernetes controller pattern (watch → reconcile) but with DCM acting as the API server rather than a Kubernetes cluster.
Pros
- Familiar pattern for teams experienced with Kubernetes controllers
- Could eliminate the messaging system dependency for creation requests
- DCM retains full visibility of pending requests (they live in DCM’s own storage, not in a bus topic)
- No additional infrastructure beyond DCM itself — the agent only needs outbound connectivity to DCM’s API, which it already has for registration and heartbeats
Cons
- Requires DCM to implement watch/notification semantics natively, which adds complexity to the control plane
- The messaging system is still required for status reporting (SP → bus → DCM), so this does not fully eliminate the messaging infrastructure dependency
- Maturity of a DCM-native watch system is unproven compared to established messaging systems (e.g., NATS JetStream)
Status
Deferred
Rationale
The watch/reconcile pattern’s main advantage is eliminating the messaging system for creation requests and keeping all request state within DCM. However, the messaging system is already required for status reporting (SP → bus → DCM), so removing it for creation requests alone does not eliminate the infrastructure dependency.
Additionally, DCM does not currently expose watch/notification semantics. Building a reliable, scalable watch system into DCM requires further investigation — particularly around delivery guarantees, fan-out to multiple agents, and behaviour under network partitions. This is deferred to a future iteration when the trade-offs are better understood and the maturity level of a DCM-native watch system can be assessed.
Future Enhancements
This section lists potential enhancements to the environment agent that are out of scope for the initial implementation but are expected to be addressed in future iterations. Items marked with (consolidation) are already referenced elsewhere in this document; they are gathered here for visibility.
Agent High Availability (consolidation)
The current design assumes a single agent instance per environment, making it a single point of failure. A future iteration would support multiple agent replicas for the same environment consuming from the same messaging topic as competing consumers. This requires defining leader election or partitioned consumption semantics, agent identity (shared name vs. unique replica IDs), heartbeat coordination (each replica vs. a single heartbeat per environment), and DCM-side handling of multiple registrations for the same environment. Referenced in Open Questions (item 1), Overview, Re-Registration on Restart, and Risks and Mitigations.
Hot-Reload of Agent Configuration (consolidation)
Currently, changes to the agent’s configuration (e.g., cost tier, enabled embedded SPs) require a restart to take effect. A future iteration would allow the agent to detect configuration changes at runtime — via file watchers, environment variable polling, or Kubernetes ConfigMap updates — and propagate them to DCM without downtime. Referenced in Open Questions (item 2).
Agent-Declared Congestion Threshold
The current congestion mechanism relies on a single global
consumer_lag_threshold set by DCM and applied uniformly to all agents. This
works as a baseline quality-of-service control but does not account for
heterogeneous agent capacities — an edge agent with limited resources may become
overloaded well before reaching a threshold that is comfortable for a
well-provisioned datacenter agent. A future iteration would allow each agent to
declare its own congestion threshold, reflecting its actual processing capacity.
Two approaches are worth exploring:
- Agent-provided threshold: The agent includes a
congestion_thresholdfield in the heartbeat (or at registration time). DCM uses this value instead of the global threshold when evaluating that agent’sconsumer_lag. DCM remains the decision-maker. - Agent self-declaration: The agent directly reports a
congestedflag in the heartbeat. DCM trusts the agent’s own assessment of its capacity without performing a comparison. This gives the agent full autonomy over congestion signaling but reduces DCM’s ability to enforce uniform QoS.
Design considerations include: whether the global threshold acts as a floor/ceiling even when a per-agent value is present, how to prevent misconfigured agents from never declaring congestion, and whether the threshold should be static (set at registration) or dynamic (updated in each heartbeat as conditions change).
Multiple SPs per Service Type (consolidation)
The current design enforces a one-SP-per-service-type constraint. A future iteration would allow multiple SPs to register for the same service type within an agent, with selection strategies such as affinity-based routing (e.g., prefer the SP closest to the data), capacity-based routing (e.g., least-loaded SP), or round-robin. This would require defining a selection API, conflict resolution semantics, and health-aware load balancing across SPs serving the same type. Referenced in Overview and Service Type Uniqueness.
Authentication and Authorization for SP Registration (consolidation)
External SP registration is currently unauthenticated; the interim mitigation is network isolation. A future iteration would introduce an authentication and authorization layer for the agent’s REST API (e.g., mTLS, API tokens, or OIDC), ensuring that only authorized SPs can register. This also applies to the agent’s status endpoint and any future administrative APIs. Referenced in Risks and Mitigations.
Watch/Reconcile Pattern for Creation Requests (consolidation)
An alternative to the current messaging-based creation flow, where the agent would poll DCM’s API or receive notifications of pending resource requests targeting its environment, then reconcile them Kubernetes-controller style. This approach could eliminate the messaging system dependency for creation requests (though it remains needed for status reporting) at the cost of implementing watch/notification semantics in DCM. See Alternative 1: Watch / Reconcile Pattern for the full analysis and rationale for deferral.
SP Hub/Store and Plugin SDK
Instead of — or in addition to — the current manual registration process for external SPs, a plugin system would make it simpler to discover, provision, and register SPs. This enhancement has two complementary facets:
- Plugin SDK: A formal interface and development kit for building SPs as self-contained plugins. The SDK would define the SP contract (health endpoint, creation/deletion handlers, status reporting), packaging format, and versioning conventions. Third-party developers would build SPs against this contract and distribute them as installable plugins.
- SP Hub/Store: A centralized, curated marketplace — similar to Helm Hub or OperatorHub — where pre-built SP packages are published, versioned, and discoverable. An administrator would browse the hub, select an SP, and the agent would download, install, and register it automatically, reducing the operational burden of deploying and configuring external SPs.
Together, the plugin SDK and hub/store would lower the barrier for extending DCM with new service types, accelerate SP adoption, and standardize the SP development experience.
Declarative Apply Semantics and Resource Updates
The current design uses separate CloudEvent types for creation
(dcm.request.create) and deletion (dcm.request.delete). A future iteration
would replace dcm.request.create with a declarative dcm.request.apply type
that carries the desired spec for a resource. The SP would determine whether the
resource already exists and perform the appropriate action (create or update),
reporting the outcome back to the agent (resource-created or
resource-updated). This approach unifies creation and update operations under
a single message type, eliminating the need for a separate dcm.request.update.
Deletion would remain a distinct dcm.request.delete type since it carries no
spec. Adopting apply semantics requires defining: SP API support for upsert
(create-or-update), update semantics (full replace vs. partial patch), field
mutability rules, and how SPs report intermediate states during updates (e.g.,
an UPDATING status).
Observability and Metrics
The agent currently exposes SP health via Kubernetes pod conditions, but does not emit structured telemetry. A future iteration would add agent-level observability: Prometheus metrics for request throughput (by service type and outcome), SP health state transitions, retry topic depth, and end-to-end message latency. Distributed tracing (e.g., OpenTelemetry) across the DCM → messaging system → agent → SP path would help diagnose latency and failures in the creation flow.
SP Lifecycle Management
Updating an embedded or external SP currently requires manual intervention — restarting the agent (for embedded SPs) or redeploying the external SP process. A future iteration would introduce SP lifecycle management capabilities: versioned SP upgrades, rolling updates that drain in-flight requests before swapping to the new version, and the ability to run two versions of the same SP side by side during a canary deployment. For embedded SPs, this could leverage the plugin SDK (see SP Hub/Store and Plugin SDK) to load new versions without rebuilding the agent binary.
SP-Based Advertisement for Policy Selection
Currently the agent advertises the service types it supports. An alternative approach would have the agent advertise the SPs registered to it instead. Each SP payload would contain the service type along with additional SP-related metadata that policies could use to select the agent — and, indirectly, the SP, since only one SP per service type is supported by the agent. This model would give policies richer context for placement decisions (e.g., SP capabilities, version, or provider-specific attributes) beyond the bare service type. This idea requires careful analysis before being considered for implementation: implications on the registration flow, policy contract, and the coupling between policy logic and SP internals need thorough evaluation.
A corollary of this model is state reconciliation on agent restart. If the agent advertises its SPs to DCM during registration, DCM could respond with the latest known state it holds for that agent (active instances, pending requests, etc.). This would allow the agent to reconstruct its view of the world from DCM rather than maintaining its own persistent store. In effect, persistence responsibility would shift entirely to the DCM control plane, and the agent would become stateless across restarts — simplifying its operational footprint and eliminating the need for local storage or a dedicated database. This further reinforces the need for careful design: the registration handshake would become a synchronization protocol, and failure modes around stale or partial state responses must be addressed.