APIHUB documentation
Guides for people who install, run, use, and change Qubership APIHUB. The pages are Markdown files in the
docs/ folder of the repository. They change together
with the code, and the site shows the same files.
Who reads what
Section titled “Who reads what”| You want to | Start with |
|---|---|
| Try APIHUB or bring up an environment | Installation guide |
| Operate an installation | Admin guide and Maintenance guide |
| Publish, browse, and compare APIs | User guide |
| Understand how the product is built | Architecture |
| Change the code | Developer guide |
Get started
Section titled “Get started”- Installation guide: prerequisites, the Compose and Podman walkthrough, Helm install and upgrade, and the local Kubernetes quickstart.
- Configuration reference: every setting, from the Helm values to each service’s
config.yamlor environment, with the tokens and URLs that must match across services.
User guide
Section titled “User guide”- User guide: vocabulary and everyday workflows.
- Portal user guide: workspaces, packages, versions, comparison, and operations.
- Agents user guide: discovering APIs in a Kubernetes cluster and promoting them to the Portal.
- Making a service discoverable: what the APIHUB agent looks for in a service.
Reference
Section titled “Reference”- API changes: the rules that classify an API change as breaking, deprecating, non-breaking, or annotation, for OpenAPI, GraphQL, and schemas.
Administration
Section titled “Administration”- Admin guide: single sign-on, Helm operations, Compose caveats, and the extensions.
- Maintenance guide: backups, cleanup jobs, and token handling.
- Administration topics: the security model, data maintenance, business metrics, static resources, and migration analysis. The admin guide links each one.
Architecture
Section titled “Architecture”- Architecture: the system overview, the feature list, the processing libraries, the build process, and the database structure.
- The generated database ERDs show the schema of each backend.
Design items
Section titled “Design items”- Design items: how each feature behaves, by area, with the ID scheme and a template for new items.
Development
Section titled “Development”- Developer guide: workstation setup, workflow, build and test, local run, debugging, CI, API guidelines, and the release process.
Internal records
Section titled “Internal records”- Internal: architecture decision records, project history, and the team process. These pages are on GitHub only and not on the documentation site.
Deployment assets
Section titled “Deployment assets”The deployment assets live outside this folder, in deploy/:
| Path | Role |
|---|---|
deploy/docker-compose/apihub-generic/ |
Reference Compose stack with generate_env_and_up_compose.sh |
deploy/docker-compose/with-keycloak/ |
Compose stack with a Keycloak SSO recipe |
deploy/helm-templates/ |
The Helm chart and its commented production values.yaml |
deploy/helm-templates/local-k8s-quickstart/ |
Kind and Rancher lab automation; not for production |
The annotated service configuration templates sit next to each module, for example
backend/portal-backend/config.template.yaml and
backend/agent/config.template.yaml.