Rationalize features 22/88122/6
authorguillaume.lambert <guillaume.lambert@orange.com>
Fri, 28 Feb 2020 11:28:55 +0000 (12:28 +0100)
committerguillaume.lambert <guillaume.lambert@orange.com>
Sat, 29 Feb 2020 14:12:45 +0000 (15:12 +0100)
- clean features pom.xml configurations
- remove models and api useless features
- separate TAPI support in a specific feature
  and migrate tapi blueprint folder
- declare TAPI and inventory in karaf pom.xml
- update user guide

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I87ccca5e295c14e1a3ed2d06bebe312a463a5d9c

docs/user-guide.rst
features/odl-transportpce-ordmodels/pom.xml [deleted file]
features/odl-transportpce-tapi/pom.xml [moved from features/odl-transportpce-api/pom.xml with 73% similarity]
features/odl-transportpce/pom.xml
features/pom.xml
karaf/pom.xml
tapi/src/main/resources/org/OSGI-INF/blueprint/tapi-blueprint.xml [moved from tapi/src/main/resources/org/opendaylight/blueprint/tapi-blueprint.xml with 100% similarity]

index 6b691f56683fba69af24dee3153757ab4afe7daf..aba848f4052419585fe7ed74a60b9442a259b63d 100644 (file)
@@ -41,26 +41,18 @@ TransportPCE User-Facing Features
    -  This feature contains all other features/bundles of TransportPCE project.
       If you install it, it provides all functions that the TransportPCE project
       can support.
-
--  **odl-transportpce-api**
-
-   -  This feature contains all Transportpce project specific models defined in "Service-path".
+      It exposes all Transportpce project specific models defined in "Service-path".
       These models complement OpenROADM models describing South and Northbound APIs, and define the
       data structure used to interconnect the generic blocks/functions described on the previous
       diagram.
 
--  **odl-transportpce-ordmodels**
-
-   -  This feature contains all OpenROADM models : Common, Device, Network and Service models.
-
--  **bundle transportpce-tapimodels**
-
-   -  This bundle contains models coming from TAPI version 2.1.2.
+-  **feature odl-transportpce-tapi**
 
--  **bundle transportpce-tapis**
+   -  This feature provides transportPCE a limited support of TAPI version 2.1.2 Northbound interface.
 
-   -  This bundle contains limited support of TAPI version 2.1.2 Northbound interface.
+-  **feature odl-transportpce-inventory**
 
+   -  This feature provides transportPCE an external connector to a MariaDB inventory currently limited to openROADM 1.2.1 devices.
 
 How To Start
 ------------
@@ -83,4 +75,12 @@ Run OpenDaylight and install TransportPCE Service *odl-transportpce* as below::
 
    feature:install odl-transportpce
 
+if you need TAPI limited support, then run::
+
+   feature:install odl-transportpce-tapi
+
+if you need the inventory external connector support limited to 1.2.1 OpenROADM devices, then run::
+
+   feature:install odl-transportpce-inventory
+
 For a more detailed overview of the TransportPCE, see the :ref:`transportpce-dev-guide`.
diff --git a/features/odl-transportpce-ordmodels/pom.xml b/features/odl-transportpce-ordmodels/pom.xml
deleted file mode 100644 (file)
index f782f5f..0000000
+++ /dev/null
@@ -1,62 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Copyright © 2016 Orange and others. All rights reserved.
-
-This program and the accompanying materials are made available under the
-terms of the Eclipse Public License v1.0 which accompanies this distribution,
-and is available at http://www.eclipse.org/legal/epl-v10.html INTERNAL
--->
-<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">
-  <modelVersion>4.0.0</modelVersion>
-
-  <parent>
-    <groupId>org.opendaylight.odlparent</groupId>
-    <artifactId>single-feature-parent</artifactId>
-    <version>6.0.4</version>
-    <relativePath/>
-  </parent>
-
-  <groupId>org.opendaylight.transportpce</groupId>
-  <artifactId>odl-transportpce-ordmodels</artifactId>
-  <version>1.0.0-SNAPSHOT</version>
-  <packaging>feature</packaging>
-
-  <name>OpenDaylight :: transportpce :: ordmodels</name>
-
-  <dependencies>
-    <dependency>
-      <groupId>${project.groupId}.ordmodels</groupId>
-      <artifactId>transportpce-ordmodels-common</artifactId>
-      <version>${project.version}</version>
-    </dependency>
-    <dependency>
-      <groupId>${project.groupId}.ordmodels</groupId>
-      <artifactId>transportpce-ordmodels-network</artifactId>
-      <version>${project.version}</version>
-    </dependency>
-    <dependency>
-      <groupId>${project.groupId}.ordmodels</groupId>
-      <artifactId>transportpce-ordmodels-service</artifactId>
-      <version>${project.version}</version>
-    </dependency>
-    <dependency>
-      <groupId>${project.groupId}.ordmodels</groupId>
-      <artifactId>transportpce-ordmodels-device</artifactId>
-      <version>${project.version}</version>
-    </dependency>
-  </dependencies>
-
-<!-- skipping test since this is a util project / folder -->
-  <build>
-    <plugins>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-surefire-plugin</artifactId>
-        <version>2.18.1</version>
-        <configuration>
-          <skipTests>true</skipTests>
-        </configuration>
-      </plugin>
-    </plugins>
-  </build>
-</project>
similarity index 73%
rename from features/odl-transportpce-api/pom.xml
rename to features/odl-transportpce-tapi/pom.xml
index e02d163dc0e380d20da4f004aa433a3512ae6a2f..bb82551fe5273e75d7046decf050c559d7039058 100644 (file)
@@ -17,43 +17,48 @@ and is available at http://www.eclipse.org/legal/epl-v10.html INTERNAL
   </parent>
 
   <groupId>org.opendaylight.transportpce</groupId>
-  <artifactId>odl-transportpce-api</artifactId>
+  <artifactId>odl-transportpce-tapi</artifactId>
   <version>1.0.0-SNAPSHOT</version>
   <packaging>feature</packaging>
 
-  <name>OpenDaylight :: transportpce :: api</name>
-
-  <properties>
-    <netconf.version>1.8.0-SNAPSHOT</netconf.version>
-    <configfile.directory>etc/opendaylight/karaf</configfile.directory>
-  </properties>
+  <name>OpenDaylight :: transportpce :: tapi</name>
 
   <dependencies>
     <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>odl-transportpce-ordmodels</artifactId>
+      <groupId>org.opendaylight.transportpce</groupId>
+      <artifactId>odl-transportpce</artifactId>
       <version>${project.version}</version>
       <classifier>features</classifier>
       <type>xml</type>
     </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
-      <artifactId>transportpce-api</artifactId>
+      <artifactId>transportpce-tapimodels</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>transportpce-tapi</artifactId>
       <version>${project.version}</version>
     </dependency>
   </dependencies>
 
-<!-- skipping test since this is a util project / folder -->
+  <properties>
+    <maven.deploy.skip>true</maven.deploy.skip>
+    <maven.install.skip>true</maven.install.skip>
+  </properties>
+
+<!-- skipping test since this is an umbrella project / folder -->
   <build>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>2.18.1</version>
         <configuration>
           <skipTests>true</skipTests>
         </configuration>
       </plugin>
     </plugins>
   </build>
+
 </project>
index 7b21fa48d800f47249361291db0ec6852ad5fd6a..58ff28c175ea76254afba2231a8b5719a2a92e74 100644 (file)
@@ -28,54 +28,64 @@ and is available at http://www.eclipse.org/legal/epl-v10.html INTERNAL
     <netconf.version>1.8.0-SNAPSHOT</netconf.version>
     <restconf.version>1.11.0-SNAPSHOT</restconf.version>
     <configfile.directory>etc/opendaylight/karaf</configfile.directory>
+    <maven.deploy.skip>true</maven.deploy.skip>
+    <maven.install.skip>true</maven.install.skip>
   </properties>
 
   <dependencies>
     <dependency>
-      <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>odl-transportpce-api</artifactId>
+      <groupId>${project.groupId}.ordmodels</groupId>
+      <artifactId>transportpce-ordmodels-common</artifactId>
       <version>${project.version}</version>
-      <classifier>features</classifier>
-      <type>xml</type>
     </dependency>
     <dependency>
-      <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>transportpce-common</artifactId>
+      <groupId>${project.groupId}.ordmodels</groupId>
+      <artifactId>transportpce-ordmodels-network</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}.ordmodels</groupId>
+      <artifactId>transportpce-ordmodels-service</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}.ordmodels</groupId>
+      <artifactId>transportpce-ordmodels-device</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>
       <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>transportpce-renderer</artifactId>
+      <artifactId>transportpce-api</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>
       <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>transportpce-networkmodel</artifactId>
+      <artifactId>transportpce-common</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>
       <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>transportpce-olm</artifactId>
+      <artifactId>transportpce-renderer</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>
       <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>transportpce-pce</artifactId>
+      <artifactId>transportpce-networkmodel</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>
       <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>transportpce-servicehandler</artifactId>
+      <artifactId>transportpce-olm</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>
       <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>transportpce-tapimodels</artifactId>
+      <artifactId>transportpce-pce</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>
       <groupId>org.opendaylight.transportpce</groupId>
-      <artifactId>transportpce-tapi</artifactId>
+      <artifactId>transportpce-servicehandler</artifactId>
       <version>${project.version}</version>
     </dependency>
 
@@ -115,11 +125,11 @@ and is available at http://www.eclipse.org/legal/epl-v10.html INTERNAL
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>2.18.1</version>
         <configuration>
           <skipTests>true</skipTests>
         </configuration>
       </plugin>
     </plugins>
   </build>
+
 </project>
index b3ef9c442237612af8f15e6721d7aa2d71215cc2..e28ea55d30d7c9c8c04e54e76bb833c370d10a07 100644 (file)
@@ -23,9 +23,8 @@ and is available at http://www.eclipse.org/legal/epl-v10.html INTERNAL
   <packaging>pom</packaging>
 
   <modules>
-    <module>odl-transportpce-ordmodels</module>
-    <module>odl-transportpce-api</module>
     <module>odl-transportpce</module>
+    <module>odl-transportpce-tapi</module>
     <module>odl-transportpce-inventory</module>
   </modules>
 </project>
index a954e468daf06638cd0d0669f4772c4536aec892..10ebeb5c37c480513bc9f9bb52d50014e8eaedc0 100644 (file)
@@ -33,6 +33,7 @@ and is available at http://www.eclipse.org/legal/epl-v10.html INTERNAL
   </properties>
 
   <dependencies>
+
     <dependency>
     <!-- scope is compile so all features (there is only one) are installed into startup.properties
                 and the feature repo itself is not installed -->
@@ -49,6 +50,23 @@ and is available at http://www.eclipse.org/legal/epl-v10.html INTERNAL
       <type>xml</type>
       <scope>runtime</scope>
     </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>odl-transportpce-tapi</artifactId>
+      <version>${project.version}</version>
+      <classifier>features</classifier>
+      <type>xml</type>
+      <scope>runtime</scope>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>odl-transportpce-inventory</artifactId>
+      <version>${project.version}</version>
+      <classifier>features</classifier>
+      <type>xml</type>
+      <scope>runtime</scope>
+    </dependency>
+
   </dependencies>
 
   <build>