Repository: bahir-website Updated Branches: refs/heads/master 9c5bcb98a -> b536ac52d
[BAHIR-90] Include Apache Flink extensions to website This commit setups links for documentation and downloads for Apache Bahir Flink extensions. The Flink docs are generated using the updated update-docs.sh script in #8. It also revamps the website's project infrastructure, configuration, and navigation / layouts for documentations and the download page to be more friendly for newly supported platforms in the future. Closes #9 Project: http://git-wip-us.apache.org/repos/asf/bahir-website/repo Commit: http://git-wip-us.apache.org/repos/asf/bahir-website/commit/b536ac52 Tree: http://git-wip-us.apache.org/repos/asf/bahir-website/tree/b536ac52 Diff: http://git-wip-us.apache.org/repos/asf/bahir-website/diff/b536ac52 Branch: refs/heads/master Commit: b536ac52d5d35d8b9e21887efb70cdbb5d4e86de Parents: 9c5bcb9 Author: Tzu-Li (Gordon) Tai <[email protected]> Authored: Wed Mar 1 16:53:14 2017 +0800 Committer: Luciano Resende <[email protected]> Committed: Mon Mar 13 17:08:03 2017 -0700 ---------------------------------------------------------------------- README.md | 7 +- site/_config.yml | 4 +- site/_data/navigation.yml | 14 +- site/_data/project.yml | 42 +++-- .../themes/apache-clean/_navigation.html | 8 +- site/_includes/themes/apache/_navigation.html | 8 +- .../apache-clean/bootstrap/css/bootstrap.css | 2 +- site/community.md | 5 +- site/docs/flink/current/documentation.md | 42 +++++ .../flink/current/flink-streaming-activemq.md | 44 +++++ site/docs/flink/current/flink-streaming-akka.md | 66 +++++++ .../docs/flink/current/flink-streaming-flume.md | 47 +++++ .../docs/flink/current/flink-streaming-netty.md | 94 ++++++++++ .../docs/flink/current/flink-streaming-redis.md | 173 +++++++++++++++++++ site/docs/flink/overview.md | 31 ++++ site/docs/spark/overview.md | 34 ++++ site/download.md | 105 ----------- site/downloads/flink.md | 116 +++++++++++++ site/downloads/spark.md | 116 +++++++++++++ site/index.md | 15 +- site/releases/2.0.0/release-notes.md | 69 -------- site/releases/2.0.1/release-notes.md | 43 ----- site/releases/2.0.2/release-notes.md | 43 ----- site/releases/2.1.0/release-notes.md | 36 ---- site/releases/spark/2.0.0/release-notes.md | 69 ++++++++ site/releases/spark/2.0.1/release-notes.md | 43 +++++ site/releases/spark/2.0.2/release-notes.md | 43 +++++ site/releases/spark/2.1.0/release-notes.md | 36 ++++ 28 files changed, 1020 insertions(+), 335 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index fef7ef9..f28e6c8 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,8 @@ The steps below will install the latest [Jekyll](https://jekyllrb.com/) version ``` 1. sudo gem install jekyll bundler -2. sudo bundle install +2. cd site +3. sudo bundle install ``` For more information, see [Installing Jekyll](https://jekyllrb.com/docs/installation/). @@ -57,7 +58,7 @@ To update the current documentation contents, use the update-doc script. This sc ``` 1. update-doc.sh -2. git commit -a -m"My updates" +2. git commit -a -m "My updates" 3. git push 4. ./publish.sh 5. git push origin asf-site @@ -72,7 +73,7 @@ To publish new contents to the website, commit your changes to master, and use t ``` 1. Make your changes -2. git commit -a -m"My updates" +2. git commit -a -m "My updates" 3. git push 4. ./publish.sh 5. git push origin asf-site http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/_config.yml ---------------------------------------------------------------------- diff --git a/site/_config.yml b/site/_config.yml index cdd65f0..f4daf91 100644 --- a/site/_config.yml +++ b/site/_config.yml @@ -16,7 +16,7 @@ title: Apache Bahir email: [email protected] description: > # this means to ignore newlines until "baseurl:" - Apache Bahir provides extensions to distributed analytic platforms such as Apache Spark. + Apache Bahir provides extensions to distributed analytic platforms such as Apache Spark and Apache Flink. baseurl: "" # the subpath of your site, e.g. /blog url: "http://bahir.apache.org"; # the base hostname & protocol for your site #twitter_username: ApacheBahir @@ -29,7 +29,7 @@ excerpt_separator: "" repository: https://github.com/apache/bahir-website destination: _site -exclude: [README.md,Gemfile*,"docs/spark/templates"] +exclude: [README.md,Gemfile*,docs/*/templates] keep_files: [".git", ".svn", "apidocs"] # if 'analytics_on' is true, analytics section will be rendered on the HTML pages http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/_data/navigation.yml ---------------------------------------------------------------------- diff --git a/site/_data/navigation.yml b/site/_data/navigation.yml index b8a01b2..b2f6515 100644 --- a/site/_data/navigation.yml +++ b/site/_data/navigation.yml @@ -50,16 +50,10 @@ topnav: - title: Documentation subcategories: - - title: Bahir Spark Extensions - Current - url: /docs/spark/current/documentation - - title: Bahir Spark Extensions - 2.1.0 - url: /docs/spark/2.1.0/documentation - - title: Bahir Spark Extensions - 2.0.2 - url: /docs/spark/2.0.2/documentation - - title: Bahir Spark Extensions - 2.0.1 - url: /docs/spark/2.0.1/documentation - - title: Bahir Spark Extensions - 2.0.0 - url: /docs/spark/2.0.0/documentation + - title: Bahir Spark Extensions + url: /docs/spark/overview + - title: Bahir Flink Extensions + url: /docs/flink/overview - title: GitHub url: https://github.com/apache/bahir http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/_data/project.yml ---------------------------------------------------------------------- diff --git a/site/_data/project.yml b/site/_data/project.yml index 33454a2..3bc44b5 100644 --- a/site/_data/project.yml +++ b/site/_data/project.yml @@ -15,15 +15,12 @@ # # Apache Project configurations # + +# settings common across all supported platforms + name: Apache Bahir short_name: Bahir -unix_name: bahir -github_project_name: bahir -description: Apache Bahir provides extensions to distributed analytic platforms such as Apache Spark. - -download: /download -latest_release: 2.1.0 -latest_release_date: 02/22/2017 +description: Apache Bahir provides extensions to distributed analytic platforms such as Apache Spark and Apache Flink. dev_list: [email protected] dev_list_subscribe: [email protected] @@ -48,10 +45,33 @@ commits_list_archive_markmail: jira: BAHIR -source_repository: https://git-wip-us.apache.org/repos/asf/bahir.git -source_repository_mirror: https://github.com/apache/bahir - website_repository: https://git-wip-us.apache.org/repos/asf/bahir-website.git website_repository_mirror: https://github.com/apache/bahir-website -podling: false \ No newline at end of file +podling: false + +# settings specific to supported platforms + +# Apache Spark + +spark_unix_name: bahir +spark_github_project_name: bahir + +spark_latest_release: 2.1.0 +spark_latest_release_date: 02/22/2017 +spark_download: /downloads/spark + +spark_source_repository: https://git-wip-us.apache.org/repos/asf/bahir.git +spark_source_repository_mirror: https://github.com/apache/bahir + +# Apache Flink + +flink_unix_name: bahir-flink +flink_github_project_name: bahir-flink + +#flink_latest_release: +#flink_latest_release_date: +flink_download: /downloads/flink + +flink_source_repository: https://git-wip-us.apache.org/repos/asf/bahir-flink.git +flink_source_repository_mirror: https://github.com/apache/bahir-flink \ No newline at end of file http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/_includes/themes/apache-clean/_navigation.html ---------------------------------------------------------------------- diff --git a/site/_includes/themes/apache-clean/_navigation.html b/site/_includes/themes/apache-clean/_navigation.html index 5fc7aa8..f56f510 100644 --- a/site/_includes/themes/apache-clean/_navigation.html +++ b/site/_includes/themes/apache-clean/_navigation.html @@ -5,8 +5,12 @@ <!--h1>{{ site.data.project.name }}</h1--> <p>{{ site.data.project.description }}</p> - {% if site.data.project.latest_release %} - <a href="{{ site.data.project.download }}" class="btn btn-primary btn-lg bigFingerButton" role="button">Download {{ site.data.project.name }} {{site.data.project.latest_release}}</a></p> + {% if site.data.project.spark_latest_release %} + <a href="{{ site.data.project.spark_download }}" class="btn btn-primary btn-lg bigFingerButton" role="button">Download {{ site.data.project.name }} Spark Extensions {{ site.data.project.spark_latest_release }}</a></p> + {% endif %} + + {% if site.data.project.flink_latest_release %} + <a href="{{ site.data.project.flink_download }}" class="btn btn-primary btn-lg bigFingerButton" role="button">Download {{ site.data.project.name }} Flink Extensions {{ site.data.project.flink_latest_release }}</a></p> {% endif %} </div> </div> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/_includes/themes/apache/_navigation.html ---------------------------------------------------------------------- diff --git a/site/_includes/themes/apache/_navigation.html b/site/_includes/themes/apache/_navigation.html index 02dc76d..618a1fa 100644 --- a/site/_includes/themes/apache/_navigation.html +++ b/site/_includes/themes/apache/_navigation.html @@ -49,8 +49,12 @@ <h1>{{ site.data.project.name }}</h1> <p>{{ site.data.project.description }}</p> - {% if site.data.project.latest_release %} - <a href="{{ site.data.project.download }}" class="btn btn-primary btn-lg bigFingerButton" role="button">Get {{ site.data.project.short_name }}</a></p> + {% if site.data.project.spark_latest_release %} + <a href="{{ site.data.project.spark_download }}" class="btn btn-primary btn-lg bigFingerButton" role="button">Get {{ site.data.project.short_name }} Spark Extensions</a></p> + {% endif %} + + {% if site.data.project.flink_latest_release %} + <a href="{{ site.data.project.flink_download }}" class="btn btn-primary btn-lg bigFingerButton" role="button">Get {{ site.data.project.short_name }} Flink Extensions</a></p> {% endif %} </div> </div> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/assets/themes/apache-clean/bootstrap/css/bootstrap.css ---------------------------------------------------------------------- diff --git a/site/assets/themes/apache-clean/bootstrap/css/bootstrap.css b/site/assets/themes/apache-clean/bootstrap/css/bootstrap.css index 1af5861..379e1d2 100644 --- a/site/assets/themes/apache-clean/bootstrap/css/bootstrap.css +++ b/site/assets/themes/apache-clean/bootstrap/css/bootstrap.css @@ -5229,7 +5229,7 @@ a.list-group-item.active > .badge, .jumbotron { padding: 30px; margin-bottom: 30px; - font-size: 21px; + font-size: 20px; font-weight: 200; line-height: 2.1428571435; color: inherit; http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/community.md ---------------------------------------------------------------------- diff --git a/site/community.md b/site/community.md index 44a73f0..2ab2b70 100644 --- a/site/community.md +++ b/site/community.md @@ -73,7 +73,10 @@ Enhancement requests for new features are also welcome. The more concrete and ra ## Source Code -The project sources are accessible via the [source code repository]({{ site.data.project.source_repository }}) which is also mirrored in [GitHub]({{ site.data.project.source_repository_mirror }}) +The project sources for each supported platform are accessible via their respective source code repositories: + + - Apache Spark Extensions: ({{ site.data.project.spark_source_repository }}), also mirrored in [GitHub]({{ site.data.project.spark_source_repository_mirror }}) + - Apache Flink Extensions: ({{ site.data.project.flink_source_repository }}), also mirrored in [GitHub]({{ site.data.project.flink_source_repository_mirror }}) ## Website Source Code http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/docs/flink/current/documentation.md ---------------------------------------------------------------------- diff --git a/site/docs/flink/current/documentation.md b/site/docs/flink/current/documentation.md new file mode 100644 index 0000000..55b557f --- /dev/null +++ b/site/docs/flink/current/documentation.md @@ -0,0 +1,42 @@ +--- +layout: page +title: Extensions for Apache Flink (1.0.0-SNAPSHOT) +description: Extensions for Apache Flink (1.0.0-SNAPSHOT) +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +### Apache Bahir Extensions for Apache Flink + +<br/> + +#### Streaming Connectors + +[ActiveMQ connector](../flink-streaming-activemq) + +[Akka connector](../flink-streaming-akka) + +[Flume connector](../flink-streaming-flume) + +[Netty connector](../flink-streaming-netty) + +[Redis connector](../flink-streaming-redis) http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/docs/flink/current/flink-streaming-activemq.md ---------------------------------------------------------------------- diff --git a/site/docs/flink/current/flink-streaming-activemq.md b/site/docs/flink/current/flink-streaming-activemq.md new file mode 100644 index 0000000..ce8a162 --- /dev/null +++ b/site/docs/flink/current/flink-streaming-activemq.md @@ -0,0 +1,44 @@ +--- +layout: page +title: Apache Flink Streaming Connector for ActiveMQ +description: Apache Flink Streaming Connector for ActiveMQ +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Flink ActiveMQ Connector + +This connector provides a source and sink to [Apache ActiveMQ](http://activemq.apache.org/)⢠+To use this connector, add the following dependency to your project: + + <dependency> + <groupId>org.apache.bahir</groupId> + <artifactId>flink-connector-activemq_2.11</artifactId> + <version>1.0-SNAPSHOT</version> + </dependency> + +*Version Compatibility*: This module is compatible with ActiveMQ 5.14.0. + +Note that the streaming connectors are not part of the binary distribution of Flink. You need to link them into your job jar for cluster execution. +See how to link with them for cluster execution [here](https://ci.apache.org/projects/flink/flink-docs-release-1.2/dev/linking.html). + +The source class is called `AMQSource`, and the sink is `AMQSink`. http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/docs/flink/current/flink-streaming-akka.md ---------------------------------------------------------------------- diff --git a/site/docs/flink/current/flink-streaming-akka.md b/site/docs/flink/current/flink-streaming-akka.md new file mode 100644 index 0000000..7469666 --- /dev/null +++ b/site/docs/flink/current/flink-streaming-akka.md @@ -0,0 +1,66 @@ +--- +layout: page +title: Apache Flink Streaming Connector for Akka +description: Apache Flink Streaming Connector for Akka +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Flink Akka Connector + +This connector provides a sink to [Akka](http://akka.io/) source actors in an ActorSystem. +To use this connector, add the following dependency to your project: + + <dependency> + <groupId>org.apache.bahir</groupId> + <artifactId>flink-connector-akka_2.11</artifactId> + <version>1.0-SNAPSHOT</version> + </dependency> + +*Version Compatibility*: This module is compatible with Akka 2.0+. + +Note that the streaming connectors are not part of the binary distribution of Flink. You need to link them into your job jar for cluster execution. +See how to link with them for cluster execution [here](https://ci.apache.org/projects/flink/flink-docs-release-1.2/dev/linking.html). + +## Configuration + +The configurations for the Receiver Actor System in Flink Akka connector can be created using the standard typesafe `Config (com.typesafe.config.Config)` object. + +To enable acknowledgements, the custom configuration `akka.remote.auto-ack` can be used. + +The user can set any of the default configurations allowed by Akka as well as custom configurations allowed by the connector. + +A sample configuration can be defined as follows: + + String configFile = getClass().getClassLoader() + .getResource("feeder_actor.conf").getFile(); + Config config = ConfigFactory.parseFile(new File(configFile)); + +## Message Types + +There are 3 different kind of message types which the receiver Actor in Flink Akka connector can receive. + +- message containing `Iterable<Object>` data + +- message containing generic `Object` data + +- message containing generic `Object` data and a `Timestamp` value passed as `Tuple2<Object, Long>`. http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/docs/flink/current/flink-streaming-flume.md ---------------------------------------------------------------------- diff --git a/site/docs/flink/current/flink-streaming-flume.md b/site/docs/flink/current/flink-streaming-flume.md new file mode 100644 index 0000000..01e1bae --- /dev/null +++ b/site/docs/flink/current/flink-streaming-flume.md @@ -0,0 +1,47 @@ +--- +layout: page +title: Apache Flink Streaming Connector for Apache Flume +description: Apache Flink Streaming Connector for Apache Flume +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Flink Flume Connector + +This connector provides a sink that can send data to [Apache Flume](https://flume.apache.org/)â¢. To use this connector, add the +following dependency to your project: + + <dependency> + <groupId>org.apache.bahir</groupId> + <artifactId>flink-connector-flume_2.11</artifactId> + <version>1.0-SNAPSHOT</version> + </dependency> + +*Version Compatibility*: This module is compatible with Flume 1.5.0. + +Note that the streaming connectors are not part of the binary distribution of Flink. You need to link them into your job jar for cluster execution. +See how to link with them for cluster execution [here](https://ci.apache.org/projects/flink/flink-docs-release-1.2/dev/linking.html). + +To create a `FlumeSink` instantiate the following constructor: + + FlumeSink(String host, int port, SerializationSchema<IN> schema) + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/docs/flink/current/flink-streaming-netty.md ---------------------------------------------------------------------- diff --git a/site/docs/flink/current/flink-streaming-netty.md b/site/docs/flink/current/flink-streaming-netty.md new file mode 100644 index 0000000..9ec2442 --- /dev/null +++ b/site/docs/flink/current/flink-streaming-netty.md @@ -0,0 +1,94 @@ +--- +layout: page +title: Apache Flink Streaming Connector for Netty +description: Apache Flink Streaming Connector for Netty +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Flink Netty Connector + +This connector provides tcp source and http source for receiving push data, implemented by [Netty](http://netty.io). + +Note that the streaming connectors are not part of the binary distribution of Flink. You need to link them into your job jar for cluster execution. +See how to link with them for cluster execution [here](https://ci.apache.org/projects/flink/flink-docs-release-1.2/dev/linking.html). + +## Data Flow + +``` ++-------------+ (2) +------------------------+ +| user system | <----- | Third Register Service | ++-------------+ +------------------------+ + | ^ + | (3) | + | | + V | ++--------------------+ | +| Flink Netty Source | ----------------+ ++--------------------+ (1) +``` + +There are three components: + +* User System - where the data stream is coming from +* Third Register Service - receive `Flink Netty Source`'s register request (ip and port) +* Flink Netty Source - Netty Server for receiving pushed streaming data from `User System` + + +## Maven Dependency +To use this connector, add the following dependency to your project: + +``` +<dependency> + <groupId>org.apache.bahir</groupId> + <artifactId>flink-connector-netty_2.11</artifactId> + <version>1.0-SNAPSHOT</version> +</dependency> +``` + +## Usage + +*Tcp Source:* + +``` +val env = StreamExecutionEnvironment.getExecutionEnvironment +env.addSource(new TcpReceiverSource("msg", 7070, Some("http://localhost:9090/cb";))) +``` +>paramKey: the http query param key +>tryPort: try to use this point, if this point is used then try a new port +>callbackUrl: register connector's ip and port to a `Third Register Service` + +*Http Source:* + +``` +val env = StreamExecutionEnvironment.getExecutionEnvironment +env.addSource(new TcpReceiverSource(7070, Some("http://localhost:9090/cb";))) +``` +>tryPort: try to use this port, if this point is used then try a new port +>callbackUrl: register connector's ip and port to a `Third Register Service` + +## Full Example + +There are two example to get started: + +* [StreamSqlExample](https://github.com/apache/bahir-flink/blob/master/flink-connector-netty/src/test/scala/org/apache/flink/streaming/connectors/netty/example/StreamSqlExample.scala) +* [TcpSourceExample](https://github.com/apache/bahir-flink/blob/master/flink-connector-netty/src/test/scala/org/apache/flink/streaming/connectors/netty/example/TcpSourceExample.scala) http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/docs/flink/current/flink-streaming-redis.md ---------------------------------------------------------------------- diff --git a/site/docs/flink/current/flink-streaming-redis.md b/site/docs/flink/current/flink-streaming-redis.md new file mode 100644 index 0000000..de306c5 --- /dev/null +++ b/site/docs/flink/current/flink-streaming-redis.md @@ -0,0 +1,173 @@ +--- +layout: page +title: Apache Flink Streaming Connector for Redis +description: Apache Flink Streaming Connector for Redis +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Flink Redis Connector + +This connector provides a Sink that can write to [Redis](http://redis.io/) and also can publish data +to [Redis PubSub](http://redis.io/topics/pubsub). To use this connector, add the +following dependency to your project: + + <dependency> + <groupId>org.apache.bahir</groupId> + <artifactId>flink-connector-redis_2.11</artifactId> + <version>1.0-SNAPSHOT</version> + </dependency> + +*Version Compatibility*: This module is compatible with Redis 2.8.5. + +Note that the streaming connectors are not part of the binary distribution of Flink. You need to link them into your job jar for cluster execution. +See how to link with them for cluster execution [here](https://ci.apache.org/projects/flink/flink-docs-release-1.2/dev/linking.html). + +## Installing Redis + +Follow the instructions from the [Redis download page](http://redis.io/download). + + +## Redis Sink + +A class providing an interface for sending data to Redis. +The sink can use three different methods for communicating with different type of Redis environments: + +1. Single Redis Server +2. Redis Cluster +3. Redis Sentinel + +This code shows how to create a sink that communicate to a single redis server: + +**Java:** + + + public static class RedisExampleMapper implements RedisMapper<Tuple2<String, String>>{ + + @Override + public RedisCommandDescription getCommandDescription() { + return new RedisCommandDescription(RedisCommand.HSET, "HASH_NAME"); + } + + @Override + public String getKeyFromData(Tuple2<String, String> data) { + return data.f0; + } + + @Override + public String getValueFromData(Tuple2<String, String> data) { + return data.f1; + } + } + FlinkJedisPoolConfig conf = new FlinkJedisPoolConfig.Builder().setHost("127.0.0.1").build(); + + DataStream<String> stream = ...; + stream.addSink(new RedisSink<Tuple2<String, String>>(conf, new RedisExampleMapper()); + + + +**Scala:** + + class RedisExampleMapper extends RedisMapper[(String, String)]{ + override def getCommandDescription: RedisCommandDescription = { + new RedisCommandDescription(RedisCommand.HSET, "HASH_NAME") + } + + override def getKeyFromData(data: (String, String)): String = data._1 + + override def getValueFromData(data: (String, String)): String = data._2 + } + val conf = new FlinkJedisPoolConfig.Builder().setHost("127.0.0.1").build() + stream.addSink(new RedisSink[(String, String)](conf, new RedisExampleMapper)) + + + +This example code does the same, but for Redis Cluster: + +**Java:** + + FlinkJedisPoolConfig conf = new FlinkJedisPoolConfig.Builder() + .setNodes(new HashSet<InetSocketAddress>(Arrays.asList(new InetSocketAddress(5601)))).build(); + + DataStream<String> stream = ...; + stream.addSink(new RedisSink<Tuple2<String, String>>(conf, new RedisExampleMapper()); + +**Scala:** + + + val conf = new FlinkJedisPoolConfig.Builder().setNodes(...).build() + stream.addSink(new RedisSink[(String, String)](conf, new RedisExampleMapper)) + + +This example shows when the Redis environment is with Sentinels: + +Java: + + FlinkJedisSentinelConfig conf = new FlinkJedisSentinelConfig.Builder() + .setMasterName("master").setSentinels(...).build(); + + DataStream<String> stream = ...; + stream.addSink(new RedisSink<Tuple2<String, String>>(conf, new RedisExampleMapper()); + + +Scala: + + val conf = new FlinkJedisSentinelConfig.Builder().setMasterName("master").setSentinels(...).build() + stream.addSink(new RedisSink[(String, String)](conf, new RedisExampleMapper)) + + +This section gives a description of all the available data types and what Redis command used for that. + +<table class="table table-bordered" style="width: 75%"> + <thead> + <tr> + <th class="text-center" style="width: 20%">Data Type</th> + <th class="text-center" style="width: 25%">Redis Command [Sink]</th> + </tr> + </thead> + <tbody> + <tr> + <td>HASH</td><td><a href="http://redis.io/commands/hset";>HSET</a></td> + </tr> + <tr> + <td>LIST</td><td> + <a href="http://redis.io/commands/rpush";>RPUSH</a>, + <a href="http://redis.io/commands/lpush";>LPUSH</a> + </td> + </tr> + <tr> + <td>SET</td><td><a href="http://redis.io/commands/rpush";>SADD</a></td> + </tr> + <tr> + <td>PUBSUB</td><td><a href="http://redis.io/commands/publish";>PUBLISH</a></td> + </tr> + <tr> + <td>STRING</td><td><a href="http://redis.io/commands/set";>SET</a></td> + </tr> + <tr> + <td>HYPER_LOG_LOG</td><td><a href="http://redis.io/commands/pfadd";>PFADD</a></td> + </tr> + <tr> + <td>SORTED_SET</td><td><a href="http://redis.io/commands/zadd";>ZADD</a></td> + </tr> + </tbody> +</table> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/docs/flink/overview.md ---------------------------------------------------------------------- diff --git a/site/docs/flink/overview.md b/site/docs/flink/overview.md new file mode 100644 index 0000000..e42f12c --- /dev/null +++ b/site/docs/flink/overview.md @@ -0,0 +1,31 @@ +--- +layout: page +title: Extensions for Apache Flink +description: Extensions for Apache Flink +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +### Apache Bahir Extensions for Apache Flink + + - [Current - 1.0-SNAPSHOT](/docs/flink/current/documentation) + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/docs/spark/overview.md ---------------------------------------------------------------------- diff --git a/site/docs/spark/overview.md b/site/docs/spark/overview.md new file mode 100644 index 0000000..7b232ce --- /dev/null +++ b/site/docs/spark/overview.md @@ -0,0 +1,34 @@ +--- +layout: page +title: Extensions for Apache Spark +description: Extensions for Apache Spark +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +### Apache Bahir Extensions for Apache Spark + + - [Current - 2.2.0-SNAPSHOT](/docs/spark/current/documentation) + - [2.1.0](/docs/spark/2.1.0/documentation) + - [2.0.2](/docs/spark/2.0.2/documentation) + - [2.0.1](/docs/spark/2.0.1/documentation) + - [2.0.0](/docs/spark/2.0.0/documentation) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/download.md ---------------------------------------------------------------------- diff --git a/site/download.md b/site/download.md deleted file mode 100644 index 5558109..0000000 --- a/site/download.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -layout: page -title: Downloads -description: Project Downloads page -group: nav-right ---- -<!-- -{% comment %} -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 with -the License. You may obtain a copy of the License at - -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. -{% endcomment %} ---> -{% include JB/setup %} - -# {{ site.data.project.name }} Downloads - -Please find below the latest releases of {{ site.data.project.name }}. Note that the binary artifacts are also published through Maven. - -## Latest Release - -Our latest release is {{ site.data.project.name }} {{site.data.project.latest_release}}, released on {{site.data.project.latest_release_date}}. - -{% if site.data.project.latest_release %} -<table class="table table-hover sortable"> - <thead> - <tr> - <th><b>Name</b></th> - <th><b>Archive</b></th> - <th><b>MD5</b></th> - <!--th><b>SHA-1</b></th--> - <th><b>signature</b></th> - </tr> - </thead> - <tbody> - <tr> - <td>{{ site.data.project.name }} {{site.data.project.latest_release}} (tar.gz)</td> - <td><a href="http://www.apache.org/dyn/closer.lua/{{site.data.project.unix_name}}/{{site.data.project.latest_release}}/apache-bahir-{{site.data.project.latest_release}}-src.tar.gz";>tar.gz</a></td> - <td><a href="http://www.apache.org/dist/{{site.data.project.unix_name}}/{{site.data.project.latest_release}}/apache-bahir-{{site.data.project.latest_release}}-src.tar.gz.md5";>MD5</a></td> - <!--td><a href="http://www.apache.org/dist/{{site.data.project.unix_name}}/{{site.data.project.latest_release}}/apache-bahir-{{site.data.project.latest_release}}-src.tar.gz.sha1";>SHA-1</a></td--> - <td><a href="http://www.apache.org/dist/{{site.data.project.unix_name}}/{{site.data.project.latest_release}}/apache-bahir-{{site.data.project.latest_release}}-src.tar.gz.asc";>ASC</a></td> - </tr> - <tr> - <td>{{ site.data.project.name }} {{site.data.project.latest_release}} (zip)</td> - <td><a href="http://www.apache.org/dyn/closer.lua/{{site.data.project.unix_name}}/{{site.data.project.latest_release}}/apache-bahir-{{site.data.project.latest_release}}-src.zip";>zip</a></td> - <td><a href="http://www.apache.org/dist/{{site.data.project.unix_name}}/{{site.data.project.latest_release}}/apache-bahir-{{site.data.project.latest_release}}-src.zip.md5";>MD5</a></td> - <!--td><a href="http://www.apache.org/dist/{{site.data.project.unix_name}}/{{site.data.project.latest_release}}/apache-bahir-{{site.data.project.latest_release}}-src.zip.sha1";>SHA-1</a></td--> - <td><a href="http://www.apache.org/dist/{{site.data.project.unix_name}}/{{site.data.project.latest_release}}/apache-bahir-{{site.data.project.latest_release}}-src.zip.asc";>ASC</a></td> - </tr> - <tr> - <td>Release Notes</td> - <td><a href="/releases/{{ site.data.project.latest_release }}/release-notes">{{ site.data.project.latest_release }}</a></td> - <td></td> - <!--td></td--> - <td></td> - </tr> - </tbody> -</table> -{% endif %} - - -Instructions for checking hashes and signatures is indicated on the [Verifying Apache Software Foundation Releases](http://www.apache.org/info/verification.html) page. - -You can also retrieve the source files from our git repository by typing: - -<pre> -git clone https://github.com/apache/bahir.git -cd bahir -git checkout -b tags/v{{site.data.project.latest_release}} v{{site.data.project.latest_release}} -</pre> - - - -## Verifying a Release - -Choose a source distribution in either *tar* or *zip* format, -and [verify](http://www.apache.org/dyn/closer.cgi#verify) -using the corresponding *pgp* signature (using the committer file in -[KEYS](http://www.apache.org/dist/{{ site.data.project.unix_name }}/KEYS)). -If you cannot do that, the *md5* hash file may be used to check that the -download has completed OK. - -For fast downloads, current source distributions are hosted on mirror servers; -older source distributions are in the -[archive](http://archive.apache.org/dist/{{ site.data.project.unix_name }}/). -If a download from a mirror fails, retry, and the second download will likely -succeed. - -For security, hash and signature files are always hosted at -[Apache](https://www.apache.org/dist). - -## Previous Releases - -All previous releases of Apache Bahir can be found in the [archives](http://archive.apache.org/dist/bahir/). http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/downloads/flink.md ---------------------------------------------------------------------- diff --git a/site/downloads/flink.md b/site/downloads/flink.md new file mode 100644 index 0000000..6c3e181 --- /dev/null +++ b/site/downloads/flink.md @@ -0,0 +1,116 @@ +--- +layout: page +title: Bahir Flink Extensions Downloads +description: Bahir Flink Extensions Downloads page +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# {{ site.data.project.name }} Flink Extensions Downloads + +Please find below the latest releases of {{ site.data.project.name }} for Apache Flink Extensions. Note that the binary artifacts for each platform are also published independently through Maven. + +## Bahir Flink Extensions Latest Release + +{% if site.data.project.flink_latest_release %} + +Our latest {{ site.data.project.name }} release for Apache Flink extensions is {{site.data.project.flink_latest_release}}, released on {{site.data.project.flink_latest_release_date}}. + +<table class="table table-hover sortable"> + <thead> + <tr> + <th><b>Name</b></th> + <th><b>Archive</b></th> + <th><b>MD5</b></th> + <!--th><b>SHA-1</b></th--> + <th><b>signature</b></th> + </tr> + </thead> + <tbody> + <tr> + <td>{{ site.data.project.name }} Flink Extensions {{site.data.project.flink_latest_release}} (tar.gz)</td> + <td><a href="http://www.apache.org/dyn/closer.lua/{{site.data.project.flink_unix_name}}/{{site.data.project.flink_latest_release}}/apache-bahir-{{site.data.project.flink_latest_release}}-src.tar.gz";>tar.gz</a></td> + <td><a href="http://www.apache.org/dist/{{site.data.project.flink_unix_name}}/{{site.data.project.flink_latest_release}}/apache-bahir-{{site.data.project.flink_latest_release}}-src.tar.gz.md5";>MD5</a></td> + <!--td><a href="http://www.apache.org/dist/{{site.data.project.flink_unix_name}}/{{site.data.project.flink_latest_release}}/apache-bahir-{{site.data.project.flink_latest_release}}-src.tar.gz.sha1";>SHA-1</a></td--> + <td><a href="http://www.apache.org/dist/{{site.data.project.flink_unix_name}}/{{site.data.project.flink_latest_release}}/apache-bahir-{{site.data.project.flink_latest_release}}-src.tar.gz.asc";>ASC</a></td> + </tr> + <tr> + <td>{{ site.data.project.name }} Flink Extensions {{site.data.project.flink_latest_release}} (zip)</td> + <td><a href="http://www.apache.org/dyn/closer.lua/{{site.data.project.flink_unix_name}}/{{site.data.project.flink_latest_release}}/apache-bahir-{{site.data.project.flink_latest_release}}-src.zip";>zip</a></td> + <td><a href="http://www.apache.org/dist/{{site.data.project.flink_unix_name}}/{{site.data.project.flink_latest_release}}/apache-bahir-{{site.data.project.flink_latest_release}}-src.zip.md5";>MD5</a></td> + <!--td><a href="http://www.apache.org/dist/{{site.data.project.flink_unix_name}}/{{site.data.project.flink_latest_release}}/apache-bahir-{{site.data.project.flink_latest_release}}-src.zip.sha1";>SHA-1</a></td--> + <td><a href="http://www.apache.org/dist/{{site.data.project.flink_unix_name}}/{{site.data.project.flink_latest_release}}/apache-bahir-{{site.data.project.flink_latest_release}}-src.zip.asc";>ASC</a></td> + </tr> + <tr> + <td>Release Notes</td> + <td><a href="/releases/flink/{{ site.data.project.flink_latest_release }}/release-notes">{{ site.data.project.flink_latest_release }}</a></td> + <td></td> + <!--td></td--> + <td></td> + </tr> + </tbody> +</table> + +You can also retrieve the source files from our git repository by typing: + +<pre> +git clone {{site.data.project.flink_source_repository_mirror}} +cd {{site.data.project.flink_github_project_name}} +git checkout -b tags/v{{site.data.project.flink_latest_release}} v{{site.data.project.flink_latest_release}} +</pre> + +### Previous Releases + +All previous releases of {{ site.data.project.name }} Flink Extensions can be found in the [archives](http://archive.apache.org/dist/{{site.data.project.flink_unix_name}}/). + +## Verifying a Release + +Instructions for checking hashes and signatures is indicated on the [Verifying Apache Software Foundation Releases](http://www.apache.org/info/verification.html) page. + +Choose a source distribution in either *tar* or *zip* format, +and [verify](http://www.apache.org/dyn/closer.cgi#verify) +using the corresponding *pgp* signature (using the committer file in +[KEYS](http://www.apache.org/dist/{{ site.data.project.flink_unix_name }}/KEYS)). +If you cannot do that, the *md5* hash file may be used to check that the +download has completed OK. + +For fast downloads, current source distributions are hosted on mirror servers; +older source distributions are in the +[archive](http://archive.apache.org/dist/{{ site.data.project.flink_unix_name }}/). +If a download from a mirror fails, retry, and the second download will likely +succeed. + +For security, hash and signature files are always hosted at +[Apache](https://www.apache.org/dist). + +{% else %} + +Currently, there isn't a release available for Bahir Flink Extensions yet. + +You can still retrieve the source files from our git repository by typing: + +<pre> +git clone {{site.data.project.flink_source_repository_mirror}} +cd {{site.data.project.flink_github_project_name}} +</pre> + +{% endif %} http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/downloads/spark.md ---------------------------------------------------------------------- diff --git a/site/downloads/spark.md b/site/downloads/spark.md new file mode 100644 index 0000000..4e60973 --- /dev/null +++ b/site/downloads/spark.md @@ -0,0 +1,116 @@ +--- +layout: page +title: Bahir Spark Extensions Downloads +description: Bahir Spark Extensions Downloads page +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# {{ site.data.project.name }} Spark Extensions Downloads + +Please find below the latest releases of {{ site.data.project.name }} for Apache Spark Extensions. Note that the binary artifacts for each platform are also published independently through Maven. + +## Bahir Spark Extensions Latest Release + +{% if site.data.project.spark_latest_release %} + +Our latest {{ site.data.project.name }} release for Apache Spark extensions is {{site.data.project.spark_latest_release}}, released on {{site.data.project.spark_latest_release_date}}. + +<table class="table table-hover sortable"> + <thead> + <tr> + <th><b>Name</b></th> + <th><b>Archive</b></th> + <th><b>MD5</b></th> + <!--th><b>SHA-1</b></th--> + <th><b>signature</b></th> + </tr> + </thead> + <tbody> + <tr> + <td>{{ site.data.project.name }} Spark Extensions {{site.data.project.spark_latest_release}} (tar.gz)</td> + <td><a href="http://www.apache.org/dyn/closer.lua/{{site.data.project.spark_unix_name}}/{{site.data.project.spark_latest_release}}/apache-bahir-{{site.data.project.spark_latest_release}}-src.tar.gz";>tar.gz</a></td> + <td><a href="http://www.apache.org/dist/{{site.data.project.spark_unix_name}}/{{site.data.project.spark_latest_release}}/apache-bahir-{{site.data.project.spark_latest_release}}-src.tar.gz.md5";>MD5</a></td> + <!--td><a href="http://www.apache.org/dist/{{site.data.project.spark_unix_name}}/{{site.data.project.spark_latest_release}}/apache-bahir-{{site.data.project.spark_latest_release}}-src.tar.gz.sha1";>SHA-1</a></td--> + <td><a href="http://www.apache.org/dist/{{site.data.project.spark_unix_name}}/{{site.data.project.spark_latest_release}}/apache-bahir-{{site.data.project.spark_latest_release}}-src.tar.gz.asc";>ASC</a></td> + </tr> + <tr> + <td>{{ site.data.project.name }} Spark Extensions {{site.data.project.spark_latest_release}} (zip)</td> + <td><a href="http://www.apache.org/dyn/closer.lua/{{site.data.project.spark_unix_name}}/{{site.data.project.spark_latest_release}}/apache-bahir-{{site.data.project.spark_latest_release}}-src.zip";>zip</a></td> + <td><a href="http://www.apache.org/dist/{{site.data.project.spark_unix_name}}/{{site.data.project.spark_latest_release}}/apache-bahir-{{site.data.project.spark_latest_release}}-src.zip.md5";>MD5</a></td> + <!--td><a href="http://www.apache.org/dist/{{site.data.project.spark_unix_name}}/{{site.data.project.spark_latest_release}}/apache-bahir-{{site.data.project.spark_latest_release}}-src.zip.sha1";>SHA-1</a></td--> + <td><a href="http://www.apache.org/dist/{{site.data.project.spark_unix_name}}/{{site.data.project.spark_latest_release}}/apache-bahir-{{site.data.project.spark_latest_release}}-src.zip.asc";>ASC</a></td> + </tr> + <tr> + <td>Release Notes</td> + <td><a href="/releases/spark/{{ site.data.project.spark_latest_release }}/release-notes">{{ site.data.project.spark_latest_release }}</a></td> + <td></td> + <!--td></td--> + <td></td> + </tr> + </tbody> +</table> + +You can also retrieve the source files from our git repository by typing: + +<pre> +git clone {{site.data.project.spark_source_repository_mirror}} +cd {{site.data.project.spark_github_project_name}} +git checkout -b tags/v{{site.data.project.spark_latest_release}} v{{site.data.project.spark_latest_release}} +</pre> + +### Previous Releases + +All previous releases of {{ site.data.project.name }} Spark Extensions can be found in the [archives](http://archive.apache.org/dist/{{site.data.project.spark_unix_name}}/). + +## Verifying a Release + +Instructions for checking hashes and signatures is indicated on the [Verifying Apache Software Foundation Releases](http://www.apache.org/info/verification.html) page. + +Choose a source distribution in either *tar* or *zip* format, +and [verify](http://www.apache.org/dyn/closer.cgi#verify) +using the corresponding *pgp* signature (using the committer file in +[KEYS](http://www.apache.org/dist/{{ site.data.project.spark_unix_name }}/KEYS)). +If you cannot do that, the *md5* hash file may be used to check that the +download has completed OK. + +For fast downloads, current source distributions are hosted on mirror servers; +older source distributions are in the +[archive](http://archive.apache.org/dist/{{ site.data.project.spark_unix_name }}/). +If a download from a mirror fails, retry, and the second download will likely +succeed. + +For security, hash and signature files are always hosted at +[Apache](https://www.apache.org/dist). + +{% else %} + +Currently, there isn't a release available for Bahir Spark Extensions yet. + +You can still retrieve the source files from our git repository by typing: + +<pre> +git clone {{site.data.project.spark_source_repository_mirror}} +cd {{site.data.project.spark_github_project_name}} +</pre> + +{% endif %} http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/index.md ---------------------------------------------------------------------- diff --git a/site/index.md b/site/index.md index e8cb0f9..e10e534 100644 --- a/site/index.md +++ b/site/index.md @@ -26,10 +26,9 @@ limitations under the License. ## What is {{ site.data.project.name }} -{{ site.data.project.name }} provides extensions to distributed analytic platforms such as [Apache Spark](http://spark.apache.org){:target="_blank"} and [Apache Fink](http://flink.apache.org){:target="_blank"}. - -{{ site.data.project.short_name }} currently extends the reach of your analytic platform by providing a diversity of streaming connectors and SQL data sources. +{{ site.data.project.name }} provides extensions to multiple distributed analytic platforms, extending their reach with a diversity of streaming connectors and SQL data sources. +Currently, {{ site.data.project.short_name }} provides extensions for [Apache Spark](http://spark.apache.org){:target="_blank"} and [Apache Flink](http://flink.apache.org){:target="_blank"}. ## Apache Spark extensions @@ -43,16 +42,18 @@ limitations under the License. ## Apache Flink extensions - - Flink connector for ActiveMQ - - Flink connector for Flume - - Flink connector for Redis + - Flink streaming connector for ActiveMQ + - Flink streaming connector for Flume + - Flink streaming connector for Redis + - Flink streaming connector for Akka + - Flink streaming connector for Netty The {{ site.data.project.name }} community welcomes the proposal of new extensions. ## Contact the {{ site.data.project.short_name }} community -For {{ site.data.project.short_name }} updates and news, subscribe to our development mailing list. Check out [All Mailing Lists](/community) +For {{ site.data.project.short_name }} updates and news, subscribe to our development mailing list. Check out [All Mailing Lists](/community). <div class="row"> <div class="col-md-12"> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/releases/2.0.0/release-notes.md ---------------------------------------------------------------------- diff --git a/site/releases/2.0.0/release-notes.md b/site/releases/2.0.0/release-notes.md deleted file mode 100644 index 51f1caa..0000000 --- a/site/releases/2.0.0/release-notes.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: page -title: Bahir Release 2.0.0 -description: Release Notes for Apache Bahir 2.0.0 -group: nav-right ---- -<!-- -{% comment %} -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 with -the License. You may obtain a copy of the License at - -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. -{% endcomment %} ---> - -{% include JB/setup %} - - -# Apache Bahir 2.0 for Apache Spark 2.0 - -## Bug - - [BAHIR-13] - Update spark tags dependency - [BAHIR-14] - Cleanup maven pom from Spark dependencies - [BAHIR-15] - Enable RAT on Bahir builds - [BAHIR-16] - Build issues due to log4j properties not found - [BAHIR-18] - Include examples in Maven test build - [BAHIR-23] - Build should fail on Checkstyle violation - [BAHIR-24] - Fix MQTT Python code - [BAHIR-38] - Spark-submit does not use latest locally installed Bahir packages - [BAHIR-42] - Refactor sql-streaming-mqtt examples to follow other projects pattern - [BAHIR-43] - Add missing apache license header to sql-mqtt file - [BAHIR-44] - Add new sql-streaming-mqtt to distribution - -## Improvement - - [BAHIR-36] - Update readme.md with build instructions - -## New Feature - - [BAHIR-2] - Create initial build for Bahir components - [BAHIR-39] - MQTT as a streaming source for SQL Streaming - -## Task - - [BAHIR-17] - Prepare release based on Apache Spark 2.0.0-preview - [BAHIR-22] - Add script to run examples - [BAHIR-35] - Include Python code in the binary jars for use with "--packages ..." - [BAHIR-37] - Prepare release based on Apache Spark 2.0.0 - -## Sub-task - - [BAHIR-19] - Create Bahir source distribution - [BAHIR-20] - Create release script - [BAHIR-21] - Create script to change build between scala 2.10 and 2.11 - [BAHIR-28] - Add documentation for streaming-akka connector - [BAHIR-29] - Add documentation for streaming-mqtt connector - [BAHIR-30] - Add documentation for streaming-twitter connector - [BAHIR-31] - Add documentation for streaming-zeromq connector http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/releases/2.0.1/release-notes.md ---------------------------------------------------------------------- diff --git a/site/releases/2.0.1/release-notes.md b/site/releases/2.0.1/release-notes.md deleted file mode 100644 index 90d6d94..0000000 --- a/site/releases/2.0.1/release-notes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: page -title: Bahir Release 2.0.1 -description: Release Notes for Apache Bahir 2.0.1 -group: nav-right ---- -<!-- -{% comment %} -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 with -the License. You may obtain a copy of the License at - -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. -{% endcomment %} ---> - -{% include JB/setup %} - -# Apache Bahir 2.0.1 for Apache Spark 2.0.1 - -## Bug - - [BAHIR-52] - Update extension documentation formats for code sections - [BAHIR-69] - Release script fails intermitently when publishing to staging maven repo - -## Improvement - - [BAHIR-51] - Add additional MQTT options/parameters to MQTTInputDStream and MqttStreamSource - [BAHIR-53] - Add additional MQTT options/parameters to MQTTInputDStream - [BAHIR-61] - Enable release script to publish release by a specific rc tag - -## Task - - [BAHIR-62] - Prepare release based on Apache Spark 2.0.1 http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/releases/2.0.2/release-notes.md ---------------------------------------------------------------------- diff --git a/site/releases/2.0.2/release-notes.md b/site/releases/2.0.2/release-notes.md deleted file mode 100644 index 2636f48..0000000 --- a/site/releases/2.0.2/release-notes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: page -title: Bahir Release 2.0.2 -description: Release Notes for Apache Bahir 2.0.2 -group: nav-right ---- -<!-- -{% comment %} -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 with -the License. You may obtain a copy of the License at - -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. -{% endcomment %} ---> - -{% include JB/setup %} - - -# Apache Bahir 2.0.2 for Apache Spark 2.0.2 - -## Task - - [BAHIR-82] - Prepare release based on Apache Spark 2.0.2 - -## Sub-Task - - [BAHIR-64] - Add test that Akka streaming connector can receive data - [BAHIR-69] - Clean build between different scala versions - -## Test - - [BAHIR-83] - Flaky test in BasicMQTTSourceSuite - [BAHIR-84] - Build log flooded with test log messages http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/releases/2.1.0/release-notes.md ---------------------------------------------------------------------- diff --git a/site/releases/2.1.0/release-notes.md b/site/releases/2.1.0/release-notes.md deleted file mode 100644 index e33f499..0000000 --- a/site/releases/2.1.0/release-notes.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: page -title: Bahir Release 2.1.0 -description: Release Notes for Apache Bahir 2.1.0 -group: nav-right ---- -<!-- -{% comment %} -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 with -the License. You may obtain a copy of the License at - -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. -{% endcomment %} ---> - -{% include JB/setup %} - - -# Apache Bahir 2.1 for Apache Spark 2.1 - -## Task - - [BAHIR-87] - Prepare release based on Apache Spark 2.1.0 - [MINOR] - Update Scaladoc in MQTTWordCount example - [MINOR] - Fix Maven artifact IDs in README.md files - http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/releases/spark/2.0.0/release-notes.md ---------------------------------------------------------------------- diff --git a/site/releases/spark/2.0.0/release-notes.md b/site/releases/spark/2.0.0/release-notes.md new file mode 100644 index 0000000..51f1caa --- /dev/null +++ b/site/releases/spark/2.0.0/release-notes.md @@ -0,0 +1,69 @@ +--- +layout: page +title: Bahir Release 2.0.0 +description: Release Notes for Apache Bahir 2.0.0 +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + + +# Apache Bahir 2.0 for Apache Spark 2.0 + +## Bug + + [BAHIR-13] - Update spark tags dependency + [BAHIR-14] - Cleanup maven pom from Spark dependencies + [BAHIR-15] - Enable RAT on Bahir builds + [BAHIR-16] - Build issues due to log4j properties not found + [BAHIR-18] - Include examples in Maven test build + [BAHIR-23] - Build should fail on Checkstyle violation + [BAHIR-24] - Fix MQTT Python code + [BAHIR-38] - Spark-submit does not use latest locally installed Bahir packages + [BAHIR-42] - Refactor sql-streaming-mqtt examples to follow other projects pattern + [BAHIR-43] - Add missing apache license header to sql-mqtt file + [BAHIR-44] - Add new sql-streaming-mqtt to distribution + +## Improvement + + [BAHIR-36] - Update readme.md with build instructions + +## New Feature + + [BAHIR-2] - Create initial build for Bahir components + [BAHIR-39] - MQTT as a streaming source for SQL Streaming + +## Task + + [BAHIR-17] - Prepare release based on Apache Spark 2.0.0-preview + [BAHIR-22] - Add script to run examples + [BAHIR-35] - Include Python code in the binary jars for use with "--packages ..." + [BAHIR-37] - Prepare release based on Apache Spark 2.0.0 + +## Sub-task + + [BAHIR-19] - Create Bahir source distribution + [BAHIR-20] - Create release script + [BAHIR-21] - Create script to change build between scala 2.10 and 2.11 + [BAHIR-28] - Add documentation for streaming-akka connector + [BAHIR-29] - Add documentation for streaming-mqtt connector + [BAHIR-30] - Add documentation for streaming-twitter connector + [BAHIR-31] - Add documentation for streaming-zeromq connector http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/releases/spark/2.0.1/release-notes.md ---------------------------------------------------------------------- diff --git a/site/releases/spark/2.0.1/release-notes.md b/site/releases/spark/2.0.1/release-notes.md new file mode 100644 index 0000000..90d6d94 --- /dev/null +++ b/site/releases/spark/2.0.1/release-notes.md @@ -0,0 +1,43 @@ +--- +layout: page +title: Bahir Release 2.0.1 +description: Release Notes for Apache Bahir 2.0.1 +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + +# Apache Bahir 2.0.1 for Apache Spark 2.0.1 + +## Bug + + [BAHIR-52] - Update extension documentation formats for code sections + [BAHIR-69] - Release script fails intermitently when publishing to staging maven repo + +## Improvement + + [BAHIR-51] - Add additional MQTT options/parameters to MQTTInputDStream and MqttStreamSource + [BAHIR-53] - Add additional MQTT options/parameters to MQTTInputDStream + [BAHIR-61] - Enable release script to publish release by a specific rc tag + +## Task + + [BAHIR-62] - Prepare release based on Apache Spark 2.0.1 http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/releases/spark/2.0.2/release-notes.md ---------------------------------------------------------------------- diff --git a/site/releases/spark/2.0.2/release-notes.md b/site/releases/spark/2.0.2/release-notes.md new file mode 100644 index 0000000..2636f48 --- /dev/null +++ b/site/releases/spark/2.0.2/release-notes.md @@ -0,0 +1,43 @@ +--- +layout: page +title: Bahir Release 2.0.2 +description: Release Notes for Apache Bahir 2.0.2 +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + + +# Apache Bahir 2.0.2 for Apache Spark 2.0.2 + +## Task + + [BAHIR-82] - Prepare release based on Apache Spark 2.0.2 + +## Sub-Task + + [BAHIR-64] - Add test that Akka streaming connector can receive data + [BAHIR-69] - Clean build between different scala versions + +## Test + + [BAHIR-83] - Flaky test in BasicMQTTSourceSuite + [BAHIR-84] - Build log flooded with test log messages http://git-wip-us.apache.org/repos/asf/bahir-website/blob/b536ac52/site/releases/spark/2.1.0/release-notes.md ---------------------------------------------------------------------- diff --git a/site/releases/spark/2.1.0/release-notes.md b/site/releases/spark/2.1.0/release-notes.md new file mode 100644 index 0000000..e33f499 --- /dev/null +++ b/site/releases/spark/2.1.0/release-notes.md @@ -0,0 +1,36 @@ +--- +layout: page +title: Bahir Release 2.1.0 +description: Release Notes for Apache Bahir 2.1.0 +group: nav-right +--- +<!-- +{% comment %} +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 with +the License. You may obtain a copy of the License at + +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. +{% endcomment %} +--> + +{% include JB/setup %} + + +# Apache Bahir 2.1 for Apache Spark 2.1 + +## Task + + [BAHIR-87] - Prepare release based on Apache Spark 2.1.0 + [MINOR] - Update Scaladoc in MQTTWordCount example + [MINOR] - Fix Maven artifact IDs in README.md files +
