Kong API gateway: route structure for external administrative endpoints
| 🌐 This document is available in both English and Ukrainian. Use the language toggle in the top right corner to switch between versions. |
This document contains information about the general provisions for the formation of external access points of administrative endpoints.
1. General description
-
All external administrative tool endpoints are called through a separate Kong API Gateway from registry components
-
In Kong API Gateway, a single URI is configured through which access to the form is performed:
https://admin-tools-<openshift-project-name>.<dns-wildcard> -
OIDC plugin must be configured on the service
-
The path to the endpoints must not contain the name of the service to which this or that resource belongs
2. High-level technical design
This diagram shows the platform components involved in the implementation of the requirements and the interaction between them.
3. List of endpoints in the system
| Admin tool name | Ingress name | Ingress host | Route path | Service name |
|---|---|---|---|---|
Jenkins |
admin-tools-jenkins |
admin-tools-<openshift-project-name>.<dns-wildcard> |
/cicd |
admin-tools-jenkins |
Gerrit |
admin-tools-gerrit |
/vcs |
admin-tools-gerrit |
|
Nexus |
admin-tools-nexus |
/artifacts |
admin-tools-nexus |
|
Camunda |
admin-tools-bp-admin-portal |
/bp-admin |
bp-admin-portal |
|
Redash |
admin-tools-redash-admin |
/analytics-admin |
admin-tools-redash-admin |
|
Redash |
admin-tools-redash-viewer |
/analytics |
admin-tools-redash-viewer |
|
Kafka-UI |
admin-tools-kafka-ui |
/kafka-ui |
admin-tools-kafka-ui |
|
Admin portal |
admin-tools-admin-portal |
/ |
admin-tools-admin-portal |
4. System components and their purpose within the solution design
This section provides a list of system components that are involved or need to be changed/created within the framework of the implementation of functional requirements according to the technical design of the solution.
| Component | Official title |
|---|---|
Saving and retrieving binary artifacts |
nexus |
Saving platform configuration and registries |
gerrit |
Deployment of registers |
jenkins |
API Gateway |
administrative-kong |
Business process modeling tool |
bp-admin-portal |
Data analysis tool |
redash/redash-admin |
Kafka cluster monitoring tool |
kafka-ui |
Settings of service mesh |
istio-configuration |
Settings of network policies |
network-management |