From a9fd405794bc7d7ed5e4723d86d540e02f216ae3 Mon Sep 17 00:00:00 2001 From: Sabby Anandan Date: Tue, 19 Jul 2016 06:55:05 -0700 Subject: [PATCH] Update REAMDEs - remove hardcoded versions - add bulk app upload step - correct stream properties - remove redis requirement --- analytics/twitter-analytics/README.adoc | 8 ++ datascience/species-prediction/README.adoc | 17 +++-- streaming/http-to-cassandra/README.adoc | 38 +++++----- streaming/http-to-mysql/README.adoc | 86 +++------------------- 4 files changed, 51 insertions(+), 98 deletions(-) diff --git a/analytics/twitter-analytics/README.adoc b/analytics/twitter-analytics/README.adoc index 02d3728..03b7da5 100644 --- a/analytics/twitter-analytics/README.adoc +++ b/analytics/twitter-analytics/README.adoc @@ -51,6 +51,14 @@ dataflow:>version 1.0.0.BUILD-SNAPSHOT ``` ++ +. https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[Register] Kafka binder variant of out-of-the-box applications ++ + +``` +dataflow:>app import --uri http://bit.ly/stream-applications-kafka-maven +``` + + . Create and deploy the following streams + diff --git a/datascience/species-prediction/README.adoc b/datascience/species-prediction/README.adoc index d558920..2755334 100644 --- a/datascience/species-prediction/README.adoc +++ b/datascience/species-prediction/README.adoc @@ -12,7 +12,6 @@ We will begin by discussing the steps to prep, configure and operationalize Spri In order to get started, make sure that you have the following components: * Local build of link:https://github.com/spring-cloud/spring-cloud-dataflow[Spring Cloud Data Flow] -* Running instance of link:http://redis.io/[Redis] * Running instance of link:http://kafka.apache.org/downloads.html[Kafka] === Running the Sample Locally @@ -21,7 +20,7 @@ In order to get started, make sure that you have the following components: + ``` $ cd -$ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-server-local-1.0.0.BUILD-SNAPSHOT.jar +$ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-server-local-[VERSION].BUILD-SNAPSHOT.jar ``` + @@ -30,7 +29,7 @@ $ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-serv + ``` $ cd -$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0.BUILD-SNAPSHOT.jar +$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-[VERSION].BUILD-SNAPSHOT.jar ____ ____ _ __ / ___| _ __ _ __(_)_ __ __ _ / ___| | ___ _ _ __| | @@ -43,11 +42,19 @@ $ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0 | |_| | (_| | || (_| | | _| | | (_) \ V V / / / / / / / |____/ \__,_|\__\__,_| |_| |_|\___/ \_/\_/ /_/_/_/_/_/ -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT Welcome to the Spring Cloud Data Flow shell. For assistance hit TAB or type "help". dataflow:>version -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT +``` + ++ +. https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[Register] Kafka binder variant of out-of-the-box applications ++ + +``` +dataflow:>app import --uri http://bit.ly/stream-applications-kafka-maven ``` + diff --git a/streaming/http-to-cassandra/README.adoc b/streaming/http-to-cassandra/README.adoc index 89bfb56..8dc95ce 100644 --- a/streaming/http-to-cassandra/README.adoc +++ b/streaming/http-to-cassandra/README.adoc @@ -12,7 +12,6 @@ We will begin by discussing the steps to prep, configure and operationalize Spri In order to get started, make sure that you have the following components: * Local build of link:https://github.com/spring-cloud/spring-cloud-dataflow[Spring Cloud Data Flow] -* Running instance of link:http://redis.io/[Redis] * Running instance of link:http://kafka.apache.org/downloads.html[Kafka] * Running instance of link:http://cassandra.apache.org/[Apache Cassandra] * A database utility tool such as link:http://dbeaver.jkiss.org/[DBeaver] to connect to the Cassandra instance. You might have to provide `host`, `port`, `username` and `password` depending on the Cassandra configuration you are using. @@ -35,7 +34,7 @@ CREATE TABLE book ( + ``` $ cd -$ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-server-local-1.0.0.BUILD-SNAPSHOT.jar +$ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-server-local-[VERSION].BUILD-SNAPSHOT.jar ``` + @@ -44,7 +43,7 @@ $ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-serv + ``` $ cd -$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0.BUILD-SNAPSHOT.jar +$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-[VERSION].BUILD-SNAPSHOT.jar ____ ____ _ __ / ___| _ __ _ __(_)_ __ __ _ / ___| | ___ _ _ __| | @@ -57,22 +56,30 @@ $ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0 | |_| | (_| | || (_| | | _| | | (_) \ V V / / / / / / / |____/ \__,_|\__\__,_| |_| |_|\___/ \_/\_/ /_/_/_/_/_/ -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT Welcome to the Spring Cloud Data Flow shell. For assistance hit TAB or type "help". dataflow:>version -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT +``` + ++ +. https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[Register] Kafka binder variant of out-of-the-box applications ++ + +``` +dataflow:>app import --uri http://bit.ly/stream-applications-kafka-maven ``` + . Create the stream + ``` -dataflow:>stream create cassandrastream --definition "http --server.port=8888 --spring.cloud.stream.bindings.output.contentType='application/json' | cassandra --ingestQuery='insert into book (id, isbn, title, author) values (uuid(), ?, ?, ?)' --spring.cassandra.keyspace=clouddata" --deploy +dataflow:>stream create cassandrastream --definition "http --server.port=8888 --spring.cloud.stream.bindings.output.contentType='application/json' | cassandra --ingestQuery='insert into book (id, isbn, title, author) values (uuid(), ?, ?, ?)' --keyspace=clouddata" --deploy Created and deployed new stream 'cassandrastream' ``` -NOTE: If Cassandra isn't running on default port on `localhost` or if you need username and password to connect, use one of the following options to specify the necessary connection parameters: `--spring.cassandra.username='' --spring.cassandra.password='' --spring.cassandra.port= --spring.cassandra.contactPoints=` +NOTE: If Cassandra isn't running on default port on `localhost` or if you need username and password to connect, use one of the following options to specify the necessary connection parameters: `--username='' --password='' --port= --contact-points=` + . Verify the stream is successfully deployed @@ -118,7 +125,6 @@ In order to get started, make sure that you have the following components: * Cloud Foundry instance * Local build of https://github.com/spring-cloud/spring-cloud-dataflow[Spring Cloud Data Flow] * Local build of Spring Cloud Data Flow's https://github.com/spring-cloud/spring-cloud-dataflow-server-cloudfoundry[Cloud Foundry Server] -* Running instance of `redis` in Cloud Foundry * Running instance of `rabbit` in Cloud Foundry * Running instance of `cassandra` in Cloud Foundry or from another Cloud provider * A database utility tool such as link:http://dbeaver.jkiss.org/[DBeaver] to connect to the Cassandra instance. You might have to provide `host`, `port`, `username` and `password` depending on the Cassandra configuration you are using. @@ -173,7 +179,7 @@ dataflow-server started 1/1 1G 1G dataflow-server.a ``` $ cd -$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0.BUILD-SNAPSHOT.jar +$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-[VERSION].BUILD-SNAPSHOT.jar ____ ____ _ __ / ___| _ __ _ __(_)_ __ __ _ / ___| | ___ _ _ __| | @@ -186,7 +192,7 @@ $ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0 | |_| | (_| | || (_| | | _| | | (_) \ V V / / / / / / / |____/ \__,_|\__\__,_| |_| |_|\___/ \_/\_/ /_/_/_/_/_/ -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT Welcome to the Spring Cloud Data Flow shell. For assistance hit TAB or type "help". server-unknown:> @@ -199,19 +205,15 @@ server-unknown:> server-unknown:>dataflow config server http://dataflow-server.app.io Successfully targeted http://dataflow-server.app.io dataflow:>version -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT ``` + -. https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[Register] RabbitMQ binder variant of the `http` and `cassandra` applications +. https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[Register] RabbitMQ binder variant of out-of-the-box applications + ``` -dataflow:>module register --type source --name http --uri maven://org.springframework.cloud.stream.app:http-source-rabbit:1.0.0.BUILD-SNAPSHOT --force -Successfully registered module 'source:http' - -dataflow:>module register --type sink --name cassandra --uri maven://org.springframework.cloud.stream.app:cassandra-sink-rabbit:1.0.0.BUILD-SNAPSHOT --force -Successfully registered module 'sink:cassandra' +dataflow:>app import --uri http://bit.ly/stream-applications-rabbit-maven ``` + @@ -219,7 +221,7 @@ Successfully registered module 'sink:cassandra' + ``` -dataflow:>stream create cassandrastream --definition "http --spring.cloud.stream.bindings.output.contentType='application/json' | cassandra --ingestQuery='insert into book (id, isbn, title, author) values (uuid(), ?, ?, ?)' --spring.cassandra.username='' --spring.cassandra.password='' --spring.cassandra.port= --spring.cassandra.contactPoints= --spring.cassandra.keyspace=''" --deploy +dataflow:>stream create cassandrastream --definition "http --spring.cloud.stream.bindings.output.contentType='application/json' | cassandra --ingestQuery='insert into book (id, isbn, title, author) values (uuid(), ?, ?, ?)' --username='' --password='' --port= --contact-points= --keyspace=''" --deploy Created and deployed new stream 'cassandrastream' ``` diff --git a/streaming/http-to-mysql/README.adoc b/streaming/http-to-mysql/README.adoc index 1400fce..08283fa 100644 --- a/streaming/http-to-mysql/README.adoc +++ b/streaming/http-to-mysql/README.adoc @@ -12,7 +12,6 @@ We will begin by discussing the steps to prep, configure and operationalize Spri In order to get started, make sure that you have the following components: * Local build of https://github.com/spring-cloud/spring-cloud-dataflow[Spring Cloud Data Flow] -* Running instance of link:http://redis.io/[Redis] * Running instance of link:http://kafka.apache.org/downloads.html[Kafka] * Running instance of link:http://www.mysql.com/[MySQL] * A database utility tool such as link:http://dbeaver.jkiss.org/[DBeaver] or link:https://www.dbvis.com/[DbVisualizer] @@ -34,7 +33,7 @@ CREATE TABLE names ``` $ cd -$ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-server-local-1.0.0.BUILD-SNAPSHOT.jar +$ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-server-local-[VERSION].BUILD-SNAPSHOT.jar ``` + @@ -44,7 +43,7 @@ $ java -jar spring-cloud-dataflow-server-local/target/spring-cloud-dataflow-serv ``` $ cd -$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0.BUILD-SNAPSHOT.jar +$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-[VERSION].BUILD-SNAPSHOT.jar ____ ____ _ __ / ___| _ __ _ __(_)_ __ __ _ / ___| | ___ _ _ __| | @@ -57,47 +56,19 @@ $ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0 | |_| | (_| | || (_| | | _| | | (_) \ V V / / / / / / / |____/ \__,_|\__\__,_| |_| |_|\___/ \_/\_/ /_/_/_/_/_/ -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT Welcome to the Spring Cloud Data Flow shell. For assistance hit TAB or type "help". dataflow:>version -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT ``` + -. Patch the `jdbc` sink with `mysql` driver - -- build the https://github.com/spring-cloud/spring-cloud-stream-app-starters#spring-cloud-stream-app-starters[spring-cloud-stream-app-starters] project -- cd `jdbc-sink-kafka` -- modify `pom.xml` to include `mysql` driver (_remove `hsqldb`_) -+ -[source,xml] ----- - - org.hsqldb - hsqldb - 2.3.3 - test - - - mysql - mysql-connector-java - 5.1.37 - - - org.apache.tomcat - tomcat-jdbc - 8.0.33 - ----- -+ -- build project: `mvn clean install` -- force https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[register] the app in Spring Cloud Data Flow server +. https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[Register] Kafka binder variant of out-of-the-box applications + ``` -dataflow:>app register --name jdbc --type sink --uri maven://org.springframework.cloud.stream.app:jdbc-sink-kafka:1.0.0.BUILD-SNAPSHOT --force -Successfully registered application 'sink:jdbc' +dataflow:>app import --uri http://bit.ly/stream-applications-kafka-maven ``` + @@ -153,7 +124,6 @@ In order to get started, make sure that you have the following components: * Cloud Foundry instance * Local build of https://github.com/spring-cloud/spring-cloud-dataflow[Spring Cloud Data Flow] * Local build of Spring Cloud Data Flow's https://github.com/spring-cloud/spring-cloud-dataflow-server-cloudfoundry[Cloud Foundry Server] -* Running instance of `redis` in Cloud Foundry * Running instance of `rabbit` in Cloud Foundry * Running instance of `mysql` * A database utility tool such as link:http://dbeaver.jkiss.org/[DBeaver] or link:https://www.dbvis.com/[DbVisualizer] @@ -205,7 +175,7 @@ dataflow-server started 1/1 1G 1G dataflow-serv ``` $ cd -$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0.BUILD-SNAPSHOT.jar +$ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-[VERSION].BUILD-SNAPSHOT.jar ____ ____ _ __ / ___| _ __ _ __(_)_ __ __ _ / ___| | ___ _ _ __| | @@ -218,7 +188,7 @@ $ java -jar spring-cloud-dataflow-shell/target/spring-cloud-dataflow-shell-1.0.0 | |_| | (_| | || (_| | | _| | | (_) \ V V / / / / / / / |____/ \__,_|\__\__,_| |_| |_|\___/ \_/\_/ /_/_/_/_/_/ -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT Welcome to the Spring Cloud Data Flow shell. For assistance hit TAB or type "help". server-unknown:> @@ -231,49 +201,15 @@ server-unknown:> server-unknown:>dataflow config server http://dataflow-server.app.io Successfully targeted http://dataflow-server.app.io dataflow:>version -1.0.0.BUILD-SNAPSHOT +[VERSION].BUILD-SNAPSHOT ``` + -. Patch the `jdbc` sink with `mysql` driver - -- build the https://github.com/spring-cloud/spring-cloud-stream-app-starters#spring-cloud-stream-app-starters[spring-cloud-stream-app-starters] project -- cd `jdbc-sink-rabbit` -- modify `pom.xml` to include `mysql` driver (_remove `hsqldb`_) -+ -[source,xml] ----- - - org.hsqldb - hsqldb - 2.3.3 - test - - - mysql - mysql-connector-java - 5.1.37 - - - org.apache.tomcat - tomcat-jdbc - 8.0.33 - ----- -+ -- build project: `mvn clean install` -+ - -+ -. https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[Register] RabbitMQ binder variant of the `http` and `jdbc` applications +. https://github.com/spring-cloud/spring-cloud-dataflow/blob/master/spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc#register-a-stream-app[Register] RabbitMQ binder variant of out-of-the-box applications + ``` -dataflow:>app register --type source --name http --uri maven://org.springframework.cloud.stream.app:http-source-rabbit:1.0.0.BUILD-SNAPSHOT --force -Successfully registered application 'source:http' - -dataflow:>app register --type sink --name jdbc --uri maven://org.springframework.cloud.stream.app:jdbc-sink-rabbit:1.0.0.BUILD-SNAPSHOT --force -Successfully registered application 'sink:jdbc' +dataflow:>app import --uri http://bit.ly/stream-applications-rabbit-maven ``` +