Skip to content

Commit e3e9dde

Browse files
committed
Typo fixes to the architecture.md design doc
1 parent 5c93768 commit e3e9dde

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/design/architecture.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,20 @@ it only presents fetched data and sends requests to the backend for actions.
99
The backend runs in a Kubernetes cluster as a kubernetes service. Alternatively, it may run anywhere
1010
outside of the cluster, given that it can connect to the master. The backend is a HTTP server that
1111
proxies data requests to appropriate remote backends (e.g., k8s apiserver or heapster) or implements
12-
business logic. The backend implements business logic when remote backends APIs do not provide
13-
support required use case directly, e.g., “I want to get a list of pods with their CPU usage metric
12+
business logic. The backend implements business logic when remote backends APIs do not
13+
support required use case directly, e.g., “get a list of pods with their CPU usage metric
1414
timeline”. Figure 1 outlines the architecture of the project.
1515

1616
![Architecture Overview](architecture.png?raw=true "Architecture overview")
17+
1718
*Figure 1: Project architecture overview*
1819

1920
Rationale for having a backend that implements business logic:
2021

2122
* Clear separation between the presentation layer (frontend) and business logic layer (backend).
22-
This is because every action goes through API.
23+
This is because every action goes through well defined API.
2324
* Transactional actions are easier to implement on the backend than on the frontend. Examples of
24-
such actions: "Create a replication controller and a service for it" or "Do a rolling update".
25+
such actions: "create a replication controller and a service for it" or "do a rolling update".
2526
* Possible code reuse from existing tools (e.g., kubectl) and upstream contributions to the tools.
2627
* Speed: getting composite data from beckends is faster on the backend (if it runs close to the
2728
data sources). For example, getting a list of pods with their CPU utilization timeline

0 commit comments

Comments
 (0)