Documentation
¶
Index ¶
Constants ¶
View Source
const ( VersionMajor = 0 VersionMinor = 11 VersionPatch = 0 VersionReleaseLevel = "beta" VersionReleaseNumber = 14 )
Version component constants for the current build.
Variables ¶
View Source
var GitVersion string
Set the GitVersion via -ldflags="-X 'github.com/rotationalio/ensign/pkg.GitVersion=$(git rev-parse --short HEAD)'"
Functions ¶
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ensign implements the Ensign single node server.
|
Package ensign implements the Ensign single node server. |
|
info
Implements a go routine that collects topic info periodically outside of the broker.
|
Implements a go routine that collects topic info periodically outside of the broker. |
|
mock
Package mock implements an in-memory gRPC mock Ensign server that can be connected to using a bufconn.
|
Package mock implements an in-memory gRPC mock Ensign server that can be connected to using a bufconn. |
|
o11y
Package o11y (a numeronym for "observability") exports server-specific metric collectors to Prometheus for monitoring of the service and Ensign nodes.
|
Package o11y (a numeronym for "observability") exports server-specific metric collectors to Prometheus for monitoring of the service and Ensign nodes. |
|
store
Ensign maintains two separate storage locations on disk: the event store which is intended to be an append-only fast disk write for incoming events and a meta store which is used to persist operational metadata such as topic and placement information.
|
Ensign maintains two separate storage locations on disk: the event store which is intended to be an append-only fast disk write for incoming events and a meta store which is used to persist operational metadata such as topic and placement information. |
|
store/errors
Package errors implements standard database read/write errors for the store package.
|
Package errors implements standard database read/write errors for the store package. |
|
topics
Package topics provides some helpers for managing topics in memory.
|
Package topics provides some helpers for managing topics in memory. |
|
authtest
Package authtest provides helper functionality for testing authentication with Quarterdeck as simply as possible.
|
Package authtest provides helper functionality for testing authentication with Quarterdeck as simply as possible. |
|
db
Package db establishes a connection with a Raft replicated sqlite3 database.
|
Package db establishes a connection with a Raft replicated sqlite3 database. |
|
keygen
Package keygen provides functionality for generating API client IDs and secrets.
|
Package keygen provides functionality for generating API client IDs and secrets. |
|
Uptime is a small, lightweight service that tracks the status of Rotational services and watches for outages.
|
Uptime is a small, lightweight service that tracks the status of Rotational services and watches for outages. |
|
health
Package health implements health check clients to return server system statuses.
|
Package health implements health check clients to return server system statuses. |
|
services
Package services provides an Info and Service data structure that is used for two purposes: loading configuration information from disk and storing status information in the database.
|
Package services provides an Info and Service data structure that is used for two purposes: loading configuration information from disk and storing status information in the database. |
|
utils
|
|
|
keymu
Package keymu provides a map of mutexes that allows users to lock and unlock single keys in the data structure.
|
Package keymu provides a map of mutexes that allows users to lock and unlock single keys in the data structure. |
|
metrics
metrics tracks request behavior inside tenant (which manages Ensign user accounts, projects, and topics) and quarterdeck (which manages authentication and authorization)
|
metrics tracks request behavior inside tenant (which manages Ensign user accounts, projects, and topics) and quarterdeck (which manages authentication and authorization) |
|
mtls
Package mtls has helper functionality for organizing and maintaining key material on disk and establishing connections between servers and clients using mTLS cryptography.
|
Package mtls has helper functionality for organizing and maintaining key material on disk and establishing connections between servers and clients using mTLS cryptography. |
|
probez
Package probez provides a simple http server that implements Kubernetes readiness probes (e.g.
|
Package probez provides a simple http server that implements Kubernetes readiness probes (e.g. |
|
service
Package service unifies how our HTTP services run to deduplicate code between different microservices.
|
Package service unifies how our HTTP services run to deduplicate code between different microservices. |
|
sqlite
Package sqlite implements a connect hook around the sqlite3 driver so that the underlying connection can be fetched from the driver for more advanced operations such as backups.
|
Package sqlite implements a connect hook around the sqlite3 driver so that the underlying connection can be fetched from the driver for more advanced operations such as backups. |
|
tasks
Package tasks provides functionality for services to run a fixed number of workers to conduct generic asynchronous tasks.
|
Package tasks provides functionality for services to run a fixed number of workers to conduct generic asynchronous tasks. |
|
tlstest
This file ported from net/http/internal/testcert/testcert.go
|
This file ported from net/http/internal/testcert/testcert.go |
|
ulids
Package ulid is a lightweight wrapper around the github.com/oklog/ulid package that provides some common functionality (like checking if a ULID is null or is zero) as well as a process-global, cryptographically random, monotonic, and thread-safe ulid generation mechanism that can be used from external packages.
|
Package ulid is a lightweight wrapper around the github.com/oklog/ulid package that provides some common functionality (like checking if a ULID is null or is zero) as well as a process-global, cryptographically random, monotonic, and thread-safe ulid generation mechanism that can be used from external packages. |
Click to show internal directories.
Click to hide internal directories.