Skip to content

Commit

Permalink
Merge pull request #157 from catenax-ng/release/v2.0.0-arc42-update
Browse files Browse the repository at this point in the history
[4º] - Release/v2.0.0 arc42 update: Updated the Arc42 and created the data retrieval guide
  • Loading branch information
matbmoser authored Dec 22, 2023
2 parents a994911 + 872c541 commit cd820e7
Show file tree
Hide file tree
Showing 105 changed files with 10,468 additions and 564 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,8 @@ target

*.tgz
.tgz
tgz
tgz

## Backup Files
*.bck
*.bak
10 changes: 9 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,18 @@ You must have [Helm](https://helm.sh/), [Minikube](https://minikube.sigs.k8s.io

## Install

### First Step: Configuration

First configure the [`values.yaml`](./charts/digital-product-pass/values.yaml) file with the secrets and the necessary configuration for starting the application correctly.

> **TIP**: For a correct Catena-X integration get the correct credentials from the Portal! You can also place this secrets in a Vault so that the credentials are safe!
### Second Step: Deployment

To install the application using the configured helm charts use the following command from the project root directory:

```bash
helm install digital-product-pass ./charts/digital-product-pass -f charts/digital-product-pass/values.yaml -f charts/digital-product-pass/values-int.yaml
helm install digital-product-pass ./charts/digital-product-pass -f charts/digital-product-pass/values.yaml
```

> **NOTE**: This command will deploy the complete application.
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,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/GraphicBatteryPassportViewGeneralInfo.png)
![General Info View](./docs/arc42/media/GraphicBatteryPassportViewGeneralInfo.png)

> **Note**: For more information check the [documentation section](./docs/README.md)
Expand All @@ -56,6 +56,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](./consumer-backend/productpass/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 |
Expand Down
1,377 changes: 816 additions & 561 deletions docs/arc42/Arc42.md

Large diffs are not rendered by default.

Binary file removed docs/arc42/CancelFlow.jpeg
Binary file not shown.
Binary file removed docs/arc42/CreateAPI.jpeg
Binary file not shown.
Binary file removed docs/arc42/CreateProcessFlow.jpeg
Binary file not shown.
Binary file removed docs/arc42/DeclineFlow.jpeg
Binary file not shown.
Binary file removed docs/arc42/GetStatus.jpeg
Binary file not shown.
Binary file removed docs/arc42/GraphicBatteryPassportView.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/arc42/GraphicRuntimeView.png
Binary file not shown.
Binary file removed docs/arc42/PassportRetrievalFlow.jpeg
Binary file not shown.
Binary file removed docs/arc42/SearchAPI.jpeg
Binary file not shown.
Binary file removed docs/arc42/SearchFlow.jpeg
Binary file not shown.
Binary file removed docs/arc42/SignAPI.jpeg
Binary file not shown.
Binary file removed docs/arc42/SignFlow.jpeg
Binary file not shown.
Binary file removed docs/arc42/StateDiagram.jpeg
Binary file not shown.
Binary file removed docs/arc42/TechnicalIntegrationResume.jpeg
Binary file not shown.
File renamed without changes
File renamed without changes
Binary file added docs/arc42/media/DPPView1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/arc42/media/DPPView2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/arc42/media/GraphicBatteryPassportView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/arc42/media/auth/authenticationFlow.jpg
Binary file added docs/arc42/media/dataRetrieval/agreeApiFlow.jpg
Binary file added docs/arc42/media/dataRetrieval/cancelApiFlow.jpg
Binary file added docs/arc42/media/dataRetrieval/cancelFlowApi.jpg
Binary file added docs/arc42/media/dataRetrieval/createApiFlow.jpg
Binary file added docs/arc42/media/dataRetrieval/dataApiFlow.jpg
Binary file added docs/arc42/media/dataRetrieval/declineApiFlow.jpg
Binary file added docs/arc42/media/dataRetrieval/searchApiFlow.jpg
Binary file added docs/arc42/media/dataRetrieval/userFlow.jpg
197 changes: 197 additions & 0 deletions docs/arc42/media/diagrams/agreeApiFlow.drawio.xml

Large diffs are not rendered by default.

634 changes: 634 additions & 0 deletions docs/arc42/media/diagrams/agreeApiSequence.drawio.xml

Large diffs are not rendered by default.

659 changes: 659 additions & 0 deletions docs/arc42/media/diagrams/authenticationFlow.drawio.xml

Large diffs are not rendered by default.

87 changes: 87 additions & 0 deletions docs/arc42/media/diagrams/cancelApiFlow.drawio.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<?xml version="1.0" encoding="UTF-8"?>
<mxfile host="confluence.catena-x.net" modified="2023-11-22T12:11:28.106Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36" etag="pjpheaTrWyfJc9TDJtpe" version="21.6.8" type="atlas">
<diagram id="RrzvB8BrPyg7ILuAO5EA" name="Page-1">
<mxGraphModel dx="2234" dy="864" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="NzVJY4d6P1EwE6PzjqN9-5" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="NzVJY4d6P1EwE6PzjqN9-2" target="NzVJY4d6P1EwE6PzjqN9-4" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-2" value="" style="strokeWidth=2;html=1;shape=mxgraph.flowchart.start_2;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="-690" y="367.5" width="30" height="30" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-9" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;" parent="1" source="NzVJY4d6P1EwE6PzjqN9-3" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="-160" y="383" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;exitPerimeter=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="NzVJY4d6P1EwE6PzjqN9-3" target="NzVJY4d6P1EwE6PzjqN9-12" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-3" value="Does processId exists &lt;br&gt;and sign token is valid?" style="strokeWidth=2;html=1;shape=mxgraph.flowchart.decision;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="-410" y="332.5" width="210" height="100" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-6" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="NzVJY4d6P1EwE6PzjqN9-4" target="NzVJY4d6P1EwE6PzjqN9-3" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-4" value="/cancel&lt;br&gt;is called" style="rounded=1;whiteSpace=wrap;html=1;absoluteArcSize=1;arcSize=14;strokeWidth=2;" parent="1" vertex="1">
<mxGeometry x="-600" y="350" width="150" height="65" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-8" value="" style="strokeWidth=2;html=1;shape=mxgraph.flowchart.start_2;whiteSpace=wrap;fillColor=#000000;" parent="1" vertex="1">
<mxGeometry x="554" y="367.5" width="30" height="30" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="NzVJY4d6P1EwE6PzjqN9-12" target="NzVJY4d6P1EwE6PzjqN9-8" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-12" value="Fail with error" style="rounded=1;whiteSpace=wrap;html=1;absoluteArcSize=1;arcSize=14;strokeWidth=2;" parent="1" vertex="1">
<mxGeometry x="374" y="440" width="150" height="65" as="geometry" />
</mxCell>
<mxCell id="NzVJY4d6P1EwE6PzjqN9-14" value="No" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="-350" y="432.5" width="40" height="30" as="geometry" />
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-7" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;exitPerimeter=0;" parent="1" source="ul9yC1-Y8u_IhuCL7Q6E-2" target="NzVJY4d6P1EwE6PzjqN9-12" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="PNFCjHKm92M3_J8GO2mC-2" target="ul9yC1-Y8u_IhuCL7Q6E-9" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="334" y="382.5" as="sourcePoint" />
</mxGeometry>
</mxCell>
<mxCell id="PNFCjHKm92M3_J8GO2mC-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;exitPerimeter=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="ul9yC1-Y8u_IhuCL7Q6E-2" target="PNFCjHKm92M3_J8GO2mC-2" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-2" value="Was the process &lt;br&gt;already&amp;nbsp;&lt;br&gt;&amp;nbsp;canceled, signed &lt;br&gt;or&amp;nbsp; declined?" style="strokeWidth=2;html=1;shape=mxgraph.flowchart.decision;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="-160" y="332.5" width="210" height="100" as="geometry" />
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-4" value="Yes" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="-100" y="432.5" width="40" height="30" as="geometry" />
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-5" value="Yes" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="-200" y="350" width="40" height="30" as="geometry" />
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-12" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="ul9yC1-Y8u_IhuCL7Q6E-9" target="NzVJY4d6P1EwE6PzjqN9-8" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-9" value="Cancel the Negotiation&lt;br&gt;and return confirmation" style="rounded=1;whiteSpace=wrap;html=1;absoluteArcSize=1;arcSize=14;strokeWidth=2;" parent="1" vertex="1">
<mxGeometry x="374" y="350" width="150" height="65" as="geometry" />
</mxCell>
<mxCell id="ul9yC1-Y8u_IhuCL7Q6E-11" value="No" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="320" y="350" width="40" height="30" as="geometry" />
</mxCell>
<mxCell id="PNFCjHKm92M3_J8GO2mC-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;exitPerimeter=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="PNFCjHKm92M3_J8GO2mC-2" target="NzVJY4d6P1EwE6PzjqN9-12" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="PNFCjHKm92M3_J8GO2mC-2" value="Has the process finished&lt;br&gt;the negotiation?" style="strokeWidth=2;html=1;shape=mxgraph.flowchart.decision;whiteSpace=wrap;" parent="1" vertex="1">
<mxGeometry x="100" y="332.5" width="210" height="100" as="geometry" />
</mxCell>
<mxCell id="PNFCjHKm92M3_J8GO2mC-5" value="Yes" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="160" y="432.5" width="40" height="30" as="geometry" />
</mxCell>
<mxCell id="PNFCjHKm92M3_J8GO2mC-7" value="No" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="50" y="350" width="40" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Loading

0 comments on commit cd820e7

Please sign in to comment.