Self-hosted clone of https://github.com/openova-io/openova (post-cutover, standalone)
Go to file
hatiyildiz 3b7610d5d9 feat(provisioner): parentDomains[] data model + per-domain abstraction (#826)
Sub-1 of epic #825 (Multi-domain Sovereign). Backend-only per the
SCOPE CORRECTION on issue #826: the wizard stays single-FQDN, multi-
domain capability is a Day-2 admin-console action (#829, already
merged with an in-memory stub waiting on this PR's persistence
layer).

What this PR adds:

  - provisioner.ParentDomain struct (Name, Role, RegistrarKind,
    RegistrarCredsRef, AddedAt) with role constants
    ParentDomainRolePrimary | ParentDomainRoleSMEPool. Wire shape
    matches the handler-layer ParentDomain in
    handler/parent_domains.go (#829), so the handler's swap from
    in-memory store → Deployment.parentDomains[] is a one-line
    change in a follow-up PR.
  - Request.ParentDomains []ParentDomain field. Backward-compatible:
    when the slice is empty, Validate() synthesises a single primary
    entry from SovereignPoolDomain (or SovereignFQDN) so legacy
    single-FQDN payloads + on-disk records read cleanly. The next
    Save() round-trips the array form — transparent migration with
    no one-shot script.
  - validateParentDomains: enforces "exactly one primary", role enum,
    FQDN regex (RFC 1035, mirrors wizard isValidDomain), duplicate-
    name dedupe, lowercase normalisation in place.
  - ProvisionParentDomain / ProvisionParentDomains: the per-domain
    abstraction the issue's DoD calls out as "reusable function ready
    for #829". Day-2 add-domain calls this with the same step list
    (registrar-flip → powerdns-zone-create → cert-manager-cert) the
    Day-1 path uses; idempotent, stops on first error, emits per-step
    SSE events for the admin panel.
  - Request.PrimaryParentDomain() / SMEPoolParentDomains() lookup
    helpers so the catalyst-api handler + SME signup wizard read the
    primary / sme-pool subset without re-iterating at every call site.
  - writeTfvars emits parent_domains as a JSON array (never null) so
    a future OpenTofu module's `for pd in var.parent_domains`
    validator accepts the input — same nil-trap fix the regions slice
    already carries.
  - store.RedactedRequest + ToProvisionerRequest round-trip the slice
    verbatim. Fields are non-secret (RegistrarCredsRef points at a
    SealedSecret name; plaintext registrar credentials never live on
    the deployment record).
  - store.crdStore mirrors the slice into the ProvisioningState CRD
    spec so admin tooling reading via the K8s API sees the live pool.

What this PR does NOT touch (explicit scope):

  - products/catalyst/bootstrap/ui/src/pages/wizard/** — wizard UI
    stays single-FQDN per the issue's SCOPE CORRECTION.
  - products/catalyst/bootstrap/api/internal/handler/parent_domains.go
    — the #829-merged Day-2 admin handler keeps its in-memory store;
    a one-line follow-up PR swaps to Deployment.parentDomains[].

Inviolable Principle #4: defaultRegistrarKindFromEnv reads
CATALYST_DEFAULT_REGISTRAR_KIND so operators on registrars other
than Dynadot override the synthesis path without code changes. No
TLD or count is hardcoded.

Tests:

  - 14 new unit tests across two new files (parent_domains_test.go in
    provisioner + store packages). Cover: synthesis from
    SovereignFQDN + SovereignPoolDomain, "exactly one primary"
    invariant (rejects 2 + 0), unknown role, empty role, malformed
    FQDN, duplicate names, uppercase normalisation, lookup helpers,
    step-runner ordering + first-error halt, slice-flavour
    multi-domain iteration, JSON round-trip through Redact + Save +
    LoadAll, empty-slice omitempty, legacy on-disk record loads
    cleanly + migration synthesises primary on Validate.
  - Pre-existing Harbor-token + AuthHandover-signer-nil failures
    persist on origin/main; this PR introduces no new failures.

Closes #826.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-04 21:33:51 +02:00
.claude docs(iter-1): add IMPLEMENTATION-STATUS, fix wrong-org refs, reconcile monorepo 2026-04-27 20:43:31 +02:00
.github feat(e2e): SME demo Playwright spec — full 6-step happy path (#805) (#823) 2026-05-04 22:52:07 +04:00
.playwright-mcp feat(wizard): job dependencies SVG DAG + (stretch) timeline view (closes #206) (#212) 2026-04-29 21:40:43 +02:00
clusters feat(bp-newapi): chart maturation + first-otech deploy + Qwen vLLM channel (#799) (#812) 2026-05-04 22:17:25 +04:00
core fix(services): go mod tidy across sibling services after #798 shared deps bump (#821) 2026-05-04 22:35:46 +04:00
docs docs(adr): ADR-0003 RBAC ↔ NewAPI user-create hook contract (#796) (#807) 2026-05-04 21:33:12 +04:00
infra/hetzner fix(provisioner+observer): document cpx21 availability + kubectl retry/LKG (closes #752, #753) (#756) 2026-05-04 17:11:44 +04:00
platform fix(bp-gitea): ship gitea-admin-secret with random password (#830) (#832) 2026-05-04 23:26:55 +04:00
products feat(provisioner): parentDomains[] data model + per-domain abstraction (#826) 2026-05-04 21:33:51 +02:00
scripts feat(bp-newapi): chart maturation + first-otech deploy + Qwen vLLM channel (#799) (#812) 2026-05-04 22:17:25 +04:00
tests feat(phase-8b): sovereign wizard auth-gate + handover JWT minting + Playwright CI fixes (#611) 2026-05-02 19:17:56 +04:00
.gitignore fix(bp-seaweedfs): vendor upstream chart, drop fromToml-using template (#340) (#504) 2026-05-02 01:20:59 +04:00
CLAUDE.md docs(component-count): update 53 → 56 anchors after Pass 105 (spire + nats-jetstream + sealed-secrets) 2026-04-28 13:48:24 +02:00
README.md docs(reconcile-pass-2): align docs with ground truth at 6afdb303 2026-04-29 11:48:57 +02:00

OpenOva Catalyst

A self-sufficient Kubernetes-native platform. Published as signed OCI Blueprints. Deployable as your own Sovereign.

Catalyst is the open-source platform built by OpenOva. It turns any Kubernetes cluster into a Sovereign: a self-contained control plane that hosts Organizations, Environments, and Applications via GitOps + Crossplane, with a unified UI/Git/API for users.


Documentation

Document What it covers
docs/GLOSSARY.md Canonical terminology — read first
docs/ARCHITECTURE.md Catalyst architecture overview
docs/IMPLEMENTATION-STATUS.md What's built today vs what's design-only — read second
docs/NAMING-CONVENTION.md Naming patterns for every resource type
docs/PERSONAS-AND-JOURNEYS.md Personas × journeys matrix; surfaces
docs/SECURITY.md Identity (SPIFFE + Keycloak), secrets (OpenBao + ESO), rotation, multi-region semantics
docs/SOVEREIGN-PROVISIONING.md How to bring a Sovereign online
docs/BLUEPRINT-AUTHORING.md Writing Blueprints (incl. Crossplane Compositions)
docs/PLATFORM-TECH-STACK.md Every component's role in Catalyst
docs/SRE.md Operating a Sovereign
docs/BUSINESS-STRATEGY.md Product strategy and GTM
docs/TECHNOLOGY-FORECAST-2027-2030.md Component forecast 20272030
docs/VALIDATION-LOG.md Trail of doc-integrity validation passes (audit log)

Heads-up before reading further: the architecture docs in this repo describe Catalyst's target state. Significant portions are not yet implemented — see docs/IMPLEMENTATION-STATUS.md for what exists today vs what is design.


The model in 60 seconds

OpenOva (the company) publishes Catalyst (the platform).
A deployed Catalyst is called a Sovereign.

A Sovereign has:
  - Organizations (multi-tenancy unit)
  - Environments (org-scoped, env-typed: prod/stg/uat/dev/poc)
  - Applications (installed Blueprints)
  - Blueprints (the App Store catalog — public + Org-private)

Users install Applications from Blueprints into Environments.
Blueprints can depend on Blueprints (arbitrary depth).
Each Environment is one Gitea repo + one or more vclusters.
Every state change is a Git commit.
Every UI surface reads from a single CQRS projection.

Same code runs in every Sovereign:
  - openova         (run by us; SaaS Organizations)
  - omantel         (run by Omantel; SME Organizations across Oman)
  - bankdhofar      (run by the bank; internal Organizations)
  - your-company    (run by you, on infrastructure you choose)

See docs/GLOSSARY.md for every term, docs/ARCHITECTURE.md for the full picture.


What's in this repo

openova/
├── core/              # Catalyst control-plane application (Go) — design-stage; mostly placeholders today
├── platform/          # Component Blueprint folders (one folder per upstream OSS project)
├── products/          # Composite Blueprint folders OpenOva publishes
│   ├── catalyst/      # The Catalyst control plane itself, target umbrella Blueprint
│   ├── cortex/        # AI Hub (LLM serving, RAG, AI safety)
│   ├── axon/          # SaaS LLM Gateway (default upstream for Cortex)
│   ├── fingate/       # Open Banking (PSD2/FAPI sandbox)
│   ├── fabric/        # Data & Integration (event-driven + lakehouse)
│   └── relay/         # Communication (email, video, chat, WebRTC)
│                      # (specter and exodus are deliverable services, not Blueprints in this layout)
└── docs/              # Platform documentation

Each folder under platform/ and products/ is the source of one Blueprint, published from CI as a signed OCI artifact at ghcr.io/openova-io/bp-<name>:<semver> (the bp- prefix is added to the OCI artifact name; folder names stay short). Per-folder isolation is provided at the OCI artifact layer, not the Git repo layer — this is a monorepo with per-Blueprint fan-out, not a meta-repo of separate Git repositories. See docs/BLUEPRINT-AUTHORING.md §2 for the folder layout contract.

Today, the 12-component bootstrap kit (cilium, cert-manager, flux, crossplane, sealed-secrets, spire, nats-jetstream, openbao, keycloak, gitea, powerdns + the bp-catalyst-platform umbrella under products/catalyst/) ships with full chart/ + blueprint.yaml per docs/IMPLEMENTATION-STATUS.md §7, plus products/axon/ and the external-dns leaf chart. The remaining 45 platform components and the cortex / fabric / fingate / relay product folders are design-stage — README only — until each lands its Blueprint manifest, chart, Compositions, and CI fan-out.


Stack at a glance

Layer Technology
Container runtime k3s (k8s-conformant), containerd
CNI / Service Mesh Cilium (eBPF mTLS, L7 policies, Gateway API)
GitOps Flux (per-vcluster, lightweight)
Git Gitea (per-Sovereign, hosts Blueprint mirror + per-Environment repos)
IaC for non-K8s Crossplane (the only IaC; not user-facing)
Bootstrap IaC OpenTofu (one-shot, archived after Phase 0)
Multi-tenancy vcluster (one per Organization per host cluster)
Identity (workloads) SPIFFE/SPIRE (5-min rotating SVIDs, mTLS everywhere)
Identity (users) Keycloak (per-Org for SME, per-Sovereign for corporate)
Secrets OpenBao (Apache 2.0; independent Raft per region, no stretched cluster) + External Secrets Operator
Event spine NATS JetStream (Apache 2.0; pub/sub + KV; per-Org accounts)
TLS cert-manager + Let's Encrypt or corporate CA
Policy Kyverno
Supply chain cosign (Sigstore), Syft + Grype SBOM, Trivy scans
Runtime security Falco (eBPF)
Observability OpenTelemetry → Grafana stack (Alloy + Loki + Mimir + Tempo)
WAF Coraza (OWASP CRS)
DNS PowerDNS authoritative per Sovereign zone + DNSSEC + lua-records (ifurlup, pickclosest); pool-domain-manager allocates pool subdomains and flips parent-zone NS via registrar adapters (Cloudflare / Namecheap / GoDaddy / OVH / Dynadot) — see docs/MULTI-REGION-DNS.md, docs/PLATFORM-POWERDNS.md
Backup Velero (to SeaweedFS, which routes the cold tier to cloud archival S3)
Container registry Harbor

For the full component list and trends see docs/PLATFORM-TECH-STACK.md and docs/TECHNOLOGY-FORECAST-2027-2030.md.


Cloud providers

Provider Status
Hetzner Cloud Available (most-tested path)
AWS / GCP / Azure Crossplane providers available; full path coming
Oracle Cloud (OCI) Crossplane provider available; full path coming
Huawei Cloud Crossplane provider available; full path coming

All providers reach Catalyst via the same Crossplane abstraction; Sovereign provisioning details per provider are in docs/SOVEREIGN-PROVISIONING.md.


Getting started

Try it (managed)

Visit marketplace.openova.io to install Applications on the openova Sovereign without any infrastructure setup. SaaS journey for SMEs and evaluations.

Run your own Sovereign

1. Provision via catalyst-provisioner.openova.io (managed bootstrap), OR
2. Self-host bp-catalyst-provisioner in your own infrastructure (air-gap path).

Then follow the procedure in docs/SOVEREIGN-PROVISIONING.md.

Build a Blueprint

See docs/BLUEPRINT-AUTHORING.md. A Blueprint is a folder under platform/<name>/ (or products/<name>/) in this monorepo containing blueprint.yaml + manifests (Helm chart or Kustomize base) + (optional) Crossplane Compositions. CI signs each folder's contents and publishes to OCI as ghcr.io/openova-io/bp-<name>:<semver>. Catalyst's blueprint-controller picks it up automatically. Org-private Blueprints follow the same shape inside per-Sovereign Gitea repos.


License

All Blueprints and the Catalyst control plane are open source. Each component carries its own upstream license (typically Apache 2.0, MPL 2.0, or BSD-3); see each component's LICENSE file.

OpenOva charges for support, managed operations, and expert services — never for access to code. See docs/BUSINESS-STRATEGY.md §10.


Contributing

PRs welcome. The contribution path for Blueprints (including Crossplane Compositions) is documented in docs/BLUEPRINT-AUTHORING.md §13. Issues and discussions on GitHub.


Cloud-native is the foundation. Catalyst is how you operate it.