Skip to content
Permalink
Browse files
IGNITE-16968 Fix the sources directory for extension release (#139)
  • Loading branch information
Mmuzaf committed May 13, 2022
1 parent 12cc59d commit a2e75dbef49345bbeed15ae289a2d0fd007bef0e
Showing 14 changed files with 38 additions and 30 deletions.
@@ -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
@@ -33,7 +33,7 @@
<!-- main project directory structure -->
<fileSet>
<directory>.</directory>
<outputDirectory>modules/${project.artifactId}</outputDirectory>
<outputDirectory>modules/${basedir.name}</outputDirectory>
<useDefaultExcludes>true</useDefaultExcludes>
<excludes>
<!-- build output -->
@@ -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.
@@ -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`.

@@ -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.
@@ -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.,
+
@@ -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.


@@ -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.


@@ -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
---------------------------------------------
@@ -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.


@@ -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
-------------------------------------------
@@ -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
@@ -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
-------------------------------------
@@ -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.

0 comments on commit a2e75db

Please sign in to comment.