You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ma...@apache.org on 2023/10/26 00:59:42 UTC

[camel-karavan] 02/02: Readme update

This is an automated email from the ASF dual-hosted git repository.

marat pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-karavan.git

commit cd99698b44eeb06a7a73fd93657eae72b6733569
Author: Marat Gubaidullin <ma...@talismancloud.io>
AuthorDate: Wed Oct 25 20:59:29 2023 -0400

    Readme update
---
 README.md                       |   9 ++++++++-
 docs/ARCHITECTURE.md            |  39 +++++++++++++++++++++++++++++++++++++++
 images/karavan-architecture.png | Bin 0 -> 46631 bytes
 3 files changed, 47 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 74d56da1..0ce664f0 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,13 @@ Karavan provides VS Code extension for local developer experience
 * [Openshift](docs/WEB_OPENSHIFT.md)
 
 ### Developer guide
-[How to build Karavan](docs/DEV.md)
+* [Architecture](docs/ARCHITECTURE.md)
+* [How to build](docs/DEV.md)
 
+
+### Feedback
 If you haven't done so yet, please be sure to download Karavan and give it a try. We're excited to receive your feedback and learn about your experiences!
+
+* [Ask questions](https://github.com/apache/camel-karavan/discussions)
+* [Open Issues](https://github.com/apache/camel-karavan/issues)
+
diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md
new file mode 100644
index 00000000..6362e271
--- /dev/null
+++ b/docs/ARCHITECTURE.md
@@ -0,0 +1,39 @@
+## Apache Camel Karavan Architecture
+
+![How to use](../images/karavan-architecture.png)
+
+### Karavan components
+
+#### Web application
+
+End-user application to interact with.
+
+#### Infinispan
+
+Karavan keeps all project files and monitoring data in Infinispan Caches
+
+#### Karavan run
+
+Container created by Karavan application to run project in developer mode.
+Container uses `apache/camel-karavan-devmode` image to run.
+
+#### Karavan build
+
+Container created by Karavan application to build and deploy project.
+Container uses `apache/camel-karavan-devmode` image to run.
+
+#### Git repository
+
+All Karavan projects and build scripts stored in Git repository.
+
+#### Image Registry
+
+Karavan Build push images to Image registry configured
+
+#### Maven Repository
+
+Karavan run and build use Maven repository to get dependencies.
+
+#### Integrations
+
+Running integration microservices 
diff --git a/images/karavan-architecture.png b/images/karavan-architecture.png
new file mode 100644
index 00000000..cce331d2
Binary files /dev/null and b/images/karavan-architecture.png differ