Files
cairnobs/enterprise/internal/apiconfig/apiconfig.go
T
jcoffey-dev c920e0f2c4 Finish the Cairn OBS rename through services, docs, and assets
The rename commit before this one covered module paths and the obvious
user-facing strings; this is the rest of it -- the places where "sentry"
was a default value, a filename, or a picture rather than a word in a
sentence.

Defaults that changed: CLICKHOUSE_DATABASE (sentry -> cairnobs),
POSTGRES_DATABASE (sentry_metadata -> cairnobs_metadata), and
POSTGRES_USERNAME (sentry -> cairnobs), across api/alerting/ingest and
the enterprise binaries, plus the compose files and migrate scripts that
create those objects. These are *defaults*, so a deployment that sets
them explicitly is unaffected -- but any deployment relying on the old
defaults must have its environment updated before it picks this up, or
it will come up pointing at a database that doesn't exist.

Also: the light-mode logo variants (the dark ones existed alone, so the
landing page and sidebar rendered a dark mark on a light background),
regenerated favicons, and the docs/README/threat-model prose that still
said Sentry.
2026-08-22 16:12:08 -07:00

162 lines
6.3 KiB
Go

// Package apiconfig loads enterprise-api's configuration from
// environment variables -- same convention as every other Go service in
// this repo. Named apiconfig, not config, to avoid colliding with the
// already-existing enterprise/internal/config (enterprise-auth's own,
// differently-shaped config) within the same module.
package apiconfig
import (
"fmt"
"os"
"strconv"
"time"
)
type Config struct {
HTTPListenAddr string
// ClickHouseAddr is the shared physical ClickHouse server's native
// address -- every tenant's connection (chrunner.Registry) and the
// admin connection (tenantprovision) both dial this same address,
// just with different credentials. Tenants sharing one physical
// server is today's model; per-tenant dedicated cluster nodes is
// named as later, non-schema-changing work in
// /docs/phase-4-isolation-design.md.
ClickHouseAddr string
// ClickHouseAdmin is the access_management-enabled credential
// tenantprovision uses for CREATE DATABASE/USER/GRANT -- the same
// credential api's plain (non-enterprise) binary uses as its one
// shared connection today (docker-compose.yml's CLICKHOUSE_PASSWORD).
// Never used to run a tenant's actual queries.
ClickHouseAdmin ClickHouseAdminConfig
Postgres PostgresConfig
AuditWriter AuditWriterConfig
SearchGRPCAddr string
QueryTimeout time.Duration
CORSAllowedOrigin string
// EnterpriseAuthURL, like api's own config, is optional -- see that
// package's doc comment on the nil-authorizer no-op default. In
// practice a real enterprise-api deployment always sets this (there
// is no reason to run this binary instead of plain api without RBAC
// enforcement on), but nothing here hard-requires it, for the same
// "never break a simpler deployment shape" reasoning used
// throughout this codebase.
EnterpriseAuthURL string
// TenantCRDNamespace enables enterprise/internal/tenantcrd syncing
// for -provision-tenant (cmd/enterprise-api/main.go's
// runProvisionTenant) -- empty (the default) means skip it entirely,
// same "off unless configured" shape as EnterpriseAuthURL above.
// Deployments with no Kubernetes cluster at all (docker-compose)
// never set this.
TenantCRDNamespace string
// AI gates Phase 7's AI-assisted query features, same shape and same
// env var names as api/internal/config.AIConfig -- duplicated rather
// than imported (that package is under api/internal/, which Go's
// internal/ visibility rule blocks a separate module like this one
// from importing at all, the same constraint that already moved
// querylang/executor and dashboards out of internal/ in earlier
// phases) -- matches this file's own existing pattern of
// independently defining every field even where it overlaps with
// api/internal/config's (Postgres, SearchGRPCAddr, and so on), not a
// new inconsistency introduced here.
AI AIConfig
}
type AIConfig struct {
OllamaBaseURL string
OllamaModel string
OllamaFastModel string
}
type ClickHouseAdminConfig struct {
Username string
Password string
}
type PostgresConfig struct {
Addr string
Database string
Username string
Password string
}
// AuditWriterConfig is the separate, narrowly-granted credential
// enterprise/internal/audit.Store requires -- see that package's doc
// comment on why it must never share api's/dashboards' pool.
type AuditWriterConfig struct {
Username string
Password string
}
// devOnlyCredential/devOnlyAuditWriterCredential are docker-compose.yml's
// zero-config defaults -- see api/internal/config.Config.
// DevCredentialWarnings for the full reasoning (duplicated here per
// this repo's no-shared-code-between-services convention).
const (
devOnlyCredential = "cairnobs-dev-only"
devOnlyAuditWriterCredential = "audit-writer-dev-only"
)
// DevCredentialWarnings reports which configured credentials still
// equal their literal dev-only defaults -- cmd/enterprise-api/main.go
// logs each one loudly at startup. A warning, not a startup-refusing
// error: local dev's zero-config docker-compose.yml path legitimately
// leaves these at their default values.
func (c Config) DevCredentialWarnings() []string {
var warnings []string
if c.ClickHouseAdmin.Password == devOnlyCredential {
warnings = append(warnings, "CLICKHOUSE_ADMIN_PASSWORD is still the default dev-only value -- set a real password before this is reachable outside local dev")
}
if c.Postgres.Password == devOnlyCredential {
warnings = append(warnings, "POSTGRES_PASSWORD is still the default dev-only value -- set a real password before this is reachable outside local dev")
}
if c.AuditWriter.Password == devOnlyAuditWriterCredential {
warnings = append(warnings, "AUDIT_WRITER_PASSWORD is still the default dev-only value -- set a real password before this is reachable outside local dev")
}
return warnings
}
func Load() (Config, error) {
cfg := Config{
HTTPListenAddr: getenv("HTTP_LISTEN_ADDR", ":8083"),
ClickHouseAddr: getenv("CLICKHOUSE_ADDR", "localhost:9000"),
ClickHouseAdmin: ClickHouseAdminConfig{
Username: getenv("CLICKHOUSE_ADMIN_USERNAME", "default"),
Password: getenv("CLICKHOUSE_ADMIN_PASSWORD", ""),
},
Postgres: PostgresConfig{
Addr: getenv("POSTGRES_ADDR", "localhost:5432"),
Database: getenv("POSTGRES_DATABASE", "cairnobs_metadata"),
Username: getenv("POSTGRES_USERNAME", "cairnobs"),
Password: getenv("POSTGRES_PASSWORD", ""),
},
AI: AIConfig{
OllamaBaseURL: getenv("OLLAMA_BASE_URL", ""),
OllamaModel: getenv("OLLAMA_MODEL", "qwen2.5-coder:7b"),
OllamaFastModel: getenv("OLLAMA_FAST_MODEL", "qwen2.5-coder:1.5b"),
},
AuditWriter: AuditWriterConfig{
Username: getenv("AUDIT_WRITER_USERNAME", "audit_writer"),
Password: getenv("AUDIT_WRITER_PASSWORD", ""),
},
SearchGRPCAddr: getenv("SEARCH_GRPC_ADDR", "localhost:50052"),
CORSAllowedOrigin: getenv("CORS_ALLOWED_ORIGIN", "*"),
EnterpriseAuthURL: getenv("ENTERPRISE_AUTH_URL", ""),
TenantCRDNamespace: getenv("TENANT_CRD_NAMESPACE", ""),
}
timeoutSec, err := strconv.Atoi(getenv("QUERY_TIMEOUT_SECONDS", "30"))
if err != nil {
return Config{}, fmt.Errorf("QUERY_TIMEOUT_SECONDS: %w", err)
}
cfg.QueryTimeout = time.Duration(timeoutSec) * time.Second
return cfg, nil
}
func getenv(key, fallback string) string {
if v := os.Getenv(key); v != "" {
return v
}
return fallback
}