README
¶
Packages · Stack Integration · Docs
Bluebottle: the shared library for the Mulga stack
Bluebottle holds the cross-cutting Go packages that Spinifex, Predastore, Viperblock and Northstar all need, so that they do not depend on another service repo to get them.
Packages
| Package | Purpose |
|---|---|
pkg/auth |
ARN parsing and formatting |
pkg/fipsboot |
FIPS 140-3 startup enforcement via blank import |
pkg/iampolicy |
IAM policy types, matching and evaluation |
pkg/masterkey |
Master key loading, derivation and AEAD encryption |
pkg/otelsetup |
OpenTelemetry tracer/meter/logger bootstrap, slog bridge, HTTP instrumentation, log sanitisation |
pkg/ratelimit |
Token bucket rate limiting and its configuration |
pkg/safecast |
Range-checked integer conversions |
pkg/sigv4 |
AWS SigV4 parsing, verification and URI canonicalisation |
pkg/tlsconfig |
Cluster-wide TLS 1.3 curve allowlist |
Stack Integration
Bluebottle sits below every service in the Mulga stack and depends on none of them.
| Repository | What it uses |
|---|---|
| Spinifex | All nine packages: SigV4 and IAM for the AWS gateway, master keys for credential storage, telemetry, rate limiting, the TLS curve allowlist, the FIPS guard and the conversion helpers across services |
| Predastore | S3 request signing, IAM policy evaluation, encryption at rest, telemetry, rate limiting, TLS curve allowlist, FIPS guard |
| Viperblock | Master keys for volume encryption, telemetry, FIPS guard, conversion helpers |
| Northstar | Telemetry, FIPS guard |
Trademarks
Amazon Web Services, AWS, Amazon S3 and AWS IAM are trademarks of Amazon.com, Inc. or its affiliates. Bluebottle is not affiliated with or endorsed by Amazon Web Services.
License
Bluebottle is licensed under the GNU Affero General Public License v3.0 (AGPLv3) license.
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
fipsboot
Package fipsboot enforces FIPS 140-3 at startup via blank import in every binary.
|
Package fipsboot enforces FIPS 140-3 at startup via blank import in every binary. |
|
iampolicy
Package iampolicy holds the canonical IAM policy-document DTOs and the explicit-deny-wins access evaluator shared by predastore and spinifex.
|
Package iampolicy holds the canonical IAM policy-document DTOs and the explicit-deny-wins access evaluator shared by predastore and spinifex. |
|
masterkey
Package masterkey loads the cluster master key from disk and turns it into an AES-256-GCM cipher.AEAD used to seal and open shard fragments at rest.
|
Package masterkey loads the cluster master key from disk and turns it into an AES-256-GCM cipher.AEAD used to seal and open shard fragments at rest. |
|
otelsetup
Package otelsetup configures OpenTelemetry tracing, metrics and logging for Mulga services.
|
Package otelsetup configures OpenTelemetry tracing, metrics and logging for Mulga services. |
|
safecast
Package safecast holds range-checked integer conversions that clamp rather than wrap, so a value that does not fit the target type saturates at its bound instead of silently becoming a small or negative number.
|
Package safecast holds range-checked integer conversions that clamp rather than wrap, so a value that does not fit the target type saturates at its bound instead of silently becoming a small or negative number. |
|
tlsconfig
Package tlsconfig pins the cluster-wide TLS 1.3 curve preference list.
|
Package tlsconfig pins the cluster-wide TLS 1.3 curve preference list. |
Click to show internal directories.
Click to hide internal directories.