Skip to content

docs(edge-sync): document both sides of edge sync - #20

Merged
xe-nvdk merged 1 commit into
mainfrom
docs/edge-sync
Aug 7, 2026
Merged

xe-nvdk merged 1 commit into
mainfrom
docs/edge-sync

Conversation

@xe-nvdk

@xe-nvdk xe-nvdk commented Aug 7, 2026

Copy link
Copy Markdown
Member

Summary

Documents edge sync end to end, covering the hub receive side (Basekick-Labs/arc#570–#576) and the spoke push side (Basekick-Labs/arc#578) in one guide — an operator setting this up needs both halves.

Hub: enabling it, registering and managing spokes, secrets encrypted at rest, batch reconcile, the status codes a spoke acts on, and backend support (verify-before-commit everywhere, byte-offset resume local-only).

Spoke: the [edge_sync.spoke] block, the environment-only secret, the three operator endpoints, how to read a pass result, and scheduling it yourself until the Enterprise agent ships.

Limitations are stated, not implied

  • Passes are manual in this release; the scheduled agent is Enterprise.
  • Uploads are buffered, not streamed.
  • Abandoned staging is not swept automatically.
  • A retention policy whose database matches a spoke's namespace will delete that spoke's files — the namespace is the spoke ID, and retention operates on whatever database name it is given.
  • Reconcile answers from the index rather than re-hashing storage, so hub-side corruption after a verified commit is a storage-integrity concern rather than a sync one.

Notes

🤖 Generated with Claude Code

Covers the hub receive side (Basekick-Labs/arc#570-#576) and the spoke
push side (Basekick-Labs/arc#578) in one guide, since an operator setting
this up needs both halves.

Hub: enabling it, registering and managing spokes, secrets encrypted at
rest, batch reconcile, the status codes a spoke acts on, and backend
support (verify-before-commit everywhere, byte-offset resume local-only).

Spoke: the [edge_sync.spoke] block, the environment-only secret, the
three operator endpoints, how to read a pass result, and scheduling it
yourself until the Enterprise agent ships.

Limitations are stated rather than implied: passes are manual in this
release, uploads are buffered, abandoned staging is not swept
automatically, and a retention policy whose database matches a spoke's
namespace will delete that spoke's files. Also notes that reconcile
answers from the index rather than re-hashing storage, so hub-side
corruption after a verified commit is a storage-integrity concern rather
than a sync one.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant