246 write an architecture document for didcomm mediator server e13 #269

Tekum-Emmanuella · 2024-11-22T15:15:48Z

please @ all, read this arc doc so we can review together and merge.

…-server-e13' of github.com:adorsys/didcomm-mediator-rs into 246-write-an-architecture-document-for-didcomm-mediator-server-e13

Signed-off-by: Francis Pouatcha <[email protected]>

merging from main

Christiantyemele · 2024-11-25T13:56:26Z

docs/arc42.md

+
+---
+
+# DIDComm Mediator RS - ARC42 Architecture Documentation


this RS here is confusing

Christiantyemele · 2024-11-25T14:01:05Z

docs/arc42.md

+
+### 2.1 Technical Constraints
+- **Rust Programming Language**: Ensures high performance and memory safety.
+- **Transport Agnosticism**: Supports various protocols (HTTP, Bluetooth, etc.).


Bluetooth is not yet supported

Christiantyemele · 2024-11-25T14:04:54Z

docs/arc42.md

+- **No External State**: Minimal reliance on external systems for scalability.
+
+### 2.2 Regulatory Constraints
+- **Privacy Compliance**: Aligns with GDPR and similar regulations.


What does this GDPR means

docs/arc42.md

Christiantyemele · 2024-11-25T14:13:59Z

docs/arc42.md

+| **DID Rotation**                        | Accepted                 | ✅ Implemented             |
+| **Cross-Domain Messaging/Routing Protocol** | Adopted                  | ✅ Implemented             |
+| **Trust Ping Protocol**                 | Adopted                  | ✅ Implemented             |
+| **Discover Features Protocol**          | Adopted                  | ⚪ In Progress              |


Christiantyemele · 2024-11-25T14:17:21Z

docs/arc42.md

+2. **In Progress Features**:
+   - **Discover Features Protocol** and **Out-of-Band Messaging** are under development to expand functionality.
+   - **Basic Message Protocol** will enable straightforward message exchanges between agents.
+


i feel like its preferable to remove this highlight here because this will require frequent modifications, beside the discover features protocol is implemented already

Christiantyemele · 2024-11-25T14:23:28Z

docs/arc42.md

+
+1. **Web Plugin Layer**: 
+   - Enables plug-and-play of web endpoints.
+   - Currently used to implement features such as DID endpoints, out-of-band messages, and DIDComm messaging.


Suggested change

- Currently used to implement features such as DID endpoints, out-of-band messages, and DIDComm messaging.

- Currently used to implement features such as **DID Endpoints**, **out-of-band messaging**, and **DIDComm messaging**.

Christiantyemele · 2024-11-25T14:33:10Z

docs/arc42.md

+At the core is the **Generic Server**, responsible for hosting the overall application and enabling the plugin system. The main components are:
+
+1. **Dispatcher**: Routes incoming requests to the appropriate web plugin.
+2. **Web Plugin Layer**: Hosts modular implementations for endpoint-specific logic (e.g., DID endpoint generation, out-of-band messages).


Suggested change

2. **Web Plugin Layer**: Hosts modular implementations for endpoint-specific logic (e.g., DID endpoint generation, out-of-band messages).

2. **Web Plugin Layer**: Hosts modular implementations for endpoint-specific logic (e.g., DID endpoint generation, out-of-band messaging).

Christiantyemele · 2024-11-25T14:39:38Z

docs/arc42.md

+graph TD
+    GenericServer[Generic Server] --> Dispatcher[Dispatcher]
+    Dispatcher --> WebPluginLayer[Web Plugin Layer]
+    WebPluginLayer --> DIDEndpoint[DID Endpoint]
+    WebPluginLayer --> OOBMessaging[Out-of-Band Messages]
+    WebPluginLayer --> DIDCommMessaging[DIDComm Messaging Endpoint]
+    DIDCommMessaging --> CommonProcessing[Common DIDComm Processing]
+    DIDCommMessaging --> MessagingPlugins[Messaging Plugin Layer]
+    MessagingPlugins --> Forward[Forward Protocol]
+    MessagingPlugins --> Pickup[Pickup Protocol]
+    MessagingPlugins --> Coordination[Mediator Coordination Protocol]
+    MessagingPlugins --> Trustping[Trust Ping Protocol]
+```


Please change the Out-of-Band messages to Out-of-Band Messaging

Christiantyemele · 2024-11-25T14:54:00Z

docs/arc42.md

+
+**Disadvantages**:
+- No fault tolerance: if the mediator fails, the service becomes unavailable.
+- Limited scalability.
+
+---
+
+#### 2. **Distributed Deployment with Load Balancer (Recommended)**
+
+**Use Case**: Ideal for production environments requiring high availability and scalability.
+
+- Multiple mediator instances are deployed behind a load balancer.
+- The load balancer distributes requests evenly across mediators, ensuring efficient utilization of resources.
+- Supports horizontal scaling by adding more mediator instances as needed.
+
+**Advantages**:
+- High availability: If one mediator instance fails, others continue handling requests.
+- Scalable: New instances can be added to handle increased load.
+- Efficient routing: Load balancer optimizes resource utilization.
+
+**Disadvantages**:
+- Slightly higher complexity due to additional components (load balancer).
+
+---
+
+### 7.3 Deployment Diagram
+
+Below is a component diagram showcasing the deployment with multiple mediators and a load balancer:
+
+```mermaid
+graph TD
+    subgraph Internet
+        User1[Recipient Agent]
+        User2[Sender Agent]
+    end
+
+    User1 --> LB[Load Balancer]
+    User2 --> LB
+
+    subgraph Mediator Cluster
+        Mediator1[Mediator Instance 1]
+        Mediator2[Mediator Instance 2]
+    end
+
+    LB --> Mediator1
+    LB --> Mediator2
+
+    Mediator1 --> DB1[Message Storage DB]
+    Mediator2 --> DB1
+```
+
+---
+
+### 7.4 Deployment Considerations
+
+#### **Cloud Deployment**
+
+**Infrastructure**: 
+- Use cloud platforms like AWS, Azure, or GCP.
+- Services like Elastic Load Balancer (AWS), Application Gateway (Azure), or Cloud Load Balancer (GCP) can be employed for load balancing.
+
+**Scaling**:
+- Leverage auto-scaling groups to dynamically scale mediator instances based on traffic.
+
+**Monitoring**:
+- Use monitoring tools (e.g., Prometheus, CloudWatch, or Azure Monitor) to track mediator performance, error rates, and resource usage.
+
+---
+
+#### **On-Premises Deployment**
+
+**Infrastructure**:
+- Deploy mediators on virtual machines or containers (e.g., Docker).
+- Use a software-based load balancer (e.g., HAProxy, NGINX) for request distribution.
+
+**Scaling**:
+- Add more mediator instances manually to handle increased traffic.
+
+**Monitoring**:
+- Use tools like Grafana and Prometheus to monitor system health.
+
+---
+
+### 7.5 Benefits of Load Balancer in Deployment
+
+1. **Fault Tolerance**:
+   - Ensures service continuity even if one mediator instance fails.
+
+2. **Scalability**:
+   - Handles growing traffic by distributing load across multiple instances.
+
+3. **Optimized Resource Utilization**:
+   - Prevents overloading a single mediator, ensuring consistent performance.
+
+4. **Simplified Maintenance**:
+   - Instances can be updated or replaced without downtime by redirecting traffic.
+
+This detailed deployment view provides clarity on how the system can be deployed effectively, balancing performance, fault tolerance, and scalability.
+
+---


in the whole of this deployment view we only saying what can be use, i think the document is to empose what to do base our capabilities

Blindspot22 · 2024-11-26T07:12:13Z

docs/arc42.md

+#### 8.1.6 Secure Logging and Monitoring
+
+**Log Handling**:
+- Sensitive data (e.g., private keys, PII) is redacted from logs.


(PII) is good but I think it will be best if you just wrote it out as (Personally Identifiable Information).

Blindspot22 · 2024-11-26T07:22:05Z

docs/arc42.md

+
+1. **Static Application Security Testing (SAST)**:
+   - Tools like **SonarQube**, **CodeQL**, or **Checkmarx** are used to scan source code for vulnerabilities.
+   - Integrated into CI/CD pipelines to analyze every commit and pull request.


Suggested change

- Integrated into CI/CD pipelines to analyze every commit and pull request.

Integration of CI/CD pipelines to analyze every commit and pull request.

or

Suggested change

- Integrated into CI/CD pipelines to analyze every commit and pull request.

Integrated CI/CD pipelines to analyze every commit and pull request.

Blindspot22 · 2024-11-26T07:26:18Z

docs/arc42.md

+| **DID Rotation**                        | Accepted                 | ✅ Implemented             |
+| **Cross-Domain Messaging/Routing Protocol** | Adopted                  | ✅ Implemented             |
+| **Trust Ping Protocol**                 | Adopted                  | ✅ Implemented             |
+| **Discover Features Protocol**          | Adopted                  | ⚪ In Progress              |


chendiblessing and others added 19 commits November 15, 2024 09:21

feat: init Architecture doc

7c40911

updated: the arch doc

88f8255

updated: with the template of the arch document

9f2e3ff

Added the technical context to.

fcfd756

added:technological decisions on solution strategy

fdc1da8

Merge branch '246-write-an-architecture-document-for-didcomm-mediator…

7864573

…-server-e13' of github.com:adorsys/didcomm-mediator-rs into 246-write-an-architecture-document-for-didcomm-mediator-server-e13

Added the technical context to.

cbb880c

fix():fixed dupicated indentation errors.

45eec53

updated:solution strategy

3b293ee

Merge branch '246-write-an-architecture-document-for-didcomm-mediator…

e739343

…-server-e13' of github.com:adorsys/didcomm-mediator-rs into 246-write-an-architecture-document-for-didcomm-mediator-server-e13

Initial setup of the architecture document

bf501af

Signed-off-by: Francis Pouatcha <[email protected]>

updated arc doc with Architecture Decisions and Quality Requirements.

466489d

updated arc document with risk and technical debt

82e2805

updated architecture document with the product management section

b73f917

updated arc doc with the glossary composed of key words.

edfc5ff

mordified arc doc with the glossary composed of key words.

55a6e7e

updated architecture document with the product management section

5dd9515

mordified arc glosssary.

ebe6b59

Merge pull request #268 from adorsys/main

f582aef

merging from main

Tekum-Emmanuella requested review from francis-pouatcha, IngridPuppet, Hermann-Core, Christiantyemele, Blindspot22 and ndefokou November 22, 2024 15:15

Tekum-Emmanuella assigned chendiblessing and Tekum-Emmanuella Nov 22, 2024

Tekum-Emmanuella linked an issue Nov 22, 2024 that may be closed by this pull request

Write an Architecture Document for DIDComm Mediator Server E13 #246

Open

7 tasks

Christiantyemele requested changes Nov 25, 2024

View reviewed changes

Blindspot22 requested changes Nov 26, 2024

View reviewed changes

Blindspot22 added documentation Improvements or additions to documentation enhancement New feature or request Pending and removed Pending labels Nov 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

246 write an architecture document for didcomm mediator server e13 #269

246 write an architecture document for didcomm mediator server e13 #269

Tekum-Emmanuella commented Nov 22, 2024

Christiantyemele Nov 25, 2024

Christiantyemele Nov 25, 2024

Christiantyemele Nov 25, 2024

Christiantyemele Nov 25, 2024

Blindspot22 Nov 26, 2024

Christiantyemele Nov 25, 2024

Christiantyemele Nov 25, 2024

Christiantyemele Nov 25, 2024

Christiantyemele Nov 25, 2024

Christiantyemele Nov 25, 2024

Blindspot22 Nov 26, 2024 •

edited

Loading

Blindspot22 Nov 26, 2024 •

edited

Loading

Blindspot22 Nov 26, 2024

	\| Discover Features Protocol \| Adopted \| ⚪ In Progress \|
	\| Discover Features Protocol \| Adopted \| ⚪ Implemented \|

	- Currently used to implement features such as DID endpoints, out-of-band messages, and DIDComm messaging.
	- Currently used to implement features such as DID Endpoints, out-of-band messaging, and DIDComm messaging.

	2. Web Plugin Layer: Hosts modular implementations for endpoint-specific logic (e.g., DID endpoint generation, out-of-band messages).
	2. Web Plugin Layer: Hosts modular implementations for endpoint-specific logic (e.g., DID endpoint generation, out-of-band messaging).

	- Integrated into CI/CD pipelines to analyze every commit and pull request.
	Integration of CI/CD pipelines to analyze every commit and pull request.

	- Integrated into CI/CD pipelines to analyze every commit and pull request.
	Integrated CI/CD pipelines to analyze every commit and pull request.

246 write an architecture document for didcomm mediator server e13 #269

Are you sure you want to change the base?

246 write an architecture document for didcomm mediator server e13 #269

Conversation

Tekum-Emmanuella commented Nov 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Blindspot22 Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

Blindspot22 Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Blindspot22 Nov 26, 2024 •

edited

Loading

Blindspot22 Nov 26, 2024 •

edited

Loading