Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
dst
command
Command dst reproduces deterministic simulation runs (issue #3): given a seed it replays the exact op trace the DST tests execute, printing the trace and any invariant violations.
|
Command dst reproduces deterministic simulation runs (issue #3): given a seed it replays the exact op trace the DST tests execute, printing the trace and any invariant violations. |
|
openstorage
command
Serve/CLI configuration resolution: flags take precedence, then the canonical OPENSTORAGE_* environment variables, then the SPIKE_*/legacy spike aliases (PG_URL, BLOB_URL) so phase-0 invocations keep working.
|
Serve/CLI configuration resolution: flags take precedence, then the canonical OPENSTORAGE_* environment variables, then the SPIKE_*/legacy spike aliases (PG_URL, BLOB_URL) so phase-0 invocations keep working. |
|
internal
|
|
|
api
Named-repo route aliases /api/repos/{repo_name}/...
|
Named-repo route aliases /api/repos/{repo_name}/... |
|
auth
Package auth declares the JWT authentication contract for the HTTP API (docs/reference/authentication.md): customer-signed tokens verified against per-org public keys.
|
Package auth declares the JWT authentication contract for the HTTP API (docs/reference/authentication.md): customer-signed tokens verified against per-org public keys. |
|
blob
Package blob provides immutable pack-object storage: the BlobStore contract plus the S3/MinIO implementation (gocloud.dev s3blob).
|
Package blob provides immutable pack-object storage: the BlobStore contract plus the S3/MinIO implementation (gocloud.dev s3blob). |
|
envconfig
Package envconfig resolves OPENSTORAGE_* settings.
|
Package envconfig resolves OPENSTORAGE_* settings. |
|
events
Package events implements the docs/reference/webhooks.md outbound-webhook surface: HMAC delivery signing, the per-attempt delivery worker (re-signing on every retry), the storage contract for registered webhooks, and the ref.RefStore decorator that turns won non-ephemeral CAS ref flips into `push` events (docs/explanation/domain-model.md invariant 7).
|
Package events implements the docs/reference/webhooks.md outbound-webhook surface: HMAC delivery signing, the per-attempt delivery worker (re-signing on every retry), the storage contract for registered webhooks, and the ref.RefStore decorator that turns won non-ephemeral CAS ref flips into `push` events (docs/explanation/domain-model.md invariant 7). |
|
githttp
commitgraph.go refreshes the split commit-graph of a cache repo after a full hydrate (issue #307, ADR-47).
|
commitgraph.go refreshes the split commit-graph of a cache repo after a full hydrate (issue #307, ADR-47). |
|
gitlimit
Package gitlimit is the shared chokepoint for git subprocesses that untrusted input can make expensive (#313, #322): the process-wide admission pool, the per-child heap cap, and their error values.
|
Package gitlimit is the shared chokepoint for git subprocesses that untrusted input can make expensive (#313, #322): the process-wide admission pool, the per-child heap cap, and their error values. |
|
gitread
Package gitread is the read-side git plumbing layer for the /api/v1 git:read endpoints (docs/reference/http-api.md): ref resolution, ls-tree, log, diff, blame, grep, and tar.gz archive streaming over a hydrated bare cache repo.
|
Package gitread is the read-side git plumbing layer for the /api/v1 git:read endpoints (docs/reference/http-api.md): ref resolution, ls-tree, log, diff, blame, grep, and tar.gz archive streaming over a hydrated bare cache repo. |
|
jobs
Package jobs is the phase-5 background-work seam (plan Decision 1): one Queue interface with two implementations sharing the same worker code — River (durable Postgres jobs, at-least-once with backoff retries and unique-by-repo sync jobs) for postgres deployments, and an in-process goroutine queue for local/sqlite mode, whose queued work is lost on process restart (the documented ADR trade-off; local mode keeps working, no silent breakage).
|
Package jobs is the phase-5 background-work seam (plan Decision 1): one Queue interface with two implementations sharing the same worker code — River (durable Postgres jobs, at-least-once with backoff retries and unique-by-repo sync jobs) for postgres deployments, and an in-process goroutine queue for local/sqlite mode, whose queued work is lost on process restart (the documented ADR trade-off; local mode keeps working, no silent breakage). |
|
lfsscan
Package lfsscan is the leaf reachability layer of unreferenced-LFS-object reclamation (issue #73): a lenient Git LFS pointer-file decoder and a bounded `git rev-list`/`cat-file` walk collecting the OIDs reachable pointer files reference.
|
Package lfsscan is the leaf reachability layer of unreferenced-LFS-object reclamation (issue #73): a lenient Git LFS pointer-file decoder and a bounded `git rev-list`/`cat-file` walk collecting the OIDs reachable pointer files reference. |
|
meta
Phase-5 eventing/sync persistence contract (docs/reference/webhooks.md webhooks, docs/reference/http-api.md git-credentials + upstream sync): webhook registrations, git credentials, and repo upstream links live in the meta database next to the repo rows they reference.
|
Phase-5 eventing/sync persistence contract (docs/reference/webhooks.md webhooks, docs/reference/http-api.md git-credentials + upstream sync): webhook registrations, git credentials, and repo upstream links live in the meta database next to the repo rows they reference. |
|
metrics
Package metrics owns the opt-in Prometheus exposition (ADR-48, issue #325).
|
Package metrics owns the opt-in Prometheus exposition (ADR-48, issue #325). |
|
ref
absence_sqlite.go mirrors absence.go's fleet-wide registry paging for the SQLite backend (issue #101) — see absence.go for the rationale.
|
absence_sqlite.go mirrors absence.go's fleet-wide registry paging for the SQLite backend (issue #101) — see absence.go for the rationale. |
|
ref/s3wal
Package s3wal is the S3-manifest-WAL RefStore experiment (issue #133, docs/plans/s3wal-plan.md): one JSON manifest object per base repo group, advanced by conditional PUT (If-Match / If-None-Match: *).
|
Package s3wal is the S3-manifest-WAL RefStore experiment (issue #133, docs/plans/s3wal-plan.md): one JSON manifest object per base repo group, advanced by conditional PUT (If-Match / If-None-Match: *). |
|
ref/s3wal/s3waltest
Package s3waltest carries the shared s3wal test fixtures: the pinned SeaweedFS/MinIO testcontainers, raw path-style S3 client construction, bucket bootstrap/cleanup helpers, and the Phase 1a {seq, nonce} payload codec.
|
Package s3waltest carries the shared s3wal test fixtures: the pinned SeaweedFS/MinIO testcontainers, raw path-style S3 client construction, bucket bootstrap/cleanup helpers, and the Phase 1a {seq, nonce} payload codec. |
|
s3oplog
Package s3oplog is the per-request S3 round-trip log seam (issue #182): when OPENSTORAGE_S3_OP_LOG names a file, every S3 HTTP attempt made through the openstorage SDK clients — the s3wal conditional client (ref and meta authority) and the blob client — appends one whitespace- separated line:
|
Package s3oplog is the per-request S3 round-trip log seam (issue #182): when OPENSTORAGE_S3_OP_LOG names a file, every S3 HTTP attempt made through the openstorage SDK clients — the s3wal conditional client (ref and meta authority) and the blob client — appends one whitespace- separated line: |
|
secrets
Package secrets implements optional application-level envelope encryption for secret columns in the metadata store (issue #54): webhook HMAC signing keys and upstream-sync credential passwords.
|
Package secrets implements optional application-level envelope encryption for secret columns in the metadata store (issue #54): webhook HMAC signing keys and upstream-sync credential passwords. |
|
simtest
Package simtest is the deterministic simulation testing harness (issue #3, ported from waltier's SimStore + DST design): fault-injection decorators for blob.BlobStore and ref.RefStore plus a seeded, serialized multi-node simulation with invariant oracles.
|
Package simtest is the deterministic simulation testing harness (issue #3, ported from waltier's SimStore + DST design): fault-injection decorators for blob.BlobStore and ref.RefStore plus a seeded, serialized multi-node simulation with invariant oracles. |
|
sync
Package sync implements upstream mirror synchronization (docs/explanation/domain-model.md invariant 11, docs/reference/http-api.md "Upstream sync", docs/reference/webhooks.md repo.sync.* events): a worker mirror-fetches from an upstream git provider and loopback-pushes into this server's own git smart-HTTP endpoint, reusing pack storage, ref policy, CAS, and push-event emission (phase-5 Decision 4).
|
Package sync implements upstream mirror synchronization (docs/explanation/domain-model.md invariant 11, docs/reference/http-api.md "Upstream sync", docs/reference/webhooks.md repo.sync.* events): a worker mirror-fetches from an upstream git provider and loopback-pushes into this server's own git smart-HTTP endpoint, reusing pack storage, ref policy, CAS, and push-event emission (phase-5 Decision 4). |
|
testutil/seaweedcapture
Package seaweedcapture retains opt-in, private logs for SeaweedFS test fixtures.
|
Package seaweedcapture retains opt-in, private logs for SeaweedFS test fixtures. |
|
testutil/testimages
Package testimages pins the container images that tests and fixtures pull.
|
Package testimages pins the container images that tests and fixtures pull. |
|
version
Package version reports the build version of the openstorage binary.
|
Package version reports the build version of the openstorage binary. |
Click to show internal directories.
Click to hide internal directories.