You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spot.apache.org by ev...@apache.org on 2017/03/29 16:51:47 UTC
[23/50] [abbrv] incubator-spot git commit: Adding README and
requiremets for API Resources
Adding README and requiremets for API Resources
Project: http://git-wip-us.apache.org/repos/asf/incubator-spot/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-spot/commit/ffc6dbc6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-spot/tree/ffc6dbc6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-spot/diff/ffc6dbc6
Branch: refs/heads/SPOT-35_graphql_api
Commit: ffc6dbc616a91485a34d2fff3917ab03fbcb3411
Parents: 3718d80
Author: Everardo Lopez Sandoval (Intel) <el...@elopezsa-mac02.local>
Authored: Thu Mar 9 13:26:30 2017 -0600
Committer: Diego Ortiz Huerta <di...@intel.com>
Committed: Wed Mar 15 11:49:48 2017 -0700
----------------------------------------------------------------------
spot-oa/api/resources/README.md | 50 ++++++++++++++++++++++++++++++++++++
spot-oa/requirements.txt | 6 +++++
2 files changed, 56 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-spot/blob/ffc6dbc6/spot-oa/api/resources/README.md
----------------------------------------------------------------------
diff --git a/spot-oa/api/resources/README.md b/spot-oa/api/resources/README.md
new file mode 100644
index 0000000..1d74e6f
--- /dev/null
+++ b/spot-oa/api/resources/README.md
@@ -0,0 +1,50 @@
+
+
+# API Resources
+
+
+API Resources are the backend methods used by GraphQL to perform CRUD operations to Apache Spot (incubating) like score connections, performa a threat investigation, generate a storyboard, etc.
+
+**Classes:**
+
+* Resources/flow.py
+* Resources/dns
+* Resources/proxy
+* Resources/configurator
+* Resources/hdfs_client
+* Resources/impala_engine.py
+
+
+
+## **Configuration Required (spot.conf):**
+
+API Resources use WebHDFS REST API (https://hadoop.apache.org/docs/r1.0.4/webhdfs.html) and Impala API based on that some new configuration is required.
+
+**_Keys in HDFS section:_**
+
+**NAME_NODE:** this key is required to setup the name node (full DNS domain or IP) to get connected to WebHDFS REST API.
+**WEB_PORT:** Web port to WebHDFS REST API (default=50070)
+
+**_Keys in Impala section:_**
+
+**IMPALA_DEM:** This key has been there since the last release ,but now that we spot uses an API to get connected you need to either put the impala daemon full DNS or Server IP.
+**IMPALA_PORT:** Port on which HiveServer2 client requests are served by Impala Daemons.
+
+## **Prerequisites:**
+
+#### Python:
+* setuptools
+* thrift==0.9.3
+* impyla
+* hdfs
+
+**NOTE: all this requirements are already part of requiremets.txt file, you dont need to install the python prerequisites manually.**
+
+#### Hadoop:
+
+* Impala.
+* WebHDFS REST API.
+
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-spot/blob/ffc6dbc6/spot-oa/requirements.txt
----------------------------------------------------------------------
diff --git a/spot-oa/requirements.txt b/spot-oa/requirements.txt
index 9d6f868..9f3afb8 100644
--- a/spot-oa/requirements.txt
+++ b/spot-oa/requirements.txt
@@ -18,3 +18,9 @@ flask
flask-graphql
graphql-core
urllib3
+
+# API Resources
+setuptools>=3.4.4
+thrift==0.9.3
+impyla
+hdfs