Skip to content

Download or Build

Regunath B edited this page Sep 17, 2021 · 4 revisions

This page lists Maven Dependencies for applications that intend to use Flux.

Flux release repository

Flux builds are distributed via the Clojars community maintained repository for open source libraries. A sample Maven settings file with relevant public repositories is available here : Maven user settings (Note : The artifactory settings may need to be suitably modified if you have a local instance or removed altogether if your build relies entirely on public repositories.)

Add the following repository to your Maven settings or POM build file to access releases builds:

<repository>
    <id>clojars</id>
    <name>Clojars repository</name>
    <url>https://clojars.org/repo</url>
</repository>

Maven artifacts

Flux is made up of multiple modules. These modules allow users to write their own workflows using the client SDK or just use the runtime engine and its Http API interface. Version of these artifacts map to stable releases. For e.g. 1.0.0 for Version 1.0.0.

Examples

GroupID/Org ArtifactID/Name Description
com.flipkart.flux examples Examples for different Flux features

Client SDK

GroupID/Org ArtifactID/Name Description
com.flipkart.flux client Client SDK for writing workflows and state machines

Runtime

GroupID/Org ArtifactID/Name Description
com.flipkart.flux task Task execution support, Concurrency, Retries
com.flipkart.flux runtime Container for Flux, the API gateways, State management

Model

GroupID/Org ArtifactID/Name Description
com.flipkart.flux model Domain entities and interfaces for programming on Flux

Persistence-MySQL

GroupID/Org ArtifactID/Name Description
com.flipkart.flux persistence-mysql Persistence bindings for MySQL

Redriver

GroupID/Org ArtifactID/Name Description
com.flipkart.flux redriver Used for global retries (refer redriver section of feature set)

Building Flux

Flux uses the Maven build system. Flux may be built as follows after cloning from this github repository:

cd flux
mvn clean install -DskipTests

In order to build with tests, execute:

`mvn -Dflux.orchestration.configurationFile=<path where flux is checked out>/flux/runtime/src/main/resources/packaged/orchestrationConfiguration.yml clean install
Clone this wiki locally