diff --git a/README.md b/README.md index a8d5cb90d..5202ebcca 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ In particular, the appliction is used to access the battery passport data provid Here is a preview from the DPP App UI, where we visualize a test battery passport in this case. -![General Info View](./docs/arc42/media/GraphicBatteryPassportViewGeneralInfo.png) +![General Info View](./docs/architecture/media/GraphicBatteryPassportViewGeneralInfo.png) > **Note**: For more information check the [documentation section](./docs/README.md) @@ -57,18 +57,19 @@ To get started you can have a look into our documentation: | Name | Description | | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Arc42](./docs/arc42/Arc42.md) | Main Architecture Document (Arc42) of Digital Product Pass Application | -| [Administration Guide](./docs/admin%20guide/AdminGuide.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 | +| [Arc42](./docs/architecture/Arc42.md) | Main Architecture Document (Arc42) of Digital Product Pass Application | +| [Interoperability](./docs/interoperability/InteroperabilityGuide.md) | Interoperability document of Digital Product Pass Application | +| [Data Sovereignty](./docs/data-sovereignty/PolicyConfigGuide.md) | Data Sovereignty document of Digital Product Pass Application | +| [Administration Guide](./docs/admin/AdminGuide.md) | Administration Guide explaining the infrastructure and how to configure the application | +| [Data Retrieval Guide](./docs/data-retrieval/README.md) | Guide on how to retrieve data from the Catena-X Network as the Digital Product Pass | | [Backend Documentation](./dpp-backend/digitalproductpass/README.md) | Backend documentation Product Passport App | -| [Deployment in Argo CD](./deployment/README.md) | Technical Guide - Deployment in ArgoCD - integration environment | | [Docker Overview](./deployment/local/iam/README.md) | Overview on general docker commands | | [Keycloak Overview](./deployment/local/iam/README.md) | This guide describes how to setup a keycloak instance in local docker forcontainer and import existing realm.json file. | | [Short Introduction into the project](./docs/GETTING-STARTED.md) | Digital Product Pass App infrastructure, helm installation guide, technical usage guide | -| [Code Scaning with Kics and Trivy](./docs/infrastructure%20as%20code/IaC.md) | Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github | +| [Code Scaning with Kics and Trivy](./docs/security/infrastructure-as-code/IaC.md) | Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github | | [Release Guidelines](./docs/RELEASE.md) | Digital Product Pass App Release Guide | -| [Secret Management](./docs/secrets%20management/SECRETS_MANAGEMENT.md) | Secrets management with CX HashiCorp Vault and ArgoCD Vault Plugin (AVP) - client credentials, database passwords, access tokens | -| [End User Manual](./docs/user%20manual/UserManual.md) | End User Manual Product Viewer App | +| [Secret Management](./docs/security/secrets-management/SecretsManagement.md) | Secrets management to store client credentials, database passwords, access tokens | +| [End User Manual](./docs/user/UserManual.md) | End User Manual Product Viewer App | | [Postman Overview](./deployment/local/postman//README.md) | Technical guide depicts the battery pass end-to-end API calls through the postman REST client | | [Changelog](./CHANGELOG.md) | Changelog | | [Helm Charts](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/charts/digital-product-pass) | Project's Helm Charts | diff --git a/charts/digital-product-pass/Chart.yaml b/charts/digital-product-pass/Chart.yaml index aff830514..e0822b687 100644 --- a/charts/digital-product-pass/Chart.yaml +++ b/charts/digital-product-pass/Chart.yaml @@ -42,7 +42,7 @@ type: application # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 2.3.2 +version: 2.3.3 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to diff --git a/charts/digital-product-pass/values-beta.yaml b/charts/digital-product-pass/values-beta.yaml deleted file mode 100644 index 1519c7675..000000000 --- a/charts/digital-product-pass/values-beta.yaml +++ /dev/null @@ -1,111 +0,0 @@ -################################################################################# -# Tractus-X - Digital Product Passport Application -# -# Copyright (c) 2022, 2024 BMW AG, Henkel AG & Co. KGaA -# Copyright (c) 2023, 2024 CGI Deutschland B.V. & Co. KG -# Copyright (c) 2022, 2024 Contributors to the Eclipse Foundation -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, -# either express or implied. See the -# License for the specific language govern in permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################################# - -backend: - ingress: - enabled: true - # className: "nginx" - annotations: - ingressClassName: nginx - # kubernetes.io/tls-acme: "true" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: &hostname "materialpass.beta.demo.catena-x.net" - paths: - - path: / - pathType: Prefix - tls: - - secretName: tls-secret - hosts: - - *hostname - - edc: - xApiKey: - participantId: &bpn - hostname: "materialpass.beta.demo.catena-x.net/consumer" - - hostname: *hostname - securityCheck: - bpn: true - edc: true - - irs: - enabled: true - hostnam: "materialpass-irs.beta.demo.catena-x.net" - - process: - encryptionKey: "" - - discovery: - hostname: "semantics.beta.demo.catena-x.net/discoveryfinder" - -frontend: - ingress: - enabled: true - #className: "" - annotations: - ingressClassName: nginx - # kubernetes.io/tls-acme: "true" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/rewrite-target: /$2 - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - nginx.ingress.kubernetes.io/service-upstream: "true" - hosts: - - host: materialpass.beta.demo.catena-x.net - paths: - - path: /passport(/|$)(.*) - pathType: Prefix - tls: - - secretName: tls-secret - hosts: - - materialpass.beta.demo.catena-x.net - - # Product Passport UI Configuration - backend: - hostname: "materialpass.beta.demo.catena-x.net" - - supportContact: - adminEmail: "admin@example.com" - - portal: - hostname: "portal.beta.demo.catena-x.net" - -oauth: - hostname: "centralidp.data.demo.catena-x.net" - techUser: - clientId: - clientSecret: - realm: - appId: - bpnCheck: - enabled: true - bpn: *bpn - roleCheck: - enabled: false - apiKey: - header: "X-Api-Key" - secret: diff --git a/charts/digital-product-pass/values-dev.yaml b/charts/digital-product-pass/values-dev.yaml deleted file mode 100644 index ffd4d8f5d..000000000 --- a/charts/digital-product-pass/values-dev.yaml +++ /dev/null @@ -1,112 +0,0 @@ -################################################################################# -# Tractus-X - Digital Product Passport Application -# -# Copyright (c) 2022, 2024 BMW AG, Henkel AG & Co. KGaA -# Copyright (c) 2023, 2024 CGI Deutschland B.V. & Co. KG -# Copyright (c) 2022, 2024 Contributors to the Eclipse Foundation -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, -# either express or implied. See the -# License for the specific language govern in permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################################# - -backend: - ingress: - enabled: true - # className: "nginx" - annotations: - ingressClassName: nginx - # kubernetes.io/tls-acme: "true" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: &hostname "materialpass.dev.demo.catena-x.net" - paths: - - path: / - pathType: Prefix - tls: - - secretName: tls-secret - hosts: - - *hostname - - edc: - xApiKey: - participantId: &bpn - hostname: "materialpass.dev.demo.catena-x.net/consumer" - - hostname: *hostname - - securityCheck: - bpn: true - edc: true - - irs: - enabled: true - hostname: "materialpass-irs.dev.demo.catena-x.net" - - process: - encryptionKey: "" - - discovery: - hostname: "semantics.dev.demo.catena-x.net/discoveryfinder" - -frontend: - ingress: - enabled: true - #className: "" - annotations: - ingressClassName: nginx - # kubernetes.io/tls-acme: "true" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/rewrite-target: /$2 - nginx.ingress.kubernetes.io/service-upstream: "true" - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: materialpass.dev.demo.catena-x.net - paths: - - path: /passport(/|$)(.*) - pathType: Prefix - tls: - - secretName: tls-secret - hosts: - - materialpass.dev.demo.catena-x.net - - # Product Passport UI Configuration - backend: - hostname: *hostname - - supportContact: - adminEmail: "admin@example.com" - - portal: - hostname: "portal.dev.demo.catena-x.net" - -oauth: - hostname: "centralidp.dev.demo.catena-x.net" - techUser: - clientId: - clientSecret: - realm: - appId: - bpnCheck: - enabled: true - bpn: *bpn - roleCheck: - enabled: false - apiKey: - header: "X-Api-Key" - secret: diff --git a/charts/digital-product-pass/values.yaml b/charts/digital-product-pass/values.yaml index 299c1beb1..eefa69963 100644 --- a/charts/digital-product-pass/values.yaml +++ b/charts/digital-product-pass/values.yaml @@ -36,7 +36,7 @@ backend: name: "dpp-backend" image: repository: docker.io/tractusx/digital-product-pass-backend - pullPolicy: Always + pullPolicy: IfNotPresent # -- Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) imagePullSecrets: [] @@ -56,7 +56,7 @@ backend: nginx.ingress.kubernetes.io/ssl-passthrough: "false" nginx.ingress.kubernetes.io/backend-protocol: "HTTP" hosts: - - host: &hostname "localhost" + - host: &hostname "" paths: - path: / pathType: Prefix @@ -263,7 +263,7 @@ frontend: name: "dpp-frontend" image: repository: docker.io/tractusx/digital-product-pass-frontend - pullPolicy: Always + pullPolicy: IfNotPresent # -- Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) imagePullSecrets: [] diff --git a/deployment/README.md b/deployment/README.md index ff27efd55..24d20c72b 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -22,108 +22,20 @@ SPDX-License-Identifier: Apache-2.0 --> -## Technical Guide - Deployment in Argo CD +## Deployment Guide -> [Getting Started Documentation](../docs/GETTING-STARTED.md) +### Reference Links -This document describes the battery pass application deployment steps in using helm charts. In order to deploy the app components, the following artifacts are required. +* [Getting Started Documentation](../docs/GETTING-STARTED.md) +* [Install.md](../INSTALL.md) +* Helm Charts + * [edc-consumer](./infrastructure/data-consumer/edc-consumer) + * [edc-provider](./infrastructure/data-provider/edc-provider) + * [digital-product-pass](../charts/digital-product-pass) +* OpenAPI Documentation + * [Open API documentation in Swagger](https://dpp.int.demo.catena-x.net/swagger-ui/index.html) + * [Central Swagger Hub](https://app.swaggerhub.com/apis/eclipse-tractusx-bot/digital-product-pass) -> **NOTE**: This tutorial demonstrates the deployment of the application on Argo CD infrastructure. It is assumed that the infrastructure is already configured. Further documentation about the Argo CD. [What is Argo CD platform?](http://argo-cd.readthedocs.io/en/stable) - -- Link to the Integration environment: [ArgoCD - Product Material Passport](https://argo.int.demo.catena-x.net) - -- [edc-consumer](./infrastructure/data-consumer/edc-consumer) - -- [edc-provider](./infrastructure/data-provider/edc-provider) - -- [digital-product-pass](../charts/digital-product-pass) - - dpp-frontend - - dpp-backend - -#### Sign in via the GitHub account - -After signing in into the account, you can see the allocated space inside the namespace 'product-material-pass' and project 'project-material-pass' for the digital product pass team. The new app should be created inside this space. - -#### Creating New Application - -Create new app from the top-left corner button. -Fill out the following required fields. -- **Application Name:** (e.g., edc-consumer, digital-product-pass) -- **Project:** project-material-pass -- **Source:** Git repository where the application artifacts are stored (https://github.com/eclipse-tractusx/digital-product-pass) -- **Revision:** select branch or a tag -- **Path:** The path to the deployment (possible values: deployment/infrastructure/data-consumer/edc-consumer, deployment/infrastructure/data-provider/edc-provider, charts/digital-product-pass) -- **Cluster URL:** https://kubernetes.default.svc -- **Namespace:** product-material-pass -- **Plugin:** argocd-vault-plugin-helm-args - - Set following helm args with the corresponding application: - - digital-product-pass: set ENV as ***helm_args = -f values.yaml'*** - - edc-consumer: set ENV as ***helm_args = -f values.yaml'*** - - edc-provider: set ENV as ***helm_args = -f values.yaml'*** - -Click on 'Create' button - -![Create New App](./media/create-app.png) -![Select Valut Plugin](./media/create-app-with-plugin.png) - -- Go inside the application and sync it. It would take some time to get synced. - -![Sync App](./media/sync-app.png) - -![Sync App](./media/sync-pod.png) - -![Consumer frontend and backend pods](./media/running-pods.png) -- Go to the individual logs tab - -Frontend logs: -![Consumer frontend logs](./media/frontend-logs.png) - -Backend logs: -![Consumer backend logs](./media/backend-logs.png) - -If everything works fine then the application is deployed... - -#### Digital-Product-Pass: - -##### Consumer-Frontend: - -The dpp frontend is a consumer user interface application for the digital product passports that interacts with the end-user and displays passports. The steps above will be followed to deploy the consumer frontend component. - -In the end, the frontend should be accessible at https://dpp.int.demo.catena-x.net. You would be redirected to the CatenaX central IDP and can see the login page after company selection. - -##### Login credentails: -- **Company Selection:** CX-Test-Access -- **User 1:** Role: Dismantler, user: company 1 user, Password: changeme -- **User 2:** Role: Recycler, user: company 2 user, Password: changeme - -#### Example Product Pass IDs: - -- CX:XYZ78901:BAT-XYZ789 (with child components) -- CX:XYZ78901:IMR18650V1 (without child components) - -#### Example Screenshots: - -![Company Selection Page](./media/company-selection.png) - -![Login Page](./media/login.png) - -![QR Code Scanner](./media/dashboard.png) - -![QR Code Scanner](./media/passport-scan.png) - -![Battery Passport - General Information](./media/product-passport.png) - -![Drill down components](./media/components.png) - -##### Consumer-Backend: - -The consumer backend is a Java based spring boot application which implements the service modules and business layer to manage the passports in frontend component. - -[Open API documentation in Swagger](https://dpp.int.demo.catena-x.net/swagger-ui/index.html) - -[Central Swagger Hub](https://app.swaggerhub.com/apis/eclipse-tractusx-bot/digital-product-pass/2.0.1) - -![Swagger UI](./media/swagger.png)
diff --git a/docs/GETTING-STARTED.md b/docs/GETTING-STARTED.md index cdd61a972..c0e6a6c98 100644 --- a/docs/GETTING-STARTED.md +++ b/docs/GETTING-STARTED.md @@ -68,7 +68,7 @@ minikube start --cpus 4 --memory 8096 minikube addons enable ingress ``` -The secrets/credentials for all components are stored in CX Hashicorp vault (a CatenaX shared service). There is a argocd-vault-plugin which retrieves secrets when it comes to INT or DEV, but the plugin does not work locally as we are not using argocd to deploy the apps in localhost. Therefore, the secrets variables in configurations need to be substituted with their actual values and security must also be ensured during the substitution process. To achieve this, a shell script is used to set/unset [init-values.sh](../deployment/local/testing/init-values.sh) in required components as needed. +The secrets/credentials for all components are stored in a centralized vault service (HashiCorp Vault). The secrets in configurations must be populated with their values, and security must also be ensured during the substitution process. To achieve this, a shell script is available to set/unset [init-values.sh](../deployment/local/testing/init-values.sh) in required components as needed. > Prerequisite: Prior to run the scripts, the values for the follwoing environment variables should be placed in the script. diff --git a/docs/README.md b/docs/README.md index efa76316f..c80a79d53 100644 --- a/docs/README.md +++ b/docs/README.md @@ -56,7 +56,7 @@ Welcome to the documentation section, below you will find all the necesary docs | Name | Description | | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Business Statement](./business%20statement/BusinessStatement.md) | Business Context from the Application | +| [Business Statement](./interoperability/InteroperabilityGuide.md) | Business Context from the Application | # Application User Interface Preview @@ -64,11 +64,11 @@ Here you can find some application screenshots that will help you to visualize a ## Passport Search View -![Search View](./arc42/media/GraphicQRCodeView.png) +![Search View](./architecture/media/GraphicQRCodeView.png) ## Passport General Information View -![General Info View](./arc42/media/GraphicBatteryPassportViewGeneralInfo.png) +![General Info View](./architecture/media/GraphicBatteryPassportViewGeneralInfo.png) ## User Interface Documentation @@ -76,7 +76,7 @@ If you need an extra guideline to understand the application user interface plea | Name | Description | | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [User Manual](./user%20manual/UserManual.md) | User Manual explaining the user interface | +| [User Manual](./user/UserManual.md) | User Manual explaining the user interface | # Architecture Documentation @@ -84,11 +84,11 @@ If you need an extra guideline to understand the application user interface plea For understating the achitecture first take a look at the following diagram: -![Application Scope](./arc42/media/dataRetrieval/digitalProductPassContext.drawio.svg) +![Application Scope](./architecture/media/dataRetrieval/digitalProductPassContext.drawio.svg) 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](../deployment/infrastructure/data-consumer/edc-consumer/), which is maintained by the Eclipse Foundation and can be found in the [Eclipse Tractus-X EDC Repository](https://github.com/eclipse-tractusx/tractusx-edc). -The [Arc42](./arc42/Arc42.md) 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. +The [Arc42](./architecture/Arc42.md) 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. ## Documents of Interest @@ -96,8 +96,8 @@ Here are all the docs you need to understand the architecture and arhitecture co | Name | Description | | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Arc42](./arc42/Arc42.md) | Main architecture document of the Digital Product Pass Application | -| [Administration Guide](./admin%20guide/AdminGuide.md) | Administration Guide explaining the infrastructure and how to configure the application +| [Arc42](./architecture/Arc42.md) | Main architecture document of the Digital Product Pass Application | +| [Administration Guide](./admin/AdminGuide.md) | Administration Guide explaining the infrastructure and how to configure the application # User and Technical User Changelogs @@ -123,7 +123,6 @@ Here you will find the Infrastructure documentation for the Digital Product Pass Name | Description | | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Getting Started Introduction](./GETTING-STARTED.md) | Digital Product Pass application infrastructure, installation guide, technical usage guide -| [Deployment in Argo CD](../deployment/README.md) | Technical Guide - Deployment in ArgoCD - integration environment | | [Docker Overview](../deployment/local/iam/README.md) | Overview on general docker commands | # Security Documentation @@ -133,8 +132,8 @@ Here you can find the main security documentatin for the Digital Product Pass Ap Name | Description | | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | [Keycloak Overview](../deployment/local/iam/README.md) | 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%20as%20code/IaC.md) | 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%20management/SECRETS_MANAGEMENT.md) | Secrets management with CX HashiCorp Vault and ArgoCD Vault Plugin (AVP) - client credentials, database passwords, access tokens | +[Code Scaning with Kics and Trivy](./security/infrastructure-as-code/IaC.md) | 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](./security/secrets-management/SecretsManagement.md) | Secrets management to store client credentials, database passwords, access tokens | # Testing Documentation diff --git a/docs/RELEASE.md b/docs/RELEASE.md index a4ef55896..97f4da51d 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -45,7 +45,7 @@ Aditional Helm charts of below components can be found in *deployment/infrastruc In order to update helm charts, please update helm chart version and related dependencies from *version* property in *Chart.yaml file* for the above components. In addition, if there are changes to application version, the *appVersion* property also needs to be changed. -Navigate to the [Deploymment Guide](/deployment/README.md) and follow the steps. The deployment guide illustrates the manual steps to install helm deployments into ArgoCD INT environment. +Navigate to the [Deploymment Guide](/deployment/README.md) and have a look into the reference links. ## NOTICE diff --git a/docs/admin guide/AdminGuide.md b/docs/admin/AdminGuide.md similarity index 99% rename from docs/admin guide/AdminGuide.md rename to docs/admin/AdminGuide.md index 355e3a6a1..6c225cf18 100644 --- a/docs/admin guide/AdminGuide.md +++ b/docs/admin/AdminGuide.md @@ -172,7 +172,7 @@ In order to set up the secret management please follow this guide: | Name | Location | Link | | ---- | -------- | ---- | -| Secrets Management Documentation | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/secrets%20management/SECRETS_MANAGEMENT.md](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/secrets%20management/SECRETS_MANAGEMENT.md) | +| Secrets Management Documentation | GitHub | [https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/security/secrets-management/SecretsManagement.md](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/security/secrets-management/SecretsManagement.md) | ## EDC Provider Configuration diff --git a/docs/admin guide/media/CXLogo.png b/docs/admin/media/CXLogo.png similarity index 100% rename from docs/admin guide/media/CXLogo.png rename to docs/admin/media/CXLogo.png diff --git a/docs/arc42/Arc42.md b/docs/architecture/Arc42.md similarity index 97% rename from docs/arc42/Arc42.md rename to docs/architecture/Arc42.md index 5bad6147e..d2aa8bcd8 100644 --- a/docs/arc42/Arc42.md +++ b/docs/architecture/Arc42.md @@ -255,7 +255,7 @@ If the `configuration.dtr.central` is disabled the backend will also make a call ### Data Retrieval Flow -As detailed at the [Data Retrieval Guide Phases](../data%20retrieval%20guide/DataRetrievalGuide.md#data-retrieval-flow) there are 4 main phases required to retrieve data in the **Catena-X Network**: +As detailed at the [Data Retrieval Guide Phases](../data-retrieval/README.md#data-retrieval-flow) there are 4 main phases required to retrieve data in the **Catena-X Network**: 1. Discovery Phase 2. Digital Twin Registry Search Phase @@ -280,10 +280,10 @@ The keys used for searching the endpoints in the Discovery Service by default ar in case the keys used in the Discovery Service are another ones. #### Digital Twin Registry Search Phase -The **Digital Twin Registry Search Phase** as it is detailed at the [Data Retrieval Guide Phase 1 and 2](../data%20retrieval%20guide/DataRetrievalGuide.md#1-discovery-phase--2-digital-twin-registry-search-phase) is the junction of two main phases the *Discovery Phase* and the *Digital Twin Registry Search Phase* which are essential for starting the Digital Twin Search. +The **Digital Twin Registry Search Phase** as it is detailed at the [Data Retrieval Guide Phase 1 and 2](../data-retrieval/README.md#1-discovery-phase--2-digital-twin-registry-search-phase) is the junction of two main phases the *Discovery Phase* and the *Digital Twin Registry Search Phase* which are essential for starting the Digital Twin Search. The `/create` api is responsible for calling the `BPN Discovery` service searching for the BPN of a `manufacturerPartId` and validating if there is any `Decentral Digital Twin Registry` available for the BPN number found in the `EDC Discovery` service. -This is detailed [here](../data%20retrieval%20guide/DataRetrievalGuide.md#1-discovery-phase--2-digital-twin-registry-search-phase) in the Data Retrieval Guide. +This is detailed [here](../data-retrieval/README.md#1-discovery-phase--2-digital-twin-registry-search-phase) in the Data Retrieval Guide. The API is called "**create**" because it is responsible for creating the **process** which will be responsible for doing the data retrieval in the Digital Product Pass. Basically it creates a `processId` when the `Digital Twin Registries` are found and are available for searching Digital Twins. @@ -301,7 +301,7 @@ Basically it creates a `processId` when the `Digital Twin Registries` are found #### Digital Twin Search -The **Digital Twin Search** as it is detailed at the [Data Retrieval Guide Phase 3](../data%20retrieval%20guide/DataRetrievalGuide.md#3-digital-twin-search-phase-1) is the phase responsible for search in all the **Digital Twin Registries** found at the previous phase, finding and retrieving the searched **Digital Twin**. +The **Digital Twin Search** as it is detailed at the [Data Retrieval Guide Phase 3](../data-retrieval/README.md#3-digital-twin-search-phase-1) is the phase responsible for search in all the **Digital Twin Registries** found at the previous phase, finding and retrieving the searched **Digital Twin**. As described at the *Data Retrieval Guide* the **Digital Product Pass** Application is searching by default for the *partInstanceId* of an specific digital twin. @@ -339,7 +339,7 @@ This means that first the backend will search in the digital twin if the digital #### Data Negotiation and Transfer Phase -The **Data Negotiation and Transfer Phase** as it is detailed at the [Data Retrieval Guide Phase 4](../data%20retrieval%20guide/DataRetrievalGuide.md#4-data-negotiation-and-transfer-phase-1) is the phase responsible for the final data transfer and negotiation. In this phase we retrieve the data using the EDC. +The **Data Negotiation and Transfer Phase** as it is detailed at the [Data Retrieval Guide Phase 4](../data-retrieval/README.md#4-data-negotiation-and-transfer-phase-1) is the phase responsible for the final data transfer and negotiation. In this phase we retrieve the data using the EDC. Once the user has the contract he can call the `/agree` API to start the negotiation process and the transfer of the passport. This means that the user accepted the policy and the frame-contracts contained in the contract policy. @@ -542,9 +542,9 @@ Alternatively (or additionally) you can use a table. The title of the table is t * [ARC42 Documentation](./Arc42.md) * [GitHub Documentation](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/docs) -* [Administration Guide](../admin%20guide/AdminGuide.md) +* [Administration Guide](../admin/AdminGuide.md) * [API Documentation (Swagger)](https://app.swaggerhub.com/apis/eclipse-tractusx-bot/digital-product-pass) -* [Data Retrieval Guide](../data%20retrieval%20guide/DataRetrievalGuide.md) +* [Data Retrieval Guide](../data-retrieval/README.md) #### Catena-X Shared Services @@ -689,7 +689,7 @@ A developer who creates a new feature branch to work on a specific feature that During the merge process, the build pipeline also known as Continuous integration (CI) gets triggered through a git action which builds the application artifacts, packages them into a docker image, and finally publishes the image onto the GitHub Container Registry with the tag holding latest commit SHA. In addition, other jobs are also executed which scan the code based on various criteria to fulfill the quality gate requirements. -The application deployment is translated into Kubernetes resources through helm charts which are deployed in Argo CD. We take the advantage of built-in AutoSync feature of ArgoCD that does the Continuous Deployment(CD) job for us. This is done by matching the current and desired state of the application if there is a new code change or a new container image uploaded to a registry. +The application deployment is translated into Kubernetes resources through helm charts which can be deployed in some cloud environment. At the time of writing this guide, ArgoCD platform was used for deployment purposes. We take the advantage of ArgoCD to leverage the Continuous Deployment (CD) process through its built-in auto-sync feature. This is done by matching the current and desired state of the application once a code is pushed or a new container image is uploaded to a registry. ![Whitebox Overall System](./media/intrastructure/GraphicWhiteboxOverallSys.drawio.svg) diff --git a/docs/arc42/media/CXlogo.png b/docs/architecture/media/CXlogo.png similarity index 100% rename from docs/arc42/media/CXlogo.png rename to docs/architecture/media/CXlogo.png diff --git a/docs/arc42/media/DPPView1.jpg b/docs/architecture/media/DPPView1.jpg similarity index 100% rename from docs/arc42/media/DPPView1.jpg rename to docs/architecture/media/DPPView1.jpg diff --git a/docs/arc42/media/DPPView2.jpg b/docs/architecture/media/DPPView2.jpg similarity index 100% rename from docs/arc42/media/DPPView2.jpg rename to docs/architecture/media/DPPView2.jpg diff --git a/docs/arc42/media/GraphicAvatar.png b/docs/architecture/media/GraphicAvatar.png similarity index 100% rename from docs/arc42/media/GraphicAvatar.png rename to docs/architecture/media/GraphicAvatar.png diff --git a/docs/arc42/media/GraphicBasicTable.png b/docs/architecture/media/GraphicBasicTable.png similarity index 100% rename from docs/arc42/media/GraphicBasicTable.png rename to docs/architecture/media/GraphicBasicTable.png diff --git a/docs/arc42/media/GraphicBatteryPassportView.png b/docs/architecture/media/GraphicBatteryPassportView.png similarity index 100% rename from docs/arc42/media/GraphicBatteryPassportView.png rename to docs/architecture/media/GraphicBatteryPassportView.png diff --git a/docs/arc42/media/GraphicBatteryPassportViewGeneralInfo.png b/docs/architecture/media/GraphicBatteryPassportViewGeneralInfo.png similarity index 100% rename from docs/arc42/media/GraphicBatteryPassportViewGeneralInfo.png rename to docs/architecture/media/GraphicBatteryPassportViewGeneralInfo.png diff --git a/docs/arc42/media/GraphicLogos.png b/docs/architecture/media/GraphicLogos.png similarity index 100% rename from docs/arc42/media/GraphicLogos.png rename to docs/architecture/media/GraphicLogos.png diff --git a/docs/arc42/media/GraphicQRCodeView.png b/docs/architecture/media/GraphicQRCodeView.png similarity index 100% rename from docs/arc42/media/GraphicQRCodeView.png rename to docs/architecture/media/GraphicQRCodeView.png diff --git a/docs/arc42/media/GraphicSearchView.png b/docs/architecture/media/GraphicSearchView.png similarity index 100% rename from docs/arc42/media/GraphicSearchView.png rename to docs/architecture/media/GraphicSearchView.png diff --git a/docs/arc42/media/GraphicVueFrameworkComparison2022.png b/docs/architecture/media/GraphicVueFrameworkComparison2022.png similarity index 100% rename from docs/arc42/media/GraphicVueFrameworkComparison2022.png rename to docs/architecture/media/GraphicVueFrameworkComparison2022.png diff --git a/docs/arc42/media/arc42logo.png b/docs/architecture/media/arc42logo.png similarity index 100% rename from docs/arc42/media/arc42logo.png rename to docs/architecture/media/arc42logo.png diff --git a/docs/arc42/media/auth/authenticationFlow.drawio.svg b/docs/architecture/media/auth/authenticationFlow.drawio.svg similarity index 100% rename from docs/arc42/media/auth/authenticationFlow.drawio.svg rename to docs/architecture/media/auth/authenticationFlow.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/agreeApiFlow.drawio.svg b/docs/architecture/media/dataRetrieval/agreeApiFlow.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/agreeApiFlow.drawio.svg rename to docs/architecture/media/dataRetrieval/agreeApiFlow.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/agreeApiSequence.drawio.svg b/docs/architecture/media/dataRetrieval/agreeApiSequence.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/agreeApiSequence.drawio.svg rename to docs/architecture/media/dataRetrieval/agreeApiSequence.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/cancelApiFlow.drawio.svg b/docs/architecture/media/dataRetrieval/cancelApiFlow.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/cancelApiFlow.drawio.svg rename to docs/architecture/media/dataRetrieval/cancelApiFlow.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/cancelFlowApi.drawio.svg b/docs/architecture/media/dataRetrieval/cancelFlowApi.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/cancelFlowApi.drawio.svg rename to docs/architecture/media/dataRetrieval/cancelFlowApi.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/createApiFlow.drawio.svg b/docs/architecture/media/dataRetrieval/createApiFlow.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/createApiFlow.drawio.svg rename to docs/architecture/media/dataRetrieval/createApiFlow.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/createApiSequence.drawio.svg b/docs/architecture/media/dataRetrieval/createApiSequence.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/createApiSequence.drawio.svg rename to docs/architecture/media/dataRetrieval/createApiSequence.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/dataApiFlow.drawio.svg b/docs/architecture/media/dataRetrieval/dataApiFlow.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/dataApiFlow.drawio.svg rename to docs/architecture/media/dataRetrieval/dataApiFlow.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/dataRetrievalResume.drawio.svg b/docs/architecture/media/dataRetrieval/dataRetrievalResume.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/dataRetrievalResume.drawio.svg rename to docs/architecture/media/dataRetrieval/dataRetrievalResume.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/declineApiFlow.drawio.svg b/docs/architecture/media/dataRetrieval/declineApiFlow.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/declineApiFlow.drawio.svg rename to docs/architecture/media/dataRetrieval/declineApiFlow.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/digitalProductPassContext.drawio.svg b/docs/architecture/media/dataRetrieval/digitalProductPassContext.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/digitalProductPassContext.drawio.svg rename to docs/architecture/media/dataRetrieval/digitalProductPassContext.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/searchApiFlow.drawio.svg b/docs/architecture/media/dataRetrieval/searchApiFlow.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/searchApiFlow.drawio.svg rename to docs/architecture/media/dataRetrieval/searchApiFlow.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/searchApiSequence.drawio.svg b/docs/architecture/media/dataRetrieval/searchApiSequence.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/searchApiSequence.drawio.svg rename to docs/architecture/media/dataRetrieval/searchApiSequence.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/statusApiFlow.drawio.svg b/docs/architecture/media/dataRetrieval/statusApiFlow.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/statusApiFlow.drawio.svg rename to docs/architecture/media/dataRetrieval/statusApiFlow.drawio.svg diff --git a/docs/arc42/media/dataRetrieval/userFlow.drawio.svg b/docs/architecture/media/dataRetrieval/userFlow.drawio.svg similarity index 100% rename from docs/arc42/media/dataRetrieval/userFlow.drawio.svg rename to docs/architecture/media/dataRetrieval/userFlow.drawio.svg diff --git a/docs/arc42/media/intrastructure/DeployementView.drawio.svg b/docs/architecture/media/intrastructure/DeployementView.drawio.svg similarity index 100% rename from docs/arc42/media/intrastructure/DeployementView.drawio.svg rename to docs/architecture/media/intrastructure/DeployementView.drawio.svg diff --git a/docs/arc42/media/intrastructure/GraphicArchitectureDiagram.drawio.svg b/docs/architecture/media/intrastructure/GraphicArchitectureDiagram.drawio.svg similarity index 100% rename from docs/arc42/media/intrastructure/GraphicArchitectureDiagram.drawio.svg rename to docs/architecture/media/intrastructure/GraphicArchitectureDiagram.drawio.svg diff --git a/docs/arc42/media/intrastructure/GraphicBackendComponent.drawio.svg b/docs/architecture/media/intrastructure/GraphicBackendComponent.drawio.svg similarity index 100% rename from docs/arc42/media/intrastructure/GraphicBackendComponent.drawio.svg rename to docs/architecture/media/intrastructure/GraphicBackendComponent.drawio.svg diff --git a/docs/arc42/media/intrastructure/GraphicBlackboxOverallSys.drawio.svg b/docs/architecture/media/intrastructure/GraphicBlackboxOverallSys.drawio.svg similarity index 50% rename from docs/arc42/media/intrastructure/GraphicBlackboxOverallSys.drawio.svg rename to docs/architecture/media/intrastructure/GraphicBlackboxOverallSys.drawio.svg index 07fbbe8fe..40f76b3c5 100644 --- a/docs/arc42/media/intrastructure/GraphicBlackboxOverallSys.drawio.svg +++ b/docs/architecture/media/intrastructure/GraphicBlackboxOverallSys.drawio.svg @@ -1,4 +1,4 @@ -
Battery pass consumer app (consumer-ui)
Battery pass consume...
Kubernetes cluster - ArgoCD
Kubernetes cluster - ArgoCD
materialpass-edc
(Consumer EDC)
materialpass-edc...
Frontend
Frontend
Backend
Backend
Deployment
Deployment
Source Code Management
Source Code Manageme...
Source code
Source code
Github Container Registry (ghcr)
Github Container...
eclipse-tractusx/digital-product-pass
eclipse-tractusx/digital-product-pass
Consumer backend
Consumer backendText is not SVG - cannot display \ No newline at end of file +
Battery pass consumer app (consumer-ui)
Battery pass consume...
Kubernetes cluster
Kubernetes cluster
materialpass-edc
(Consumer EDC)
materialpass-edc...
Frontend
Frontend
Backend
Backend
Deployment
Deployment
Source Code Management
Source Code Manageme...
Source code
Source code
Github Container Registry (ghcr)
Github Container...
eclipse-tractusx/digital-product-pass
eclipse-tractusx/digital-product-pass
Consumer backend
Consumer backendText is not SVG - cannot display diff --git a/docs/arc42/media/intrastructure/GraphicBulidingBlockView.drawio.svg b/docs/architecture/media/intrastructure/GraphicBulidingBlockView.drawio.svg similarity index 52% rename from docs/arc42/media/intrastructure/GraphicBulidingBlockView.drawio.svg rename to docs/architecture/media/intrastructure/GraphicBulidingBlockView.drawio.svg index 17b422c07..89d26df08 100644 --- a/docs/arc42/media/intrastructure/GraphicBulidingBlockView.drawio.svg +++ b/docs/architecture/media/intrastructure/GraphicBulidingBlockView.drawio.svg @@ -1,4 +1,4 @@ -
consumer-ui
consumer-ui
materialpass-edc
materialpass-edc
Scope & Context
Scope & Context
Level 1
Level 1
Level 2
Level 2
Level 3
Level 3
Github Container Registry (ghcr)
Github Containe...
GitHub Repository: eclipse-tractusx/digital-product-pass
GitHub Repository: ec...
Build pipeline
Build pipeline
Application source code + build artifacts
Application source code + b...
ArgoCD
ArgoCD
Deployment Artifacts
(Kubernetes & Helm resources)
Deployment Artifacts...
Application Runtime Environment
Application Runtime Environment
Source Control (GitHub)
Source Control (GitHub)
Development
Development
Product-edc
ghcr
Product-edc...
Pushed to source control repository by developer
Pushed to source con...
Triggers build pipeline to upload docker images (CI pipeline)
Triggers build pipel...
Publishes container images onto the ghcr
Publishes container im...
Quality Gates checks
Quality Gates checks
Triggers jobs to verify quality gates requirements
Triggers jobs to veri...
Pull container images from the product-edc ghcr
Pull container image...
Backend Service
Backend Service
Controlplane
Controlplane
Dataplane
Dataplane
Postgres
Postgres
Chart dependencies
Chart dependencies
Pull container images from the battery pass ghcr
Pull container images from...
EDC consumer umbrella helm chart
EDC consumer umbrell...
materialpass-edc
(Consumer EDC)
materialpass-edc...
Battery passport consumer application
Battery passport consumer applic...
Consumer-Backend
Consumer-Backend
consumer-backend
consumer-backend
GitHub Repository: catenax-ng/tx-digital-product-pass
GitHub Repository: cat...
Pull Request (PR) to main branch
Pull Request (PR...
Approve PR &
merge code by release manager
Approve PR &...
Create PR by developers
Create PR by...Text is not SVG - cannot display +
consumer-ui
consumer-ui
materialpass-edc
materialpass-edc
Scope & Context
Scope & Context
Level 1
Level 1
Level 2
Level 2
Level 3
Level 3
Github Container Registry (ghcr)
Github Containe...
GitHub Repository: eclipse-tractusx/digital-product-pass
GitHub Repository: ec...
Build pipeline
Build pipeline
Application source code + build artifacts
Application source code + b...
Kubernetes cluster
Kubernetes cluster
Deployment Artifacts
(Kubernetes & Helm resources)
Deployment Artifacts...
Application Runtime Environment
Application Runtime Environment
Source Control (GitHub)
Source Control (GitHub)
Development
Development
Product-edc
ghcr
Product-edc...
Pushed to source control repository by developer
Pushed to source con...
Triggers build pipeline to upload docker images (CI pipeline)
Triggers build pipel...
Publishes container images onto the ghcr
Publishes container im...
Quality Gates checks
Quality Gates checks
Triggers jobs to verify quality gates requirements
Triggers jobs to veri...
Pull container images from the product-edc ghcr
Pull container image...
Backend Service
Backend Service
Controlplane
Controlplane
Dataplane
Dataplane
Postgres
Postgres
Chart dependencies
Chart dependencies
Pull container images from the battery pass ghcr
Pull container images from...
EDC consumer umbrella helm chart
EDC consumer umbrell...
materialpass-edc
(Consumer EDC)
materialpass-edc...
Battery passport consumer application
Battery passport consumer applic...
Consumer-Backend
Consumer-Backend
consumer-backend
consumer-backend
GitHub Repository: catenax-ng/tx-digital-product-pass
GitHub Repository: cat...
Pull Request (PR) to main branch
Pull Request (PR...
Approve PR &
merge code by release manager
Approve PR &...
Create PR by developers
Create PR by...Text is not SVG - cannot display diff --git a/docs/arc42/media/intrastructure/GraphicCrossCuttingConcepts.drawio.svg b/docs/architecture/media/intrastructure/GraphicCrossCuttingConcepts.drawio.svg similarity index 100% rename from docs/arc42/media/intrastructure/GraphicCrossCuttingConcepts.drawio.svg rename to docs/architecture/media/intrastructure/GraphicCrossCuttingConcepts.drawio.svg diff --git a/docs/arc42/media/intrastructure/GraphicFrontendComponent.drawio.svg b/docs/architecture/media/intrastructure/GraphicFrontendComponent.drawio.svg similarity index 100% rename from docs/arc42/media/intrastructure/GraphicFrontendComponent.drawio.svg rename to docs/architecture/media/intrastructure/GraphicFrontendComponent.drawio.svg diff --git a/docs/arc42/media/intrastructure/GraphicWhiteboxOverallSys.drawio.svg b/docs/architecture/media/intrastructure/GraphicWhiteboxOverallSys.drawio.svg similarity index 100% rename from docs/arc42/media/intrastructure/GraphicWhiteboxOverallSys.drawio.svg rename to docs/architecture/media/intrastructure/GraphicWhiteboxOverallSys.drawio.svg diff --git a/docs/arc42/media/irs/ChildNotFound.jpg b/docs/architecture/media/irs/ChildNotFound.jpg similarity index 100% rename from docs/arc42/media/irs/ChildNotFound.jpg rename to docs/architecture/media/irs/ChildNotFound.jpg diff --git a/docs/arc42/media/irs/ErrorOccured.jpg b/docs/architecture/media/irs/ErrorOccured.jpg similarity index 100% rename from docs/arc42/media/irs/ErrorOccured.jpg rename to docs/architecture/media/irs/ErrorOccured.jpg diff --git a/docs/arc42/media/irs/IRSDataSearch.drawio.svg b/docs/architecture/media/irs/IRSDataSearch.drawio.svg similarity index 100% rename from docs/arc42/media/irs/IRSDataSearch.drawio.svg rename to docs/architecture/media/irs/IRSDataSearch.drawio.svg diff --git a/docs/arc42/media/irs/Loading.jpg b/docs/architecture/media/irs/Loading.jpg similarity index 100% rename from docs/arc42/media/irs/Loading.jpg rename to docs/architecture/media/irs/Loading.jpg diff --git a/docs/arc42/media/irs/TreeOfComponents.jpg b/docs/architecture/media/irs/TreeOfComponents.jpg similarity index 100% rename from docs/arc42/media/irs/TreeOfComponents.jpg rename to docs/architecture/media/irs/TreeOfComponents.jpg diff --git a/docs/arc42/media/irs/irsFlow.drawio.svg b/docs/architecture/media/irs/irsFlow.drawio.svg similarity index 100% rename from docs/arc42/media/irs/irsFlow.drawio.svg rename to docs/architecture/media/irs/irsFlow.drawio.svg diff --git a/docs/arc42/media/irs/irsSearchFlow.drawio.svg b/docs/architecture/media/irs/irsSearchFlow.drawio.svg similarity index 100% rename from docs/arc42/media/irs/irsSearchFlow.drawio.svg rename to docs/architecture/media/irs/irsSearchFlow.drawio.svg diff --git a/docs/arc42/media/irs/searchWithIrs.drawio.svg b/docs/architecture/media/irs/searchWithIrs.drawio.svg similarity index 100% rename from docs/arc42/media/irs/searchWithIrs.drawio.svg rename to docs/architecture/media/irs/searchWithIrs.drawio.svg diff --git a/docs/arc42/media/irs/searchWithItRS.drawio.svg b/docs/architecture/media/irs/searchWithItRS.drawio.svg similarity index 100% rename from docs/arc42/media/irs/searchWithItRS.drawio.svg rename to docs/architecture/media/irs/searchWithItRS.drawio.svg diff --git a/docs/business statement/media/graphArchitectureFunctionalCut.svg b/docs/business statement/media/graphArchitectureFunctionalCut.svg deleted file mode 100644 index bf0339a82..000000000 --- a/docs/business statement/media/graphArchitectureFunctionalCut.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
User
User
Product Pass Viewer App
Product Pass Viewer App
Catena-X (Network)
Catena-X (Network)
User Interace
User Interace
Authentification
Authentification
EDC Connection
EDC Connection
Data Contract Validation
Data Contract Valida...
Policies Validation
Policies Validation
Data Transmission
Data Transmission
Data Provisioning
Data ProvisioningText is not SVG - cannot display \ No newline at end of file diff --git a/docs/business statement/media/graphBusinessProblem.svg b/docs/business statement/media/graphBusinessProblem.svg deleted file mode 100644 index c7aa3a9a9..000000000 --- a/docs/business statement/media/graphBusinessProblem.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Product Pass Viewer App
Product Pass Vie...
Load Batterypass
Load Batterypass
User
User
Scan QR Code / Insert Battery ID
Scan QR Code / Inser...
User is logged on
User is lo...
Catena-X
Catena-X
yes
yes
Batterypass found?
Batterypass fou...
Request authorized?
Request authori...
Return Batterypass
Return Batterypass
Display Batterypass
Display Batterypass
Show Error Message
Show Error Message
Retrieve Information from Batterypass
Retrieve Information...
yes
yes
no
noText is not SVG - cannot display \ No newline at end of file diff --git a/docs/data retrieval guide/DataRetrievalGuide.md b/docs/data-retrieval/README.md similarity index 99% rename from docs/data retrieval guide/DataRetrievalGuide.md rename to docs/data-retrieval/README.md index d560157e9..02b95976e 100644 --- a/docs/data retrieval guide/DataRetrievalGuide.md +++ b/docs/data-retrieval/README.md @@ -62,7 +62,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-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. +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](../architecture/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. diff --git a/docs/data retrieval guide/media/dataRetrievalFlow.drawio.svg b/docs/data-retrieval/media/dataRetrievalFlow.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/dataRetrievalFlow.drawio.svg rename to docs/data-retrieval/media/dataRetrievalFlow.drawio.svg diff --git a/docs/data retrieval guide/media/dataRetrievalFlow1.drawio.svg b/docs/data-retrieval/media/dataRetrievalFlow1.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/dataRetrievalFlow1.drawio.svg rename to docs/data-retrieval/media/dataRetrievalFlow1.drawio.svg diff --git a/docs/data retrieval guide/media/dataRetrievalFlow2.drawio.svg b/docs/data-retrieval/media/dataRetrievalFlow2.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/dataRetrievalFlow2.drawio.svg rename to docs/data-retrieval/media/dataRetrievalFlow2.drawio.svg diff --git a/docs/data retrieval guide/media/dataRetrievalSequence.drawio.svg b/docs/data-retrieval/media/dataRetrievalSequence.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/dataRetrievalSequence.drawio.svg rename to docs/data-retrieval/media/dataRetrievalSequence.drawio.svg diff --git a/docs/data retrieval guide/media/dataSearchApi.drawio.svg b/docs/data-retrieval/media/dataSearchApi.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/dataSearchApi.drawio.svg rename to docs/data-retrieval/media/dataSearchApi.drawio.svg diff --git a/docs/data retrieval guide/media/discoveryServices.drawio.svg b/docs/data-retrieval/media/discoveryServices.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/discoveryServices.drawio.svg rename to docs/data-retrieval/media/discoveryServices.drawio.svg diff --git a/docs/data retrieval guide/media/dtrSearchFlow.drawio.svg b/docs/data-retrieval/media/dtrSearchFlow.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/dtrSearchFlow.drawio.svg rename to docs/data-retrieval/media/dtrSearchFlow.drawio.svg diff --git a/docs/data retrieval guide/media/dtrSearchSequence.drawio.svg b/docs/data-retrieval/media/dtrSearchSequence.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/dtrSearchSequence.drawio.svg rename to docs/data-retrieval/media/dtrSearchSequence.drawio.svg diff --git a/docs/data retrieval guide/media/searchApiFlow.drawio.svg b/docs/data-retrieval/media/searchApiFlow.drawio.svg similarity index 100% rename from docs/data retrieval guide/media/searchApiFlow.drawio.svg rename to docs/data-retrieval/media/searchApiFlow.drawio.svg diff --git a/docs/data-sovereignty/PolicyConfigGuide.md b/docs/data-sovereignty/PolicyConfigGuide.md index 1fe89da29..9549bd685 100644 --- a/docs/data-sovereignty/PolicyConfigGuide.md +++ b/docs/data-sovereignty/PolicyConfigGuide.md @@ -154,14 +154,14 @@ If the parameter is set to `false` the backend will automatically select the fir ## Policy Selection Options -For viewing and understanding the latest information regarding the policy selection flow see th [User Manual](../user%20manual/UserManual.md). +For viewing and understanding the latest information regarding the policy selection flow see th [User Manual](../user/UserManual.md). In this documentation some points and resources will be indicated: ### Auto-Negotiation If Auto sign setting is enabled, the first valid contract policy checked against the configuration is always chosen as shown in below screenshot. -The passport is shown to the user as shown in a [Passport Page](../user%20manual/UserManual.md#passport-page). +The passport is shown to the user as shown in a [Passport Page](../user/UserManual.md#passport-page). ![Loading Product Pass](../user%20manual/media/loadingPass.png) @@ -171,7 +171,7 @@ This feature requires user action. If disabled, the contract policy must be choo ![Before Contract Policy Selection](../user%20manual/media/beforePolicySelection.png) -The sign feature basically signs the contract policy before the contract negotiation is done. The right contract policy must be selected by the user, otherwise the contract negotiation is aborted and user is returned back to the [Main Menu](../user%20manual/UserManual.md#main-menu). +The sign feature basically signs the contract policy before the contract negotiation is done. The right contract policy must be selected by the user, otherwise the contract negotiation is aborted and user is returned back to the [Main Menu](../user/UserManual.md#main-menu). ![Agree Contract policy](../user%20manual/media/agreePolicy.png) @@ -194,12 +194,12 @@ In case the user want to see more details from the policy, it can be done by cli ![View Contract Policy](../user%20manual/media/viewPolicy.png) -The user accepts the right contract policy, and click on the **Agree** button which resumes the remaining negotiation and data transfer steps. In the end, the passport data is retrieved and displays to the user [Passport Page](../user%20manual/UserManual.md#passport-page). +The user accepts the right contract policy, and click on the **Agree** button which resumes the remaining negotiation and data transfer steps. In the end, the passport data is retrieved and displays to the user [Passport Page](../user/UserManual.md#passport-page). ![After Contract Policy Selection](../user%20manual/media/afterPolicySelection.png) #### Decline Contract -If a user is not permitted to accept a particular policy from his company, the contract policy can be declined in this case. The user will be redirected to the [Main Menu](../user%20manual/UserManual.md#main-menu). +If a user is not permitted to accept a particular policy from his company, the contract policy can be declined in this case. The user will be redirected to the [Main Menu](../user/UserManual.md#main-menu). ![Decline Contract Policy](../user%20manual/media/declinePolicy.png) diff --git a/docs/infrastructure as code/media/kics.png b/docs/infrastructure as code/media/kics.png deleted file mode 100644 index 501334c53..000000000 Binary files a/docs/infrastructure as code/media/kics.png and /dev/null differ diff --git a/docs/infrastructure as code/media/trivy.png b/docs/infrastructure as code/media/trivy.png deleted file mode 100644 index bd4a9f4a5..000000000 Binary files a/docs/infrastructure as code/media/trivy.png and /dev/null differ diff --git a/docs/business statement/BusinessStatement.md b/docs/interoperability/InteroperabilityGuide.md similarity index 70% rename from docs/business statement/BusinessStatement.md rename to docs/interoperability/InteroperabilityGuide.md index 89077aff7..0759df153 100644 --- a/docs/business statement/BusinessStatement.md +++ b/docs/interoperability/InteroperabilityGuide.md @@ -24,9 +24,8 @@ # Digital Product Passport Application ->Some links might not be accesible as they lead to a private confluence. If you need access please reach out to the dev Team and request what information you need for what reason. -The Product Passport Application enables the user to retrieve detailed information for a given product. The product can be looked up via ID or via a QR Code which is printed on the product. +The Digital Product Passport (DPP) Application enables the user to retrieve detailed information for a given product. The product can be looked up via ID or via a QR Code which is printed on the product. This first version of the Product Passport Application is focusing exclusively on the battery: @@ -35,7 +34,7 @@ The Passport itself is defined by the usage of Catena-X shared services, a stand ## Persona: -The Viewer App can be used from different personas: +The DPP App can be used from different personas: * Supplier * Car Producer @@ -69,21 +68,26 @@ BMW, CGI and Henkel have jointly decided to initiate and drive the topic of data ## Business Semantic Alignment -The business semantic alignment is limited to the business domain sustainability. The main goal of this app is to visualize the product pass and in the first step the battery pass. The data model for the battery pass was developed within the material pass team and is a candidate for standardization. Other data models are currently not neccesary. +The business semantic alignment is limited to the business domain sustainability/circular economy. The main goal of this app is to visualize the digital product pass and in the first step the battery pass and transmission pass. The data models for the battery pass, digital product pass and transmission pass were made by the digital product pass team and are standardized in Catena-X. ## Mapping against Catena-X Architecture Framework -The Product Passport Viewer App is using the following standardization candidates: +Which standardization candidates are you intending to use in your scenario, which ones did you decide not to use? -* Battery Passport -* Digital Product Passport -* Transmission Passport +The Digital Product Passport App is using the following standardization candidates: + +* Battery Passport (For Release 24.05 version 5.0.0 of the Battery Pass is used) → https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.battery.battery_pass/5.0.0 +* Digital Product Passport (For Release 24.05 version 4.0.0 of the DPP is used) → https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.generic.digital_product_passport/4.0.0 +* Gearbox/Transmission Passport (For Release 24.05 version 1.0.0 of the Transmission Pass is used) ->https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.transmission.transmission_pass/1.0.0 The following candidates are not yet implemented: * Sealant Passport, Tire Passport * E-Drive +## Technical Integration Design + +The technical integration design can be found in the [arc42 documentation](../architecture/Arc42.md) ## NOTICE diff --git a/docs/interoperability/media/graphArchitectureFunctionalCut.svg b/docs/interoperability/media/graphArchitectureFunctionalCut.svg new file mode 100644 index 000000000..6403627f8 --- /dev/null +++ b/docs/interoperability/media/graphArchitectureFunctionalCut.svg @@ -0,0 +1,4 @@ + + + +
User
User
Digital Product Pass App
Digital Product Pass App
Catena-X (Network)
Catena-X (Network)
User Interace
User Interace
Authentification
Authentification
EDC Connection
EDC Connection
Data Contract Validation
Data Contract Valida...
Policies Validation
Policies Validation
Data Transmission
Data Transmission
Data Provisioning
Data ProvisioningText is not SVG - cannot display \ No newline at end of file diff --git a/docs/interoperability/media/graphBusinessProblem.svg b/docs/interoperability/media/graphBusinessProblem.svg new file mode 100644 index 000000000..d3124c29d --- /dev/null +++ b/docs/interoperability/media/graphBusinessProblem.svg @@ -0,0 +1,4 @@ + + + +
Digital Product Pass App
Digital Product...
Load Passport
Load Passport
User
User
Scan QR Code / Insert Serialized ID
Scan QR Code / Inser...
User is logged on
User is lo...
Catena-X
Catena-X
yes
yes
Passport
found?
Passport...
Request authorized?
Request authori...
Return Battery Pass, Digital Product Pass or Transmission Pass
Return Battery Pass,...
Display Battery Pass, Digital Product Pass or Transmission Pass
Display Battery Pass...
Show Error Message
Show Error Message
Retrieve Information from Battery Pass, Digital Product Pass or Transmission Pass
Retrieve Information...
yes
yes
no
noText is not SVG - cannot display \ No newline at end of file diff --git a/docs/infrastructure as code/IaC.md b/docs/security/infrastructure-as-code/IaC.md similarity index 56% rename from docs/infrastructure as code/IaC.md rename to docs/security/infrastructure-as-code/IaC.md index 80ea18450..8b85b9117 100644 --- a/docs/infrastructure as code/IaC.md +++ b/docs/security/infrastructure-as-code/IaC.md @@ -23,50 +23,57 @@ --> ## Infrastructure As Code (IaC) with KICS -This tool intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github. It is integrated as GitHub action into the repository workflows [KICS](../.github/workflows/kics.yml) and also a successor of Checkov. IaC must be scanned via nightly GitHub action and High/critical error findings are not accepted. +This tool intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github. It is integrated as GitHub action into the repository workflows [KICS](../../../.github/workflows/kics.yml) and also a successor of Checkov. IaC must be scanned via nightly GitHub action and High/critical error findings are not accepted. -To integrate KICS into a repository, please see its [documentation](https://catenax-ng.github.io/docs/security/how-to-integrate-kics). +To integrate KICS into a repository, please see its [documentation](https://eclipse-tractusx.github.io/docs/release/trg-8/trg-8-02). ### Results Since, it is triggered via nnightly build daily, the below output is taken from one of the jobs history. -![IaC with KICS](./media/kics.png) +![IaC with KICS](./media/output-kics.png) -Complete history can be seen [here](https://github.com/catenax-ng/product-battery-passport-consumer-app/actions/workflows/kics.yml) +Complete history can be seen [here](https://github.com/eclipse-tractusx/digital-product-pass/actions/workflows/kics.yml) ## Container Scan with Trivy -This tool intends to find security vulnerabilities by scanning the container images and upload results to the github security tab. Similar to KICS, it is also integrated as GitHub action [Trivy](../.github/workflows/trivy.yml) and triggerd via nightly build. All containers in GitHub Packages must be scanned and High/critical error findings are not accepted. +This tool intends to find security vulnerabilities by scanning the container images and upload results to the github security tab. Similar to KICS, it is also integrated as GitHub action [Trivy](../../../.github/workflows/trivy.yml) and triggerd via nightly build. All containers in GitHub Packages must be scanned and High/critical error findings are not accepted. -To integrate Trivy into a repository, please see its [documentation](https://catenax-ng.github.io/docs/security/how-to-integrate-trivy). +To integrate Trivy into a repository, please see its [documentation](https://eclipse-tractusx.github.io/docs/release/trg-8/trg-8-04). ### Results Since, it is triggered as a build every night, the below output is taken from one of the jobs history. -![Scan containers with Trivy](./media/trivy.png) +#### Backend Scanning +![Scan backend container with Trivy](./media/output-trivy-backend.png) -Complete history can be seen [here](https://github.com/catenax-ng/product-battery-passport-consumer-app/actions/workflows/trivy.yml) +#### Frontend Scanning + +![Scan frontend container with Trivy](./media/output-trivy-frontend.png) + +Complete history can be seen [here](https://github.com/eclipse-tractusx/digital-product-pass/actions/workflows/trivy.yml) ## Static Application Serucity Testing -The static application security testing is performed by Veracode tool through GitHub actions. -Code must be scanned weekly with Veracode tool, medium risks require mitigation statement, high and above not accepted. +The static application security testing is performed by CodeQL tool through GitHub actions. +Code must be scanned weekly with CodeQL tool, medium risks require mitigation statement, high and above not accepted. -### Veracode Static Analysis pipeline Scan +### CodeQL Code Analysis -It performs code analysis in the pipeline, show results and feedback once pipeline is finished. It helps for pull requests to know about very high/high security findings prior to merging code. This job is optional at the moment. +It builds, package up the code and performs code analysis to the CodeQL platform. It helps for pull requests to know about very high/high security findings prior to merging code. It is one of the important jobs, and must be aligned to the quality gate requirements. -### Veracode Upload and Scan +To integrate CodeQL into a repository, please see its [documentation](https://eclipse-tractusx.github.io/docs/release/trg-8/trg-8-01). + +### Results +![Code analysis with CodeQL](./media/output-codeql.png) -It builds, package up the code and upload results to the [veracode platform](https://analysiscenter.veracode.com). It is one of the important jobs, and must be aligned to the quality gate requirements. -Please see more details about Veracode tool integration [here](https://catenax-ng.github.io/docs/security/how-to-integrate-veracode). +Complete history can be seen [here](https://github.com/eclipse-tractusx/digital-product-pass/actions/workflows/codeql.yaml) ## NOTICE diff --git a/docs/security/infrastructure-as-code/media/output-codeql.png b/docs/security/infrastructure-as-code/media/output-codeql.png new file mode 100644 index 000000000..9a44aed9c Binary files /dev/null and b/docs/security/infrastructure-as-code/media/output-codeql.png differ diff --git a/docs/security/infrastructure-as-code/media/output-kics.png b/docs/security/infrastructure-as-code/media/output-kics.png new file mode 100644 index 000000000..578ac86b1 Binary files /dev/null and b/docs/security/infrastructure-as-code/media/output-kics.png differ diff --git a/docs/security/infrastructure-as-code/media/output-trivy-backend.png b/docs/security/infrastructure-as-code/media/output-trivy-backend.png new file mode 100644 index 000000000..7c9a2f8cc Binary files /dev/null and b/docs/security/infrastructure-as-code/media/output-trivy-backend.png differ diff --git a/docs/security/infrastructure-as-code/media/output-trivy-frontend.png b/docs/security/infrastructure-as-code/media/output-trivy-frontend.png new file mode 100644 index 000000000..e598907ee Binary files /dev/null and b/docs/security/infrastructure-as-code/media/output-trivy-frontend.png differ diff --git a/docs/secrets management/SECRETS_MANAGEMENT.md b/docs/security/secrets-management/SecretsManagement.md similarity index 72% rename from docs/secrets management/SECRETS_MANAGEMENT.md rename to docs/security/secrets-management/SecretsManagement.md index 3a9d4b433..d59090284 100644 --- a/docs/secrets management/SECRETS_MANAGEMENT.md +++ b/docs/security/secrets-management/SecretsManagement.md @@ -22,28 +22,27 @@ SPDX-License-Identifier: Apache-2.0 --> -## Secrets management with CX HashiCorp Vault and ArgoCD Vault Plugin (AVP) +## Secrets management with HashiCorp Vault Service The client credentials, database passwords, access tokens are considered as secrets and they are usually kept in a vault. CatenaX have a central Hashicorp vault component to store these types of secrets and credentails to prevant from revealing them in a public source code repository to ensure security. These secrets are then utilized by Kubernetes resources through helm charts in a safe and secure manner. -ArgoCD access these secrets through vault plugins **(avp)** which solves the secret management issues with GitOps. Vault plugin internally uses a special vault token for authentication, retrieve actual secret values against their keys and subsitute them in a deployment. +At the time of writing this guide, ArgoCD was used to deploy the application. It accesses the secrets through its built-in vault plugins which solves the secret management issues with GitOps. Vault plugin internally uses a special vault token for authentication, retrieve actual secret values against their keys and subsitute them in a deployment. Further read about ArgoCD valut plugin here: [ArgoCD vault plugin](https://argocd-vault-plugin.readthedocs.io/en/stable/) -MaterialPass team is allocated a vault space at [CX HashiCorp Vault - Material Pass ](https://vault.demo.catena-x.net/ui/vault/secrets/material-pass/list). +MaterialPass team is allocated a vault space at [HashiCorp Vault - Material Pass ](https://vault.demo.catena-x.net/ui/vault/secrets/material-pass/list). To access a material pass vault space, a vault token is required Vault contents: -- **ids-daps_key** -- **ids_daps_crt** -- **int/** (directory used for integration environment) -- **dev/** (directory used for development purposes) -- **beta/** (directory used for beta environment) -- **int-client-secret** -- **dev-client-secret** -- **beta-client-secret** -- **edc-encryption-key** +- **edc/oauth#api.key** +- **edc/participant#bpnNumber** +- **backend/#signKey** +- **backend#clientId** +- **backend#clientSecret** +- **oauth#realm** +- **oauth#appId** +- **oauth#xApiKey** To put a secret from vault, a special pattern is followed in helm values files: @@ -65,13 +64,22 @@ To use a vault and create new secret, please look here: [how to-use vault create ### Using Docker -If consumer frontend is run using docker, the following environment variables must be set in [build and deploy script](../../dpp-frontend/buildAndDeploy.sh): +If dpp frontend is run using docker, the following environment variables must be set in [build and deploy script](../../../dpp-frontend/buildAndDeploy.sh): -- PASS_VERSION - APP_VERSION -- APP_API_TIMEOUT - APP_API_MAX_RETRIES +- API_SEARCH_TIMEOUT +- API_NEGOTIATE_TIMEOUT +- API_DECLINE_TIMEOUT - APP_API_DELAY +- REPO_COMMIT_ID +- REPO_ENDPOINT_URL +- AUTH_ROLE_CHECK +- AUTH_BPN_CHECK +- AUTH_BPN_NUMBER +- APP_PORTAL_URL +- APP_ADMIN_EMAIL +- APP_AUTO_SIGN - IDENTITY_PROVIDER_URL - HOST_URL - DATA_URL @@ -95,7 +103,7 @@ Further info about vault plugin for helm charts: [argocd-vault-plugin-helm](http ## Secrets Scanning ### Veracode -Veracode upload-and-scan is used for secret scanning and scan results are then published in veracode dashboard once job is completed [Static Application Serucity Testing](./IaC.md) +Veracode upload-and-scan is used for secret scanning and scan results are then published in veracode dashboard once job is completed [Static Application Serucity Testing](../infrastructure-as-code/IaC.md) ### Git Guardian @@ -111,12 +119,11 @@ A client-side git hook similar to pre-commit hook that runs right before code ch GitGuardian hooks are performed through ggshield utility. ggshield is a wrapper around GitGuardian API for secrets detection that requires an API key to work. Please refer the official documentation for more information [here](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit) -The git hooks for this repository are set up in [yaml file](../pre-commit-config.yaml) - - - -Setting up Git Guradian for the project [gitguardian-shield](https://docs.gitguardian.com/ggshield-docs/getting-started) +#### Links +- Setting up Git Guradian for the project: [gitguardian-shield](https://docs.gitguardian.com/ggshield-docs/getting-started) +- The git hooks for the repository: [yaml file](../../../pre-commit-config.yaml) +- Release Guidelines requirements: [here](https://eclipse-tractusx.github.io/docs/release/trg-8/trg-8-03) ## NOTICE diff --git a/docs/user manual/UserManual.md b/docs/user/UserManual.md similarity index 99% rename from docs/user manual/UserManual.md rename to docs/user/UserManual.md index 60743305c..23f82dd32 100644 --- a/docs/user manual/UserManual.md +++ b/docs/user/UserManual.md @@ -225,5 +225,6 @@ This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LIC - 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 diff --git a/docs/user manual/media/afterPolicySelection.png b/docs/user/media/afterPolicySelection.png similarity index 100% rename from docs/user manual/media/afterPolicySelection.png rename to docs/user/media/afterPolicySelection.png diff --git a/docs/user manual/media/agreePolicy.png b/docs/user/media/agreePolicy.png similarity index 100% rename from docs/user manual/media/agreePolicy.png rename to docs/user/media/agreePolicy.png diff --git a/docs/user manual/media/aspectNotSupported.png b/docs/user/media/aspectNotSupported.png similarity index 100% rename from docs/user manual/media/aspectNotSupported.png rename to docs/user/media/aspectNotSupported.png diff --git a/docs/user manual/media/beforePolicySelection.png b/docs/user/media/beforePolicySelection.png similarity index 100% rename from docs/user manual/media/beforePolicySelection.png rename to docs/user/media/beforePolicySelection.png diff --git a/docs/user manual/media/declinePolicy.png b/docs/user/media/declinePolicy.png similarity index 100% rename from docs/user manual/media/declinePolicy.png rename to docs/user/media/declinePolicy.png diff --git a/docs/user manual/media/irs.png b/docs/user/media/irs.png similarity index 100% rename from docs/user manual/media/irs.png rename to docs/user/media/irs.png diff --git a/docs/user manual/media/irsJob.png b/docs/user/media/irsJob.png similarity index 100% rename from docs/user manual/media/irsJob.png rename to docs/user/media/irsJob.png diff --git a/docs/user manual/media/loadingPass.png b/docs/user/media/loadingPass.png similarity index 100% rename from docs/user manual/media/loadingPass.png rename to docs/user/media/loadingPass.png diff --git a/docs/user manual/media/mainMenu.png b/docs/user/media/mainMenu.png similarity index 100% rename from docs/user manual/media/mainMenu.png rename to docs/user/media/mainMenu.png diff --git a/docs/user manual/media/notAuthorized.png b/docs/user/media/notAuthorized.png similarity index 100% rename from docs/user manual/media/notAuthorized.png rename to docs/user/media/notAuthorized.png diff --git a/docs/user manual/media/productPassport.png b/docs/user/media/productPassport.png similarity index 100% rename from docs/user manual/media/productPassport.png rename to docs/user/media/productPassport.png diff --git a/docs/user manual/media/scanPassport.png b/docs/user/media/scanPassport.png similarity index 100% rename from docs/user manual/media/scanPassport.png rename to docs/user/media/scanPassport.png diff --git a/docs/user manual/media/userProfile.png b/docs/user/media/userProfile.png similarity index 100% rename from docs/user manual/media/userProfile.png rename to docs/user/media/userProfile.png diff --git a/docs/user manual/media/viewPolicy.png b/docs/user/media/viewPolicy.png similarity index 100% rename from docs/user manual/media/viewPolicy.png rename to docs/user/media/viewPolicy.png diff --git a/dpp-backend/charts/digital-product-pass-backend/values-dev.yaml b/dpp-backend/charts/digital-product-pass-backend/values-dev.yaml deleted file mode 100644 index 4f4dc3695..000000000 --- a/dpp-backend/charts/digital-product-pass-backend/values-dev.yaml +++ /dev/null @@ -1,76 +0,0 @@ -################################################################################# -# Tractus-X - Digital Product Passport Application -# -# Copyright (c) 2022, 2024 BMW AG, Henkel AG & Co. KGaA -# Copyright (c) 2023, 2024 CGI Deutschland B.V. & Co. KG -# Copyright (c) 2022, 2024 Contributors to the Eclipse Foundation -# -# See the NOTICE file(s) distributed with this work for additional -# information regarding copyright ownership. -# -# This program and the accompanying materials are made available under the -# terms of the Apache License, Version 2.0 which is available at -# https://www.apache.org/licenses/LICENSE-2.0. -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, -# either express or implied. See the -# License for the specific language govern in permissions and limitations -# under the License. -# -# SPDX-License-Identifier: Apache-2.0 -################################################################################# - -ingress: - enabled: true - # className: "nginx" - annotations: - ingressClassName: nginx - # kubernetes.io/tls-acme: "true" - nginx.ingress.kubernetes.io/force-ssl-redirect: "true" - nginx.ingress.kubernetes.io/ssl-passthrough: "false" - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: &hostname "dpp-backend.dev.demo.catena-x.net" - paths: - - path: / - pathType: Prefix - tls: - - secretName: tls-secret - hosts: - - *hostname - -edc: - xApiKey: - participantId: &bpn - endpoint: "materialpass.dev.demo.catena-x.net/consumer" - -hostname: *hostname - -securityCheck: - bpn: true - edc: true - -irs: - enabled: true - hostname: "materialpass-irs.dev.demo.catena-x.net" - -process: - encryptionKey: "" - -discovery: - hostname: "semantics.dev.demo.catena-x.net/discoveryfinder" - -oauth: - hostname: "centralidp.int.demo.catena-x.net" - techUser: - clientId: - clientSecret: - realm: - appId: - bpnCheck: - enabled: true - bpn: *bpn - roleCheck: - enabled: false diff --git a/dpp-backend/charts/digital-product-pass-backend/values.yaml b/dpp-backend/charts/digital-product-pass-backend/values.yaml index 7bb62806e..a69d0735c 100644 --- a/dpp-backend/charts/digital-product-pass-backend/values.yaml +++ b/dpp-backend/charts/digital-product-pass-backend/values.yaml @@ -34,7 +34,7 @@ fullnameOverride: "" image: repository: docker.io/tractusx/digital-product-pass-backend - pullPolicy: Always + pullPolicy: IfNotPresent # -- Existing image pull secret to use to [obtain the container image from private registries](https://kubernetes.io/docs/concepts/containers/images/#using-a-private-registry) imagePullSecrets: [] @@ -48,7 +48,7 @@ service: ingress: enabled: false hosts: - - host: &hostname "localhost" + - host: &hostname "" paths: - path: / pathType: Prefix diff --git a/dpp-frontend/src/components/general/Header.vue b/dpp-frontend/src/components/general/Header.vue index b2c96252a..36d35c9af 100644 --- a/dpp-frontend/src/components/general/Header.vue +++ b/dpp-frontend/src/components/general/Header.vue @@ -38,19 +38,11 @@ - + - + - {{ $t("header.helpBtn") }} {{ $t("header.helpTooltip") }} @@ -58,17 +50,10 @@ - +
@@ -77,14 +62,8 @@

{{ role }}

- - {{ - $t("header.signOut") - }} + + {{ $t("header.signOut") }}