Merge pull request eclipse-tractusx#529 from catenax-ng/feature/TRI-1…

…585-up-to-date-component-diagram feat(docs):[TRI-1585] Add missing components to building block view
ds-jhartmann · Sep 15, 2023 · c984dbc · c984dbc
2 parents 0af5bb2 + 4d52e59
commit c984dbc
Show file tree

Hide file tree

Showing 16 changed files with 147 additions and 39 deletions.
diff --git a/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc b/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc
@@ -31,4 +31,72 @@ include::../../../uml-diagrams/building-block-view/whitebox_overall_decentral.pu
 
 |MIW
 |Managed Identity Wallet as Self-Sovereign-Identity Provider for EDC
-|===
+
+|Discovery Finder
+|The Discovery Finder is used to get the EDC Discovery Endpoint for a certain type of identification, e.g. BPNL.
+
+|EDC Discovery
+|The EDC Discovery Service is used to get EDC endpoints for a certain BPNL.
+
+|Semantic Hub
+|Semantic Hub provides information about semantic models in a specific version. This also includes JSON schemas, which IRS uses to validate the payload received by data providers.
+
+|BPDM
+|The Business Partner Data Management (BPDM) Service is used by the IRS to access shared business partner data for BPNs of Data Providers along the supply chain.
+|===
+
+
+|===
+|Number |Description
+
+| 01
+| IrsApiConsumer calls the **IRS** public **API**
+
+| 02
+| IrsApiConsumer must authorize using **technical C-X User**
+
+| 03
+| Delegate authorization request to **IdP**
+
+| 04
+| IRS requesting for **SubmodelAspects** using **EDC**
+
+| 05
+| IRS requesting the **decentral DigitalTwinRegistry** over **EDC** and service discovery flow
+
+| 06
+| IRS uses EDC to ensure sovereign data consumption
+
+| 07
+| IRS MUST authorize at central IAM
+
+| 08
+| IRS lookup for EDC Provider by given BPNs over the **EDC Discovery Service**
+
+| 09
+| IRS lookup for **EDC Discovery Services** by given type <BPN> over the **Discovery Finder**
+
+| 10
+| IRS uses **Semantic Hub** to validate of **SubmodelAspects** payloads agains the schema provided in **Semantic Hub**
+
+| 11
+| In case "lookupBPNs" is active IRS provides a lookup of company for given BPN
+
+| 12
+| **EDC** is connected to **Managed Identity Wallet** for access policy check for data offers
+
+| 13
+| **EDC** communication covering negotiation and data consumption
+
+| 14
+| **EDC** is connected to **Managed Identity Wallet** for access policy check for data offers
+
+| 15
+| **IRS** accessing to **SubmodelServer** on Tier Level using the **EDC**
+
+| 16
+| **IRS** accessing the **decentral DigitalTwinRegistry** on Tier Level using the **EDC**
+|===
+
+
+
diff --git a/docs/src/uml-diagrams/building-block-view/building-block-view.puml b/docs/src/uml-diagrams/building-block-view/building-block-view.puml
@@ -1,6 +1,9 @@
 @startuml
 skinparam monochrome true
 skinparam shadowing false
+skinparam linetype ortho
+skinparam defaultFontName "Architects daughter"
+
 
  component [**IRS-Application**] <<System>> as IRS {
     component [**RecursiveJobHandler**] <<Component>> as RecursiveJobHandler

diff --git a/docs/src/uml-diagrams/building-block-view/level-2-int-recursive-job-handler.puml b/docs/src/uml-diagrams/building-block-view/level-2-int-recursive-job-handler.puml
@@ -1,6 +1,8 @@
 @startuml
 skinparam monochrome true
 skinparam shadowing false
+skinparam linetype ortho
+skinparam defaultFontName "Architects daughter"
 
  component [**RecursiveJobHandler**] <<Component>> as RecursiveJobHandler {
     component [**AASRecursiveJobHandler**] <<Component>> as AASRecursiveJobHandler

diff --git a/docs/src/uml-diagrams/building-block-view/level-2-int-transfer-process-management.puml b/docs/src/uml-diagrams/building-block-view/level-2-int-transfer-process-management.puml
@@ -3,6 +3,8 @@ skinparam monochrome true
 skinparam shadowing false
 skinparam nodesep 10
 skinparam ranksep 100
+skinparam linetype ortho
+skinparam defaultFontName "Architects daughter"
 
 
 component [**TransferProcessManagement**] <<Component>> as TransferProcessManagement {

diff --git a/docs/src/uml-diagrams/building-block-view/level-2-int.puml b/docs/src/uml-diagrams/building-block-view/level-2-int.puml
@@ -1,6 +1,8 @@
 @startuml
 skinparam monochrome true
 skinparam shadowing false
+skinparam linetype ortho
+skinparam defaultFontName "Architects daughter"
 
  component [**Controller**] <<System>> as Controller {
     component [**IrsController**] <<Component>> as IrsController

diff --git a/docs/src/uml-diagrams/building-block-view/whitebox_overall.puml b/docs/src/uml-diagrams/building-block-view/whitebox_overall.puml
@@ -2,6 +2,8 @@
 skinparam monochrome true
 skinparam shadowing false
 skinparam spacing 50
+skinparam linetype ortho
+skinparam defaultFontName "Architects daughter"
 
 
 component [**IRSApplication**] <<System>> {

diff --git a/docs/src/uml-diagrams/building-block-view/whitebox_overall_decentral.puml b/docs/src/uml-diagrams/building-block-view/whitebox_overall_decentral.puml
@@ -2,51 +2,67 @@
 skinparam monochrome true
 skinparam shadowing false
 skinparam spacing 50
+skinparam linetype ortho
+skinparam nodesep 150
+skinparam ranksep 150
+skinparam defaultFontName "Architects daughter"
 
 
-component [**IRSApplication**] <<System>> {
-	component [**IRS**] <<System>> as IRS
-	component [**EDC Consumer**] <<System>> as EDC
+package [**OEM**] <<CatenaX Company>> as consumer {
 
-}
+    package [**IRS-Application**] <<IRS System>> as irs_component {
+	    component [**IRS**] <<System>> as IRS
+	    component [**EDC (Consumer)**] <<System>> as EDC
+    }
+     component [**SubmodelServer**] <<System>> as SubmodelServerOEM
+     component [**decentral Digital Twin Registry**] <<System>> as DT_REG_OEM
 
-component [**CatenaX-Network**] <<CX-Environment>> {
-    component [**IAM/KeyCloak**] <<System>> as IAM_IRS
-    component [**MIW**] <<System>> as identity_wallet
 }
 
-component [**Tier/OEM**] <<Tier/OEM-Environment>> {
-
-    component [**EDC_Provider_OEM**] <<System>> as EDCProviderOEM
-    component [**EDC_Provider_Tier1**] <<System>> as EDCProviderTier1
-    component [**EDC_Provider_Tier1.1**] <<System>> as EDCProviderTier11
-    component [**SubmodelServer_OEM**] <<System>> as SubmodelServerOEM
-    component [**SubmodelServer_Tier1**] <<System>> as SubmodelServerTier1
-    component [**SubmodelServer_Tier1.1**] <<System>> as SubmodelServerTier11
-    component [**Digital Twin Registry_OEM**] <<System>> as DT_REGOEM
-    component [**Digital Twin Registry_Tier1**] <<System>> as DT_REG1
-    component [**Digital Twin Registry_Tier1.1**] <<System>> as DT_REG11
+package [**CatenaX-Network**] as network {
+    component [**Managed Identity Wallet**] <<System>> as miw
+    component [**Portal Application**] <<System>> as IAM_IRS
+    component [**Portal (IAM/IdP/KeyCloak)**] <<System>> as Portal_IdP
+    component [**EDC Discovery Service**] <<System>> as edc_discovery
+    component [**Discovery Finder**] <<System>> as discovery_finder
+    component [**Semantic Hub**] <<System>> as semantic_hub
+    component [**BPDM**] <<System>> as bpdm
 }
 
 
+
+
+package [**N-Tier**] <<CatenaX Data Provider Company>> as provider {
+    component [**EDC (Provider)**] <<System>> as EDCProvider
+    component [**SubmodelServer**] <<System>> as SubmodelServer
+    component [**decentral Digital Twin Registry**] <<System>> as DT_REG
+
+}
+
 actor IrsApiConsumer
 
-IrsApiConsumer -right(0- IRS
-IrsApiConsumer <.r.> IAM_IRS
-IRS <.d.> EDC
-IRS <.l.> IAM_IRS
-EDC <..> identity_wallet
-EDC <..> EDCProviderOEM
-EDC <...> EDCProviderTier1
-EDC <....> EDCProviderTier11
-identity_wallet <..> EDCProviderOEM
-identity_wallet <...> EDCProviderTier1
-identity_wallet <....> EDCProviderTier11
-EDCProviderOEM <..> SubmodelServerOEM
-EDCProviderTier1 <..> SubmodelServerTier1
-EDCProviderTier11 <..> SubmodelServerTier11
-EDCProviderOEM <..> DT_REGOEM
-EDCProviderTier1 <..> DT_REG1
-EDCProviderTier11 <..> DT_REG11
+IrsApiConsumer -left(0- IRS : **[01]**
+IrsApiConsumer <.r.> IAM_IRS  : **[02]**
+IAM_IRS  <..> Portal_IdP  : **[03]**
+EDC <-> SubmodelServerOEM  : **[04]**
+EDC <->  DT_REG_OEM  : **[05]**
+IRS <.d.> EDC  : **[06]**
+IRS <..> IAM_IRS : **[07]**
+IRS <..> edc_discovery  : **[08]**
+
+IRS <..> discovery_finder  : **[09]**
+IRS <..> semantic_hub  : **[10]**
+IRS <..> bpdm  : **[11]**
+EDC <..> miw  : **[12]**
+EDC <..> EDCProvider  : **[13]**
+
+miw <..> EDCProvider  : **[14]**
+EDCProvider <--> SubmodelServer : **[15]**
+EDCProvider <--> DT_REG : **[16]**
+
+miw -[hidden]d- IAM_IRS : **[17]**
+miw -[hidden]r- discovery_finder : **[18]**
+discovery_finder -[hidden]d- edc_discovery : **[19]**
+bpdm -[hidden]d- semantic_hub : **[20]**
 
 @enduml
diff --git a/docs/src/uml-diagrams/decentral-twin-registry/decentral-digital-registry-brief.puml b/docs/src/uml-diagrams/decentral-twin-registry/decentral-digital-registry-brief.puml
@@ -1,6 +1,7 @@
 @startuml
 skinparam monochrome true
 skinparam shadowing false
+skinparam defaultFontName "Architects daughter"
 
 
 autonumber "<b>[000]"

diff --git a/docs/src/uml-diagrams/decentral-twin-registry/decentral-digital-registry.puml b/docs/src/uml-diagrams/decentral-twin-registry/decentral-digital-registry.puml
@@ -1,6 +1,7 @@
 @startuml
 skinparam monochrome true
 skinparam shadowing false
+skinparam defaultFontName "Architects daughter"
 
 
 autonumber "<b>[000]"

diff --git a/docs/src/uml-diagrams/decentral-twin-registry/edc-service-discovery-cache.puml b/docs/src/uml-diagrams/decentral-twin-registry/edc-service-discovery-cache.puml
@@ -1,6 +1,7 @@
 @startuml
 skinparam monochrome true
 skinparam shadowing false
+skinparam defaultFontName "Architects daughter"
 
 
 autonumber "<b>[000]"

diff --git a/docs/src/uml-diagrams/deployment-view/deployment-chain.puml b/docs/src/uml-diagrams/deployment-view/deployment-chain.puml
@@ -3,6 +3,7 @@ skinparam monochrome true
 skinparam shadowing false
 skinparam nodesep 100
 skinparam ranksep 20
+skinparam defaultFontName "Architects daughter"
 
 node ArgoCD
 node GitHub

diff --git a/docs/src/uml-diagrams/deployment-view/level-0-dev.puml b/docs/src/uml-diagrams/deployment-view/level-0-dev.puml
@@ -3,6 +3,7 @@ skinparam monochrome true
 skinparam shadowing false
 skinparam nodesep 100
 skinparam ranksep 20
+skinparam defaultFontName "Architects daughter"
 
 cloud Keycloak
 

diff --git a/docs/src/uml-diagrams/deployment-view/level-0-int.puml b/docs/src/uml-diagrams/deployment-view/level-0-int.puml
@@ -3,6 +3,7 @@ skinparam monochrome true
 skinparam shadowing false
 skinparam nodesep 100
 skinparam ranksep 20
+skinparam defaultFontName "Architects daughter"
 
 cloud "Digital Twin Registry" as dtr
 cloud "EDC Providers" as providers

diff --git a/docs/src/uml-diagrams/deployment-view/level-0-isolated.puml b/docs/src/uml-diagrams/deployment-view/level-0-isolated.puml
@@ -3,6 +3,8 @@ skinparam monochrome true
 skinparam shadowing false
 skinparam nodesep 100
 skinparam ranksep 20
+skinparam defaultFontName "Architects daughter"
+skinparam linetype ortho
 
 
 node "Kubernetes Cluster" as k8s {
@@ -20,7 +22,7 @@ node "Kubernetes Cluster" as k8s {
     }
 
     component Keycloak
-    component "DAPS" as daps
+    component "Managed IdentityWallet" as MIW
 
     component "Discovery Service" as ds
     component "Semantic Hub" as semHub
@@ -30,8 +32,8 @@ node "Kubernetes Cluster" as k8s {
     IRS --> consumer
     IRS --> ds
 
-    daps ---> provider
-    daps ---> consumer
+    MIW ---> provider
+    MIW ---> consumer
 
     provider <-> consumer
 

diff --git a/docs/src/uml-diagrams/deployment-view/level-1.puml b/docs/src/uml-diagrams/deployment-view/level-1.puml
@@ -3,6 +3,7 @@ skinparam monochrome true
 skinparam shadowing false
 skinparam nodesep 100
 skinparam ranksep 20
+skinparam defaultFontName "Architects daughter"
 
 node IRS <<app>> {
 

diff --git a/docs/src/uml-diagrams/policy-store/policy-store-model.puml b/docs/src/uml-diagrams/policy-store/policy-store-model.puml
@@ -1,4 +1,8 @@
 @startuml
+skinparam monochrome true
+skinparam shadowing false
+skinparam nodesep 100
+skinparam ranksep 20
 'https://plantuml.com/class-diagram
 
 'https://www.w3.org/TR/odrl-model/'