Welcome to the documentation section, below you will find all the necesary docs of interest for undestanding the DPP application.
- Business Statement and Application Use Case
- Application User Interface Preview
- Architecture Documentation
- User and Technical User Changelogs
- Technical Documentation
- Security Documentation
- Testing Documentation
- Release Guidelines Documentation
- API Documentation
Note: IMPORTANT! Before you start with the architecture docs please take a look at the business context from the application use case. In this way you will be able to understand much better the further documentation.
| Name | Description |
|---|---|
| Business Statement | Business Context from the Application |
Here you can find some application screenshots that will help you to visualize and get to know the UI.
If you need an extra guideline to understand the application user interface please check the user manual:
| Name | Description |
|---|---|
| User Manual | User Manual explaining the user interface |
For understating the achitecture first take a look at the following diagram:
Here you can see that the Digital Product Pass Application is located between the consumer and the data provider. It should be provided by the Consumer and conected to a EDC. At the moment the DPP is hosted by Catena-X and is connected to a test EDC Consumer, which is maintained by the Eclipse Foundation and can be found in the Eclipse Tractus-X EDC Repository.
The Arc42 documentation is the main architecture guide you can read in order to have a overview from the application and get to know more about the system.
Here are all the docs you need to understand the architecture and arhitecture configurations:
| Name | Description |
|---|---|
| Arc42 | Main architecture document of the Digital Product Pass Application |
| Administration Guide | Administration Guide explaining the infrastructure and how to configure the application |
| Name | Description |
|---|---|
| Technical User Changelog | Documentation containing all the release changes at a technical level. |
| User Changelog | Resumed released changes from the application without getting into so much technical detail. |
You can find the backend documentation at the following location:
| Name | Description |
|---|---|
| Backend Documentation | Backend documentation Product Passport App |
Here you will find the Infrastructure documentation for the Digital Product Pass Application:
| Name | Description |
|---|---|
| Getting Started Introduction | Digital Product Pass application infrastructure, installation guide, technical usage guide |
| Deployment in Argo CD | Technical Guide - Deployment in ArgoCD - integration environment |
| Docker Overview | Overview on general docker commands |
Here you can find the main security documentatin for the Digital Product Pass Application
| Name | Description |
|---|---|
| Keycloak Overview | This guide describes how to setup a keycloak instance in local docker container and import existing realm.json file. |
| Code Scaning with Kics and Trivy | Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github |
| Secret Management | Secrets management with CX HashiCorp Vault and ArgoCD Vault Plugin (AVP) - client credentials, database passwords, access tokens |
Here you can find the test (End to End, etc.) documentation for the Digital Product Pass Application
| Name | Description |
|---|---|
| Cypress Overview | Documentation for Battery Passport App E2E Cypress test |
| Name | Description |
|---|---|
| Release Guidelines | Product Battery Pass Consumer App Release Guide |
Here you can find the API documentation, there is a postman collection with the workflow that our application is following to retrive the data:
| Name | Description |
|---|---|
| Postman Overview | Technical guide depicts the battery pass end-to-end API calls through the postman REST client |
Additionally we have a open swagger documentation at the following URL:
https://dpp.int.demo.catena-x.net/swagger-ui/index.html
You can also deploy the application using the deployment guidelines, which will be deployed at:
https://localhost:8888/swagger-ui/index.html
Note: The port can vary if you change the port at the configuration.
This work is licensed under the Apache-2.0.
- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2022, 2024 BMW AG, Henkel AG & Co. KGaA
- SPDX-FileCopyrightText: 2023, 2024 CGI Deutschland B.V. & Co. KG
- SPDX-FileCopyrightText: 2023, 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/digital-product-pass