# Apache Karaf Maven example ## Abstract This example provides several Maven module showing usage of Karaf Maven plugin. Each module uses a specific goal of the Karaf Maven plugin, covering different use cases. ## Maven Modules * **karaf-maven-example-run** uses the `karaf-maven-plugin:run` goal to download and start a Karaf instance. * **karaf-maven-example-run-bundle** uses the `karaf-maven-plugin:run` goal to download, start a Karaf instance and deploy the project bundle in this running instance. * **karaf-maven-example-deploy** uses the `karaf-maven-plugin:deploy` goal to deploy the module artifact into a Karaf instance (remote for example). * **karaf-maven-example-client** uses the `karaf-maven-plugin:client` goal to execute a shell command on a running Karaf instance. * **karaf-maven-example-kar** packages a features repository as a kar file, ready to be deployed. * **karaf-maven-example-assembly** uses the `karaf-maven-plugin` to create a Karaf distribution. ## Goals Execution ### Run The `karaf-maven-example-run` example downloads and starts a Apache Karaf container via Maven. By default, we just start and stop the instance (`false`), but you can leave the instance running using `true`. Simply do: ``` mvn clean install ``` ### Run & Deploy The `karaf-maven-example-run-bundle` example is similar to the `karaf-maven-example-run` adding the deployment on the current project bundle in the running instance. The Karaf plugin is able to use the project artifact (jar, bundle, feature, whatever) when using `true`. It will automatically try to deploy the module artifact into the running Karaf instance. Simply do: ``` mvn clean install ``` ### Deploy The `karaf-maven-example-deploy` example expects a Apache Karaf instance running locally on your machine. Then, it will automatically deploy the project artifact to this running instance (when `` configuration is `true`, which is the default). By default, it uses SSH, but you can use JMX instead (using `false` configuration). It's also possible to deploy additional artifacts using `` configuration. Simply do: ``` mvn clean install ``` ### Client The `karaf-maven-example-client` example allows you to execute some shell commands on a running Karaf instance (using SSH) directly from Maven. It allows you to install features, change configuration or whatever, and get the output within Maven. It's possible to execute commands (specified with `` configuration) and/or scripts (specified with `` configuration). Simply do: ``` mvn clean install ``` ### KAR The `karaf-maven-example-kar` example shows how to create a KAR file containing project artifact. Simply do: ``` mvn clean install ``` ### Assembly The `karaf-maven-example-assembly` example shows how to create your own Karaf distribution easily. Simply do: ``` mvn clean install ```