You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by merrimanr <gi...@git.apache.org> on 2017/09/26 21:30:33 UTC
[GitHub] metron pull request #773: METRON-1206: Make alerts UI conform to ops UI for ...
GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/773
METRON-1206: Make alerts UI conform to ops UI for install
## Contributor Comments
This PR is a precursor to [METRON-1207](https://issues.apache.org/jira/browse/METRON-1207) and [METRON-1208](https://issues.apache.org/jira/browse/METRON-1208). The list of changes include:
- addition of a configuration file (as opposed to passing in arguments to the start script)
- a new init script for start/stop/restart operations
- updated assembly.xml to reflect shared expressjs directory structure
- changed port for Alerts UI to 4201 to avoid conflict with Management UI
- updated Alerts UI documentation
This can be tested by following the instructions in the README. The previously mentioned follow-on PRs are also ready once this has been accepted.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.
Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
### For code changes:
- [x] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
- [x] Have you included steps or a guide to how the change may be verified and tested manually?
- [x] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [x] Have you written or updated unit tests and or integration tests to verify your changes?
- [x] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [x] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/merrimanr/incubator-metron METRON-1206
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/773.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #773
----
commit a8437e86ac36806cc9b4ed2c031509af13ba478a
Author: merrimanr <me...@gmail.com>
Date: 2017-09-26T21:17:33Z
initial commit
----
---
[GitHub] metron pull request #773: METRON-1206: Make alerts UI conform to ops UI for ...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/773#discussion_r141461626
--- Diff: metron-interface/metron-alerts/README.md ---
@@ -28,7 +87,7 @@
```
1. You can view the GUI @http://localhost:4200 . The default credentials for login are admin/password
--- End diff --
Should be 4201 now, right?
---
[GitHub] metron pull request #773: METRON-1206: Make alerts UI conform to ops UI for ...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/773#discussion_r141473085
--- Diff: metron-interface/metron-alerts/README.md ---
@@ -28,7 +87,7 @@
```
1. You can view the GUI @http://localhost:4200 . The default credentials for login are admin/password
--- End diff --
Nevermind, github is is being weird for me and showing it inconsistently
---
[GitHub] metron pull request #773: METRON-1206: Make alerts UI conform to ops UI for ...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/773#discussion_r141461458
--- Diff: metron-interface/metron-alerts/README.md ---
@@ -6,15 +6,74 @@
- [Installing on an existing Cluster](#installing-on-an-existing-cluster)
## Caveats
-* UI doesn't have an authentication module yet
* UI uses local storage to save all the data. A middleware needs to be designed and developed for persisting the data
## Prerequisites
-* Elastic search should be up and running and should have some alerts populated by metron topologies
+* The Metron REST application should be up and running and Elasticsearch should have some alerts populated by Metron topologies
+* The Management UI should be installed (which includes [Express](https://expressjs.com/))
* The alerts can be populated using Quick Dev, Full Dev or any other setup
* UI is developed using angular4 and uses angular-cli
* node.JS >= 7.8.0
+## Installation
+
+### From Source
+
+1. Package the application with Maven:
+
+ ```
+ cd metron-interface/metron-alerts
+ mvn clean package
+ ```
+
+1. Untar the archive in the $METRON_HOME directory. The directory structure will look like:
+
+ ```
+ bin
+ metron-alerts-ui
+ web
+ expressjs
+ alerts-server.js
+ alerts-ui
+ web assets (html, css, js, ...)
+ ```
+
+1. Copy the `$METRON_HOME/bin/metron-alerts-ui` script to `/etc/init.d/metron-alerts-ui`
+
+1. [Express](https://expressjs.com/) is installed at `$METRON_HOME/web/expressjs/` as part of the Management UI installation process. The Management UI should be installeed first on the same host as the Alerts UI.
+
+### From Package Manager
+
+1. Deploy the RPM at `/metron/metron-deployment/packaging/docker/rpm-docker/target/RPMS/noarch/metron-alerts-$METRON_VERSION-*.noarch.rpm`
+
+1. Install the RPM with:
+
+ ```
+ rpm -ih metron-alerts-$METRON_VERSION-*.noarch.rpm
+ ```
+
+## Configuration
+
+The Alerts UI is configured in the `$METRON_HOME/config/alerts_ui.yml` file. Create this file and set the values to match your environment:
+
+```
+port: port the alerts UI will run on
+
+rest:
+ host: REST application host
+ port: REST applciation port
+```
+
+## Usage
+
+After configuration is complete, the Management UI can be managed as a service:
+
+```
+service metron-alerts-ui start
+```
+
+The application will be available at http://host:4201 assuming the port is set to `4201`. Logs can be found at `/var/log/metron/metron-management-ui.log`.
--- End diff --
`metron-management-ui.log` to `metron-alerts-ui.log`
---
[GitHub] metron pull request #773: METRON-1206: Make alerts UI conform to ops UI for ...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/773#discussion_r141460898
--- Diff: metron-interface/metron-alerts/README.md ---
@@ -6,15 +6,74 @@
- [Installing on an existing Cluster](#installing-on-an-existing-cluster)
## Caveats
-* UI doesn't have an authentication module yet
* UI uses local storage to save all the data. A middleware needs to be designed and developed for persisting the data
## Prerequisites
-* Elastic search should be up and running and should have some alerts populated by metron topologies
+* The Metron REST application should be up and running and Elasticsearch should have some alerts populated by Metron topologies
+* The Management UI should be installed (which includes [Express](https://expressjs.com/))
* The alerts can be populated using Quick Dev, Full Dev or any other setup
* UI is developed using angular4 and uses angular-cli
* node.JS >= 7.8.0
+## Installation
+
+### From Source
+
+1. Package the application with Maven:
+
+ ```
+ cd metron-interface/metron-alerts
+ mvn clean package
+ ```
+
+1. Untar the archive in the $METRON_HOME directory. The directory structure will look like:
+
+ ```
+ bin
+ metron-alerts-ui
+ web
+ expressjs
+ alerts-server.js
+ alerts-ui
+ web assets (html, css, js, ...)
+ ```
+
+1. Copy the `$METRON_HOME/bin/metron-alerts-ui` script to `/etc/init.d/metron-alerts-ui`
+
+1. [Express](https://expressjs.com/) is installed at `$METRON_HOME/web/expressjs/` as part of the Management UI installation process. The Management UI should be installeed first on the same host as the Alerts UI.
+
+### From Package Manager
--- End diff --
RPM sounds like it exists in one of the followon PRs that's coming. Can we move this section to that PR?
---
[GitHub] metron pull request #773: METRON-1206: Make alerts UI conform to ops UI for ...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/773
---
[GitHub] metron pull request #773: METRON-1206: Make alerts UI conform to ops UI for ...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/773#discussion_r141471628
--- Diff: metron-interface/metron-alerts/README.md ---
@@ -28,7 +87,7 @@
```
1. You can view the GUI @http://localhost:4200 . The default credentials for login are admin/password
--- End diff --
@merrimanr Looks like Github hid this one since it's a change to a preexisting thing.
---
[GitHub] metron issue #773: METRON-1206: Make alerts UI conform to ops UI for install
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/metron/pull/773
+1, thanks for making the adjustments
---
[GitHub] metron issue #773: METRON-1206: Make alerts UI conform to ops UI for install
Posted by merrimanr <gi...@git.apache.org>.
Github user merrimanr commented on the issue:
https://github.com/apache/metron/pull/773
The latest commit should address all the PR comments.
---
[GitHub] metron pull request #773: METRON-1206: Make alerts UI conform to ops UI for ...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/773#discussion_r141460799
--- Diff: metron-interface/metron-alerts/README.md ---
@@ -6,15 +6,74 @@
- [Installing on an existing Cluster](#installing-on-an-existing-cluster)
## Caveats
-* UI doesn't have an authentication module yet
* UI uses local storage to save all the data. A middleware needs to be designed and developed for persisting the data
## Prerequisites
-* Elastic search should be up and running and should have some alerts populated by metron topologies
+* The Metron REST application should be up and running and Elasticsearch should have some alerts populated by Metron topologies
+* The Management UI should be installed (which includes [Express](https://expressjs.com/))
* The alerts can be populated using Quick Dev, Full Dev or any other setup
* UI is developed using angular4 and uses angular-cli
* node.JS >= 7.8.0
+## Installation
+
+### From Source
+
+1. Package the application with Maven:
+
+ ```
+ cd metron-interface/metron-alerts
+ mvn clean package
+ ```
+
+1. Untar the archive in the $METRON_HOME directory. The directory structure will look like:
+
+ ```
+ bin
+ metron-alerts-ui
+ web
+ expressjs
+ alerts-server.js
+ alerts-ui
+ web assets (html, css, js, ...)
+ ```
+
+1. Copy the `$METRON_HOME/bin/metron-alerts-ui` script to `/etc/init.d/metron-alerts-ui`
+
+1. [Express](https://expressjs.com/) is installed at `$METRON_HOME/web/expressjs/` as part of the Management UI installation process. The Management UI should be installeed first on the same host as the Alerts UI.
--- End diff --
`installeed` to `installed`.
---