Directories
¶
| Path | Synopsis |
|---|---|
|
Package apilimit combines shared request budgets with bounded local work.
|
Package apilimit combines shared request budgets with bounded local work. |
|
Package archive reads zip, tar and tar.gz archives: the walker the item service explodes and serves archive entries with, and a bounded walker and reader the format handlers (decision 0032) read packages with, such as an npm tarball's package.json and file count, a NuGet package's .nuspec or a jar's POM.
|
Package archive reads zip, tar and tar.gz archives: the walker the item service explodes and serves archive entries with, and a bounded walker and reader the format handlers (decision 0032) read packages with, such as an npm tarball's package.json and file count, a NuGet package's .nuspec or a jar's POM. |
|
Package archivecheck validates bounded archive structure before native-client extraction.
|
Package archivecheck validates bounded archive structure before native-client extraction. |
|
Package blob is the content-addressed binary store behind every repository (decision record 0004).
|
Package blob is the content-addressed binary store behind every repository (decision record 0004). |
|
azure
Package azure is the Azure Blob Storage blob store (decision 0027).
|
Package azure is the Azure Blob Storage blob store (decision 0027). |
|
blobtest
Package blobtest is the contract every blob.Store backend must satisfy.
|
Package blobtest is the contract every blob.Store backend must satisfy. |
|
cold
Package cold will wrap the cold blob tier for archiving and stage the content that restore jobs bring back.
|
Package cold will wrap the cold blob tier for archiving and stage the content that restore jobs bring back. |
|
fs
Package fs is the local-disk blob store.
|
Package fs is the local-disk blob store. |
|
gcs
Package gcs is the Google Cloud Storage blob store (decision 0027).
|
Package gcs is the Google Cloud Storage blob store (decision 0027). |
|
mirror
Package mirror is a blob store that keeps each blob on several member stores at once (decision 0028): different clouds, regions or accounts, any mix of the fs, s3, gcs and azure backends.
|
Package mirror is a blob store that keeps each blob on several member stores at once (decision 0028): different clouds, regions or accounts, any mix of the fs, s3, gcs and azure backends. |
|
s3
Package s3 is the S3-compatible blob store (AWS S3, MinIO, Ceph RGW and similar).
|
Package s3 is the S3-compatible blob store (AWS S3, MinIO, Ceph RGW and similar). |
|
session
Package session is the upload session shared by the object-store blob backends (s3, gcs, azure; decision 0027).
|
Package session is the upload session shared by the object-store blob backends (s3, gcs, azure; decision 0027). |
|
Package buildinfo carries the version metadata that the linker stamps into the binary with -ldflags -X. A plain `go build` stamps nothing, so it reports "devel" and empty values.
|
Package buildinfo carries the version metadata that the linker stamps into the binary with -ldflags -X. A plain `go build` stamps nothing, so it reports "devel" and empty values. |
|
Package cdn signs download URLs on a CDN in front of an object store (decision 0029).
|
Package cdn signs download URLs on a CDN in front of an object store (decision 0029). |
|
cdntest
Package cdntest is a fake CDN edge for tests (decision 0029).
|
Package cdntest is a fake CDN edge for tests (decision 0029). |
|
Package configdoc holds configuration documents: identity-provider settings, the descriptor sections that are not repositories or security, and the external secret backends.
|
Package configdoc holds configuration documents: identity-provider settings, the descriptor sections that are not repositories or security, and the external secret backends. |
|
Package crypt seals secret columns at rest (decision record 0017): remote repository and proxy passwords, LDAP and mail credentials, webhook secrets, key pair private keys, OIDC secrets and the token signing key.
|
Package crypt seals secret columns at rest (decision record 0017): remote repository and proxy passwords, LDAP and mail credentials, webhook secrets, key pair private keys, OIDC secrets and the token signing key. |
|
Package events will dispatch the outbox's events to subscribers: a bus on which each consumer subscribes to topics, with a dispatch loop driven by the work queue.
|
Package events will dispatch the outbox's events to subscribers: a bus on which each consumer subscribes to topics, with a dispatch loop driven by the work queue. |
|
gen
|
|
|
access
Package access is the generated strict chi server for the Access REST API: the identity, token and project surface served under /access.
|
Package access is the generated strict chi server for the Access REST API: the identity, token and project surface served under /access. |
|
artifactory
Package artifactory is the generated strict chi server for the Artifact repository REST API: the management surface served under /artifactory.
|
Package artifactory is the generated strict chi server for the Artifact repository REST API: the management surface served under /artifactory. |
|
distribution
Package distribution is the generated strict chi server for the Distribution REST API: the release bundle distribution surface (bundles v1, distribution rules and jobs, signing keys and edge targets) served under /distribution.
|
Package distribution is the generated strict chi server for the Distribution REST API: the release bundle distribution surface (bundles v1, distribution rules and jobs, signing keys and edge targets) served under /distribution. |
|
event
Package event is the generated strict chi server for the Event REST API: the webhook subscription surface served under /event.
|
Package event is the generated strict chi server for the Event REST API: the webhook subscription surface served under /event. |
|
grid
Package grid is the generated strict chi server for the Topology REST API: the topology and monitoring surface (known peer instances, their topology and health) served under /grid.
|
Package grid is the generated strict chi server for the Topology REST API: the topology and monitoring surface (known peer instances, their topology and health) served under /grid. |
|
operations
Package operations is the generated table of every operation in the seven bundled specs, with the chi route pattern the router serves it under and the classes it declares, and an Index that finds the operation a request addresses before routing.
|
Package operations is the generated table of every operation in the seven bundled specs, with the chi route pattern the router serves it under and the classes it declares, and an Index that finds the operation a request addresses before routing. |
|
pfed
Package pfed is the generated strict chi server for the Platform federation REST API: federations of peer instances and their membership, served under /pfed.
|
Package pfed is the generated strict chi server for the Platform federation REST API: federations of peer instances and their membership, served under /pfed. |
|
worker
Package worker is the generated strict chi server for the Workers REST API: the serverless worker surface (worker definitions, the action catalogue, test, execute, rerun and execution history) served under /worker.
|
Package worker is the generated strict chi server for the Workers REST API: the serverless worker surface (worker definitions, the action catalogue, test, execute, rerun and execution history) served under /worker. |
|
Package httpkit holds the HTTP helpers every module's handlers share: the request context values the middleware leaves for handlers, the selection of an error response profile by ordered path rules, error and JSON writing, the caller checks handlers start with, and the conversion of OpenAPI path templates to chi patterns.
|
Package httpkit holds the HTTP helpers every module's handlers share: the request context values the middleware leaves for handlers, the selection of an error response profile by ordered path rules, error and JSON writing, the caller checks handlers start with, and the conversion of OpenAPI path templates to chi patterns. |
|
apierror
Package apierror renders errors with the response profile each client expects.
|
Package apierror renders errors with the response profile each client expects. |
|
baseurl
Package baseurl resolves the public base URL a response must embed.
|
Package baseurl resolves the public base URL a response must embed. |
|
middleware
Package middleware holds the HTTP middleware that no module owns: request IDs, the access log, panic recovery, the management body limit, vendor media type normalisation, trailing-slash collection paths, a HEAD answered through its GET route, and the error handler of the generated strict servers.
|
Package middleware holds the HTTP middleware that no module owns: request IDs, the access log, panic recovery, the management body limit, vendor media type normalisation, trailing-slash collection paths, a HEAD answered through its GET route, and the error handler of the generated strict servers. |
|
Package idempotency runs a keyed request's local transactional effect at most once under its Idempotency-Key: while the key is unexpired, a retry of a committed effect gets the stored receipt, confirmed against the current state, instead of running the effect again.
|
Package idempotency runs a keyed request's local transactional effect at most once under its Idempotency-Key: while the key is unexpired, a retry of a committed effect gets the stored receipt, confirmed against the current state, instead of running the effect again. |
|
Package instance holds this instance's identity: the jfrt@<uuid> id that Artifactory reports as its service id, the Ed25519 key pair that peers know the instance by, and the peer protocol version it speaks (decision 0021).
|
Package instance holds this instance's identity: the jfrt@<uuid> id that Artifactory reports as its service id, the Ed25519 key pair that peers know the instance by, and the peer protocol version it speaks (decision 0021). |
|
Package keymaterial checks key material and opens it for signing: that the private and public halves of an RSA, GPG, Ed25519 or ECDSA key pair belong together, that a client certificate bundle carries its own private key, and how a stored RSA, Ed25519 or ECDSA key is read back to sign or verify format metadata.
|
Package keymaterial checks key material and opens it for signing: that the private and public halves of an RSA, GPG, Ed25519 or ECDSA key pair belong together, that a client certificate bundle carries its own private key, and how a stored RSA, Ed25519 or ECDSA key is read back to sign or verify format metadata. |
|
Package kms will resolve external master-key references, so that the keyring's master key can come from an external key management service.
|
Package kms will resolve external master-key references, so that the keyring's master key can come from an external key management service. |
|
Package observe will hold the observability plumbing every module shares: metrics, the health registry and OpenTelemetry set-up.
|
Package observe will hold the observability plumbing every module shares: metrics, the health registry and OpenTelemetry set-up. |
|
Package outbox holds the ordered event streams that peers exchange and the hybrid logical clock that orders their events: the port that stores this instance's outbox, each peer's acknowledged position in it, the receiver's applied positions and the blob fetches that failed while applying, with the values it takes and returns.
|
Package outbox holds the ordered event streams that peers exchange and the hybrid logical clock that orders their events: the port that stores this instance's outbox, each peer's acknowledged position in it, the receiver's applied positions and the blob fetches that failed while applying, with the values it takes and returns. |
|
Package settings holds the keys of the singleton settings and the port that stores their values as JSON.
|
Package settings holds the keys of the singleton settings and the port that stores their values as JSON. |
|
sql
|
|
|
dialect
Package dialect is the SQL layer that every SQL store is built on: the Dialect that describes what differs between engines, the unit of work that a context carries over one *sql.DB, the migrator of the modules' migration streams, Store, the handle whose helpers run statements, encode columns, page lists and seal secret columns, and the registration through which the migrator and key rotation reach every module's stream and sealed columns.
|
Package dialect is the SQL layer that every SQL store is built on: the Dialect that describes what differs between engines, the unit of work that a context carries over one *sql.DB, the migrator of the modules' migration streams, Store, the handle whose helpers run statements, encode columns, page lists and seal secret columns, and the registration through which the migrator and key rotation reach every module's stream and sealed columns. |
|
mysql
Package mysql will open MySQL databases for the SQL layer, beside the SQLite and PostgreSQL driver packages.
|
Package mysql will open MySQL databases for the SQL layer, beside the SQLite and PostgreSQL driver packages. |
|
postgres
Package postgres opens PostgreSQL databases for the SQL layer: OpenDB returns a configured *sql.DB over pgx's database/sql adapter, and Dialect describes the engine to platform/sql/dialect.
|
Package postgres opens PostgreSQL databases for the SQL layer: OpenDB returns a configured *sql.DB over pgx's database/sql adapter, and Dialect describes the engine to platform/sql/dialect. |
|
sqlite
Package sqlite opens SQLite databases for the SQL layer: OpenDB returns a configured *sql.DB over the pure-Go modernc.org/sqlite driver, and Dialect describes the engine to platform/sql/dialect.
|
Package sqlite opens SQLite databases for the SQL layer: OpenDB returns a configured *sql.DB over the pure-Go modernc.org/sqlite driver, and Dialect describes the engine to platform/sql/dialect. |
|
sqltest
Package sqltest is the SQL harness that runs a module's store suite on each dialect: RunModule hands the suite fresh databases, on SQLite in memory and in a file and, when asked, on PostgreSQL, each migrated with the module's streams alone.
|
Package sqltest is the SQL harness that runs a module's store suite on each dialect: RunModule hands the suite fresh databases, on SQLite in memory and in a file and, when asked, on PostgreSQL, each migrated with the module's streams alone. |
|
store
|
|
|
inmem
Package inmem is the in-memory implementation of the stores the platform owns: the persistent work queue, leases, settings, configuration documents, this instance's identity, the federation outbox, upload sessions, API replays and request budgets.
|
Package inmem is the in-memory implementation of the stores the platform owns: the persistent work queue, leases, settings, configuration documents, this instance's identity, the federation outbox, upload sessions, API replays and request budgets. |
|
sql
Package sql is the SQL implementation of the stores the platform owns: the persistent work queue, leases, settings, configuration documents, this instance's identity, the federation outbox, upload sessions, API replays and request budgets, with the platform's registration with the SQL layer.
|
Package sql is the SQL implementation of the stores the platform owns: the persistent work queue, leases, settings, configuration documents, this instance's identity, the federation outbox, upload sessions, API replays and request budgets, with the platform's registration with the SQL layer. |
|
sql/migrations
Package migrations holds the platform stream: the SQLite and PostgreSQL schema of the tables of the capabilities every module shares, which the platform's SQL adapters own.
|
Package migrations holds the platform stream: the SQLite and PostgreSQL schema of the tables of the capabilities every module shares, which the platform's SQL adapters own. |
|
storetest
Package storetest is the contract suite of the stores the platform owns: one set of expectations that every implementation of the work queue, leases, settings, configuration documents, the instance identity, the federation outbox, upload sessions, API replays and request budgets must meet.
|
Package storetest is the contract suite of the stores the platform owns: one set of expectations that every implementation of the work queue, leases, settings, configuration documents, the instance identity, the federation outbox, upload sessions, API replays and request budgets must meet. |
|
testkit
|
|
|
fault
Package fault holds the failing fakes that handler tests share (decision 0015), so the error paths of streaming handlers are covered without real failures: a client that goes away mid-stream, and a blob store whose writes fail.
|
Package fault holds the failing fakes that handler tests share (decision 0015), so the error paths of streaming handlers are covered without real failures: a client that goes away mid-stream, and a blob store whose writes fail. |
|
repopath
Package repopath finds the repository root and reads files by their root-relative paths, so a test names a fixture such as "api/access.openapi.yaml" the same way from any package directory.
|
Package repopath finds the repository root and reads files by their root-relative paths, so a test names a fixture such as "api/access.openapi.yaml" the same way from any package directory. |
|
storekit
Package storekit holds the assertions and paging helpers that every store contract suite shares: a value read back compared with what a store returns for the value written, fixed instants to store, checks of a call's error, and a reader of every page of a list.
|
Package storekit holds the assertions and paging helpers that every store contract suite shares: a value read back compared with what a store returns for the value written, fixed instants to store, checks of a call's error, and a reader of every page of a list. |
|
Package tx declares the unit-of-work contract, Runner: one transaction that every store call made with its context joins, and functions deferred until that transaction commits.
|
Package tx declares the unit-of-work contract, Runner: one transaction that every store call made with its context joins, and functions deferred until that transaction commits. |
|
memtx
Package memtx is the in-memory unit of work: one database of named tables and sequences behind one gate, with the transactions, row copies and keyset paging that every in-memory store built over it shares.
|
Package memtx is the in-memory unit of work: one database of named tables and sequences behind one gate, with the transactions, row copies and keyset paging that every in-memory store built over it shares. |
|
Package work runs the persistent work queue (decision 0033): a pool of workers that lease due items, run the handler registered for each item's kind, and complete, retry or park it.
|
Package work runs the persistent work queue (decision 0033): a pool of workers that lease due items, run the handler registered for each item's kind, and complete, retry or park it. |
|
Package xzfile reads whole .xz files, as liblzma and xz -t read them, with a dictionary no larger than its block header names or the caller reads, and none above 1.5 GiB, as XZ for Java reads them, allocated as it fills, within a memory budget that the dictionaries of all decodes share.
|
Package xzfile reads whole .xz files, as liblzma and xz -t read them, with a dictionary no larger than its block header names or the caller reads, and none above 1.5 GiB, as XZ for Java reads them, allocated as it fills, within a memory budget that the dictionaries of all decodes share. |
|
lzma2
Package lzma2 decodes LZMA2 chunk sequences, the data of an xz block, with a dictionary that grows as it fills.
|
Package lzma2 decodes LZMA2 chunk sequences, the data of an xz block, with a dictionary that grows as it fills. |
Click to show internal directories.
Click to hide internal directories.