mmiklavc commented on a change in pull request #1275: METRON-1878: Add Metron as a Knox service URL: https://github.com/apache/metron/pull/1275#discussion_r243446493
########## File path: metron-interface/README.md ########## @@ -0,0 +1,73 @@ +<!-- +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. +--> +# Metron Interface + +Metron interface contains code and assets to support the various web applications in Metron. The existing modules are: + +* metron-alerts : An Angular application that exposes a way to browse, filter and act on alerts. +* metron-config: An Angular application that allows an administrator to configure and maintain Metron. +* metron-rest: A Spring REST application that supports the UI and exposes Metron features through a REST/json interface. +* metron-rest-client: Model objects used for passing data back and forth in the REST application. A Metron client would use these classes for de/serializing requests and responses. + +## Architecture + +The UIs and REST server are all run in separate web containers. The UIs are served from separate [Express](https://expressjs.com/) servers that are configured to proxy REST requests +to the REST application. Proxying REST requests satisfies the same-origin browser restriction because all requests go to Express, or the same origin. + +REST requests are handled by a [Spring Boot](https://spring.io/projects/spring-boot) application. A [Swagger](https://swagger.io/) interface is available and served by the REST application. + +### Security + +The UIs depend on REST for authentication. Credentials are passed with [Basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) and only REST requests require +authentication, static assets are not secured. Once authentication has been performed a session is established and a cookie is stored and used to authenticate subsequent requests. + +### Request/Response Flow + +The following diagram illustrates the flow of data for the various types of requests: + + Review comment: I was happy with a simple word description, but this is great. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
