Merge pull request #23 from georgep1ckers/update-readme

update to readme and image
georgep1ckers · Nov 10, 2023 · 8b93618 · 8b93618
2 parents eea13ec + 363ffe0
commit 8b93618
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/images/tracey-reloaded-architecture.png b/images/tracey-reloaded-architecture.png
diff --git a/readme.md b/readme.md
@@ -2,11 +2,19 @@
 
 Tracey Reloaded is a dummy Kubernetes-based application designed to generate logs, metrics and traces for a 'simulated' warehouse operations. It is intended to be used with OpenTelemetry for the collection of telemetry data and shipping on to Coralogix. The application consists of multiple services: 
 
-- **Warehouse Interface**
-- **Order Processor**
-- **Stock Processor**
-- **PostgreSQL Database**
+## Architecture
 
+### Services
+
+- **Warehouse Interface**: This service acts as the front-end interface for warehouse operations, it simulates order and stock requests on a loop and randomly generates errors. 
+
+- **Order Processor**: Responsible for processing orders, this service handles recieves HTTP requests from Warehouse Interface and communicates with the PostgreSQL database to add and remove orders. 
+
+- **Stock Processor**: Responsible for processing stock, this service handles recieves HTTP requests from Warehouse Interface and communicates with the PostgreSQL database to add and remove stock. 
+
+- **PostgreSQL Database**: A centralized database service that stores has 2 tables, one for orders and one for stock. 
+
+![Tracey Reloaded Architecture Diagram](./images/tracey-reloaded-architecture.png "Architecture Diagram")
 
 ## Prerequisites