Manual Installation

If Docker does not suit your needs, you can manually install the parts you need to run Spring Cloud Data Flow.

Downloading Server Jars

To begin, you need to download the server jars. To do so:

  1. Download the Spring Cloud Data Flow Server and shell by using the following commands:

    wget https://repo.spring.io/release/org/springframework/cloud/spring-cloud-dataflow-server/2.1.2.RELEASE/spring-cloud-dataflow-server-2.1.2.RELEASE.jar
    wget https://repo.spring.io/release/org/springframework/cloud/spring-cloud-dataflow-shell/2.1.2.RELEASE/spring-cloud-dataflow-shell-2.1.2.RELEASE.jar
  2. Download Skipper by running the following command:

    wget https://repo.spring.io/release/org/springframework/cloud/spring-cloud-skipper-server/2.0.3.RELEASE/spring-cloud-skipper-server-2.0.3.RELEASE.jar

If you're interested in trying out the latest BUILD-SNAPSHOT (aka: snapshot build from the master branch) of SCDF and Skipper's upstream versions, please use the following wget commands.

wget https://repo.spring.io/snapshot/org/springframework/cloud/spring-cloud-dataflow-server/2.2.0.BUILD-SNAPSHOT/spring-cloud-dataflow-server-2.2.0.BUILD-SNAPSHOT.jar
wget https://repo.spring.io/snapshot/org/springframework/cloud/spring-cloud-dataflow-shell/2.2.0.BUILD-SNAPSHOT/spring-cloud-dataflow-shell-2.2.0.BUILD-SNAPSHOT.jar
wget https://repo.spring.io/snapshot/org/springframework/cloud/spring-cloud-skipper-server/2.1.0.BUILD-SNAPSHOT/spring-cloud-skipper-server-2.1.0.BUILD-SNAPSHOT.jar

Install Messaging Middleware

These instructions require that RabbitMQ be running on the same machine as Skipper, Spring Cloud Data Flow server, and Shell.

To install and run the RabbitMQ docker image, use the following command:

docker run -d --hostname rabbitmq --name rabbitmq -p 15672:15672 -p 5672:5672 rabbitmq:3.7.14-management

Starting Server Jars

Now you need to start the applications that comprise the server. To do so:

  1. Start Skipper. To do so, in the directory where you downloaded Skipper, run the server by using java -jar, as follows:

    java -jar spring-cloud-skipper-server-2.0.3.RELEASE.jar
  2. Start the Data Flow Server. To do so, in a different terminal window and in the directory where you downloaded Data Flow, run the server by using java -jar, as follows:

    java -jar spring-cloud-dataflow-server-2.1.2.RELEASE.jar

    If Skipper and the Data Flow server are not running on the same host, set the spring.cloud.skipper.client.serverUri configuration property to the location of Skipper, as shown in the following example:

    java -jar spring-cloud-dataflow-server-2.1.2.RELEASE.jar --spring.cloud.skipper.client.serverUri=https://192.51.100.1:7577/api
  3. If you want to use the Spring Cloud Data Flow shell, start it with the following command:

    java -jar spring-cloud-dataflow-shell-2.1.2.RELEASE.jar

    If the Data Flow Server and shell are not running on the same host, you can also point the shell to the Data Flow server URL by using the dataflow config server command in Shell, as the following example shows:

    server-unknown:>dataflow config server https://198.51.100.0
    Successfully targeted https://198.51.100.0

    Alternatively, you can pass in the --dataflow.uri command line option. The shell’s --help command line option shows what is available.

Proxy Servers

If you run Spring Cloud Data Flow Server behind a proxy server (such as Zuul), you may also need to set the server.use-forward-headers property to true. An example that uses Zuul is available in the Spring Cloud Data Flow Samples repository on GitHub. Additional information is also available in the Spring Boot Reference Guide.

Accessing Data Flow Dashboard

You can now navigate to Spring Cloud Data Flow Dashboard. In your browser, navigate to the Spring Cloud Data Flow Dashboard URL.

Registering Prebuilt Applications

All the prebuilt streaming applications:

  • Are available as Apache Maven artifacts or Docker images.
  • Use RabbitMQ or Apache Kafka.
  • Support monitoring through Prometheus and InfluxDB.
  • Contain metadata for application properties used in the UI and code completion in the shell.

You can register applications individually by using the app register command or in bulk by using the app import command. There are also bulk-registration links that represent the group of prebuilt applications for a specific release, which are useful for getting started.

You can register stream and task applications by using the UI or the shell.

For streams, depending on whether you use Kafka or RabbitMQ, you can register the applications by using the respective URLs:

For tasks, you can use the following URL: https://dataflow.spring.io/task-maven-latest

From the Data Flow Shell, you can bulk import and register the applications, as the following example shows:

dataflow:>app import --uri https://dataflow.spring.io/kafka-maven-latest