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
The following commit(s) were added to refs/heads/main by this push: new 9b3e3eb README update (#447) 9b3e3eb is described below commit 9b3e3eb362ff0ba5c7a388cc1c8a00069600259e Author: Marat Gubaidullin <marat.gubaidul...@gmail.com> AuthorDate: Wed Aug 3 18:12:17 2022 -0400 README update (#447) --- DEV.md | 69 +++++++++++++++++++ README.md | 98 ++++++--------------------- images/karavan-about.png | Bin 0 -> 479349 bytes images/karavan-ipaas-1.png | Bin 0 -> 370751 bytes images/karavan-ipaas-2.png | Bin 0 -> 215284 bytes images/karavan-ipaas-3.png | Bin 0 -> 252347 bytes images/karavan-ipaas-4.png | Bin 0 -> 294548 bytes images/karavan-ipaas.png | Bin 0 -> 574557 bytes karavan-builder/README.md | 35 +++++++--- karavan-builder/openshift/kustomization.yaml | 1 - karavan-vscode/CHANGELOG.md | 5 ++ 11 files changed, 118 insertions(+), 90 deletions(-) diff --git a/DEV.md b/DEV.md new file mode 100644 index 0000000..bb4f4d8 --- /dev/null +++ b/DEV.md @@ -0,0 +1,69 @@ +## Project structure +1. Karavan-generator +Generate Camel Models and Api from Camel sources to Typescript in Karavan-designer +2. Karavan-Designer +KaravanDesigner UI component and simple web app +3. Karavan-vscode +VS Code extension based on KaravanDesigner +4. Karavan-app +Karavan Application +5. Karavan-demo +Demo of Karavan use cases + + +## How to build +1. Generate Camel Models and API for Typescript +``` +mvn clean compile exec:java -Dexec.mainClass="org.apache.camel.karavan.generator.KaravanGenerator" -f karavan-generator +``` + +2. Build VS Code extension +``` +cd karavan-vscode +yarn install +yarn run compile // dev +yarn run package //prod +``` + +3. Build Karavan app +- Build JVM Mode +``` +cd karavan-app +mvn clean package -Dquarkus.container-image.build=true +``` +- Build native +``` +DOCKER_BUILDKIT=1 docker build -f karavan-app/src/main/docker/Dockerfile.multistage -t apache/camel-karavan . +``` + +## Development Karavan app +You can run your application in dev mode that enables live coding using: +- Backend +```shell script +cd karavan-app +mvn quarkus:dev +``` +- Frontend +```shell script +cd karavan-app/src/main/webapp/ +npm start +``` + +## Running in local mode +- Run JVM Mode +```shell script +docker run -it -p 8080:8080 -v $(pwd):/deployments/integrations ghcr.io/apache/camel-karavan:latest +``` +For SELinux +```shell script +docker run -it -p 8080:8080 -v $(pwd):/deployments/integrations:z ghcr.io/apache/camel-karavan:latest +``` + +- Run native +```shell script +docker run -it -p 8080:8080 -v $(pwd):/deployments/integrations ghcr.io/apache/camel-karavan-native:latest +``` +For SELinux +```shell script +docker run -it -p 8080:8080 -v $(pwd):/deployments/integrations:z ghcr.io/apache/camel-karavan-native:latest +``` diff --git a/README.md b/README.md index f16848e..ad6c257 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,12 @@ Mastering Tool for Apache Camel makes integration easy and fun through the visualization of pipelines, integration with runtimes and package, image build and deploy to kubernetes out-of-the-box. + + ## Features +### Mode +* [Self-managed iPaaS](karavan-builder/README.md) +* [VS Code extension](karavan-vscode/README.md) ### Visual Designer for Integrations * Enterprise Integration Patterns DSL * REST DSL designer @@ -22,96 +27,31 @@ Mastering Tool for Apache Camel makes integration easy and fun through the visua * 300+ Components consumer/producer * Read/Write Integration CRD (*.yaml with kind:Integration) and plain yaml routes ### Runtimes -* [Camel-K](https://camel.apache.org/camel-k/next/index.html) * [Camel JBang](https://camel.apache.org/manual/camel-jbang.html) -* [Camel Quarkus](https://camel.apache.org/camel-quarkus/2.9.x/reference/extensions/yaml-dsl.html) +* [Camel Quarkus](https://camel.apache.org/camel-quarkus) +* [Camel Spring-Boot](https://camel.apache.org/camel-spring-boot) (WIP) +* [Camel Main](https://camel.apache.org/components/3.18.x/others/main.html) (WIP) ### Build and Deploy -* Package uber-jar -* Build Docker/OCI Image -* Deploy to Kubernetes/OpenShift +* Maven for local development +* Tekton Pipelines for Kubernetes/OpenShift ### Documentation Build-in catalogues: * Enterprise Integration Patterns * Kamelets * Components -## VS Code extension -Install Karavan VS Code extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=camel-karavan.karavan) - - - -## Standalone application - - Install Karavan Standalone command line: `docker pull ghcr.io/apache/camel-karavan:latest` +## Karavan Self-Managed iPaaS +More about [Karavan Self-Managed iPaaS](karavan-builder/README.md) - + -## Project structure -1. Karavan-generator -Generate Camel Models and Api from Camel sources to Typescript in Karavan-designer -2. Karavan-Designer -KaravanDesigner UI component and simple web app -3. Karavan-vscode -VS Code extension based on KaravanDesigner -4. Karavan-app -Karavan Application -5. Karavan-demo -Demo of Karavan use cases +## Karavan VS Code extension +Install Karavan VS Code extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=camel-karavan.karavan) -## How to build -1. Generate Camel Models and API for Typescript -``` -mvn clean compile exec:java -Dexec.mainClass="org.apache.camel.karavan.generator.KaravanGenerator" -f karavan-generator -``` - -2. Build VS Code extension -``` -cd karavan-vscode -yarn install -yarn run compile // dev -yarn run package //prod -``` - -3. Build Karavan app -- Build JVM Mode -``` -cd karavan-app -mvn clean package -Dquarkus.container-image.build=true -``` -- Build native -``` -DOCKER_BUILDKIT=1 docker build -f karavan-app/src/main/docker/Dockerfile.multistage -t apache/camel-karavan . -``` - -## Development Karavan app -You can run your application in dev mode that enables live coding using: -- Backend -```shell script -cd karavan-app -mvn quarkus:dev -``` -- Frontend -```shell script -cd karavan-app/src/main/webapp/ -npm start -``` +More about [Karavan VS Code Extension](karavan-vscode/README.md) -## Running in local mode -- Run JVM Mode -```shell script -docker run -it -p 8080:8080 -v $(pwd):/deployments/integrations ghcr.io/apache/camel-karavan:latest -``` -For SELinux -```shell script -docker run -it -p 8080:8080 -v $(pwd):/deployments/integrations:z ghcr.io/apache/camel-karavan:latest -``` + -- Run native -```shell script -docker run -it -p 8080:8080 -v $(pwd):/deployments/integrations ghcr.io/apache/camel-karavan-native:latest -``` -For SELinux -```shell script -docker run -it -p 8080:8080 -v $(pwd):/deployments/integrations:z ghcr.io/apache/camel-karavan-native:latest -``` +## Development +How to build [Karavan](DEV.md) \ No newline at end of file diff --git a/images/karavan-about.png b/images/karavan-about.png new file mode 100644 index 0000000..a79da5b Binary files /dev/null and b/images/karavan-about.png differ diff --git a/images/karavan-ipaas-1.png b/images/karavan-ipaas-1.png new file mode 100644 index 0000000..c80f1b1 Binary files /dev/null and b/images/karavan-ipaas-1.png differ diff --git a/images/karavan-ipaas-2.png b/images/karavan-ipaas-2.png new file mode 100644 index 0000000..4529645 Binary files /dev/null and b/images/karavan-ipaas-2.png differ diff --git a/images/karavan-ipaas-3.png b/images/karavan-ipaas-3.png new file mode 100644 index 0000000..095649d Binary files /dev/null and b/images/karavan-ipaas-3.png differ diff --git a/images/karavan-ipaas-4.png b/images/karavan-ipaas-4.png new file mode 100644 index 0000000..fc44376 Binary files /dev/null and b/images/karavan-ipaas-4.png differ diff --git a/images/karavan-ipaas.png b/images/karavan-ipaas.png new file mode 100644 index 0000000..f9737f2 Binary files /dev/null and b/images/karavan-ipaas.png differ diff --git a/karavan-builder/README.md b/karavan-builder/README.md index 638573a..3bd9378 100644 --- a/karavan-builder/README.md +++ b/karavan-builder/README.md @@ -1,10 +1,25 @@ -### Build docker image -``` -docker build -t apache/camel-karavan-builder . -``` - -### To deploy to test and prod from karavan namespace -``` -oc policy add-role-to-user system:image-puller system:serviceaccount:test:default --namespace=karavan -oc policy add-role-to-user system:image-puller system:serviceaccount:prod:default --namespace=karavan -``` +## Karavan Self-Managed iPaaS + +### Architecture + + +### Requirements +1. OpenShift 4.10+ cluster up and running +2. OpenShift 4.10+ CLI installed + +### Installation +* Deploy Tekton Operator + ``` + oc apply -f openshift/pipeline-operator.yaml + ``` +2. Create namespace + ``` + oc apply -f openshift/karavan-namespace.yaml + ``` +3. Set git parameters + Edit `karavan-secret.yaml` and set git repository, username and token + +4. Deploy karavan + ``` + oc apply -k openshift + ``` \ No newline at end of file diff --git a/karavan-builder/openshift/kustomization.yaml b/karavan-builder/openshift/kustomization.yaml index b046577..0b9790d 100644 --- a/karavan-builder/openshift/kustomization.yaml +++ b/karavan-builder/openshift/kustomization.yaml @@ -2,7 +2,6 @@ apiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization resources: -- karavan-namespace.yaml - karavan-acl.yaml - karavan-pvc.yaml - karavan-secret.yaml diff --git a/karavan-vscode/CHANGELOG.md b/karavan-vscode/CHANGELOG.md index 7c97daf..7a8cb0b 100644 --- a/karavan-vscode/CHANGELOG.md +++ b/karavan-vscode/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## 3.18.0 +1. Camel 3.18.0+ DSL +2. Export to Camel-Qurkus, Spring-Boot and Camel-Main +3. Default application.properties + ## 0.0.15 1. Camel 3.17.0+ DSL 2. Generate REST DSL and Routes stubs from Open API