| Brian Freeman | 6d868cc | 2017-09-28 11:14:02 +0000 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| LF Jenkins CI | b6d91ea | 2020-04-07 17:38:17 +0000 | [diff] [blame] | 2 | .. _master_index: |
| Brian Freeman | 6d868cc | 2017-09-28 11:14:02 +0000 | [diff] [blame] | 3 | |
| Nicolas Hu | 3747944 | 2017-10-03 15:13:46 -0400 | [diff] [blame] | 4 | ccsdk dashboard - Common Controller dashboard |
| Nicolas Hu | 377afe4 | 2017-10-09 11:52:23 -0400 | [diff] [blame] | 5 | ============================================= |
| 6 | This is the web UI for the Common Controller, also known as the CCSDK Dashboard. |
| 7 | |
| Brian Freeman | 6d868cc | 2017-09-28 11:14:02 +0000 | [diff] [blame] | 8 | .. toctree:: |
| 9 | :maxdepth: 1 |
| 10 | |
| Nicolas Hu | 377afe4 | 2017-10-09 11:52:23 -0400 | [diff] [blame] | 11 | Architecture |
| 12 | ------------ |
| 13 | Dashboard Project consists of the following Maven projects: |
| Brian Freeman | 6d868cc | 2017-09-28 11:14:02 +0000 | [diff] [blame] | 14 | |
| Nicolas Hu | f73ff22 | 2017-10-09 13:24:29 -0400 | [diff] [blame] | 15 | - oom-app-common: Java classes that run in a web container like Tomcat |
| 16 | - oom-app-overlay: CSS, HTML and Javascript resources for the web application |
| 17 | - oom-app-os: Web application project with features for ONAP use |
| Nicolas Hu | 377afe4 | 2017-10-09 11:52:23 -0400 | [diff] [blame] | 18 | |
| 19 | Prerequites |
| 20 | ----------- |
| 21 | The web application requires these resources: |
| Nicolas Hu | 0d7b5be | 2017-10-09 16:18:06 -0400 | [diff] [blame] | 22 | |
| Nicolas Hu | f73ff22 | 2017-10-09 13:24:29 -0400 | [diff] [blame] | 23 | - Java version 8 |
| 24 | - Apache Tomcat version 8.0 or 8.5 |
| 25 | - A Postgresql database, version 9.2 or later |
| Nicolas Hu | 377afe4 | 2017-10-09 11:52:23 -0400 | [diff] [blame] | 26 | |
| 27 | Build |
| 28 | ----- |
| 29 | Build all artifacts by invoking maven in this directory:: |
| 30 | |
| Nicolas Hu | 0d7b5be | 2017-10-09 16:18:06 -0400 | [diff] [blame] | 31 | mvn package |
| Nicolas Hu | 377afe4 | 2017-10-09 11:52:23 -0400 | [diff] [blame] | 32 | |
| 33 | Deployment steps |
| 34 | ---------------- |
| Nicolas Hu | f73ff22 | 2017-10-09 13:24:29 -0400 | [diff] [blame] | 35 | 1. Create a Postgre schema within a Postgres database. |
| 36 | 2. Populate the schema using the DDL and DML scripts in the appropriate db-scripts areas; see the README.md there for instructions to set the user's default schema. |
| 37 | 3. Configure the application by editing the files portal.properties, system.properties and dashboard.properties. |
| 38 | 4. Build a war file within the appropriate web application project ('mvn package'). |
| 39 | 5. Deploy the war file to Tomcat. |
| 40 | 6. Login the first time using credentials stored in the fn_user table at the "login_external.htm" page. |