Skip to content

Commit

Permalink
chore: add more to the glossary
Browse files Browse the repository at this point in the history
  • Loading branch information
kasir-barati committed Aug 1, 2024
1 parent 4789d61 commit b1e7ff1
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 10 deletions.
16 changes: 15 additions & 1 deletion .github/docs/glossary/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
<dl>
<dt id="#durability">
<dt id="durability">
<a href="#durability">#</a>
Durability
</dt>
<dd>
A system that is durable is able to perform its responsibilities over time, even when unexpected events may occur.
</dd>
<dt id="durableStorage">
<a href="#durableStorage">#</a>
Durable storage
</dt>
<dd>
A durable storage system will reliably store data without data loss.
</dd>
<dt id="throughput">
<a href="#throughput"></a>
Throughput
</dt>
<dd>
Throughput measures the volume of data that passes through a network in a given period.
</dd>
</dl>
21 changes: 12 additions & 9 deletions .github/docs/microservices/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,13 @@
<td><img src="./grpc.png" /></td>
</tr>
<tr>
<th>
<td>
Event Streaming Platform
<br />
AKA
<br />
Distributed Streaming Platform
</th>
</td>
<td>
Apache Kafka
</td>
Expand All @@ -79,8 +81,7 @@
<tbody>
<tr>
<td>
Optimized for high-throughput
<small>(Throughput measures the volume of data that passes through a network in a given period.)</small>
Optimized for high-<a href="../glossary/README.md#throughput">throughput</a>
and scalable processing of event data. While they can provide near real-time processing, the speed can vary depending on factors like:
<ul>
<li>Network latency.</li>
Expand Down Expand Up @@ -132,7 +133,7 @@
Data replication ensures that data is not lost if a node fails.
</li>
<li>
Durable storage: A durable storage system will reliably store data without data loss.
<a href="../glossary/README.md#durableStorage">Durable storage</a>.
</li>
<li>Partitioning: enhances both fault-tolerance and scalability.</li>
<li>replaying events, which can be beneficial for system recovery or auditing purposes.</li>
Expand Down Expand Up @@ -199,7 +200,9 @@
Evolve<small>(Assuming that it won't change its message format)</small>.
</li>
</ul>
It does not directly impact others. Messages can be buffered until the receiving service is available again.
It does not directly impact others.
<br />
And messages can be buffered until the receiving service is available again.
</td>
<td>
Less isolation compared to other methods. Since services communicate synchronously and directly, things like:
Expand All @@ -215,8 +218,8 @@
<td>
Producers and consumers of events operate independently, and the system can handle large volumes of events even if some services are temporarily unavailable. In this communication method we support:
<ol>
<li>real-time processing</li>
<li>replay events</li>
<li>Real-time processing.</li>
<li>Replay events.</li>
</ol>
Which can be useful for data recovery and analytics.
</td>
Expand Down Expand Up @@ -256,7 +259,7 @@

![API gateway functionalities](./api-gateway-functionalities.png)

By having an API gateway client interactions with the microservices architecture will be much simpler, security and scalability improves, and we can centrally managing traffics and apply policies.
By having an API gateway, client interactions with the microservices architecture, will be much simpler, security and scalability improves, and we can centrally managing traffics and apply policies.

| Functionality | Description |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down

0 comments on commit b1e7ff1

Please sign in to comment.