Skip to content

Yappes Fleet Dataplane

Register runtime gateway nodes with the Yappes control plane using a one-time token, then monitor and de-register them from the Admin Console.

Path: Admin Console → Yappes Fleet → Dataplane

At a glance

Item Detail
Console Admin Console
Path Yappes Fleet → Dataplane
Outcome Dataplane registered, linked to an environment, and visible as Active after heartbeat
Related Overview · Token · Environments

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

flowchart LR
    GenerateToken[Generate Token] --> InstallAgent[Install runtime + Agent]
    InstallAgent --> AgentRegisters[Agent registers]
    AgentRegisters --> InitialSync[Initial Sync]
    InitialSync --> ActiveStatus[Registering to Active]
Step Title Description
1 Generate Token Choose dataplane name, expiry, and control plane endpoint. Token is shown once.
2 Install runtime + Agent DevOps deploys the dataplane node and configures the agent with the token and endpoint.
3 Agent registers Agent receives dataplane ID, mTLS certificate, private key, CA bundle, and sync endpoints.
4 Initial Sync Control plane marks status Registering → Active after successful heartbeat.

Control Plane Endpoint

Read-only field populated from the platform. Copy this value when configuring agents.

Info

The control plane endpoint is not editable. Use Copy when you configure the dataplane agent.

Registered Dataplane Table

Use Search and the Status Type filter (same options as Overview): All, Active, Degraded, Decommissioned, Unreachable, Expired, Inactive.

Column Description
Data plane Name
Environment Linked environment
Metrics rps, latency, error rate
Status Active, Degraded, Decommissioned, Unreachable, Expired, or Inactive
Registered Date When the node registered
View Opens detail page

Status values

Status Meaning
Active Dataplane is registered and healthy
Degraded Dataplane is registered but reporting degraded health
Decommissioned Dataplane has been de-registered
Unreachable Control plane cannot reach the dataplane
Expired Registration or heartbeat window has expired
Inactive Dataplane is registered but not currently active

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.

Warning

The token is shown only once and is invalidated after first use. Copy it before you close the modal.

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

  1. Go to Yappes Fleet → Dataplane.
  2. Open Registration Journey → Step 1 or click Generate Token.
  3. Enter Data Plane Name, Set Expiration (In hours), and optional Description.
  4. Click Generate Token and Copy the token.

Step 2: Deploy agent

  1. Install runtime and agent on the target node (Steps 2–3 of the journey).
  2. Configure the agent with the token and control plane endpoint.

Step 3: Verify registration

  1. Wait for heartbeat and initial sync (Step 4).
  2. Confirm the dataplane appears as Active in the registered table and on Overview.

Success

Registration succeeded when the dataplane status is Active in the Dataplane list and on Overview.

Step 4: De-register (if needed)

  1. Open View on the dataplane.
  2. Click De-Register.

Note

The De-Register button is hidden when the dataplane is already decommissioned.

Next steps

  • Assign the dataplane to a gateway environment in Environments.
  • Monitor health and traffic on Overview.
  • Audit issued registration tokens on Token.
  • Overview: fleet health and traffic metrics
  • Token: issued registration tokens
  • Environments: bind a dataplane to gateway domains