kryndex / contrail-web-controller

contrail-web-controller

---

Contrail Web Controller

---

This software is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software 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.

Overview

---

The Contrail Web Controller repository contains front end Web UI code for the management of Contrail network virtualization solution. This repository contains code specific to Dashboard, Configuration, Monitoring, Reporting features available through Contrail Web UI.

The code to retreive data from other components of the system(such as vrouter, analytics etc) as requested by the features mentioned above is available in a separate code repository (https://github.com/Juniper/contrail-web-core/)

The contrail web controller component requests data to the webserver which inturn request data from various other components in the system. It further processes, consolidate the results and returns as a single response to the original request. The API request from web client to webserver and web server to other components are REST based.

Directory structure

---

webroot - Root directory for the files used in Dashboard, Configuration, Monitoring, Reporting features available through Contrail Web UI. The webroot directory internally has the following directories.

config     - Directory contains javascript files, view files used in Configure tab of Contrail Web UI. This directory also contains code used for unit testing the configuration features.

monitor   - Directory contains javascript files, view files used in Monitor tab of Contrail Web UI. This directory also contains code used for unit testing the monitoring features.

reports    - Directory contains javascript files, view files used in Query tab of Contrail Web UI. This directory also contains code used for unit testing the reporting/querying features.

setting    - Directory contains javascript files, view files used in Setting tab of Contrail Web UI. This directory also contains code used for unit testing the Config DB features.

Note: All the directories mentioned above in turn has the following directory structure for the respective feature directories..

js  - All Javascript files
views - HTML templates(view files)
test - All unit test files.

test         - This directory contains common code used for unit testing these features.

Contributing code

---

• Sign the CLA
• Push your changes to a topic branch in your fork of the repository.
• Submit a pull request to the contrail repository.