jcoffey-dev
13cf9a30cb
Full rebrand across cosmetic branding, code identifiers, and infrastructure/data-plane naming, using the supplied Cairn OBS logo package. Cosmetic: favicon/logo swap (also closes a stale license-audit finding -- the old favicon was SvelteKit's unreplaced scaffold logo), new centered welcome landing page, larger/legible sidebar logo, page titles, CLAUDE.md/README/docs prose. Code identifiers: Go module path github.com/sentry/sentry -> github.com/cairnobs/cairnobs across all 13 modules and ~91 files (protoc regenerated); Rust crates sentry-agent/sentry-parser/sentry-search -> cairnobs-*; CLI sentryctl -> cairnobsctl; Terraform provider fully renamed (sentry_dashboard etc. -> cairnobs_dashboard, provider type, env vars); every session/auth cookie name; agent config paths and Windows service identity. Deliberately preserved: the gRPC wire protocol's protobuf packages (sentry.logs.v1, sentry.agent.v1) and their Go import directory (proto/sentry/...) -- renaming the wire-level package would break every currently-deployed agent binary (confirmed two real hosts, including mail.inbuxa.com, are actively streaming through this exact contract) until rebuilt and redeployed in lockstep with an ingest cutover. Only the Go module path wrapping the generated code changes. Infrastructure: every docker-compose container name (root and three component-level compose files); the Helm chart (directory, Chart.yaml, named-template helpers, all templates, values.yaml image repos); Kubernetes Operator (CRD group sentry.io -> cairnobs.io, both CRD YAML files, Go identifiers, RBAC markers); the coupled enterprise/tenantcrd package. Caught and fixed real path-coupling bugs along the way: the Helm chart's search/ingest volume mounts and the dev-only-credential detection constant vs. docker-compose.yml's literal values had to move together or a security warning would have silently stopped firing. Data plane: Postgres database sentry_metadata -> cairnobs_metadata and role sentry -> cairnobs; ClickHouse database sentry -> cairnobs; Kafka topic sentry.logs.raw -> cairnobs.logs.raw and its consumer groups. Source-level defaults, docker-compose.yml, and every migrate.sh/ provision script default updated together; already-applied migration files left untouched per this repo's immutable-migration convention. Verified at every layer: all 13 Go modules build/vet/test clean, both Rust workspaces (agent, search) build/clippy/test clean, npm run check/ build clean, docker compose config validates on all four compose files. Live-verified against a real docker stack multiple times through this work, including a final fresh-volume run confirming the actual renamed Postgres database/role, ClickHouse database, and Kafka topic all work end to end with a real login and query, zero console errors.
82 lines
3.1 KiB
Markdown
82 lines
3.1 KiB
Markdown
# deploy/operator
|
|
|
|
A small `controller-runtime` Operator managing one CRD: `Tenant`
|
|
(`cairnobs.io/v1alpha1`). See `internal/controller/tenant_controller.go`'s
|
|
doc comment for exactly what it reconciles and -- just as importantly --
|
|
what it deliberately doesn't (no ClickHouse calls, no Tantivy filesystem
|
|
access, no `enterprise/internal/rbacstore` wiring; those are
|
|
`enterprise/internal/tenantprovision`, still unbuilt).
|
|
|
|
## Not kubebuilder-scaffolded
|
|
|
|
No `kubebuilder`/`controller-gen` binary was available in this
|
|
environment, so this package is hand-written rather than generated:
|
|
|
|
- `api/v1alpha1/zz_generated.deepcopy.go` -- normally `controller-gen
|
|
object` output; hand-written here, covered by
|
|
`api/v1alpha1/api_test.go`'s round-trip tests (mutate a copy, assert
|
|
the original is untouched -- exactly the class of bug a hand-written
|
|
`DeepCopy` is prone to).
|
|
- `config/crd/cairnobs.io_tenants.yaml` -- normally `controller-gen crd`
|
|
output from the `+kubebuilder:validation:*` markers on
|
|
`api/v1alpha1/tenant_types.go`; hand-written here and only as strong as
|
|
keeping the two in sync by hand. Validated by strict-unmarshaling it
|
|
into the real `k8s.io/apiextensions-apiserver` Go type (see
|
|
`/deploy/README.md`'s verification section) -- catches YAML/structural
|
|
mistakes, not a drift between the CRD's field *descriptions* and the
|
|
Go doc comments.
|
|
- `+kubebuilder:rbac` markers on `internal/controller/tenant_controller.go`
|
|
are present as documentation/intent (matching kubebuilder convention)
|
|
but were never run through `controller-gen rbac` -- the actual
|
|
ClusterRole is hand-written in
|
|
`/deploy/helm/cairnobs/templates/tenant-operator.yaml`, kept in sync with
|
|
those markers by hand, same caveat as the CRD above.
|
|
|
|
## Layout
|
|
|
|
```
|
|
api/v1alpha1/ Tenant, TenantSpec, TenantStatus -- the CRD's Go types
|
|
internal/controller/ TenantReconciler -- see its doc comment
|
|
cmd/tenant-operator/ main.go -- manager setup, matches every other
|
|
service's cmd/<name>/main.go convention in this repo
|
|
config/crd/ hand-written CRD YAML (see above)
|
|
```
|
|
|
|
## Building & testing
|
|
|
|
```sh
|
|
go build ./...
|
|
go vet ./...
|
|
go test ./...
|
|
```
|
|
|
|
Tests use `sigs.k8s.io/controller-runtime/pkg/client/fake`, not
|
|
`envtest` -- `envtest` needs a real `kube-apiserver`/`etcd` binary pair
|
|
(`setup-envtest`) not available in this environment. The fake client
|
|
exercises real reconcile logic (object CRUD, owner references, status
|
|
writes) but not anything a real apiserver does for you (admission,
|
|
garbage collection, watch-triggered re-reconciliation) -- see
|
|
`internal/controller/tenant_controller_test.go`'s doc comment.
|
|
|
|
```sh
|
|
docker build -f Dockerfile -t cairnobs-tenant-operator . # context is deploy/operator/, not the repo root
|
|
```
|
|
|
|
Not verified in this session -- see `/deploy/README.md`.
|
|
|
|
## Trying it against a real cluster
|
|
|
|
```sh
|
|
kubectl apply -f config/crd/cairnobs.io_tenants.yaml
|
|
kubectl apply -f - <<'EOF'
|
|
apiVersion: cairnobs.io/v1alpha1
|
|
kind: Tenant
|
|
metadata:
|
|
name: acme
|
|
spec:
|
|
displayName: "Acme Corp"
|
|
EOF
|
|
kubectl get tenant acme -o yaml # status.phase should reach Active
|
|
kubectl get secret cairnobs-tenant-acme-clickhouse -o yaml
|
|
```
|