Documentation
How APIHUB is
built and how it runs
The architecture documentation lives here, on this site. Operational and end-user guides are versioned with the product and live in the repository.
Architecture
The C4 model from context down to code, three runtime flows, and 60 sub-capabilities mapped onto the services that implement them.
Overview
Two models of the same platform, and how to read the four levels of C4.
The C4 model
Context, containers, components and code — plus what runs where in Kubernetes.
Runtime flows
What happens over time when you publish a version, run discovery, or ask an AI agent.
Capability map
Sixty sub-capabilities with technology and maturity overlays, and the ArchiMate view.
Guides
Installation, day-to-day usage and administration are versioned with the product, so they stay in
the qubership-apihub repository.
Installation Guide
Helm chart and Docker Compose deployment, prerequisites, and configuration reference.
User Guide
Working with packages, versions, publishing, comparison, and the Portal interface.
Administrator Guide
Identity providers, roles, API keys, system settings, and maintenance tasks.
Documentation
The documentation home: guides, reference, architecture, and development.
Design items
Feature designs and the design items behind them.
User documentation
Installation, administration, and user guides live on the
documentation site,
which is built from the docs/ folder of the repository.