clusterflux-public/docs/artifacts.md
Clusterflux release a2664f4345 Public release release-f6c01dca61ee
Source commit: f6c01dca61eefca1a7431c48878a04dbb7a3f710

Public tree identity: sha256:3df7a93eb61c8c5c7841ac9ad6eedec89b167fd77fdd32e9fc31b57c10207387
2026-07-17 03:04:27 +02:00

38 lines
1.6 KiB
Markdown

# Artifacts
Clusterflux separates artifact metadata from artifact bytes.
## Publish metadata
`flush()` makes a VFS artifact visible to downstream tasks and records its
digest, size, producer task and attempt, and retaining locations. It does not
upload bytes to the coordinator by default.
Your node retains artifact bytes on a best-effort basis. If every retaining node
is lost, stale, revoked, or garbage-collects the bytes, the artifact is
unavailable. Clusterflux reports that state instead of inventing durable
storage.
## Move bytes explicitly
Use `sync()` or an explicit export when you need another node or your own storage
system to hold the bytes. Same-node reuse avoids a coordinator transfer.
## Download
~~~bash
clusterflux artifact list --process <process-id>
clusterflux artifact download <artifact-id> --to ./output.bin --max-bytes 67108864
~~~
Before returning a link, the service checks authorization, current retention,
source-node liveness, live size, per-project and per-account policy, and relay
capacity. It reserves the affordable ingress and egress budget atomically. The
scoped link is unguessable, expires, can be revoked, and is bound to the actor,
tenant, project, process, artifact, and policy context.
The reverse stream counts framing, base64 expansion, failed bytes, and abandoned
transfers. The CLI verifies the final digest. Hosted policy may impose
per-project, per-tenant, and per-account size, concurrency, and period limits.
Operators may disable relay traffic as an emergency safety control; one tenant's
period usage does not consume a shared customer byte quota.