Update Readme to add the description of Maestro (#72)

* Update Readme to add the description of Maestro Signed-off-by: clyang82 <[email protected]> * Address review comments Signed-off-by: clyang82 <[email protected]> --------- Signed-off-by: clyang82 <[email protected]>
openshift-online · Apr 2, 2024 · 1e08a6a · 1e08a6a
1 parent fe88acd
commit 1e08a6a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,11 @@
-Maestro
----
+# Maestro
+Maestro is a system to leverage [CloudEvents](https://cloudevents.io/) to transport Kubernetes resources to the target clusters, and then transport the resource status back. The resources are stored in a database and the status is updated in the database as well. The system is composed of two parts: the Maestro server and the Maestro agent.
+- The Maestro server is responsible for storing the resources and their status. And sending the resources to the message broker in the CloudEvents format. The Maestro server provides Resful APIs and gRPC APIs to manage the resources.
+- Maestro agent is responsible for receiving the resources and applying them to the target clusters. And reporting back the status of the resources.
+
+## Architecture
+Taking MQTT as an example:
+![Maestro Architecture](./arch.png)
 
 ## Run for the first time
 

diff --git a/arch.png b/arch.png
diff --git a/img.png b/img.png