This repository stores helper documents for the Qubership Integration Platform (QIP).
QIP is an open-source integration solution built on Apache Camel. It enables integration between diverse systems while handling data transformation, process orchestration and mapping between different system formats.
The documents from this repository are consumed by:
- Qubership Integration UI — web interface for designing and managing integration chains
- Qubership Integration VSCode Extension — Visual Studio Code extension for working with QIP
All documentation is located in the docs/ directory and organized into the following sections:
| Section | Description |
|---|---|
| Overview | Platform concepts: token processing, Apache Camel context, chain configuration, general functions, access control |
| Chains | Chain graph editor, QIP elements library (routing, files, triggers, services, transformation, senders), triggers and properties |
| Services | External and inner cloud services, implemented services, context configuration |
| Admin Tools | Domains, variables, audit, sessions, live exchanges |
| Dev Tools | MaaS integration, diagnostic tools |
Commits and pull requests should follow the Conventional Commits specification.
Documents are written in Markdown. The naming convention uses numeric prefixes with double underscores for ordering (e.g. 00__Overview, 01__Chains). Each topic has its own directory with a main .md file and an optional img/ folder for images.
This software is licensed under Apache License Version 2.0. License text is located in the LICENSE file.
- qubership-integration-platform — core deployment guide
- qubership-integration-ui — web UI
- qubership-integration-vscode-extension — VSCode extension