Project Setup

Note: Because there has not been a release of Pravega deployed to Maven Central, yet, you currently first need to build the connectors from source before you can use them in a project.

Creating a Flink stream processing project

You can skip this step if you have a streaming project set up already.

The easiest way to set up a stream processing project with Apache Flink is to use these project templates and setup guidelines:

• Project template for Java
• Project template for Scala

After that, please follow the section below to add the Flink Pravega connectors to the project.

Add the connector dependencies

To add the Pravega connector dependencies to you project, add the following entry to your project file (for example pom.xml for Maven):

<dependency>
  <groupId>io.pravega</groupId>
  <artifactId>pravega-connectors-flink_2.11</artifactId>
  <version>0.3.0-SNAPSHOT</version>
</dependency>

Running / deploying the application

From Flink's perspective, the connector to Pravega is part of the streaming application (not part of Flink's core runtime), so the connector code must be part of the application's code artifact (JAR file). Typically, a Flink application is bundled as a fat-jar (also known as an uber-jar) such that all its dependencies are embedded.

If you have set up the project via the above linked templates/guides, everything should be set up properly.

If you set up a application's project and dependencies manually, you need to make sure that it builds a "jar with dependencies*, to include both the application and the connector classes.