README.md

piveau pipe launcher

Library for pipe actions in a piveau cluster.

Features

• Internal management of pipes
• Convenient API
• Vert.x support

Table of Contents

1. Build & Install
2. Get started
3. Cluster configuration
4. License

Build and Install

Requirements:

• Git
• Maven
• Java

$ git clone https://github.com/piveau-data/piveau-pipe-launcher.git
$ cd piveau-pipe-launcher
$ mvn install

Use

Add dependency to your project pom file:

<dependency>
    <groupId>io.piveau</groupId>
    <artifactId>pipe-launcher</artifactId>
    <version>1.0.1</version>
</dependency>

Get started

The launcher works in a piveau cluster. Therefore, the first step is to create and configure a piveau cluster object.

Future<PiveauCluster> future = PiveauCluster.init(vertx, config);
future.setHandler(ar -> {
    if (ar.succeded()) {
        ...
    } else {
        ...
    }
});

config is a JSON object defining pipe repos and service discovery. See Cluster configuration for details.

Then retrieve the pipe launcher associated to this cluster

PipeLauncher launcher = cluster.pipeLauncher();

To get a list of all available pipes:

List<Pipe> pipes = launcher.availablePipes();

And finally, launch pipes:

// run pipe simply by name
Future<Void> future1 = launcher.runPipe("mypipe");
future.setHandler(ar -> {
    if (ar.succeded()) {
        ...
    } else {
        ...
    }
});

// run pipe by name with initial data
Future<Void> future1 = launcher.runPipeWithData("mypipe", data, mimeType)
future.setHandler(ar -> {
    if (ar.succeded()) {
        ...
    } else {
        ...
    }
});

You can run pipes with and without payload data, binary or string data, with or without specific segment configurations, and more. The launcher interface will provide more convenient methods in next releases.

Cluster configuration

The current release allows to configure pipe repositories and a very simple service discovery mechanism based on a manually defined map of service names to endpoints

{
  "pipeRepositories": {
    ...
  },
  "serviceDiscovery": {
    ...
  }
}

Pipe repositories

Pipe repositories are a map of named locations for json files. The repo named resources should contain paths loaded from the classpath, all others are treated as git repositories.

"pipeRepositories": {
  "resources": {
    "paths": [ "pipes" ]
  },
  "system": {
    "uri": "",
    "branch": "master",
    "username": "",
    "token": ""
  }
}

Service discovery

The current service discovery is a JSON map of segment names to endpoints. Currently http and eventbus endpoints are supported.

"serviceDiscovery": {
  "test1-segment": {
    "http": {
      "method": "POST",
      "address": "http://example.com:8080/pipe"
    },
    "eventbus": {
      "address": "piveau.pipe.test.queue"
    } 
  },
  "test2-segment": {
    ...
  }
}

License

Apache License, Version 2.0