From 1d5c4ee245fb9d142c279d4c72c47789b28c19f9 Mon Sep 17 00:00:00 2001 From: Pierre Tessier Date: Fri, 19 Aug 2022 03:19:29 -0400 Subject: [PATCH] Update readme service graph for Feature Flag Service (#321) * update ffs graph routes * clean up ffs graph definition --- README.md | 15 +-- .../requirements/architecture_requirements.md | 2 +- docs/service_table.md | 2 +- docs/v1_graph.md | 93 ------------------- 4 files changed, 7 insertions(+), 105 deletions(-) delete mode 100644 docs/v1_graph.md diff --git a/README.md b/README.md index 2581227e9d..74323e62a1 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,6 @@ This repo is a work in progress. If you'd like to help, check out our - [Requirements](./docs/requirements/README.md) - [Service Roles](./docs/service_table.md) - [Trace Feature Coverage by Service](./docs/trace_service_features.md) -- [v1 Architecture](./docs/v1_graph.md) ## Architecture @@ -49,6 +48,8 @@ paymentservice(Payment Service):::javascript productcatalogservice(ProductCatalog Service):::golang recommendationservice(Recommendation Service):::python shippingservice(Shipping Service):::rust +featureflagservice(Feature Flag Service):::erlang +featureflagstore[(Feature Flag Store
(PostgreSQL DB))] Internet -->|HTTP| frontend loadgenerator -->|HTTP| frontend @@ -59,7 +60,6 @@ checkoutservice --> currencyservice checkoutservice --> emailservice checkoutservice --> paymentservice checkoutservice --> shippingservice -checkoutservice --> |evalFlag| featureflagbeservice frontend --> adservice frontend --> cartservice @@ -68,15 +68,12 @@ frontend --> checkoutservice frontend --> currencyservice frontend --> recommendationservice --> productcatalogservice frontend --> shippingservice -frontend --> |evalFlag| featureflagbeservice -productcatalogservice --> |evalFlag| featureflagbeservice +productcatalogservice --> |evalFlag| featureflagservice -featureflagbeservice(Flag Server):::erlang -featureflagfeservice(Flag UI/API):::erlang -featureflagstore[(Flag Store
(PostgreSQL DB))] +shippingservice --> |evalFlag| featureflagservice -featureflagfeservice --> featureflagbeservice --> featureflagstore +featureflagservice --> featureflagstore end classDef java fill:#b07219,color:white; @@ -117,8 +114,6 @@ classDef erlang fill:#b83998,color:white; classDef php fill:#4f5d95,color:white; ``` -_To view a graph of the desired state of this application [click here](./docs/v1_graph.md)_ - Find the **Protocol Buffer Definitions** in the `/pb/` directory. ## Features diff --git a/docs/requirements/architecture_requirements.md b/docs/requirements/architecture_requirements.md index 8bfd4df4d5..72a6e6940e 100644 --- a/docs/requirements/architecture_requirements.md +++ b/docs/requirements/architecture_requirements.md @@ -27,7 +27,7 @@ demonstrates the features and capabilities of OTel APIs, SDKs, and tools. features/concepts 'in the wild'. The following is a general description of the logical components of the demo -application. The future architecture is visualized [here](../v1_graph.md). +application. ## Main Application diff --git a/docs/service_table.md b/docs/service_table.md index 0139371fc7..b5c6295880 100644 --- a/docs/service_table.md +++ b/docs/service_table.md @@ -1,6 +1,6 @@ # Service Roles -View [Service Graph](./v1_graph.md) to visualize request flow. +View [Service Graph](../README.md#architecture) to visualize request flows. | Service | Language | Description | |-----------------------------------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/v1_graph.md b/docs/v1_graph.md deleted file mode 100644 index c7b1cd9df2..0000000000 --- a/docs/v1_graph.md +++ /dev/null @@ -1,93 +0,0 @@ -# Desired Service Map - -This diagram illustrates the desired relationships between services for the v1 work. -See service roles [here](./service_table.md). - -```mermaid -graph TD - -subgraph Service Diagram -adservice(Ad Service):::java -cache[(Cache
(redis))] -cartservice(Cart Service):::dotnet -checkoutservice(Checkout Service):::golang -currencyservice(Currency Service):::cpp -emailservice(Email Service):::ruby -frontend(Frontend):::golang -loadgenerator([Load Generator]):::python -paymentservice(Payment Service):::nodejs -productcatalogservice(ProductCatalog Service):::golang -recommendationservice(Recommendation Service):::python -shippingservice(Shipping Service):::rust -adminservice(Admin Service):::php -productstore[(Product Store)]:::db - -Internet -->|HTTP| frontend -loadgenerator -->|HTTP| frontend -adminservice --> productstore - -checkoutservice --> cartservice --> cache -checkoutservice --> productcatalogservice -checkoutservice --> currencyservice -checkoutservice --> emailservice -checkoutservice --> paymentservice -checkoutservice --> shippingservice - -frontend --> adservice -frontend --> cartservice -frontend --> productcatalogservice -frontend --> checkoutservice -frontend --> currencyservice -frontend --> recommendationservice --> productcatalogservice -frontend --> shippingservice - -productcatalogservice --> |evalFlag| featureflagfeservice -productcatalogservice --> productstore - -shippingservice --> |evalFlag| featureflagfeservice - -featureflagbeservice(Flag Server):::erlang -featureflagfeservice(Flag UI/API):::erlang -featureflagstore[(Flag Store
(Blob/DB))] - -featureflagfeservice --> featureflagbeservice --> featureflagstore - -end -classDef java fill:#b07219,color:white; -classDef dotnet fill:#178600,color:white; -classDef golang fill:#00add8,color:black; -classDef cpp fill:#f34b7d,color:white; -classDef ruby fill:#701516,color:white; -classDef python fill:#3572A5,color:white; -classDef nodejs fill:#f1e05a,color:black; -classDef rust fill:#dea584,color:black; -classDef erlang fill:#b83998,color:white; -classDef php fill:#4f5d95,color:white; -``` - -```mermaid -graph TD -subgraph Service Legend - javasvc(Java):::java - dotnetsvc(.NET):::dotnet - golangsvc(Go):::golang - cppsvc(C++):::cpp - rubysvc(Ruby):::ruby - pythonsvc(Python):::python - nodesvc(Node.js):::nodejs - rustsvc(Rust):::rust - erlangsvc(Erlang/Elixir):::erlang - phpsvc(PHP):::php -end - -classDef java fill:#b07219,color:white; -classDef dotnet fill:#178600,color:white; -classDef golang fill:#00add8,color:black; -classDef cpp fill:#f34b7d,color:white; -classDef ruby fill:#701516,color:white; -classDef python fill:#3572A5,color:white; -classDef nodejs fill:#f1e05a,color:black; -classDef rust fill:#dea584,color:black; -classDef erlang fill:#b83998,color:white; -classDef php fill:#4f5d95,color:white; -```