You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@eagle.apache.org by ha...@apache.org on 2016/12/23 10:34:02 UTC
incubator-eagle git commit: [DOC] Remove out-of-supported docker and
refine README
Repository: incubator-eagle
Updated Branches:
refs/heads/master 89d136ae9 -> 231560ad3
[DOC] Remove out-of-supported docker and refine README
* Remove out-of-supported docker
* Refine `README.md`
Author: Hao Chen <ha...@apache.org>
Closes #755 from haoch/RefactorDoc.
Project: http://git-wip-us.apache.org/repos/asf/incubator-eagle/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-eagle/commit/231560ad
Tree: http://git-wip-us.apache.org/repos/asf/incubator-eagle/tree/231560ad
Diff: http://git-wip-us.apache.org/repos/asf/incubator-eagle/diff/231560ad
Branch: refs/heads/master
Commit: 231560ad3eb11678d489923b03c4a017d307e8b5
Parents: 89d136a
Author: Hao Chen <ha...@apache.org>
Authored: Fri Dec 23 18:33:46 2016 +0800
Committer: Hao Chen <ha...@apache.org>
Committed: Fri Dec 23 18:33:46 2016 +0800
----------------------------------------------------------------------
README.md | 83 +++++++++++++++++++++++++++++++------------------------
eagle-docker | 20 --------------
2 files changed, 47 insertions(+), 56 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-eagle/blob/231560ad/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 49be553..bca1ab3 100755
--- a/README.md
+++ b/README.md
@@ -19,64 +19,75 @@ limitations under the License.
# Apache Eagle
-> Secure Hadoop Data in Real Time
-
-## Overview
+> The intelligent monitoring and alerting solution instantly analyzes big data platforms for security and performance
Apache� Eagle\u2122 is an open source analytics solution for identifying security and performance issues instantly on big data platforms e.g. Apache Hadoop, Apache Spark, NoSQL etc. It analyzes data activities, yarn applications, jmx metrics, and daemon logs etc., provides state-of-the-art alert engine to identify security breach, performance issues and shows insights.
-For more details, please visit [https://eagle.incubator.apache.org](https://eagle.incubator.apache.org)
+For more details, please visit [https://eagle.apache.org](https://eagle.apache.org)
-## Status
+[](https://builds.apache.org/job/incubator-eagle-main/)
+[](https://coveralls.io/github/apache/incubator-eagle)
-### Branches
-| name | build | coverage | description |
-| :---:| :---: | :---: | :--- |
-| [**master**](https://github.com/apache/incubator-eagle/tree/master) | [](https://builds.apache.org/job/incubator-eagle-main/) | [](https://coveralls.io/github/apache/incubator-eagle) | 0.5.0-incubating-SNAPSHOT | Branch for continuous development. |
+## Documentation
-### Latest Release
+You can find the latest Eagle documentation on [https://eagle.apache.org](https://eagle.apache.org/docs). This [README](README.md) file only contains basic setup instructions.
-| release date | version | release notes | artifacts | md5 checksum | sha1 checksum |
-| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
-| 2016/07/21 | [[0.4.0-incubating]](https://github.com/apache/incubator-eagle/releases/tag/v0.4.0-incubating) | [[Release Notes]](https://git-wip-us.apache.org/repos/asf?p=incubator-eagle.git;a=blob_plain;f=CHANGELOG.txt;hb=refs/tags/v0.4.0-incubating) | [[Artifacts]](http://www.apache.org/dyn/closer.cgi?path=/incubator/eagle/apache-eagle-0.4.0-incubating) | [[MD5]](https://dist.apache.org/repos/dist/release/incubator/eagle/apache-eagle-0.4.0-incubating/apache-eagle-0.4.0-incubating-src.tar.gz.md5) | [[SHA1]](https://dist.apache.org/repos/dist/release/incubator/eagle/apache-eagle-0.4.0-incubating/apache-eagle-0.4.0-incubating-src.tar.gz.sha1) |
+## Downloads
-[More Release Versions](http://archive.apache.org/dist/incubator/eagle/)
+* Latest Release
+ * [eagle-0.4.0-incubating](http://eagle.apache.org/docs/download-latest.html)
+* Archived Releases
+ * [eagle-0.3.0-incubating](http://eagle.apache.org/docs/download.html#0.3.0-incubating)
+ * [More releases](http://eagle.apache.org/docs/download.html)
-## Documentation
-You can find the latest Eagle documentation on [https://eagle.incubator.apache.org](https://eagle.incubator.apache.org/docs). This [README](README.md) file only contains basic setup instructions.
+## Getting Started
-## Build Eagle (Supports JDK-1.8)
-Eagle is built using [Apache Maven](https://maven.apache.org/). NPM should be installed (On MAC OS try "brew install node"). To build Eagle, run:
- mvn -DskipTests clean package
+### Prerequisites
+
+* [JDK 8](https://jdk8.java.net/): Java Development Tool `Version 1.8`
+* [Apache Maven](https://maven.apache.org/): Project management and comprehension tool `Version 3.x`
+* [NPM](https://www.npmjs.com/): Javascript package management tool `Version 3.x`
+
+### Building Eagle
-Note : As of version 0.5, Eagle is tested on JDK-1.8.
+> Since version 0.5, Eagle is only tested on JDK 8.
-After successfully building, you will find eagle binary tarball under _eagle-assembly/target/_
+Eagle is built using [Apache Maven](https://maven.apache.org/). NPM should be installed (On MAC OS try "brew install node"). To build Eagle, run:
+
+ mvn clean package -DskipTests
+
+After successfully building, you will find eagle binary tarball under _eagle-server-assembly/target/_
-## Eagle Quick Start in IDE (Intellij)
-### prepare
-Please have HDP sandbox ready, where you can have zookeeper, hadoop, hbase, hive ready.
+### Testing Eagle
-### Run Eagle Web Service
-Go to project eagle-webservice, run it as web application.
-
-### Run Eagle Alert Engine
-Find out org.apache.eagle.alert.engine.UnitTopologyMain, run it.
+ mvn clean test
-Note: the config is eagle-core/eagle-alert-parent/eagle-alert/alert-engine/src/main/resources/application.conf
+### Developing Eagle
+* (Optional) Install/Start [HDP Sandbox](http://hortonworks.com/products/sandbox/) which provide an all-in-one virtual machine with most dependency services like Zookeeper, Kafka, HBase, etc and monitored hadoop components.
+* Import Eagle as maven project with popular IDE like [IntelliJ IDEA](https://www.jetbrains.com/idea/)
+* Start **Eagle Server** in `debug` mode by running (default http port: `9090`, default smpt port: `5025`)
-### Run Eagle Ingestion Applications
-For example, find out org.apache.eagle.security.securitylog.HdfsAuthLogMonitoringMain, run it.
+ org.apache.eagle.server.ServerDebug
+
+ Which will start some helpful services for convenient development:
+ * Local Eagle Service on [`http://localhost:9090`](http://localhost:9090)
+ * Local SMTP Service on `localhost:5025` with REST API at [`http://localhost:9090/rest/mail`](http://localhost:9090/rest/mail)
+* Start **Eagle Apps** with Eagle Web UI in `LOCAL MODE`.
-Note: the config is eagle-security/eagle-security-hdfs-authlog/src/main/resources/application.conf
+## Getting Help
-## Get Help
-The fastest way to get response from eagle community is to send email to the mail list [dev@eagle.incubator.apache.org](mailto:dev@eagle.incubator.apache.org),
-and remember to subscribe our mail list via [dev-subscribe@eagle.incubator.apache.org](mailto:dev-subscribe@eagle.incubator.apache.org)
+The fastest way to get response from eagle community is to send email to the mail list [dev@eagle.apache.org](mailto:dev@eagle.apache.org),
+and remember to subscribe our mail list via [dev-subscribe@eagle.apache.org](mailto:dev-subscribe@eagle.apache.org)
## FAQ
+
[https://cwiki.apache.org/confluence/display/EAG/FAQ](https://cwiki.apache.org/confluence/display/EAG/FAQ)
+## Contributing
+
+Please review the [Contribution to Eagle Guide](https://cwiki.apache.org/confluence/display/EAG/Contributing+to+Eagle) for information on how to get started contributing to the project.
+
## License
+
Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). More details, please refer to [LICENSE](LICENSE) file.
http://git-wip-us.apache.org/repos/asf/incubator-eagle/blob/231560ad/eagle-docker
----------------------------------------------------------------------
diff --git a/eagle-docker b/eagle-docker
deleted file mode 100755
index f581845..0000000
--- a/eagle-docker
+++ /dev/null
@@ -1,20 +0,0 @@
-#!/bin/bash
-
-# 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.
-
-# NOTICE: This script is developed and maintained by Apache Eagle community under Apache Softwarw Foundation but not from official Docker product or community.
-
-$(dirname $0)/eagle-external/eagle-docker/bin/eagle-docker.sh $@