Skip to content

Commit

Permalink
[BREAKING CHANGE]: changed the backend path to `dpp-backend/digitalpr…
Browse files Browse the repository at this point in the history
…oductpass` and also the namespace to the correct one: org.eclipse.tractusx.digitalproductpass
  • Loading branch information
matbmoser authored Dec 22, 2023
1 parent e2008f3 commit 5108bc1
Show file tree
Hide file tree
Showing 162 changed files with 326 additions and 326 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/helm-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,14 @@ jobs:
# Build Java code with Maven
- name: Build dpp backend with maven
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
mvn -B clean install
- name: Build image for backend
id: build-backend
uses: docker/build-push-action@v3
with:
context: backend/productpass
context: dpp-backend/digitalproductpass
push: true
tags: ${{ env.REGISTRY }}/${{ env.BACKEND_IMAGE}}:${{ env.TAG }}

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/publish-dpp-backend-docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ jobs:
- name: Build dpp backend with maven for GHCR registry
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
mvn -B clean install
# Build and push Docker image with Buildx
Expand All @@ -103,7 +103,7 @@ jobs:
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
uses: docker/build-push-action@v3
with:
context: backend/productpass
context: dpp-backend/digitalproductpass
push: true
tags: ${{ steps.meta-for-ghcr.outputs.tags }}, ${{ env.REGISTRY }}/${{ github.repository }}/${{ env.IMAGE_NAME }}:latest
labels: ${{ steps.meta-for-ghcr.outputs.labels }}
Expand Down Expand Up @@ -141,7 +141,7 @@ jobs:
- name: Build dpp backend with maven for Docker Hub
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
mvn -B clean install
# Build and push Docker image with Buildx
Expand All @@ -151,7 +151,7 @@ jobs:
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
uses: docker/build-push-action@v3
with:
context: backend/productpass
context: dpp-backend/digitalproductpass
push: true
tags: ${{ steps.meta-for-dockerhub.outputs.tags }}, ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }}:latest
labels: ${{ steps.meta-for-dockerhub.outputs.labels }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sonar-scan.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
mvn -B install org.sonarsource.scanner.maven:sonar-maven-plugin:sonar
# cannot scan frontend component in one sonar cloud project where backend is also running, because frontend implemented in different technology
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/trivy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -150,22 +150,22 @@ jobs:
# Build Java code with Maven
- name: Build JAR
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
mvn -B clean install
- name: Build backend image from Dockerfile - GHCR
id: build-docker-backend-ghcr
if: ${{ github.repository != 'eclipse-tractusx/digital-product-pass' }}
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
docker build -t ${{ env.REGISTRY }}/${{ github.repository }}/${{ env.BACKEND_IMAGE_NAME }}:latest .
# Build action for docker hub registry
- name: Build backend image from Dockerfile - Docker Hub
id: build-docker-backend-dockerhub
if: ${{ github.repository == 'eclipse-tractusx/digital-product-pass' }}
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
docker build -t ${{ env.IMAGE_NAMESPACE }}/${{ env.BACKEND_IMAGE_NAME }}:latest .
- name: Run Trivy vulnerability scanner - GHCR
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/veracode-pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:

- name: build
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
mvn dependency:purge-local-repository clean verify
- run: zip -r veracode-scan-target.zip ./
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/veracode-upload.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:

- name: build
run: |
cd backend/productpass
cd dpp-backend/digitalproductpass
mvn dependency:purge-local-repository clean verify
- run: zip -r veracode-scan-target.zip ./
Expand Down
6 changes: 3 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ kubectl get pods -n product-material-pass --no-headers | awk '{if ($1 ~ "consum
```
**Example**:

![img4.png](./backend/productpass/docs/media/img4.png)
![img4.png](./dpp-backend/digitalproductpass/docs/media/img4.png)


Copy the pod name with the prefix `consumer-backend`
Expand Down Expand Up @@ -88,7 +88,7 @@ Use the following commands to install/compile the application:

### Compile Backend
```bash
cd backend/productpass
cd dpp-backend/digitalproductpass
mvn clean install test
```

Expand All @@ -98,7 +98,7 @@ Substitute the `<version>` variable with the current version of the Digital Prod

```bash

./target/productpass-<version>-SNAPSHOT.jar
./target/digitalproductpass-<version>-SNAPSHOT.jar

```
### Configure the secrets
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ To get started you can have a look into our documentation:
| [Arc42](./docs/arc42/Arc42.md) | Main Architecture Document (Arc42) of Digital Product Pass Application |
| [Administration Guide](./docs/admin%20guide/Admin_Guide.md) | Administration Guide explaining the infrastructure and how to configure the application |
| [Data Retrieval Guide](./docs/data%20retrieval%20guide/DataRetrievalGuide.md) | Guide on how to retrieve data from the Catena-X Network as the Digital Product Pass |
| [Backend Documentation](./backend/productpass/readme.md) | Backend documentation Product Passport App |
| [Backend Documentation](./dpp-backend/digitalproductpass/readme.md) | Backend documentation Product Passport App |
| [Deployment in Hotel Budapest](./deployment/README.md) | Technical Guide - Deployment in ArgoCD Hotel Budapest (integration environment) |
| [Docker Overview](./docker/README.md) | Overview on general docker commands |
| [Keycloak Overview](./docker/local/Keycloak/README.md) | This guide describes how to setup a keycloak instance in local docker container and import existing realm.json file. |
Expand Down Expand Up @@ -99,7 +99,7 @@ Eclipse Tractus-X product(s) installed within the image:
- Project home: https://projects.eclipse.org/projects/automotive.tractusx
- Dockerfiles:
- Frontend: https://github.com/eclipse-tractusx/digital-product-pass/blob/main/Dockerfile
- Backend: https://github.com/eclipse-tractusx/digital-product-pass/blob/main/backend/productpass/Dockerfile
- Backend: https://github.com/eclipse-tractusx/digital-product-pass/blob/main/dpp-backend/digitalproductpass/Dockerfile
- Project License: [Apache License, Version 2.0](https://raw.githubusercontent.com/eclipse-tractusx/digital-product-pass/main/LICENSE)


Expand Down
2 changes: 1 addition & 1 deletion docs/GETTING-STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Link to the Integration (INT) environment: [https://materialpass.int.demo.catena

- Reference docs:
- [INSTALL.md](../INSTALL.md)
- [Productpass backend](../backend/productpass/readme.md)
- [Productpass backend](../backend/digitalproductpass/readme.md)

Link to the Integration (INT) environment: [https://materialpass.int.demo.catena-x.net](https://materialpass.int.demo.catena-x.net/)

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ You can find the backend documentation at the following location:

| Name | Description |
| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Backend Documentation](./backend/productpass/readme.md) | Backend documentation Product Passport App
| [Backend Documentation](./dpp-backend/digitalproductpass/readme.md) | Backend documentation Product Passport App

## Infrastructure Documentation

Expand Down
10 changes: 5 additions & 5 deletions docs/admin guide/Admin_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,23 +125,23 @@ All the information about the backend services is described in this documentatio

| Name | Location | Link |
| ---- | -------- | ---- |
| Consumer Backend Guide | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/tree/main/backend/productpass/readme.md](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/backend/productpass/readme.md) |
| Consumer Backend Guide | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-backend/digitalproductpass/readme.md](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-backend/digitalproductpass/readme.md) |
| Open API - Swagger | GitHub | [https://materialpass.int.demo.catena-x.net/swagger-ui/index.html](https://materialpass.int.demo.catena-x.net/swagger-ui/index.html) |

### Backend Application Configuration
The configurations of log levels and other variables can be set in the following file:

| Name | Location | Link |
|-----------------------------------| -------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Backend Application Configuration | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/blob/main/backend/productpass/src/main/resources/application.yml](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/backend/productpass/src/main/resources/application.yml) |
| Backend Application Configuration | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/blob/main/dpp-backend/digitalproductpass/src/main/resources/application.yml](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/dpp-backend/digitalproductpass/src/main/resources/application.yml) |

### Spring Boot Configuration

The Consumer Backend is running over a Spring Boot server, therefore a application configuration file was created to set up mandatory parameters like the Keycloak host, and the security constrains for accessing each API and Services:

| Name | Location | Link |
| ---- | -------- | ---- |
| Spring Boot Server Configuration | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/blob/main/backend/productpass/src/main/resources/application.yml](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/backend/productpass/src/main/resources/application.yml) |
| Spring Boot Server Configuration | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/blob/main/dpp-backend/digitalproductpass/src/main/resources/application.yml](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/dpp-backend/digitalproductpass/src/main/resources/application.yml) |

All the application utilizes these variables to configure the utilities (tools) and other controllers/services.

Expand All @@ -152,7 +152,7 @@ In order to manage the logs from the application a XML file was set, it contains

| Name | Location | Link |
| ---- | -------- | ---- |
| Spring Boot Logging Configuration | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/blob/main/backend/productpass/src/main/resources/logback-spring.xml](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/backend/productpass/src/main/resources/logback-spring.xml) |
| Spring Boot Logging Configuration | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/blob/main/dpp-backend/digitalproductpass/src/main/resources/logback-spring.xml](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/dpp-backend/digitalproductpass/src/main/resources/logback-spring.xml) |

## Postman Collection

Expand Down Expand Up @@ -198,7 +198,7 @@ When configurating you EDC provider you will be able to set some assets which re
| AssetId | Combination of Digital Twin and Sub Model UUIDs | **Example value for asset**: urn:uuid:0ec8cf2b-f58e-3f13-b5ef-e7dd01d15b19 <br/>**Example value for registry**: digital-twin-registry |
| AssetType | The type of the Asset | **Example value for asset**: Asset <br/>**Example value for registry**: data.core.digitalTwinRegistry |
| Description | Simple description of the asset | Battery Passport Test Data |
| DataProviderEndpointUrl | URL to the endpoint which stores and serves the data, basically a Database that retrieves plain text/json data for a certain API | **Example value for asset**: [https://materialpass.int.demo.catena-x.net/provider_backend/data/{{DigitalTwinSubmodelId}}](https://materialpass.int.demo.catena-x.net/provider_backend/data/{{DigitalTwinSubmodelId}}) <br/> **Example value for registry**: [https://materialpass.int.demo.catena-x.net/semantics/registry/api/v3.0](https://materialpass.int.demo.catena-x.net/semantics/registry/api/v3.0) |
| DataProviderEndpointUrl | URL to the endpoint which stores and serves the data, basically a Database that retrieves plain text/json data for a certain API | **Example value for asset**: [https://materialpass.int.demo.catena-x.net/provider_dpp-backend/data/{{DigitalTwinSubmodelId}}](https://materialpass.int.demo.catena-x.net/provider_dpp-backend/data/{{DigitalTwinSubmodelId}}) <br/> **Example value for registry**: [https://materialpass.int.demo.catena-x.net/semantics/registry/api/v3.0](https://materialpass.int.demo.catena-x.net/semantics/registry/api/v3.0) |
| DigitalTwinId | Id from the Digital Twin | urn:uuid:de98db6e-8e05-5d8e-8ae8-9f702cf5c396 |
| DigitalTwinSubmodelId | Sub Model Id registered in the Digital Twin Registry | urn:uuid:555c5513-5e52-2d7d-0904-fe90829252de |

Expand Down
2 changes: 1 addition & 1 deletion docs/data retrieval guide/DataRetrievalGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Created: *25 August 2023*
- [NOTICE](#notice)

## Introduction
The Catena-X Network Data Retrieval process can be really complex and challenging to understand. The `Digital Product Pass` application as consumer application is designed to retrieve information from the Catena-X Network in its native way. We as team proposed a solution for retrieving information in this decentralized network in a very efficient way. This solution is implemented in the [`Digital Product Pass Backend`](../../consumer-backend/productpass/readme.md) and can retrieve information in approximated `8-20s` using the algorithm and procedures documented in the [Arc42](../arc42/Arc42.md) documentation.
The Catena-X Network Data Retrieval process can be really complex and challenging to understand. The `Digital Product Pass` application as consumer application is designed to retrieve information from the Catena-X Network in its native way. We as team proposed a solution for retrieving information in this decentralized network in a very efficient way. This solution is implemented in the [`Digital Product Pass Backend`](../../consumer-dpp-backend/digitalproductpass/readme.md) and can retrieve information in approximated `8-20s` using the algorithm and procedures documented in the [Arc42](../arc42/Arc42.md) documentation.

Therefore this guide is here to provide information about how to retrieve Data from the Catena-X Network like the `Digital Product Pass` application. Here we will describe the problem that many consumers application are facing then retrieving data in Catena-X and how we as the DPP Team propose our vision.

Expand Down
2 changes: 1 addition & 1 deletion docs/user manual/User Manual Product Viewer App.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ If questions arise, you can access the Catena-X Helpdesk through clicking on "He
After requesting data via one of the [product search functions](#search-for-a-product-passport), the information will be displayed on the screen. An exemplary product passport of a battery can be seen below. It provides an overview on the battery's history, technical specifications and data exchange information:

</br></br>
![Product Pass](./ProductPassport.png)
![Product Pass](./digitalproductpassport.png)
</br></br>

Hereby, the information is devided into the following sections:
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ VOLUME data log
RUN mkdir -p ./log
RUN mkdir -p ./data

COPY ./target/productpass*.jar productpass.jar
COPY ./target/digitalproductpass*.jar productpass.jar

#HEALTHCHECK --interval=60s --timeout=4s CMD curl -f http://localhost:8080/health || exit 1
HEALTHCHECK NONE
Expand All @@ -44,4 +44,4 @@ RUN chown -R 10000:3000 /app && chmod -R 775 /app/
USER 10000:3000
EXPOSE 8080

ENTRYPOINT ["java", "-jar", "./productpass.jar"]
ENTRYPOINT ["java", "-jar", "./digitalproductpass.jar"]
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>org.eclipse.tractusx</groupId>
<artifactId>productpass</artifactId>
<artifactId>digitalproductpass</artifactId>
<version>2.0.0</version>
<packaging>jar</packaging>
<name>Catena-X Digital Product Passport Backend</name>
Expand Down
File renamed without changes.
Loading

0 comments on commit 5108bc1

Please sign in to comment.