From cf198ae4897d7ef49607ffc44af68ba489150b47 Mon Sep 17 00:00:00 2001 From: Austin Parker Date: Wed, 25 May 2022 14:23:03 -0400 Subject: [PATCH 1/3] add updated graph --- README.md | 2 ++ docs/v1Graph.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+) create mode 100644 docs/v1Graph.md diff --git a/README.md b/README.md index c9fc4df7ef..61460e5bc8 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,8 @@ frontend --> recommendationservice --> productcatalogservice frontend --> shippingservice ``` +_To view a graph of the desired state of this application [click here](./docs/v1Graph.md)_ + Find **Protocol Buffers Descriptions** at the [`./pb` directory](./pb/README.md). | Service | Language | Description | diff --git a/docs/v1Graph.md b/docs/v1Graph.md new file mode 100644 index 0000000000..94d72e4666 --- /dev/null +++ b/docs/v1Graph.md @@ -0,0 +1,93 @@ +# Desired Service Map + +This diagram illustrates the desired relationships between services for the v1 work. + +```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 +checkoutservice --> |evalFlag| featureflagfeservice + +frontend --> adservice +frontend --> cartservice +frontend --> productcatalogservice +frontend --> checkoutservice +frontend --> currencyservice +frontend --> recommendationservice --> productcatalogservice +frontend --> shippingservice +frontend --> |evalFlag| featureflagfeservice + +productcatalogservice --> |evalFlag| featureflagfeservice +productcatalogservice --> productstore + +featureflagbeservice(Flag Server):::erlang +featureflagfeservice(Flag UI/API):::erlang +featureflagstore[(Flag Store
(Blob/DB))] + +featureflagfeservice --> featureflagbeservice --> featureflagstore + +end +classDef java fill:#b07219; +classDef dotnet fill:#178600; +classDef golang fill:#00add8; +classDef cpp fill:#f34b7d; +classDef ruby fill:#701516; +classDef python fill:#3572A5; +classDef nodejs fill:#f1e05a; +classDef rust fill:#dea584; +classDef erlang fill:#b83998; +classDef php fill:#4f5d95; +``` + +```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; +classDef dotnet fill:#178600; +classDef golang fill:#00add8; +classDef cpp fill:#f34b7d; +classDef ruby fill:#701516; +classDef python fill:#3572A5; +classDef nodejs fill:#f1e05a; +classDef rust fill:#dea584; +classDef erlang fill:#b83998; +classDef php fill:#4f5d95; +``` From 2f28b49a0e50a90e7a7d7edf69b8e7fe84cd10a6 Mon Sep 17 00:00:00 2001 From: Austin Parker Date: Wed, 25 May 2022 15:47:38 -0400 Subject: [PATCH 2/3] tweak colors of fonts --- docs/v1Graph.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/v1Graph.md b/docs/v1Graph.md index 94d72e4666..8b2ee5e395 100644 --- a/docs/v1Graph.md +++ b/docs/v1Graph.md @@ -53,16 +53,16 @@ featureflagstore[(Flag Store
(Blob/DB))] featureflagfeservice --> featureflagbeservice --> featureflagstore end -classDef java fill:#b07219; -classDef dotnet fill:#178600; -classDef golang fill:#00add8; -classDef cpp fill:#f34b7d; -classDef ruby fill:#701516; -classDef python fill:#3572A5; -classDef nodejs fill:#f1e05a; -classDef rust fill:#dea584; -classDef erlang fill:#b83998; -classDef php fill:#4f5d95; +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 @@ -80,14 +80,14 @@ subgraph Service Legend phpsvc(PHP):::php end -classDef java fill:#b07219; -classDef dotnet fill:#178600; -classDef golang fill:#00add8; -classDef cpp fill:#f34b7d; -classDef ruby fill:#701516; -classDef python fill:#3572A5; -classDef nodejs fill:#f1e05a; -classDef rust fill:#dea584; -classDef erlang fill:#b83998; -classDef php fill:#4f5d95; +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; ``` From a0c1b8c23c7746092a21522378c63ff7c54db91f Mon Sep 17 00:00:00 2001 From: Austin Parker Date: Wed, 25 May 2022 15:48:50 -0400 Subject: [PATCH 3/3] address review nit --- docs/v1Graph.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/v1Graph.md b/docs/v1Graph.md index 8b2ee5e395..fb43b83019 100644 --- a/docs/v1Graph.md +++ b/docs/v1Graph.md @@ -3,7 +3,6 @@ This diagram illustrates the desired relationships between services for the v1 work. ```mermaid - graph TD subgraph Service Diagram