tree: b7b894f046ce5179fe9eeb520c875d904d186c1b [path history] [tgz]
  1. e2e/
  2. scripts/
  3. src/
  4. .gitignore
  5. angular-cli.json
  6. assembly.xml
  7. karma.conf.js
  8. LICENSE
  9. NOTICE
  10. package.json
  11. pom.xml
  12. protractor.conf.js
  13. proxy.conf.json
  14. README.md
  15. tslint.json
metron-interface/metron-config/README.md

Metron Management UI

This module provides a user interface for management functions in Metron.

Prerequisites

  • A network accessible Metron REST application
  • nodejs v6.9+ (nodejs can be installed on quick dev with curl --silent --location https://rpm.nodesource.com/setup_6.x | bash - && yum install -y nodejs)

Installation

  1. Build Metron:

    mvn clean package -DskipTests
    
  2. Copy incubator-metron/metron-interface/metron-config/target/metron-config-METRON_VERSION-archive.tar.gz to the desired host.

  3. Untar the archive in the target directory. The directory structure will look like:

    bin
      start_management_ui.sh
    web
      expressjs
        package.json
        server.js
      management-ui
        web assets (html, css, js, ...)
    
  4. For production use, the contents of the ./web/management-ui directory should be deployed to a web server with paths /api/v1 and /logout mapped to the REST application url.

  5. As an example, a convenience script is included that will install a simple expressjs webserver.

  6. Then start the application with the script:

    ./bin/start_management_ui.sh
    Usage: server.js -p [port] -r [restUrl]
    Options:
      -p             Port to run metron management ui                [required]
      -r, --resturl  Url where metron rest application is available  [required]
    

Usage

The application will be available at http://host:4200 with credentials user/password, assuming the default port is configured and the dev profile is included when starting the REST application. See the REST application documentation for more information about security configuration for production.

Development

The Management UI can also be started in development mode. This allows changes to web assets to be seen interactively.

  1. Install the application with dev dependencies:

    npm install
    
  2. Start the application:

    ./scripts/start_dev.sh
    

The application will be available at http://localhost:4200/. The REST application url defaults to http://localhost:8080 but can be changed in the proxy.conf.json file.

Testing

  1. Install the application with dev dependencies:

    npm install
    
  2. Unit tests can be run with:

    npm test
    

License

This projects bundles Font Awesome which is available under the SIL Open Font License. See http://fontawesome.io/license/ for more details.