Directories
¶
| Path | Synopsis |
|---|---|
|
connectors
|
|
|
mysql
module
|
|
|
postgres
module
|
|
|
sqlite
module
|
|
|
ssh
module
|
|
|
Package entitlement verifies a machine's entitlement to run a product: local key material plus a vendor-signed roster, turned into a grant or a typed refusal.
|
Package entitlement verifies a machine's entitlement to run a product: local key material plus a vendor-signed roster, turned into a grant or a typed refusal. |
|
Package gate decides whether one invocation of a distributed binary may run.
|
Package gate decides whether one invocation of a distributed binary may run. |
|
Package git answers what a branch changed and what a working tree is at, by shelling out to the git binary.
|
Package git answers what a branch changed and what a working tree is at, by shelling out to the git binary. |
|
internal
|
|
|
core/entitlement
Package entitlement — the error-code range this domain owns (framework/connectors/ssh block).
|
Package entitlement — the error-code range this domain owns (framework/connectors/ssh block). |
|
core/gate
Package gate — the dotted-quad code range this domain owns.
|
Package gate — the dotted-quad code range this domain owns. |
|
core/git
Package git — the error-code range owned by this domain (ADR 0005 §Registry).
|
Package git — the error-code range owned by this domain (ADR 0005 §Registry). |
|
core/selfupdate
Package selfupdate — the error-code range owned by this domain (ADR 0005 §Registry).
|
Package selfupdate — the error-code range owned by this domain (ADR 0005 §Registry). |
|
kit
Package kit — who may call an operation: the principal, the rules and their checks.
|
Package kit — who may call an operation: the principal, the rules and their checks. |
|
kit/plug
Package plug is where kit's opt-in subsystems plug in: the HTTP engine, the frontends' file server and the process sampler of the runtime graph (framework/kit/server), the Studio's event stream and its profiler (framework/kit/studio), the stores and the databases (framework/kit/store), the queues (framework/kit/queue).
|
Package plug is where kit's opt-in subsystems plug in: the HTTP engine, the frontends' file server and the process sampler of the runtime graph (framework/kit/server), the Studio's event stream and its profiler (framework/kit/studio), the stores and the databases (framework/kit/store), the queues (framework/kit/queue). |
|
kit/queuekit
Package queuekit is what framework/kit/queue plugs into kit: the brokers kit's consumers' queues run on — the SDK's queue in memory, in the data directory and over SQL, a mailer's outbox on a database sealed in front of the SQL one —, the consumer that delivers them, and the migration of a queue's table (ADR 0179 §1, step 4).
|
Package queuekit is what framework/kit/queue plugs into kit: the brokers kit's consumers' queues run on — the SDK's queue in memory, in the data directory and over SQL, a mailer's outbox on a database sealed in front of the SQL one —, the consumer that delivers them, and the migration of a queue's table (ADR 0179 §1, step 4). |
|
kit/serverkit
Package serverkit is what framework/kit/server plugs into kit: the HTTP engine an app in the server profile serves on (the SDK's net/server), the frontends' file server (the SDK's net/static), and the process sampler of the runtime graph a serving app answers (the SDK's proc/process, and through it runtime/metrics and the spawn engine).
|
Package serverkit is what framework/kit/server plugs into kit: the HTTP engine an app in the server profile serves on (the SDK's net/server), the frontends' file server (the SDK's net/static), and the process sampler of the runtime graph a serving app answers (the SDK's proc/process, and through it runtime/metrics and the spawn engine). |
|
kit/storekit
Package storekit is what framework/kit/store plugs into kit: the engines kit's stores run on — the SDK's document store in memory, in the data directory and over SQL —, kit's scope on a database — the SDK's transaction manager, its check and its migrator — and the migrations of kit's tables (ADR 0179 §1).
|
Package storekit is what framework/kit/store plugs into kit: the engines kit's stores run on — the SDK's document store in memory, in the data directory and over SQL —, kit's scope on a database — the SDK's transaction manager, its check and its migrator — and the migrations of kit's tables (ADR 0179 §1). |
|
kit/studiokit
Package studiokit — the Studio's live events, as a Server-Sent Events stream.
|
Package studiokit — the Studio's live events, as a Server-Sent Events stream. |
|
service/entitlement
Package entitlement — the trust anchors this verifier accepts, and why there is more than one of them.
|
Package entitlement — the trust anchors this verifier accepts, and why there is more than one of them. |
|
service/gate
Package gate — the classifier behind framework/gate.
|
Package gate — the classifier behind framework/gate. |
|
service/git
Package git — the changed set: which files, line ranges and directories a branch touched.
|
Package git — the changed set: which files, line ranges and directories a branch touched. |
|
service/selfupdate
Package selfupdate replaces the running binary with a newer signed release.
|
Package selfupdate replaces the running binary with a newer signed release. |
|
Package kit — who may call an operation: the principal, the rules and their checks.
|
Package kit — who may call an operation: the principal, the rules and their checks. |
|
config/toml
Package toml lets a kit product read TOML configuration files — config/config.toml, config/<env>.toml — as it reads JSON ones.
|
Package toml lets a kit product read TOML configuration files — config/config.toml, config/<env>.toml — as it reads JSON ones. |
|
config/yaml
Package yaml lets a kit product read YAML configuration files — config/config.yaml, config/<env>.yaml, and .yml — as it reads JSON ones.
|
Package yaml lets a kit product read YAML configuration files — config/config.yaml, config/<env>.yaml, and .yml — as it reads JSON ones. |
|
kittest
Package kittest runs a product in its own tests as production runs it: on a data directory, where kit seals what it keeps at rest, a transaction writes files and a rollback writes them back, a store's retention erases and folds what it overwrote, and a restart reads everything back — none of which a product kept in memory (kit.InMemory) ever meets: kit seals nothing in memory.
|
Package kittest runs a product in its own tests as production runs it: on a data directory, where kit seals what it keeps at rest, a transaction writes files and a rollback writes them back, a store's retention erases and folds what it overwrote, and a restart reads everything back — none of which a product kept in memory (kit.InMemory) ever meets: kit seals nothing in memory. |
|
queue
Package queue plugs kit's queues in: the queues of the topics a service declares and of their subscriptions, of its watches and of its queued commands, and the outbox of a mailer on a database — the brokers the SDK's queue runs them on, in memory, in the data directory or on a database, and their consumers.
|
Package queue plugs kit's queues in: the queues of the topics a service declares and of their subscriptions, of its watches and of its queued commands, and the outbox of a mailer on a database — the brokers the SDK's queue runs them on, in memory, in the data directory or on a database, and their consumers. |
|
server
Package server makes a kit app in the server profile — the default — serve HTTP: its endpoints, its frontends and its health probes, on the SDK's server engine.
|
Package server makes a kit app in the server profile — the default — serve HTTP: its endpoints, its frontends and its health probes, on the SDK's server engine. |
|
store
Package store plugs kit's stores in: the stores a service declares, the databases a product keeps them in and their migrations, kit.Transact on a database, sealing at rest, history, revisions, trash, retention, holds, the privacy journal, Records and `data copy` — the engines the SDK's document store and sql run them on.
|
Package store plugs kit's stores in: the stores a service declares, the databases a product keeps them in and their migrations, kit.Transact on a database, sealing at rest, history, revisions, trash, retention, holds, the privacy journal, Records and `data copy` — the engines the SDK's document store and sql run them on. |
|
storetest
Package storetest is the conformance suite of kit's stores (ADR 0004): what a store does on every backend — in memory, in the data directory, on each database engine —, run by kit's tests on memory, files and kit's fake database, and by each engine module's tests on its engine.
|
Package storetest is the conformance suite of kit's stores (ADR 0004): what a store does on every backend — in memory, in the data directory, on each database engine —, run by kit's tests on memory, files and kit's fake database, and by each engine module's tests on its engine. |
|
studio
Package studio serves, in dev, the read-only API the kit tool's Studio reads: the graph and its event stream, traces, instances and items, the source, the dev tools — the process, the databases, goroutines, the heap profile, logs, the mailbox, former values.
|
Package studio serves, in dev, the read-only API the kit tool's Studio reads: the graph and its event stream, traces, instances and items, the source, the dev tools — the process, the databases, goroutines, the heap profile, logs, the mailbox, former values. |
|
Package model is the Product Graph: the one data shape every part of the framework agrees on.
|
Package model is the Product Graph: the one data shape every part of the framework agrees on. |
|
internal/core
Package core is the Product Graph under the names the role rule asks for: every struct carries its role (NodeEntity, GraphMessage, EndpointSpec, …).
|
Package core is the Product Graph under the names the role rule asks for: every struct carries its role (NodeEntity, GraphMessage, EndpointSpec, …). |
|
Package selfupdate replaces the running binary with a newer signed release.
|
Package selfupdate replaces the running binary with a newer signed release. |
|
Package telemetry — the exporter: a bounded ring producers never wait on, drained to the clients attached to a private socket, which it never reads.
|
Package telemetry — the exporter: a bounded ring producers never wait on, drained to the clients attached to a private socket, which it never reads. |
Click to show internal directories.
Click to hide internal directories.