Closes a gap named across CLAUDE.md/docs/architecture.md/deploy/README.md
since early Phase 4: the operator's Tenant CRD and -provision-tenant
were two disconnected mechanisms. The operator's reconciler generated a
K8s Secret with a locally-generated random password that authenticated
against nothing (nothing ever called ClickHouse to create a matching
user), and unconditionally claimed status.phase=Active the moment a
Tenant object existed -- actively misleading, not just incomplete.
Two unification shapes were considered (surfaced to the user via
AskUserQuestion, given the real difference in blast radius): the
operator's reconcile loop becoming a second real actor (new Postgres +
ClickHouse admin credentials flowing into the K8s controller, plus real
reconcile-loop idempotency/retry design for an inherently one-shot
external side effect), or keeping -provision-tenant as the sole real
actor and having it also sync its result into the CRD. Went with the
lighter option.
enterprise/internal/tenantcrd (new): a Syncer using the K8s dynamic
client (unstructured.Unstructured + a GroupVersionResource, not
deploy/operator's typed Tenant struct -- avoids a cross-module Go
dependency between two independently-versioned modules for one type).
Upserts the Tenant object, creates/updates a Secret with the *real*
ClickHouse credentials owned by that Tenant via an OwnerReference, then
patches status.{clickHouseDatabaseName,clickHouseSecretRef,
tantivyIndexPath}. Idempotent and safe to retry: never rotates a
credential across a re-sync, never overwrites a pre-existing
spec.displayName a human/GitOps process set.
cmd/enterprise-api/main.go's runProvisionTenant calls Sync when
TENANT_CRD_NAMESPACE is set (empty = no-op, same shape as every other
optional dependency in this codebase). Its "already active" refusal is
now split: ClickHouse re-provisioning is still refused (rotating a live
credential would break every open connection for no benefit), but CR
sync alone is now retryable using the credentials already on file in
rbacstore -- needed for retrying a previously-failed sync, or
backfilling CR sync for a tenant provisioned before this existed.
deploy/operator's reconciler rewritten to match: it never claims
PhaseActive on its own initiative anymore, only once
status.ClickHouseDatabaseName is non-empty (the field -provision-tenant,
and only -provision-tenant, sets). Phase is now a pure function of
{spec.suspended, status.ClickHouseDatabaseName != ""} recomputed every
reconcile, not toggled in place -- fixes a related bug the old code
would have hit once suspension was involved: un-suspending an
already-provisioned tenant needs to return straight to Active, which
isn't derivable from "last observed phase was Suspended" alone. The
reconciler no longer creates or manages any Secret, dropped its
`secrets` RBAC grant entirely, and gained zero new dependencies.
Helm chart: enterprise-api gets its own ServiceAccount/Role/RoleBinding
(get/list/create tenants, get/update/patch tenants/status, get/create/
update secrets -- least-privilege, scoped to the release namespace, not
a ClusterRole) and a TENANT_CRD_NAMESPACE env var, both gated on
tenantOperator.enabled. tenant-operator's ClusterRole loses the
secrets grant it no longer needs.
Verified in this environment: enterprise/internal/tenantcrd's tests run
against k8s.io/client-go's fake dynamic + typed clientsets (real client
library, fake transport, no cluster needed); deploy/operator's rewritten
tenant_controller_test.go runs against controller-runtime's fake
client, including new regression tests for the "must not claim Active
without confirmation" and "un-suspending returns to Active, not
Provisioning" properties; helm template + parsing the rendered YAML
confirms the RBAC split renders exactly as designed under both
tenantOperator.enabled=true/false. Not verified: an actual
-provision-tenant run against a real cluster with the operator watching
(no live cluster in this environment, same disclosed limitation as the
rest of /deploy). Docs updated in lockstep: CLAUDE.md, docs/architecture.md,
deploy/README.md, deploy/helm/sentry/README.md (including a corrected
"Trying the two-tenant example" walkthrough), phase-4-runbook.md (new
§11), enterprise/README.md. Also fixed two unrelated stale claims found
along the way: docs/architecture.md still said docker-compose.yml ran
plain api unconditionally (fixed in an earlier commit, doc not updated
then), and enterprise-api's own main.go doc comment still said Helm/
docker-compose wiring wasn't built yet.
112 lines
3.9 KiB
Go
112 lines
3.9 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
|
|
}
|
|
|
|
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
|
|
}
|
|
|
|
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", "sentry_metadata"),
|
|
Username: getenv("POSTGRES_USERNAME", "sentry"),
|
|
Password: getenv("POSTGRES_PASSWORD", ""),
|
|
},
|
|
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
|
|
}
|