Skip to content

Commit

Permalink
Merge pull request #281 from marklogic/release/1.1.3
Browse files Browse the repository at this point in the history
Merge 1.1.3 into main
  • Loading branch information
rjrudin authored Oct 21, 2024
2 parents 3d4bf73 + ca69998 commit 5610ce5
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 19 deletions.
8 changes: 4 additions & 4 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ To add Flux as a dependency to your application, add the following to your Maven
<dependency>
<groupId>com.marklogic</groupId>
<artifactId>flux-api</artifactId>
<version>1.1.2</version>
<version>1.1.3</version>
</dependency>
```

Or if you are using Gradle, add the following to your `build.gradle` file:

```
dependencies {
implementation "com.marklogic:flux-api:1.1.2"
implementation "com.marklogic:flux-api:1.1.3"
}
```

Expand Down Expand Up @@ -97,7 +97,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath "com.marklogic:flux-api:1.1.2"
classpath "com.marklogic:flux-api:1.1.3"
}
}
```
Expand Down Expand Up @@ -139,7 +139,7 @@ buildscript {
mavenCentral()
}
dependencies {
classpath "com.marklogic:flux-api:1.1.2"
classpath "com.marklogic:flux-api:1.1.3"
classpath("com.marklogic:ml-gradle:4.8.0") {
exclude group: "com.fasterxml.jackson.databind"
exclude group: "com.fasterxml.jackson.core"
Expand Down
16 changes: 8 additions & 8 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ This guide describes how to get started with Flux with some examples demonstrati
## Setup

You can download the latest release of the Flux application zip from [the latest Flux release page](https://github.com/marklogic/flux/releases).
The Flux application zip is titled `marklogic-flux-1.1.2.zip`. You can extract this zip to any location on your
The Flux application zip is titled `marklogic-flux-1.1.3.zip`. You can extract this zip to any location on your
filesystem that you prefer.

### Deploying the example application

The examples in this guide, along with examples found throughout this documentation, depend on a small MarkLogic
application that can be deployed to your own instance of MarkLogic server. The application can be downloaded from
[the latest Flux release page](https://github.com/marklogic/flux/releases) in a zip titled
`marklogic-flux-getting-started-1.1.2.zip`. To use Flux with this example application, perform the following steps:
`marklogic-flux-getting-started-1.1.3.zip`. To use Flux with this example application, perform the following steps:

1. Extract the `marklogic-flux-getting-started-1.1.2.zip` file to any location on your local filesystem.
2. Run `cd marklogic-flux-getting-started-1.1.2` to change to the directory created by extracting the ZIP file.
1. Extract the `marklogic-flux-getting-started-1.1.3.zip` file to any location on your local filesystem.
2. Run `cd marklogic-flux-getting-started-1.1.3` to change to the directory created by extracting the ZIP file.
3. Create a file named `gradle-local.properties` and add `mlPassword=your MarkLogic admin user password` to it.
4. Examine the contents of the `gradle.properties` file to ensure that the value of `mlHost` points to your MarkLogic
server and that the value of `mlRestPort` is a port available for a new MarkLogic app server to use.
Expand All @@ -38,15 +38,15 @@ privileges for running the examples in this guide. Finally, the application incl
[MarkLogic TDE template](https://docs.marklogic.com/guide/app-dev/TDE) that creates a view in MarkLogic for the purpose
of demonstrating commands that utilize a [MarkLogic Optic query](https://docs.marklogic.com/guide/app-dev/OpticAPI).

It is recommended to extract the Flux application zip into the `marklogic-flux-getting-started-1.1.2` directory so that
It is recommended to extract the Flux application zip into the `marklogic-flux-getting-started-1.1.3` directory so that
you can easily execute the examples in this guide. After extracting the application zip, the directory should have a
structure similar to this (not all files may be shown):

```
./marklogic-flux-getting-started-1.1.2
./marklogic-flux-getting-started-1.1.3
build.gradle
./data
./marklogic-flux-1.1.2
./marklogic-flux-1.1.3
./gradle
gradle.properties
gradlew
Expand All @@ -59,7 +59,7 @@ structure similar to this (not all files may be shown):
You can run Flux without any options to see the list of available commands. If you are using Flux to run these examples,
first change your current directory to where you extract Flux:

cd marklogic-flux-1.1.2
cd marklogic-flux-1.1.3

And then run the Flux executable without any options:

Expand Down
8 changes: 4 additions & 4 deletions docs/spark-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Flux integrates with [spark-submit](https://spark.apache.org/docs/latest/submitt
submit a Flux command invocation to a remote Spark cluster. Every Flux command is a Spark application, and thus every
Flux command, along with all of its option, can be invoked via `spark-submit`.

To use Flux with `spark-submit`, first download the `marklogic-flux-1.1.2-all.jar` file from the
[GitHub release page](https://github.com/marklogic/flux/releases/tag/1.1.2). This jar file includes Flux and all of
To use Flux with `spark-submit`, first download the `marklogic-flux-1.1.3-all.jar` file from the
[GitHub release page](https://github.com/marklogic/flux/releases/tag/1.1.3). This jar file includes Flux and all of
its dependencies, excluding those of Spark itself, which will be provided via the Spark cluster that you connect to
via `spark-submit`.

Expand All @@ -48,7 +48,7 @@ The following shows a notional example of running the Flux `import-files` comman
```
$SPARK_HOME/bin/spark-submit --class com.marklogic.flux.spark.Submit \
--master spark://changeme:7077 \
marklogic-flux-1.1.2-all.jar \
marklogic-flux-1.1.3-all.jar \
import-files \
--path path/to/data \
--connection-string user:password@host:8000 \
Expand All @@ -59,7 +59,7 @@ $SPARK_HOME/bin/spark-submit --class com.marklogic.flux.spark.Submit \
```
$SPARK_HOME\bin\spark-submit --class com.marklogic.flux.spark.Submit ^
--master spark://changeme:7077 ^
marklogic-flux-1.1.2-all.jar ^
marklogic-flux-1.1.3-all.jar ^
import-files ^
--path path/to/data ^
--connection-string user:password@host:8000 ^
Expand Down
4 changes: 2 additions & 2 deletions examples/client-project/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ buildscript {
mavenLocal()
}
dependencies {
classpath "com.marklogic:flux-api:1.1.2"
classpath "com.marklogic:flux-api:1.1.3"

// Demonstrates removing the Jackson libraries that otherwise cause a conflict with
// Spark, which requires Jackson >= 2.14.0 and < 2.15.0.
Expand All @@ -28,7 +28,7 @@ repositories {
}

dependencies {
implementation "com.marklogic:flux-api:1.1.2"
implementation "com.marklogic:flux-api:1.1.3"
}

tasks.register("runApp", JavaExec) {
Expand Down
11 changes: 11 additions & 0 deletions flux-cli/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ configurations {
shadowDependencies
}

configurations.all {
// By default, Spark 3.5.3 does not include the log4j 1.x dependency via its zookeeper dependency. But somehow, by
// adding hadoop-client 3.3.4 to the mix, the log4j 1.x dependency comes via the zookeeper 3.6.3 dependency. Per
// the release notes at https://zookeeper.apache.org/doc/r3.6.4/releasenotes.html, using zookeeper 3.6.4 - which
// removes log4j 1.x, thus avoiding the major CVE associated with log4j 1.x - appears safe, which is confirmed by
// tests as well.
resolutionStrategy {
force "org.apache.zookeeper:zookeeper:3.6.4"
}
}

dependencies {
implementation("org.apache.spark:spark-sql_2.12:3.5.3") {
// The rocksdbjni dependency weighs in at 50mb and so far does not appear necessary for our use of Spark.
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version=1.1.2
version=1.1.3

# Define these on the command line to publish to OSSRH
# See https://central.sonatype.org/publish/publish-gradle/#credentials for more information
Expand Down

0 comments on commit 5610ce5

Please sign in to comment.