From a2e75dbef49345bbeed15ae289a2d0fd007bef0e Mon Sep 17 00:00:00 2001 From: Maxim Muzafarov Date: Fri, 13 May 2022 11:04:21 +0300 Subject: [PATCH] IGNITE-16968 Fix the sources directory for extension release (#139) --- DEVNOTES.md | 14 +++++++++++--- assembly/source-release.xml | 2 +- docs/_docs/azure/azure.adoc | 4 ++-- docs/_docs/cdc/change-data-capture-extensions.adoc | 2 +- docs/_docs/gce/gce.adoc | 4 ++-- docs/_docs/kafka/kafka-streamer.adoc | 4 ++-- modules/aws-ext/README.txt | 4 ++-- modules/azure-ext/README.txt | 4 ++-- modules/camel-ext/README.txt | 6 +++--- modules/gce-ext/README.txt | 4 ++-- modules/hibernate-ext/hibernate/README.txt | 6 +++--- modules/kafka-ext/README.txt | 4 ++-- modules/twitter-ext/README.txt | 6 +++--- .../zookeeper-ip-finder/README.txt | 4 ++-- 14 files changed, 38 insertions(+), 30 deletions(-) diff --git a/DEVNOTES.md b/DEVNOTES.md index b484beb2..94dc1221 100644 --- a/DEVNOTES.md +++ b/DEVNOTES.md @@ -4,22 +4,30 @@ ## Build Instructions +### Build Requirements + +- JDK 8 +- Maven 3.6.3+ + ### Build all Extensions ```shell +# Run from the Ignite Extension project root mvn clean install -DskipTests -Pcheckstyle ``` ### Build an Extension ```shell -mvn clean install -f modules/sptring-boot-ext -Pcheckstyle +# Run from the Ignite Extension project root +mvn clean install -f modules/spring-boot-ext -Pcheckstyle -DskipTests ``` -OR +or ```shell -mvn clean install -pl :ignite-aws-ext -am -Pcheckstyle +# Run from the Ignite Extension project root +mvn clean install -pl :ignite-aws-ext -am -Pcheckstyle -DskipTests ``` ## Release Instructions diff --git a/assembly/source-release.xml b/assembly/source-release.xml index 21cf9d89..be66d76c 100644 --- a/assembly/source-release.xml +++ b/assembly/source-release.xml @@ -33,7 +33,7 @@ . - modules/${project.artifactId} + modules/${basedir.name} true diff --git a/docs/_docs/azure/azure.adoc b/docs/_docs/azure/azure.adoc index fd574dd7..a2281263 100644 --- a/docs/_docs/azure/azure.adoc +++ b/docs/_docs/azure/azure.adoc @@ -5,8 +5,8 @@ Apache Ignite Azure module provides Azure Blob Storage based implementation of I Depending on how you use Ignite, you can an extension using one of the following methods: -- If you use the binary distribution, move the `lib/optional/{module-dir}` to the lib directory before starting the node. -- Add libraries from `lib/optional/{module-dir}` to the classpath of your application. +- If you use the binary distribution, move the `libs/{module-dir}` to the `libs` directory of the Ignite distribution before starting the node. +- Add libraries from `libs/{module-dir}` to the classpath of your application. - Add a module as a Maven dependency to your project. diff --git a/docs/_docs/cdc/change-data-capture-extensions.adoc b/docs/_docs/cdc/change-data-capture-extensions.adoc index ca440c56..9f6a1a70 100644 --- a/docs/_docs/cdc/change-data-capture-extensions.adoc +++ b/docs/_docs/cdc/change-data-capture-extensions.adoc @@ -109,7 +109,7 @@ ignite-cdc-ext.zip . Unpack `ignite-cdc-ext.zip` archive to `$IGNITE_HOME` folder. -Now, you have additional binary `$IGNITE_HOME/bin/kafka-to-ignite.sh` and `$IGNITE_HOME/libs/optional/ignite-cdc-ext` module. +Now, you have additional binary `$IGNITE_HOME/bin/kafka-to-ignite.sh` and `$IGNITE_HOME/libs/ignite-cdc-ext` module. NOTE: Please, enable `ignite-cdc-ext` to be able to run `kafka-to-ignite.sh`. diff --git a/docs/_docs/gce/gce.adoc b/docs/_docs/gce/gce.adoc index d3fa148f..f4c02eb2 100644 --- a/docs/_docs/gce/gce.adoc +++ b/docs/_docs/gce/gce.adoc @@ -4,8 +4,8 @@ Apache Ignite GCE module provides Google Cloud Storage based implementations of Depending on how you use Ignite, you can an extension using one of the following methods: -- If you use the binary distribution, move the `lib/optional/{module-dir}` to the lib directory before starting the node. -- Add libraries from `lib/optional/{module-dir}` to the classpath of your application. +- If you use the binary distribution, move the `libs/{module-dir}` to the `libs` directory of the Ignite distribution before starting the node. +- Add libraries from `libs/{module-dir}` to the classpath of your application. - Add a module as a Maven dependency to your project. diff --git a/docs/_docs/kafka/kafka-streamer.adoc b/docs/_docs/kafka/kafka-streamer.adoc index e5ce06a9..aedb8969 100644 --- a/docs/_docs/kafka/kafka-streamer.adoc +++ b/docs/_docs/kafka/kafka-streamer.adoc @@ -25,13 +25,13 @@ Either of the following two methods can be used to achieve such streaming: == Streaming Data via Kafka Connect `IgniteSinkConnector` will help you export data from Kafka to Ignite cache by polling data from Kafka topics and writing -it to your specified cache. The connector can be found in the `optional/ignite-kafka` module. It and its dependencies +it to your specified cache. The connector can be found in the `ignite-kafka` module. It and its dependencies have to be on the classpath of a Kafka running instance, as described in the following subsection. _For more information on Kafka Connect, see http://kafka.apache.org/documentation.html#connect[Kafka Documentation, window=_blank]._ === Setting up and Running -. Add the `IGNITE_HOME/libs/optional/ignite-kafka` module to the application classpath. +. Add the `IGNITE_HOME/libs/ignite-kafka` module to the application classpath. . Prepare worker configurations, e.g., + diff --git a/modules/aws-ext/README.txt b/modules/aws-ext/README.txt index 110399a9..30829291 100644 --- a/modules/aws-ext/README.txt +++ b/modules/aws-ext/README.txt @@ -5,8 +5,8 @@ Apache Ignite AWS module provides S3-based implementations of checkpoint SPI and Depending on how you use Ignite, you can an extension using one of the following methods: -- If you use the binary distribution, move the lib/optional/{module-dir} to the lib directory before starting the node. -- Add libraries from lib/optional/{module-dir} to the classpath of your application. +- If you use the binary distribution, move the libs/{module-dir} to the 'libs' directory of the Ignite distribution before starting the node. +- Add libraries from libs/{module-dir} to the classpath of your application. - Add a module as a Maven dependency to your project. diff --git a/modules/azure-ext/README.txt b/modules/azure-ext/README.txt index b33f4b9c..be3f6968 100644 --- a/modules/azure-ext/README.txt +++ b/modules/azure-ext/README.txt @@ -5,8 +5,8 @@ Apache Ignite Azure module provides Azure Blob Storage based implementation of I Depending on how you use Ignite, you can an extension using one of the following methods: -- If you use the binary distribution, move the lib/optional/{module-dir} to the lib directory before starting the node. -- Add libraries from lib/optional/{module-dir} to the classpath of your application. +- If you use the binary distribution, move the libs/{module-dir} to the 'libs' directory of the Ignite distribution before starting the node. +- Add libraries from libs/{module-dir} to the classpath of your application. - Add a module as a Maven dependency to your project. diff --git a/modules/camel-ext/README.txt b/modules/camel-ext/README.txt index b300d51f..3f288092 100644 --- a/modules/camel-ext/README.txt +++ b/modules/camel-ext/README.txt @@ -5,9 +5,9 @@ Apache Ignite Camel provides a streamer to consume cache tuples from a Camel end HTTP, TCP, File, FTP, AMQP, SNMP, databases, etc. For more information on available components, refer to http://camel.apache.org/components.html. -To enable the Camel module when starting a standalone node, move 'optional/ignite-camel' folder -to 'libs' folder before running 'ignite.{sh|bat}' script. The content of the module folder will -be added to classpath in this case. +To enable the Camel module when starting a standalone node, move 'ignite-camel' folder +to the 'libs' directory of the Ignite distribution before starting the 'ignite.{sh|bat}' script. +The content of the module folder will be added to classpath in this case. Importing the Camel module in a Maven project --------------------------------------------- diff --git a/modules/gce-ext/README.txt b/modules/gce-ext/README.txt index 8e4d2fdd..d9b3808f 100644 --- a/modules/gce-ext/README.txt +++ b/modules/gce-ext/README.txt @@ -5,8 +5,8 @@ Apache Ignite GCE module provides Google Cloud Storage based implementations of Depending on how you use Ignite, you can an extension using one of the following methods: -- If you use the binary distribution, move the lib/optional/{module-dir} to the lib directory before starting the node. -- Add libraries from lib/optional/{module-dir} to the classpath of your application. +- If you use the binary distribution, move the libs/{module-dir} to the 'libs' directory of the Ignite distribution before starting the node. +- Add libraries from libs/{module-dir} to the classpath of your application. - Add a module as a Maven dependency to your project. diff --git a/modules/hibernate-ext/hibernate/README.txt b/modules/hibernate-ext/hibernate/README.txt index a38a38f1..6c16de0b 100644 --- a/modules/hibernate-ext/hibernate/README.txt +++ b/modules/hibernate-ext/hibernate/README.txt @@ -4,9 +4,9 @@ Apache Ignite Hibernate Module Apache Ignite Hibernate module provides Hibernate second-level cache (L2 cache) implementation based on Apache Ignite In-Memory Data Grid. -To enable Hibernate module when starting a standalone node, move 'optional/ignite-hibernate' folder to -'libs' folder before running 'ignite.{sh|bat}' script. The content of the module folder will -be added to classpath in this case. +To enable Hibernate module when starting a standalone node, move 'ignite-hibernate' folder to +the 'libs' directory of the Ignite distribution before starting the 'ignite.{sh|bat}' script. +The content of the module folder will be added to classpath in this case. Importing Hibernate Module In Maven Project ------------------------------------------- diff --git a/modules/kafka-ext/README.txt b/modules/kafka-ext/README.txt index 21852912..5977ff45 100644 --- a/modules/kafka-ext/README.txt +++ b/modules/kafka-ext/README.txt @@ -38,7 +38,7 @@ interested in): Sink Connector will help you export data from Kafka to Ignite cache. It polls data from Kafka topics and writes it to the user-specified cache. For more information on Kafka Connect, see [Kafka Documentation](http://kafka.apache.org/documentation.html#connect). -Connector can be found in 'optional/ignite-kafka.' It and its dependencies have to be on the classpath of a Kafka running instance, +Connector can be found in 'ignite-kafka.' It and its dependencies have to be on the classpath of a Kafka running instance, as described in the following subsection. ### Setting up and Running @@ -136,7 +136,7 @@ http://node1:8080/ignite?cmd=size&cacheName=cache1 Source connector enables listening to Ignite cache events and, upon filtering, stream them to Kafka. -Connector can be found in 'optional/ignite-kafka.' It and its dependencies have to be on the classpath of a Kafka running instance, +Connector can be found in 'ignite-kafka.' It and its dependencies have to be on the classpath of a Kafka running instance, as described in the following subsection. ### Setting up and Running diff --git a/modules/twitter-ext/README.txt b/modules/twitter-ext/README.txt index fee78d43..2bc44488 100644 --- a/modules/twitter-ext/README.txt +++ b/modules/twitter-ext/README.txt @@ -3,9 +3,9 @@ Apache Ignite Twitter Streamer Module Apache Ignite Twitter Streamer module provides streaming from Twitter to Ignite cache. -To enable Twitter Streamer module when starting a standalone node, move 'optional/ignite-twitter' folder to -'libs' folder before running 'ignite.{sh|bat}' script. The content of the module folder will -be added to classpath in this case. +To enable Twitter Streamer module when starting a standalone node, move 'ignite-twitter' folder to +the 'libs' directory of the Ignite distribution before starting the 'ignite.{sh|bat}' script. +The content of the module folder will be added to classpath in this case. Importing Ignite Twitter Streamer Module In Maven Project ------------------------------------- diff --git a/modules/zookeeper-ip-finder-ext/zookeeper-ip-finder/README.txt b/modules/zookeeper-ip-finder-ext/zookeeper-ip-finder/README.txt index c39a394c..d5920e1c 100644 --- a/modules/zookeeper-ip-finder-ext/zookeeper-ip-finder/README.txt +++ b/modules/zookeeper-ip-finder-ext/zookeeper-ip-finder/README.txt @@ -6,8 +6,8 @@ directory to locate other Ignite nodes to connect to. Depending on how you use Ignite, you can an extension using one of the following methods: -- If you use the binary distribution, move the lib/optional/{module-dir} to the lib directory before starting the node. -- Add libraries from lib/optional/{module-dir} to the classpath of your application. +- If you use the binary distribution, move the libs/{module-dir} to the 'libs' directory of the Ignite distribution before starting the node. +- Add libraries from libs/{module-dir} to the classpath of your application. - Add a module as a Maven dependency to your project. The module depends on third-party libraries that use the slf4j facade for logging.