Move arc42 doc to /architecure

eclipse-tractusx · Nov 14, 2024 · 964db6b · 964db6b
1 parent d737de6
commit 964db6b
Show file tree

Hide file tree

Showing 12 changed files with 78 additions and 92 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.5.2
+### Added
+### fixed
+- Change documentation folder structure
+
 ## 0.5.1
 ### Added
 ### fixed

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,26 @@
+<!--
+ * Copyright (c) 2024 Robert Bosch Manufacturing Solutions GmbH
+ * Copyright (c) 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 governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+-->
+
+# Introduction
+Following documentation is available:
+
+| Documentation                                   | Purpose                                              |
+|-------------------------------------------------|------------------------------------------------------|
+| [Arc42](architecture/)                  | Architecture documentation for the discovery finder. |
diff --git a/docs/1-introduction-and-goals.md → .../architecture/1-introduction-and-goals.md b/docs/1-introduction-and-goals.md → .../architecture/1-introduction-and-goals.md
@@ -28,10 +28,10 @@ The Discovery Finder is used to find an endpoint to a BPD Discovery for a certai
 
 | Role             | Description                                        | Goal, Intention                                             |
 |------------------|----------------------------------------------------|-------------------------------------------------------------|
-| Consumer         | uses a Discovery Finder                            | wants to find an Endpoint for a BPN Discovery to find a BPN |
-| Data Provider    |                                                    | wants that his EDC / Digital Twin can be found              |
+| Data Consumer    | The data consumer uses the Discovery Finder to search for endpoints for BPN Discoveries for a specific type.     | wants to find an Endpoint for a BPN Discovery to find a BPN |
+| Data Provider    | The data provider adds or deletes his endpoint at the Discovery Finder                                           | wants that his EDC / Digital Twin can be found              |
 | Catena-X network | provides the environment and operates the services | to enable the companies to connect and exchange data        |
-
+| Keycloak      | Keycloak is used for token validation                                                                        |                                                       |
 
 ### NOTICE
 

diff --git a/docs/2-architecture-constraints.md → ...rchitecture/2-architecture-constraints.md b/docs/2-architecture-constraints.md → ...rchitecture/2-architecture-constraints.md
diff --git a/docs/3-system-scope-and-context.md → ...rchitecture/3-system-scope-and-context.md b/docs/3-system-scope-and-context.md → ...rchitecture/3-system-scope-and-context.md
diff --git a/docs/4-runtime-view.md → docs/architecture/4-runtime-view.md b/docs/4-runtime-view.md → docs/architecture/4-runtime-view.md
diff --git a/docs/5-deployment-view.md → docs/architecture/5-deployment-view.md b/docs/5-deployment-view.md → docs/architecture/5-deployment-view.md
@@ -6,11 +6,8 @@ For Deployment needed:
 -   Kubernetes-Cluster
 -   Helm
 
-To deploy this system, you need to use the Helm Chart in a running
-Kubernetes cluster. The Helm Chart is located under
-"charts/discoveryfinder". In case you don't have a running cluster, you
-can set up one by yourself locally, using minikube. For further information
-checkout the [readme.md](https://github.com/eclipse-tractusx/sldt-discovery-finder/blob/main/README.md).
+To deploy this system, you need to use the Helm Chart in a running Kubernetes cluster. The Helm Chart is located under "charts/discoveryfinder". In case you don't have a running cluster, you
+can set up one by yourself locally, using minikube. For further information checkout the [README.md](../../README.md) and the [INSTALL.md](../../INSTALL.md).
 
 ### NOTICE
 

diff --git a/docs/6-concepts.md → docs/architecture/6-crosscutting-concepts.md b/docs/6-concepts.md → docs/architecture/6-crosscutting-concepts.md
@@ -1,4 +1,4 @@
-## 6 Concept
+## 6 Crosscutting Concept
 
 ### Overall Concept
 
@@ -118,8 +118,48 @@ With all three roles it is possible to add and delete entries from the
 Discovery Finder Database. For searching the view role is sufficient.
 The credentials are set with entries in Helm Charts.
 
-### NOTICE
+### Authentication & Authorization
+The service is secured by a OAuth2 compliant authorization. Every API call has to provide a
+valid Bearer Token. Authorization is provided by a role based access. These roles are possible:
+
+| Role                      | Description                            |
+|---------------------------|----------------------------------------|
+| view_discovery_endpoint   | can search for BPN Discovery endpoints |
+| add_discovery_endpoint    | can add BPN Discovery endpoints        |
+| delete_discovery_endpoint | can delete BPN Discovery endpoints     |
+
+
+### Security Assessment
+#### Data Flow Diagram
+
+```mermaid
+%%{init: {"flowchart": {"curve": "linear"} }}%%
+flowchart
+    DC(Data Consumer \n <i>e.g. IR</i>)
+    DP(Data Provider)
+    K(Keycloak)
+    subgraph Discovery Finder
+    DF(Discovery Finder Backend)
+    DFDB[(Discovery Finder postgres)]
+    end
+    subgraph BPN Discovery
+    BD(BPN Discovery Backend)
+    BDDB[(BPN Discovery postgres \n <i>N instances per data \n asset type and usage</i>)]
+    end
+    
+    DC <-->|Token request| K
+    DP <-->|Token request| K
+    DF <-->|Request endpoint for given type| DC
+    DF <--> DFDB
+    K -.->|Provide public key for token validation| DF
+    BD <--> BDDB
+    DC <-->|Request BPN for specific type| BD
+    DP -->|Register BPN type key| BD
+    BD -->|Success/error message for registration| DP
+    K -.->|Provide public key for token validation| BD
+```
 
+### NOTICE
 This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
 
 - SPDX-License-Identifier: Apache-2.0

diff --git a/docs/7-quality-scenarios.md → docs/architecture/7-quality-scenarios.md b/docs/7-quality-scenarios.md → docs/architecture/7-quality-scenarios.md
diff --git a/docs/glossary.md → docs/architecture/glossary.md b/docs/glossary.md → docs/architecture/glossary.md
diff --git a/docs/media/OverallConcept.png → docs/architecture/media/OverallConcept.png b/docs/media/OverallConcept.png → docs/architecture/media/OverallConcept.png
diff --git a/docs/documentation.md b/docs/documentation.md