You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streams.apache.org by sb...@apache.org on 2016/10/23 14:07:51 UTC
incubator-streams git commit: move the example help pages relating to
specific modules into those modules
Repository: incubator-streams
Updated Branches:
refs/heads/master b13d8d631 -> e50576a14
move the example help pages relating to specific modules into those modules
Project: http://git-wip-us.apache.org/repos/asf/incubator-streams/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams/commit/e50576a1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams/tree/e50576a1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams/diff/e50576a1
Branch: refs/heads/master
Commit: e50576a14dafc6e4889fced8707410417741e713
Parents: b13d8d6
Author: Steve Blackmon @steveblackmon <sb...@apache.org>
Authored: Sun Oct 23 09:07:47 2016 -0500
Committer: Steve Blackmon @steveblackmon <sb...@apache.org>
Committed: Sun Oct 23 09:07:47 2016 -0500
----------------------------------------------------------------------
.../src/site/markdown/elasticsearch.md | 33 ++++++++++++++++++++
.../src/site/site.xml | 25 +++++++++++++++
.../src/site/markdown/neo4j.md | 28 +++++++++++++++++
.../streams-persist-graph/src/site/site.xml | 25 +++++++++++++++
.../src/site/markdown/mongo.md | 33 ++++++++++++++++++++
.../streams-persist-mongo/src/site/site.xml | 25 +++++++++++++++
.../src/site/markdown/twitter.md | 22 +++++++++++++
.../streams-provider-twitter/src/site/site.xml | 25 +++++++++++++++
8 files changed, 216 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/e50576a1/streams-contrib/streams-persist-elasticsearch/src/site/markdown/elasticsearch.md
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-persist-elasticsearch/src/site/markdown/elasticsearch.md b/streams-contrib/streams-persist-elasticsearch/src/site/markdown/elasticsearch.md
new file mode 100644
index 0000000..14454a7
--- /dev/null
+++ b/streams-contrib/streams-persist-elasticsearch/src/site/markdown/elasticsearch.md
@@ -0,0 +1,33 @@
+## Elasticsearch
+
+Start elasticsearch via docker with the docker maven plugin:
+
+ docker -PdockerITs docker:start
+
+Confirm that elasticsearch is running:
+
+ docker ps
+
+Confirm that host and post(s) are in property file:
+
+ cat elasticsearch.properties
+
+Create a local file `elasticsearch.conf` with cluster details:
+
+ elasticsearch {
+ hosts += ${es.tcp.host}
+ port = ${es.tcp.port}
+ clusterName = "elasticsearch"
+ }
+
+When configuring a stream, include these files:
+
+ include "elasticsearch.properties"
+ include "elasticsearch.conf"
+
+Supply application-specific configuration as well:
+
+ elasticsearch {
+ index: ""
+ type: ""
+ }
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/e50576a1/streams-contrib/streams-persist-elasticsearch/src/site/site.xml
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-persist-elasticsearch/src/site/site.xml b/streams-contrib/streams-persist-elasticsearch/src/site/site.xml
new file mode 100644
index 0000000..e4a3647
--- /dev/null
+++ b/streams-contrib/streams-persist-elasticsearch/src/site/site.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<project>
+ <body>
+ <links name="Help">
+ <item name="Elasticsearch" href="elasticsearch.html"/>
+ </links>
+ </body>
+</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/e50576a1/streams-contrib/streams-persist-graph/src/site/markdown/neo4j.md
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-persist-graph/src/site/markdown/neo4j.md b/streams-contrib/streams-persist-graph/src/site/markdown/neo4j.md
new file mode 100644
index 0000000..c86ee8d
--- /dev/null
+++ b/streams-contrib/streams-persist-graph/src/site/markdown/neo4j.md
@@ -0,0 +1,28 @@
+## Neo4j
+
+Start neo4j via docker with the docker maven plugin:
+
+ docker -PdockerITs docker:start
+
+Confirm that neo4j is running:
+
+ docker ps
+
+Confirm that host and post(s) are in property file:
+
+ cat neo4j.properties
+
+Create a local file `neo4j.conf` with cluster details:
+
+ neo4j {
+ hostname = ${neo4j.tcp.host}
+ port = ${neo4j.tcp.port}
+ type = "neo4j"
+ graph = "data"
+ }
+
+When configuring a stream, include these files:
+
+ include "neo4j.properties"
+ include "neo4j.conf"
+
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/e50576a1/streams-contrib/streams-persist-graph/src/site/site.xml
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-persist-graph/src/site/site.xml b/streams-contrib/streams-persist-graph/src/site/site.xml
new file mode 100644
index 0000000..b894666
--- /dev/null
+++ b/streams-contrib/streams-persist-graph/src/site/site.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<project>
+ <body>
+ <links name="Help">
+ <item name="Neo4j" href="neo4j.html"/>
+ </links>
+ </body>
+</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/e50576a1/streams-contrib/streams-persist-mongo/src/site/markdown/mongo.md
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-persist-mongo/src/site/markdown/mongo.md b/streams-contrib/streams-persist-mongo/src/site/markdown/mongo.md
new file mode 100644
index 0000000..002c12d
--- /dev/null
+++ b/streams-contrib/streams-persist-mongo/src/site/markdown/mongo.md
@@ -0,0 +1,33 @@
+## Mongo
+
+Start mongo via docker with the docker maven plugin:
+
+ docker -PdockerITs docker:start
+
+Confirm that elasticsearch is running:
+
+ docker ps
+
+Confirm that host and post(s) are in property file:
+
+ cat mongo.properties
+
+Create a local file `elasticsearch.conf` with cluster details:
+
+ mongo {
+ host = ${mongo.tcp.host}
+ port = ${mongo.tcp.port}
+ }
+
+When configuring a stream, include these files:
+
+ include "mongo.properties"
+ include "mongo.conf"
+
+Supply application-specific configuration as well:
+
+ mongo {
+ db: "",
+ collection: ""
+ }
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/e50576a1/streams-contrib/streams-persist-mongo/src/site/site.xml
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-persist-mongo/src/site/site.xml b/streams-contrib/streams-persist-mongo/src/site/site.xml
new file mode 100644
index 0000000..ee8d506
--- /dev/null
+++ b/streams-contrib/streams-persist-mongo/src/site/site.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<project>
+ <body>
+ <links name="Help">
+ <item name="Mongo" href="mongo.html"/>
+ </links>
+ </body>
+</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/e50576a1/streams-contrib/streams-provider-twitter/src/site/markdown/twitter.md
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-twitter/src/site/markdown/twitter.md b/streams-contrib/streams-provider-twitter/src/site/markdown/twitter.md
new file mode 100644
index 0000000..b716115
--- /dev/null
+++ b/streams-contrib/streams-provider-twitter/src/site/markdown/twitter.md
@@ -0,0 +1,22 @@
+## Twitter Credentials
+
+Create a local file `twitter.oauth.conf` with valid twitter credentials
+
+ twitter {
+ oauth {
+ consumerKey = ""
+ consumerSecret = ""
+ accessToken = ""
+ accessTokenSecret = ""
+ }
+ }
+
+Log into developer.twitter.com
+
+Visit https://apps.twitter.com and create an application.
+
+Select your application and click into 'Keys and Access Tokens'
+
+The consumerKey and consumerSecret are application-wide.
+
+The accessToken and accessTokenSecret are per-user.
http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/e50576a1/streams-contrib/streams-provider-twitter/src/site/site.xml
----------------------------------------------------------------------
diff --git a/streams-contrib/streams-provider-twitter/src/site/site.xml b/streams-contrib/streams-provider-twitter/src/site/site.xml
new file mode 100644
index 0000000..1296d0e
--- /dev/null
+++ b/streams-contrib/streams-provider-twitter/src/site/site.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<project>
+ <body>
+ <links name="Help">
+ <item name="Twitter" href="twitter.html"/>
+ </links>
+ </body>
+</project>
\ No newline at end of file