Documentation
¶
Overview ¶
Package infra is the root of the infrastructure layer.
Inbound adapters under infra/in translate requests (HTTP, SSO callbacks, worker ticks, CLI) into application commands and queries and hold no rules. Outbound adapters under infra/out implement application ports: PostgreSQL repositories, mail, ClickHouse, object storage, outbound HTTP.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package compose assembles a replica: it builds the application's handlers on their PostgreSQL and other outbound adapters and mounts the APIs on the edge.
|
Package compose assembles a replica: it builds the application's handlers on their PostgreSQL and other outbound adapters and mounts the APIs on the edge. |
|
Package config is the server's configuration: one table declares every setting, and the loader, the keys of the configuration file and the public reference (docs/configuration.md) are all derived from it, so the reference cannot fall behind what the server reads.
|
Package config is the server's configuration: one table declares every setting, and the loader, the keys of the configuration file and the public reference (docs/configuration.md) are all derived from it, so the reference cannot fall behind what the server reads. |
|
in
|
|
|
cli
Package cli is the flagnetic command line.
|
Package cli is the flagnetic command line. |
|
http
Package http is the server's HTTP edge: the public handler with its health and readiness probes, onto which the APIs and the console are mounted.
|
Package http is the server's HTTP edge: the public handler with its health and readiness probes, onto which the APIs and the console are mounted. |
|
http/console
Package console serves the web console the binary embeds: the build of web/apps/console, or a placeholder page when the binary was built without it, so `go build` never needs Node.
|
Package console serves the web console the binary embeds: the build of web/apps/console, or a placeholder page when the binary was built without it, so `go build` never needs Node. |
|
http/deprecation
Package deprecation announces deprecated operations on the wire.
|
Package deprecation announces deprecated operations on the wire. |
|
http/management
Package management provides primitives to interact with the openapi HTTP API.
|
Package management provides primitives to interact with the openapi HTTP API. |
|
http/management/operations
Package operations reads what each operation of the management API requires from its OpenAPI document, and holds the table generated from it that the permission seam reads.
|
Package operations reads what each operation of the management API requires from its OpenAPI document, and holds the table generated from it that the permission seam reads. |
|
http/scim
Package scim provides primitives to interact with the openapi HTTP API.
|
Package scim provides primitives to interact with the openapi HTTP API. |
|
http/sdk
Package sdk provides primitives to interact with the openapi HTTP API.
|
Package sdk provides primitives to interact with the openapi HTTP API. |
|
http/sso
Package sso is the browser edge of single sign-on: the addresses a browser is sent through to sign in at an auth provider, outside the management API because every step is a navigation, not a call.
|
Package sso is the browser edge of single sign-on: the addresses a browser is sent through to sign in at an auth provider, outside the management API because every step is a navigation, not a call. |
|
worker
Package worker runs a replica's background work in rounds.
|
Package worker runs a replica's background work in rounds. |
|
Package metrics is the replica's Prometheus registry and the listener that serves it.
|
Package metrics is the replica's Prometheus registry and the listener that serves it. |
|
out
|
|
|
idphttp
Package idphttp is the HTTP client every request to an identity provider is made with, whatever the protocol it speaks.
|
Package idphttp is the HTTP client every request to an identity provider is made with, whatever the protocol it speaks. |
|
mail
Package mail is the outbound mail adapter: the templates every kind of mail is written from, in every language, and the SMTP sender.
|
Package mail is the outbound mail adapter: the templates every kind of mail is written from, in every language, and the SMTP sender. |
|
oidc
Package oidc is the outbound adapter to OpenID Connect providers, built on go-oidc.
|
Package oidc is the outbound adapter to OpenID Connect providers, built on go-oidc. |
|
password
Package password hashes members' passwords with argon2id.
|
Package password hashes members' passwords with argon2id. |
|
postgres
Package postgres is the server's PostgreSQL: the connection pool, the check that the server is a supported version, and the schema migrations embedded in the binary.
|
Package postgres is the server's PostgreSQL: the connection pool, the check that the server is a supported version, and the schema migrations embedded in the binary. |
|
postgres/access
Package access is the PostgreSQL repository of the access context: members, API tokens and sessions.
|
Package access is the PostgreSQL repository of the access context: members, API tokens and sessions. |
|
postgres/delivery
Package delivery is the PostgreSQL repository of the delivery context: for now, the ruleset version of each environment.
|
Package delivery is the PostgreSQL repository of the delivery context: for now, the ruleset version of each environment. |
|
postgres/events
Package events is the PostgreSQL repository of the events context: the raw events SDKs post and the tables that keep them apart from retries.
|
Package events is the PostgreSQL repository of the events context: the raw events SDKs post and the tables that keep them apart from retries. |
|
postgres/experiments
Package experiments is the PostgreSQL repository of the experiments context.
|
Package experiments is the PostgreSQL repository of the experiments context. |
|
postgres/flags
Package flags is the PostgreSQL repository of the flags context: flags, their configuration in each environment, and segments.
|
Package flags is the PostgreSQL repository of the flags context: flags, their configuration in each environment, and segments. |
|
postgres/governance
Package governance is the PostgreSQL repository of the governance context: the audit log, change requests, webhook subscriptions with their outbox and deliveries, the change stream and stale-flag digests.
|
Package governance is the PostgreSQL repository of the governance context: the audit log, change requests, webhook subscriptions with their outbox and deliveries, the change stream and stale-flag digests. |
|
postgres/identity
Package identity is the PostgreSQL repository of the identity context: auth providers.
|
Package identity is the PostgreSQL repository of the identity context: auth providers. |
|
postgres/projectrow
Package projectrow records, for the life of a transaction, the projects whose row it locked FOR NO KEY UPDATE, the lock every write of a project takes so that the project's writes run one at a time.
|
Package projectrow records, for the life of a transaction, the projects whose row it locked FOR NO KEY UPDATE, the lock every write of a project takes so that the project's writes run one at a time. |
|
postgres/sinks
Package sinks is the PostgreSQL repository of a project's sinks.
|
Package sinks is the PostgreSQL repository of a project's sinks. |
|
postgres/workspace
Package workspace is the PostgreSQL repository of the workspace context: projects, their environments, unit types and attributes.
|
Package workspace is the PostgreSQL repository of the workspace context: projects, their environments, unit types and attributes. |
|
saml
Package saml is the outbound adapter to SAML identity providers: the instance as a service provider, built on gosaml2 and goxmldsig.
|
Package saml is the outbound adapter to SAML identity providers: the instance as a service provider, built on gosaml2 and goxmldsig. |
|
sinks
Package sinks makes the HTTP calls of sinks: the clients each kind of target is called with, guarded by kind, and the reduction of whatever a target answers to a failure class.
|
Package sinks makes the HTTP calls of sinks: the clients each kind of target is called with, guarded by kind, and the reduction of whatever a target answers to a failure class. |
|
testclock
Package testclock is the test-only clock of FLAGNETIC_TEST_CLOCK_FILE: the wall clock moved ahead by the duration a file holds, such as "25h".
|
Package testclock is the test-only clock of FLAGNETIC_TEST_CLOCK_FILE: the wall clock moved ahead by the duration a file holds, such as "25h". |
|
webhook
Package webhook makes the HTTP calls of webhook deliveries.
|
Package webhook makes the HTTP calls of webhook deliveries. |
Click to show internal directories.
Click to hide internal directories.