Skip to content

Commit 7b9eac4

Browse files
committed
Add readme instructions about the QP deployment modes
1 parent 092b7b9 commit 7b9eac4

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

README.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,71 @@ Now, you can log in to [Grafana Cloud](https://grafana.com/products/cloud/) and
173173

174174
![Use Profiles Drilldown](./docs/images/grafana-cloud-drilldown-profiles.png)
175175

176-
To find the labels applied to the telemetry data, refer to [cloud.alloy](./alloy/cloud.alloy) and [compose.grafana-cloud.microservices.yaml](./compose.grafana-cloud.microservices.yaml) .
176+
To find the labels applied to the telemetry data, refer to [cloud.alloy](./alloy/cloud.alloy) and [compose.grafana-cloud.microservices.yaml](./compose.grafana-cloud.microservices.yaml).
177+
178+
## QuickPizza Deployment Modes: Monolithic vs Microservices
179+
180+
QuickPizza can be deployed in two modes: **monolithic** or **microservices**.
181+
182+
In microservices mode, QuickPizza is split into several independent services, each with a distinct responsibility—such as `catalog`, `recommendations`, and `public-api`. Each service runs in its own Docker container.
183+
184+
This architecture enables distributed tracing and demonstrates service-oriented observability.
185+
186+
```mermaid
187+
graph TB
188+
subgraph "QuickPizza microservices"
189+
190+
subgraph public-api-svc [public-api service]
191+
API[/gateway component/]
192+
FR[/frontend component/]
193+
end
194+
195+
copy-svc[copy service]
196+
rec-svc[recommendations service]
197+
cfg-svc[config service]
198+
ws-svc[ws service]
199+
200+
subgraph catalog-svc [catalog service]
201+
CA[/catalog component/]
202+
US[/users component/]
203+
AD[/admin component/]
204+
end
205+
206+
DB[(db)]
207+
end
208+
GA[Alloy]
209+
GC[Grafana Cloud<br/>Mimir, Loki, Tempo, Pyroscope]
210+
211+
212+
User --> FR
213+
API_Client --> API
214+
FR --> API
215+
API --> copy-svc
216+
API --> rec-svc
217+
API --> cfg-svc
218+
API --> ws-svc
219+
API --> CA
220+
API --> US
221+
API --> AD
222+
223+
CA --> DB
224+
US --> DB
225+
AD --> DB
226+
227+
228+
public-api-svc <--> GA
229+
catalog-svc <--> GA
230+
copy-svc <--> GA
231+
rec-svc <--> GA
232+
cfg-svc <--> GA
233+
ws-svc <--> GA
234+
GA --> GC
235+
```
236+
237+
The [`compose.grafana-cloud.microservices.yaml`](./compose.grafana-cloud.microservices.yaml) file configures QuickPizza in microservices mode. In this setup, Grafana Alloy collects telemetry data from each service and sends it to Grafana Cloud, enabling centralized observability across all components.
238+
239+
For monolithic deployments, all QuickPizza components run together in a single container. Grafana Alloy still collects telemetry data, but from the unified application instance. Use the [`compose.grafana-cloud.monolithic.yaml`](./compose.grafana-cloud.monolithic.yaml) or [`compose.grafana-local-stack.monolithic.yaml`](./compose.grafana-local-stack.monolithic.yaml) files to orchestrate this environment.
240+
177241

178242
### Monitor QuickPizza with Grafana Cloud Application and Frontend Observability
179243

0 commit comments

Comments
 (0)