[GitHub] incubator-metron pull request #316: METRON-503: Metron REST API

[cestella <gi...@git.apache.org>]

Github user cestella commented on a diff in the pull request:

    https://github.com/apache/incubator-metron/pull/316#discussion_r91817674
  
    --- Diff: metron-interface/metron-rest/README.md ---
    @@ -0,0 +1,55 @@
    +# Metron REST and Configuration UI
    +
    +This UI exposes and aids in sensor configuration.
    +
    +## Prerequisites
    +
    +* A running Metron cluster
    +* A running instance of MySQL 
    +* Java 8 installed
    +
    +## Installation
    +1. Package the Application with Maven:
    +    ```
    +    mvn clean package
    +    ```
    +
    +1. Untar the archive in the target directory.  The directory structure will look like: 
    +    ```
    +    bin
    +      start.sh
    +    lib
    +      metron-rest-version.jar
    +    ```
    +
    +1. Install Hibernate by downloading version 5.0.11.Final from (http://hibernate.org/orm/downloads/).  Unpack the archive and set the HIBERNATE_HOME environment variable to the absolute path of the top level directory.
    +    ```
    +    export HIBERNATE_HOME=/path/to/hibernate-release-5.0.11.Final
    +    ```
    +
    +1. Install the MySQL client by downloading version 5.1.40 from (https://dev.mysql.com/downloads/connector/j/).  Unpack the archive and set the MYSQL_CLIENT_HOME environment variable to the absolute path of the top level directory.
    +    ```
    +    export MYSQL_CLIENT_HOME=/path/to/mysql-connector-java-5.1.40
    +    ```
    +    
    +1. Create a MySQL user for the Config UI (http://dev.mysql.com/doc/refman/5.7/en/adding-users.html).
    +
    +1. Create a Config UI database in MySQL with this command:
    +    ```
    +    CREATE DATABASE IF NOT EXISTS metronrest
    +    ```
    + 
    +1. Create an `application.yml` file with the contents of [application-docker.yml](src/main/resources/application-docker.yml).  Substitute the appropriate Metron service urls (Kafka, Zookeeper, Storm, etc) in properties containing `${docker.host.address}` and update the `spring.datasource.username` and `spring.datasource.password` properties using the MySQL credentials from step 4.
    +
    +1. Start the UI with this command:
    +    ```
    +    ./bin/start.sh /path/to/application.yml
    +    ```
    --- End diff --
    
    Can we get a section laying out and documenting all of the API endpoints for these services, split by service?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---