Skip to content

Commit 6225f04

Browse files
authored
added badges
1 parent 5d852eb commit 6225f04

File tree

1 file changed

+86
-2
lines changed

1 file changed

+86
-2
lines changed

README.md

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,87 @@
1-
# elasticsearch-plugins
1+
# Elasticsearch Plugins
22

3-
<a href="https://cdap-users.herokuapp.com/"><img alt="Join CDAP community" src="https://cdap-users.herokuapp.com/badge.svg?t=1"/></a> [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
3+
[![cm-available](https://cdap-users.herokuapp.com/assets/cm-available.svg)](https://docs.cask.co/cdap/current/en/integrations/cask-market.html)
4+
![cdap-batch-source](https://cdap-users.herokuapp.com/assets/cdap-batch-source.svg)
5+
![cdap-batch-sink](https://cdap-users.herokuapp.com/assets/cdap-batch-sink.svg)
6+
![cdap-realtime-sink](https://cdap-users.herokuapp.com/assets/cdap-realtime-sink.svg)
7+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
8+
[![Join CDAP community](https://cdap-users.herokuapp.com/badge.svg?t=wrangler)](https://cdap-users.herokuapp.com?t=1)
9+
10+
Introduction
11+
============
12+
Elasticsearch plugins consists of the following plugins for CDAP pipelines:
13+
* [Elasticsearch Batch Source](docs/Elasticsearch-batchsource.md)
14+
* [Elasticsearch Batch Sink](docs/Elasticsearch-batchsink.md)
15+
* [Elasticsearch Realtime Sink](docs/Elasticsearch-realtimesource.md)
16+
17+
18+
Getting Started
19+
===============
20+
21+
Prerequisites
22+
--------------
23+
CDAP version 3.5.x or higher.
24+
25+
Building Plugins
26+
----------------
27+
You get started with Run transform plugin by building directly from the latest source code::
28+
29+
git clone https://github.com/hydrator/naive-bayes-analytics.git
30+
cd naive-bayes-analytics
31+
mvn clean package
32+
33+
After the build completes, you will have a JAR for each plugin under each
34+
``<plugin-name>/target/`` directory.
35+
36+
Deploying Plugins
37+
-----------------
38+
You can deploy a plugin using the CDAP CLI::
39+
40+
> load artifact <target/plugin-jar> config-file <resources/plugin-config>
41+
42+
> load artifact target/naive-bayes-analytics-plugin-<version>.jar \
43+
config-file target/naive-bayes-analytics-plugin-<version>.json
44+
45+
You can build without running tests: ``mvn clean install -DskipTests``
46+
47+
Limitations
48+
-----------
49+
- UI doesn't support schema's with hyphens (-), so the plugin currently transforms all the schemas with - into underscores (_). This change will be reverted after this is fixed: https://issues.cask.co/browse/HYDRATOR-1125
50+
51+
Mailing Lists
52+
-------------
53+
CDAP User Group and Development Discussions:
54+
55+
- `[email protected] <https://groups.google.com/d/forum/cdap-user>`__
56+
57+
The *cdap-user* mailing list is primarily for users using the product to develop
58+
applications or building plugins for appplications. You can expect questions from
59+
users, release announcements, and any other discussions that we think will be helpful
60+
to the users.
61+
62+
IRC Channel
63+
-----------
64+
CDAP IRC Channel: #cdap on irc.freenode.net
65+
66+
67+
License and Trademarks
68+
======================
69+
70+
Copyright © 2015-2016 Cask Data, Inc.
71+
72+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
73+
in compliance with the License. You may obtain a copy of the License at
74+
75+
http://www.apache.org/licenses/LICENSE-2.0
76+
77+
Unless required by applicable law or agreed to in writing, software distributed under the
78+
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
79+
either express or implied. See the License for the specific language governing permissions
80+
and limitations under the License.
81+
82+
Cask is a trademark of Cask Data, Inc. All rights reserved.
83+
84+
Apache, Apache HBase, and HBase are trademarks of The Apache Software Foundation. Used with
85+
permission. No endorsement by The Apache Software Foundation is implied by the use of these marks.
86+
87+
.. |(Hydrator)| image:: http://cask.co/wp-content/uploads/hydrator_logo_cdap1.png

0 commit comments

Comments
 (0)