Skip to main content

Setting up Spring Cloud Data Flow Server

Spring cloud data flow server can be used to setup the pipeline of tasks or streams. Tasks and streams can be registered with data flow server and can be executed or monitored either using cloud data flow shell or data flow server UI console/ dashboard.

Setting up Data flow server

Spring cloud data flow server can be setup using two ways, either use spring provided spring boot application or develop your own spring cloud data flow server as spring boot application.

Using Spring provided Data flow server application

There are many ways to setup data flow server as given below.
  • Local Machine
  • Cloud Foundry
  • Kubernetes
Please refer below documentation for more details for above installation types.
https://dataflow.spring.io/docs/installation/

Create Spring boot application as Data flow server

Here I will show you how to create your own spring boot application as spring cloud data flow server which you can run anywhere locally or in cloud. It gives you more freedom with application to setup the other dependencies like database or security features.

Maven Dependencies

We have used Spring Boot version 2.1.6.RELEASE which is supported by the current version of data flow server (2.2.1.RELEASE). Below are the dependencies required in pom.xml
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-dataflow-server</artifactId>
            <version>2.2.1.RELEASE</version>
        </dependency>

application.properties

In this properties file we are just creating an in-memory database using H2. However it is not required as it will automatically setup one if we don't configure it. We can use these properties to use any other database.
spring.datasource.url=jdbc:h2:tcp://localhost:19092/mem:dataflow
spring.datasource.jdbcUrl=jdbc:h2:tcp://localhost:19092/mem:dataflow
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=

spring.jpa.database-platform=org.hibernate.dialect.H2Dialect

MainDataFlowServerApplication.java

This is our main class which need to be annotated  with @EnableDataFlowServer annotation. Since we are going to run this application in our local machine, we need to exclude some auto configurations like cloud foundry, kubernetes etc. until we intend to actually configure them. When required we can remove them from exclusions and configure necessary properties for auto configuration. See the below code.
@EnableDataFlowServer
@SpringBootApplication(
        exclude = {SessionAutoConfiguration.class,
                ManagementWebSecurityAutoConfiguration.class,
                SecurityAutoConfiguration.class,
                UserDetailsServiceAutoConfiguration.class,
                LocalDeployerAutoConfiguration.class,
                CloudFoundryDeployerAutoConfiguration.class,
                KubernetesAutoConfiguration.class}
)
public class MainDataFlowServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(MainDataFlowServerApplication.class, args);
    }
}

Git URL

Below GIT URL contains complete source code.
https://github.com/thetechnojournals/spring-tutorials/tree/master/SpringCloudDataFlowServer

Running data flow server application

Once you done with all required code and configuration setup, you can build the application and use below maven command to start your data flow server.
mvn spring-boot:run
Once application is started, hit the below URL in browser and you will see the given screen as dashboard of data flow server application where you can see all registered task and streams.\
URL: http://localhost:9393/dashboard/

spring-cloud-dataflow-server

Check my another post on registering and executing Spring Batch application with Spring cloud data flow server.
https://www.thetechnojournals.com/2019/12/spring-batch-job-with-spring-cloud-data.html

Comments

Post a Comment

Popular Posts

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=...

jaxb2-maven-plugin to generate java code from XSD schema

In this tutorial I will show how to generate the Java source code from XSD schema. I will use jaxb2-maven-plugin to generate the code using XSD file which will be declared in pom.xml to make it part of build, so when maven build is executed it will generate the java code using XSD. Class generation can be controlled in plugin configuration. Maven changes (pom.xml) Include below plugin in your pom.xml. Here we have done some configuration under configuration section as given below. schemaDirectory : This is the directory where I keep my schema (XSD file). outputDirectory : This is the java source location where I want to generate the Java files. If it is not given then by default it will be generate inside target folder. clearOutputDir : If this property is true then it will generate the classes on each build otherwise it will generate only if output directory is empty. <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jaxb2-maven-plugin</art...

Multiple data source with Spring boot, batch and cloud task

Here we will see how we can configure different datasource for application and batch. By default, Spring batch stores the job details and execution details in database. If separate data source is not configured for spring batch then it will use the available data source in your application if configured and create batch related tables there. Which may be the unwanted burden on application database and we would like to configure separate database for spring batch. To overcome this situation we will configure the different datasource for spring batch using in-memory database, since we don't want to store batch job details permanently. Other thing is the configuration of  spring cloud task in case of multiple datasource and it must point to the same data source which is pointed by spring batch. In below sections, we will se how to configure application, batch and cloud task related data sources. Application Data Source Define the data source in application properties or yml con...

Microservices with Spring Boot - complete tutorial

In this tutorial we are going to learn how to develop microservices using spring boot with examples. Main focus of this tutorial is on learning by doing hands-on. Before hands-on we will first understand what is microservices and related terminologies like DDD, 12-Factors App, Dev Ops. What is a Microservice In simple terms microservice is a piece of software which has a single responsibility and can be developed, tested & deployed independently. In microservices we focus on developing independent and single fully functioning modules. Opposite to microservice, with monolithic application it focuses on all the functionality or modules in a single application. So when any changes required to monolithic application it has to deploy and test the complete application while with microservice it has to develop and deploy only affected component which is a small service. It saves lot of development and deployment time in a large application. It's basically an architectural style ...