Yappes Fleet — Dataplane¶
Overview¶
The Dataplane section manages registration of runtime gateway nodes (dataplanes) with the Yappes control plane. Registration uses a one-time token generated in the Admin Console and consumed by the dataplane agent.
Open Yappes Fleet → Dataplane in the Admin Console.
Why This Matters¶
- Secure onboarding of gateway runtime nodes via expiring registration tokens.
- Links each dataplane to a gateway Environment for routing context.
- Enables de-registration when retiring a node.
Registration Journey¶
| Step | Title | Description |
|---|---|---|
| 1 | Generate Token | Enter dataplane name, expiry, and control plane endpoint; copy token once |
| 2 | Install runtime + Agent | DevOps deploys the node and configures the agent |
| 3 | Agent registers | Agent receives ID, mTLS cert, private key, CA, and sync endpoints |
| 4 | Initial Sync | Control plane marks status Registering → Active after heartbeat |
Control Plane Endpoint¶
Read-only field populated from the platform. Copy this value when configuring agents.
Registered Dataplane Table¶
Search and Status filter (same options as Overview).
| Column | Description |
|---|---|
| Data plane | Name |
| Environment | Linked environment |
| Metrics | rps, latency, error rate |
| Status | Registration state |
| Registered Date | When the node registered |
| View | Opens detail page |
Generate Token Modal¶
| Field | Required | Description |
|---|---|---|
| Data Plane Name | Yes | Unique dataplane identifier |
| Set Expiration (In hours) | Yes | e.g. 24 |
| Control Plane Endpoint | — | Read-only |
| Description | No | Optional notes |
After generation, a Generated token modal shows the token with Copy and Done. The token is shown only once.
View Dataplane¶
| Section | Fields |
|---|---|
| Details | Data plane, Expiration, Control plane Endpoint, Environment, Status, Version Drift |
| Metrics | Request per second, Response time (avg), Error rate |
| Action | De-Register (hidden if decommissioned) |
Step-by-Step: Register a Dataplane¶
Step 1: Generate token¶
- Go to Yappes Fleet → Dataplane.
- Open Registration Journey → Step 1 or Generate Token.
- Enter Data Plane Name, Expiration, and optional Description.
- Click Generate Token and Copy the token.
Step 2: Deploy agent¶
- Install runtime and agent on the target node (Steps 2–3 of the journey).
- Configure the agent with the token and control plane endpoint.
Step 3: Verify registration¶
- Wait for heartbeat and initial sync (Step 4).
- Confirm the dataplane appears as Active in the registered table and on Overview.
Step 4: De-register (if needed)¶
- Open View on the dataplane and click De-Register.