You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spot.apache.org by na...@apache.org on 2017/09/26 22:41:42 UTC
[39/50] [abbrv] incubator-spot git commit: Add Apache Spot sample
dashboards and README
Add Apache Spot sample dashboards and README
"spot_app.json" is a configuration file containing all of the current sample Apache Spot dashboards. The current set of sample Apache Spot dashboards include: Network Activity, User Activity Summary, User Activity Details, Endpoint Activity Summary, Endpoint Activity Details, and Vulnerabilities views. Details about each of these dashboards can be found in the README along with installation instructions and sources for sample data. This file can be imported into either Arcadia Instant or Enterprise. ODM tables should be setup before importing the configuration file. Once imported the dashboards will align with the ODM tables that have been set up.
Project: http://git-wip-us.apache.org/repos/asf/incubator-spot/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-spot/commit/94a2d943
Tree: http://git-wip-us.apache.org/repos/asf/incubator-spot/tree/94a2d943
Diff: http://git-wip-us.apache.org/repos/asf/incubator-spot/diff/94a2d943
Branch: refs/heads/SPOT-181_ODM
Commit: 94a2d943aec8c5d7ffcd64014088e39b19e28753
Parents: 2ebe572
Author: Tadd Wood <ta...@arcadiadata.com>
Authored: Thu Sep 21 23:59:52 2017 -0700
Committer: natedogs911 <na...@gmail.com>
Committed: Tue Sep 26 14:47:21 2017 -0700
----------------------------------------------------------------------
spot-oa/arcadia/README.md | 84 ++++++++++++++++++++++++++++++++++++++
spot-oa/arcadia/spot_app.json | 1 +
2 files changed, 85 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-spot/blob/94a2d943/spot-oa/arcadia/README.md
----------------------------------------------------------------------
diff --git a/spot-oa/arcadia/README.md b/spot-oa/arcadia/README.md
new file mode 100644
index 0000000..919676e
--- /dev/null
+++ b/spot-oa/arcadia/README.md
@@ -0,0 +1,84 @@
+# spot-oa/arcadia
+
+## Arcadia Dashboards for Apache Spot
+
+This document describes the steps required to setup and use Arcadia Dashboards as a visualization layer on the Apache Spot Open Data Model (ODM)
+
+## Getting Started
+
+Contained in this directory is a configuration file (spot_app.json) that includes several sample dashboards for end users to setup and use with the Apache Spot ODM.
+
+#### Included Dashboards
+
+- Network Activity - Provides views of events and suspicious network flow activity
+- User Activity Summary - Provides summary level view of suspicious activity related to users in your environment.
+- User Activity Detail - Provides a contextual view of events related to users in your environment
+- Endpoint Activity Summary - Provides a summary level view of suspicious activity related to endpoint in your environment.
+- Endpoint Activity Detail - Provides a contextual view of events related to endpoints in your environment.
+- Vulnerabilities - Provides a contextual view of vulnerabilities and details related to endpoints in your environment.
+
+End users are encouraged to customize these dashboards for their own purposes and use-cases.
+
+## Prerequisites
+
+To setup and configure the Arcadia Dashboards, you must have the following:
+- A running Hadoop cluster with Impala installed and configured
+- Linux user account created in all nodes with sudo privileges
+- Installation and setup of the Open Data Model (ODM) directories and schema (see spot-setup/odm)
+- Download of Arcadia Instant (https://www.arcadiadata.com/product/instant/)
+
+Having the ODM directories populated with data or sample data is also recommended for visualizations to load properly.
+
+## Setup Instructions
+
+Following the completion of the pre-requisites and starting Arcadia Instant, you can perform the following steps to import and configure the Apache Spot dashboards contained in the **spot_app.json** file.
+1. In the Arcadia Instant Control Panel, click "Go" to launch a browser window.
+2. Click the "Data" tab, and then click "New Connection"
+3. Select "Impala" as the connection type, and configure the connection to connect to the Impala daemon on your running Hadoop cluster.
+Click the "Advanced" tab if you need to configure LDAP or Kerberos authentication for your connection.
+Also make sure "Result cache" is enabled in the "Cache" tab of your connection.
+4. Click the "Test" button to make sure you connection is working and then "Connect" to exit.
+5. Click your newly setup connection and look for a button that looks like an ellipsis (...).
+6. Click the ellipsis button, and then click "Import Visual Artifacts"
+7. Choose the **spot_app.json** file to upload.
+8. Click "Accept and Import".
+9. Presto! You should now have live dashboards connected to the Apache Spot (ODM) tables.
+
+## Sources for Sample Data
+
+If you haven't landed any data in the ODM directories yet and would like to demo the Arcadia Dashboards,
+you can complete the following steps to download sample data within your running Hadoop cluster.
+Also note that the dependencies in the Enviornment Variables section below.
+
+**OBLIGITORY DISCLAIMER**: DO NOT RUN THIS SCRIPT IF YOU ALREADY HAVE PRODUCTION DATA POPULATING THE ODM DIRECTORIES.
+
+There is a safe guard in the odm_sample_setup.sh script to prevent overwrites of data in the ODM directories,
+but its best to avoid this step altogether if you know data is already landing in those directories.
+
+#### Environment Variables
+
+The **odm_sample_setup.sh** script is dependent on the **spot.conf** file being installed (see spot-setup/odm),
+which is intended to be located in the /etc directory by default.
+
+#### Sample Data Setup Steps
+
+1. run wget http://get.arcadiadata.com.s3.amazonaws.com/spot/sample/odm_sample_setup.sh to retrieve the sample data setup script.
+2. run chmod +x odm_sample_setup.sh to make the script executable.
+3. run ./odm_sample_setup.sh to retrieve, store, and make sample data available in your ODM tables.
+
+## Licensing
+
+spot-setup is licensed under Apache Version 2.0
+
+## Contributing
+
+Create a pull request and contact the maintainers.
+
+## Issues
+
+Report issues at the Apache Spot [issues] (https://github.com/Open-Network-Insight/open-network-insight/issues) page.
+
+## Maintainers
+
+- [Tadd Wood] (https://github.com/TaddWood)
+