Merge "SDN-R add updated odlux"

1 files changed, 28 insertions, 177 deletions

diff --git a/sdnr/wt/odlux/README.md b/sdnr/wt/odlux/README.md
index 6e02db0e0..6e5d5965b 100644
--- a/sdnr/wt/odlux/README.md
+++ b/sdnr/wt/odlux/README.md
@@ -1,15 +1,22 @@
 # Developing a ODLUX application
 
+## Introduction
+
+ODLUX bundle contains the Browser based Grapical User Interface for SDN-R.
+ODLUX is available as OSGi bundle that is running in Opendaylight Karaf environment, using the configured jetty server of Opendaylight.
+Since ONAP Frankfurt a second WEB Server setup "sdncweb" is available, that extracts the JavaScrip files.
+
 ## Prerequisites
 
-* Node: 8.10 or higher
-* Yarn: 1.12.3 or higher
-* Lerna: 3.10.7 or higher
+Actual version in framework pom.xml in the frontend-maven-plugin definition.
+  * Node
+  * Yarn
+  * Lerna
 
 You can install these globally or let it be installed by maven due "mvn clean install"
 
 * Maven: 3 or higher
-* Java: 8 or higher
+* Java: 8
 
 ## Dev-Environment Installation
 
@@ -25,7 +32,7 @@ You can install these globally or let it be installed by maven due "mvn clean in
   |-framework
 
  ```
- * go to features/sdnr/wt/odlux/apps and create your app: 
+ * go to features/sdnr/wt/odlux/apps and create your app:
  ```
  mvn archetype:generate -DarchetypeGroupId=org.onap.ccsdk.features.sdnr.wt \
   -DarchetypeArtifactId=odlux-app-archetype \
@@ -40,7 +47,7 @@ You can install these globally or let it be installed by maven due "mvn clean in
  * with ```yarn start``` you can run your application due runtime in your application folder
  * by default this will run on http://localhost:3100/index.html
  * if you have added new dependencies you have to run ```lerna bootstrap``` in odlux/
- * build your app for development version you can use ```yarn run build``` or ```yarn run build:dev``` 
+ * build your app for development version you can use ```yarn run build``` or ```yarn run build:dev```
  * build for karaf with ```mvn clean install```
 
 
@@ -63,19 +70,19 @@ You can install these globally or let it be installed by maven due "mvn clean in
 ### Default menu positions
 
  * from 0 for top to 999 for bottom.
- 
+
 ```
-0	Connect
-10	Fault
-20	Maintenance
-30	Configuration
-40	Protection
-50	Performance
-60	Security
-70	Inventory
-80	Topology
-90	Mediator
-100	Help
+0    Connect
+10    Fault
+20    Maintenance
+30    Configuration
+40    Protection
+50    Performance
+60    Security
+70    Inventory
+80    Topology
+90    Mediator
+100    Help
 ```
 
 ### blueprint.xml
@@ -99,162 +106,6 @@ You can install these globally or let it be installed by maven due "mvn clean in
 
 ### pom.xml
 
-```
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-
-    <parent>
-        <groupId>org.onap.ccsdk.parent</groupId>
-        <artifactId>odlparent</artifactId>
-        <version>1.2.1-SNAPSHOT</version>
-        <relativePath />
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-    <groupId>org.onap.ccsdk.features.sdnr.wt</groupId>
-    <artifactId>sdnr-wt-odlux-app-demoApp</artifactId>
-    <version>0.4.1-SNAPSHOT</version>
-    <packaging>bundle</packaging>
-    <name>sdnr-wt-odlux-app-demoApp</name>
-    <licenses>
-        <license>
-            <name>Apache License, Version 2.0</name>
-            <url>http://www.apache.org/licenses/LICENSE-2.0</url>
-        </license>
-    </licenses>
-    <dependencies>
-        <dependency>
-            <groupId>${project.groupId}</groupId>
-            <artifactId>sdnr-wt-odlux-core-model</artifactId>
-            <version>${project.version}</version>
-        </dependency>
-        <dependency>
-            <groupId>${project.groupId}</groupId>
-            <artifactId>sdnr-wt-odlux-core-provider</artifactId>
-            <version>${project.version}</version>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <scope>test</scope>
-        </dependency>
-    </dependencies>
-    <build>
-        <sourceDirectory>src2/main/java</sourceDirectory>
-        <plugins>
-            <plugin>
-                <artifactId>maven-clean-plugin</artifactId>
-                <configuration>
-                    <filesets>
-                        <fileset>
-                            <directory>dist</directory>
-                            <followSymlinks>false</followSymlinks>
-                        </fileset>
-                        <fileset>
-                            <directory>node</directory>
-                            <followSymlinks>false</followSymlinks>
-                        </fileset>
-                        <fileset>
-                            <directory>node_modules</directory>
-                            <followSymlinks>false</followSymlinks>
-                        </fileset>
-                        <fileset>
-                            <directory>../node_modules</directory>
-                            <followSymlinks>false</followSymlinks>
-                        </fileset>
-                    </filesets>
-                </configuration>
-            </plugin>
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>build-helper-maven-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <id>add-test-source</id>
-                        <phase>generate-test-sources</phase>
-                        <goals>
-                            <goal>add-test-source</goal>
-                        </goals>
-                        <configuration>
-                            <sources>
-                                <source>src2/test/java</source>
-                            </sources>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
-            <plugin>
-                <groupId>com.github.eirslett</groupId>
-                <artifactId>frontend-maven-plugin</artifactId>
-                <version>1.8-SNAPSHOT</version>
-                <executions>
-                    <execution>
-                        <id>install node and yarn</id>
-                        <goals>
-                            <goal>install-node-and-yarn</goal>
-                        </goals>
-                        <!-- optional: default phase is "generate-resources" -->
-                        <phase>initialize</phase>
-                        <configuration>
-                            <nodeVersion>v8.10.0</nodeVersion>
-                            <yarnVersion>v1.12.3</yarnVersion>
-                        </configuration>
-                    </execution>
-                    <execution>
-                        <id>yarn build</id>
-                        <goals>
-                            <goal>yarn</goal>
-                        </goals>
-                        <configuration>
-                            <arguments>run build</arguments>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-jar-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.felix</groupId>
-                <artifactId>maven-bundle-plugin</artifactId>
-                <extensions>true</extensions>
-                <configuration>
-                    <instructions>
-                        <Import-Package>org.onap.ccsdk.features.sdnr.wt.odlux.model.*,com.opensymphony.*</Import-Package>
-                        <Private-Package></Private-Package>
-                    </instructions>
-                </configuration>
-            </plugin>
-        </plugins>
-        <resources>
-            <resource>
-                <directory>dist</directory>
-                <targetPath>odlux</targetPath>
-            </resource>
-            <resource>
-                <directory>src2/main/resources</directory>
-            </resource>
-            <resource>
-                <directory>src2/test/resources</directory>
-            </resource>
-        </resources>
-    </build>
-    <pluginRepositories>
-        <pluginRepository>
-            <id>highstreet repo</id>
-            <url>https://cloud-highstreet-technologies.com/mvn/</url>
-            <snapshots>
-                <enabled>true</enabled>
-                <updatePolicy>always</updatePolicy>
-            </snapshots>
-        </pluginRepository>
-    </pluginRepositories>
-</project>
-your
-```
-
-* a modified frontend-maven-plugin installs node, yarn and (optionally lerna) to compile the typescript sources to javascript. These will be build into the dist folder.
-
+ * The pom.xml in the framework subdirectory is the reference for ODLUX creation. [framework pom](framework/pom.xml)
+ * The node and yarn versions are specified
+ * A specific variant of "frontend-maven-plugin" is used to create the environment to compile to javascript. This modified frontend-maven-plugin installs node, yarn and (optionally lerna) to compile the typescript sources to javascript. These will be build into the dist folder.