Skip to documentation
OrbitMeshDocs
Browse documentation
Docs/Direction

DIRECTION

Roadmap

New feature development is paused.
View source

1. Current Freeze

New feature development is paused.

Current implementation state is tracked in:

The current priority is aligning the existing Traffic MVP to:

Node + Capability Binding + Runtime Binding + Endpoint + Subscription

No Mesh, Gateway, Tunnel, or additional runtime feature work should start until the existing MVP is aligned.

2. Alignment Milestones

Milestone A: Documentation

Status: aligned for the current Traffic MVP.

Deliverables:

  • Capability Model.
  • Console Information Architecture.
  • Product and Architecture docs.
  • Traffic Entry / Traffic Exit docs.
  • Edge Runtime docs.
  • Subscription docs.
  • Runtime Adapter docs.
  • Database migration direction.

Milestone B: Database SQL Migration

Deliverables:

  • SQL migration from old generic gateway model to Node model.
  • SQL migration from gateway type to capability binding role.
  • SQL migration from client configuration to subscription.
  • SQL migration from ingress endpoint to endpoint.
  • SQL migration from certificate direct binding to endpoint TLS binding.
  • SQL migration for traffic usage attribution fields.

Rules:

  • Production and development databases are migrated explicitly.
  • No program fallback logic.
  • Old columns are dropped after validation.

Milestone C: Backend Model Alignment

Status: mostly aligned for the current Traffic MVP.

Deliverables:

  • Ent schema aligned to target tables.
  • Proto and OpenAPI renamed to target resources.
  • Control Plane services renamed and reorganized.
  • Desired State generated from Node, CapabilityBinding, RuntimeBinding, Endpoint, and Subscription.
  • Traffic Policy selects traffic.exit role candidates.
  • Usage attribution uses subscription and node terms.
  • Subscription target catalog exposes renderer metadata, parameter schemas, and profile presets.

Milestone D: Edge Runtime Protocol Alignment

Deliverables:

  • register returns node_id.
  • heartbeat reports runtime binding and capability binding status.
  • desired state is node-scoped.
  • runtime configs are runtime-binding-scoped.
  • usage samples include subscription, node, capability role, runtime binding, runtime, and direction.

Milestone E: Console Alignment

Status: implemented for the current Traffic MVP routes.

Deliverables:

  • /nodes.
  • /nodes/enroll.
  • /traffic/subscriptions.
  • /traffic/policies.
  • /traffic/usage.
  • /network/endpoints.
  • /network/domains.
  • /runtime-catalog.

Labels:

  • Gateway generic label removed.
  • Client Configuration label removed.
  • Ingress/Egress top-level label removed.
  • sing-box displayed only as runtime binding.

Current Console implementation also includes:

  • catalog-driven subscription profile links.
  • subscription quota and usage state.
  • usage table filtering by scope and direction.
  • Runtime Catalog metadata and install profile views.
  • page-level context descriptions for every Console route.
  • normalized mobile card spacing, button states, and adjacent panel section spacing.
  • Endpoint and Domains & TLS tables that explicitly show address, DNS record, TLS binding, certificate, readiness, and owner context.
  • Routing Policy summaries that show Entry -> Relay -> Exit path shape and selected exit node names.
  • Usage and Quota labels that distinguish billable total, raw upload/download, effective quota state, and runtime credential blocking.

Milestone F: Traffic MVP Smoke Test

Acceptance:

  • user login works.
  • Node enrollment works.
  • traffic.entry and traffic.exit roles are visible.
  • sing-box runtime binding is installed and running.
  • subscription URL works.
  • Traffic Entry -> Traffic Exit -> GitHub path works.
  • usage reporting works.
  • quota enforcement still works.
  • certificate readiness gates subscription output.

3. Post-Alignment Feature Development

After Milestone F:

Status:

  1. Endpoint and domain workflow hardening is implemented for the Traffic MVP.
    • Control Plane publishes endpoint readiness diagnostics.
    • DNS sync and TLS binding updates recompute endpoint readiness.
    • Console shows Endpoint, Domain, Runtime Binding, DNS record, TLS binding, Certificate, owner node, and readiness blockers.
  2. Quota and usage reporting hardening is implemented for the Traffic MVP.
    • Usage samples are attributed to tenant, node, capability binding, runtime binding, endpoint, user, subscription, runtime, protocol, direction, and metering point.
    • Current runtime collection is complete for client_access; sing-box node-level exit_egress and relay_transit are partially implemented, while mesh_transit and runtime_local remain planned infrastructure metering points.
    • Subscription, user, tenant, and node quota enforcement can exclude blocked credentials from generated runtime configuration.
    • Console shows usage, quota policies, enforcement state, and policy impact preview.
    • Console supports concrete usage scope target filters, user-level quota policy creation, usage-row quota actions, current-period adjustment history, and attribution coverage display.
    • Console clearly separates billable total from raw upload/download and explains that exceeded disable quotas keep subscription URLs available while withholding affected runtime credentials.
  3. Recursive runtime parameter schema forms are implemented in Console.
    • Runtime binding configuration renders from JSON Schema.
    • Nested objects, arrays, booleans, numeric fields, selects, defaults, required fields, and basic validation are supported.

Remaining feature development after the Traffic MVP is stable:

  1. Add EasyTier Mesh/Tunnel adapter.
  2. Add Traefik Gateway adapter.
  3. Add frp or Cloudflare Tunnel adapter.

4. Release Policy

During alignment:

  • API and database changes can be breaking.
  • Tags are cut only after a phase is internally consistent.
  • SQL migration must be reviewed before production rollout.
  • Console-only changes can go directly to main when they do not depend on backend changes.
  • Backend and Edge Runtime changes should be released with separate tags when their contracts diverge.
OrbitMesh DocumentationContent follows the repository's main branch.