Self-hosted clone of https://github.com/openova-io/openova (post-cutover, standalone)
Go to file
e3mrah bcc5ac66f7
docs: unified design for EPICs 1-6 (Phase 0/1 roll-out — closes #1094 design milestone) (#1102)
* fix(catalyst): chroot cloud list views consume SSE cache (services/ingresses/deployments/statefulsets/daemonsets/namespaces/nodes)

Two stacked bugs blocked 7 cloud list views (TC-066 services, TC-067
ingresses, TC-072 deployments, TC-073 statefulsets, TC-074 daemonsets,
TC-078 namespaces, TC-079 nodes) from rendering live data even though
the architecture graph view showed full counts for the same kinds:

1) The architecture-graph widget opened its OWN useK8sCacheStream
   subscription instead of consuming the page-level snapshot exposed
   on CloudPage's useCloud() context. That meant TWO concurrent
   EventSource connections per page — the chroot's HTTP/1.1
   6-connections-per-origin budget left CloudPage's subscription
   stuck on "connecting" while the graph's stream populated its own
   private snapshot, so chip counts (read off CloudPage's snapshot)
   showed live data only when initialState happened to land before
   the budget tipped, and the K8sListPage instances always read an
   empty CloudPage snapshot.

2) K8sListPage's useMemo for `rows` listed only `[k8sSnapshot, kind,
   sortByName]` as deps. The snapshot Map is mutated IN-PLACE by
   useK8sCacheStream (intentional, to coalesce high-frequency
   bursts into one React render per tick) so its reference is
   stable across deltas — the memo never recomputed past the
   initial empty snapshot. The companion `k8sRevision` counter
   bumps on every applied event; it's the only signal that triggers
   re-derivation when the in-place Map mutates. The previous code
   referenced `k8sRevision` as a `void` no-op "for future memo
   passes" — but the future was now.

Fix:
* ArchitectureGraphPage now accepts optional `k8sSnapshot` +
  `k8sRevision` props. When provided (the production path via
  Architecture.tsx → useCloud()), the widget reads from the shared
  snapshot. When omitted (storybook / direct embed / tests), it
  falls back to opening its own subscription so the widget remains
  self-sufficient.
* Architecture.tsx forwards `k8sSnapshot` + `k8sRevision` from
  useCloud() into the widget — collapsing the two SSE connections
  into one shared page-level subscription.
* K8sListPage adds `k8sRevision` to the rows useMemo deps so the
  list re-derives on every applied delta, with an extended comment
  explaining why the revision is what makes the in-place-mutated
  Map observable.

No behaviour change for the working K8s-backed kinds (configmaps,
secrets, replicasets, endpointslices, persistentvolumes, pods) —
those went through the same path; they only "worked" when the
race happened to favour the CloudPage subscription on a given
session. PVCs/Buckets/Volumes/StorageClasses/etc continue to read
from the topology API and are unaffected.

Closes 7 FAIL rows in the iter-3 Sovereign Console QA matrix.

* docs: unified design for EPICs 1-6 (Phase 0/1 roll-out)

Single canonical reference for the Phase 0/1 plan tracked under #1094:

- Phase 0 (#1095): foundation contracts — 8 CRDs (Organization, Environment,
  Application, Blueprint, EnvironmentPolicy, SecretPolicy, Runbook, Continuum),
  6 controllers (incl. useraccess-controller replacing the broken Crossplane
  Composition path), Keycloak full-CRUD, label vocabulary enforced via Kyverno,
  vCluster scaffold, 3-region multi-cluster substrate (mgmt + 2 data planes
  with Cilium ClusterMesh), and 9 cleanup/bug-fixes (P0).

- Phase 1 — 6 EPICs in parallel:
  * #1096 Compliance — Kyverno policy library + watcher PolicyReport pipeline +
    weighted score aggregator + SRE/SecLead UI.
  * #1097 Applications — Application/Blueprint CRDs realized, application-
    controller, unified catalog-svc, live install + post-launch topology editor.
  * #1098 RBAC — useraccess-controller, Keycloak full mgmt, claims parsing,
    catalog tiers (viewer/dev/op/admin/owner), multi-grant UI.
  * #1099 Cloud Resources — k9s-on-web (drill-down + logs WS + exec + YAML
    editor + events) + Guacamole + projector.
  * #1100 Networking — default-deny CCNP baseline, Hubble UI, OTel Operator,
    Cilium ClusterMesh service routing, DMZ vCluster, NetBird mesh.
  * #1101 Multi-cluster + Continuum — CNPG cluster-pair, Continuum CRD/
    controller (lease + lua-record body synthesizer + switchover), topology UI.

The doc does not invent decisions — it stitches together what is already
locked in INVIOLABLE-PRINCIPLES.md, NAMING-CONVENTION.md, BLUEPRINT-
AUTHORING.md, adr/0001, SRE.md, and MULTI-REGION-DNS.md into one low-level
reference for the dev-loop team (Architect + 1-3 Implementers + Test-Plan
Author + Reviewer + Executor + Fix Authors + Cross-EPIC Coordinator).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Hati Yildiz <hati.yildiz@openova.io>
Co-authored-by: hatiyildiz <hatiyildiz@noreply.openova.io>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-08 21:46:22 +04:00
.claude docs(iter-1): add IMPLEMENTATION-STATUS, fix wrong-org refs, reconcile monorepo 2026-04-27 20:43:31 +02:00
.github fix(chart,ci): auto-bump literal catalyst-{api,ui} SHAs — Sovereigns + contabo were frozen at :2122fb8 (#1060) 2026-05-06 21:10:31 +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 fix(provisioner): map wizard's three-mode domain selector to tofu's binary pool/byo enum (#1069) 2026-05-07 11:26:50 +04:00
core fix(provisioning,catalog): parent-kustomization prefix collision + disable openclaw/stalwart-mail (#1043) 2026-05-06 10:21:39 +04:00
docs docs: unified design for EPICs 1-6 (Phase 0/1 roll-out — closes #1094 design milestone) (#1102) 2026-05-08 21:46:22 +04:00
infra/hetzner fix(infra/hetzner): strip any-indent comments, gate user_data ≤ 30 KiB at plan-time (#966) (#967) 2026-05-05 17:58:44 +04:00
platform fix(cutover step-01): clone+push (regular repo) instead of pull-mirror (#1033) 2026-05-06 03:19:05 +04:00
products deploy: update catalyst images to cb8c789 2026-05-08 16:17:05 +00:00
scripts chore(bootstrap-kit): remove slot 95 bp-stalwart-sovereign (Phase-2 deferred) (#958) 2026-05-05 15:55:30 +04:00
tests fix(bp-newapi+services-build): imagePullSecrets on Pod, sed bumps values.yaml smeTag (#955) 2026-05-05 15:47:37 +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.