diff --git a/README.md b/README.md index 94e40e833b..4765a0dc61 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,21 @@ To install from source, follow the instructions in the Development section below Deployment ---------- -The REST proxy includes a built-in Jetty server. The wrapper scripts -``bin/kafka-rest-start`` and ``bin/kafka-rest-stop`` are the recommended method of -starting and stopping the service. +The REST proxy includes a built-in Jetty server and can be deployed after +being configured to connect to an existing Kafka cluster. + +Running ``mvn clean package`` runs all 3 of its assembly targets. +- The ``development`` target assembles all necessary dependencies in a ``kafka-rest/target`` + subfolder without packaging them in a distributable format. The wrapper scripts + ``bin/kafka-rest-start`` and ``bin/kafka-rest-stop`` can then be used to start and stop the + service. +- The ``package`` target is meant to be used in shared dependency environments and omits some + dependencies expected to be provided externally. It assembles the other dependencies in a + ``kafka-rest/target`` subfolder as well as in distributable archives. The wrapper scripts + ``bin/kafka-rest-start`` and ``bin/kafka-rest-stop`` can then be used to start and stop the + service. +- The ``standalone`` target packages all necessary dependencies as a distributable JAR that can + be run as standard (``java -jar $base-dir/kafka-rest/target/kafka-rest-X.Y.Z-standalone.jar``). Quickstart ---------- @@ -83,7 +95,7 @@ the REST Proxy running using the default settings and some topics already create Development ----------- -To build a development version, you may need a development versions of +To build a development version, you may need development versions of [common](https://github.com/confluentinc/common), [rest-utils](https://github.com/confluentinc/rest-utils), and [schema-registry](https://github.com/confluentinc/schema-registry). After diff --git a/bin/kafka-rest-run-class b/bin/kafka-rest-run-class index 1d393722a1..4f14f887bb 100755 --- a/bin/kafka-rest-run-class +++ b/bin/kafka-rest-run-class @@ -18,7 +18,7 @@ base_dir=$(dirname $0)/.. # Development jars. `mvn package` should collect all the required dependency jars here for dir in $base_dir/kafka-rest/target/kafka-rest-*-development; do - CLASSPATH=$CLASSPATH:$dir/share/java/kafka-rest-bin/*:$dir/share/java/kafka-rest-lib/* + CLASSPATH=$CLASSPATH:$dir/share/java/kafka-rest/* done # Production jars diff --git a/kafka-rest/pom.xml b/kafka-rest/pom.xml index 9aaf339360..6099627b7c 100644 --- a/kafka-rest/pom.xml +++ b/kafka-rest/pom.xml @@ -167,6 +167,7 @@ src/assembly/development.xml src/assembly/package.xml + src/assembly/standalone.xml @@ -203,22 +204,4 @@ - - - standalone - - - - maven-assembly-plugin - - - src/assembly/standalone.xml - - - - - - - - diff --git a/kafka-rest/src/assembly/package.xml b/kafka-rest/src/assembly/package.xml index 3acc2583b5..5a2d243a7f 100644 --- a/kafka-rest/src/assembly/package.xml +++ b/kafka-rest/src/assembly/package.xml @@ -3,7 +3,7 @@ xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> package