summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-09-21 13:51:57 +0200
committerMaros Marsalek <mmarsale@cisco.com>2016-09-26 11:02:04 +0200
commit4ff0bbc3c16342bdf974299a9e444cba74096268 (patch)
tree3f14538973dfce99bee9d8c425f0ab96713c1cbf
parentac064ead56cd720fea45bc6873eb2ff821be6c8b (diff)
HONEYCOMB-209 Configure maven site
To produce site for Honeycomb + javadoc asciidoc To build the site: mvn clean install site:attach-descriptor site mvn site:stage -DstagingDirectory=/home/mmarsale/tmp/stage Change-Id: I4246bb09ba02b74a2a9c84ee73f8dba02384fffa Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
-rw-r--r--lisp/api/asciidoc/Readme.adoc3
-rwxr-xr-xlisp/api/pom.xml1
-rwxr-xr-xlisp/asciidoc/Readme.adoc (renamed from lisp/Readme.adoc)0
-rw-r--r--lisp/lisp2vpp/asciidoc/Readme.adoc3
-rwxr-xr-xlisp/lisp2vpp/pom.xml1
-rwxr-xr-xlisp/pom.xml14
-rw-r--r--nsh/api/asciidoc/Readme.adoc3
-rw-r--r--nsh/api/pom.xml1
-rw-r--r--nsh/asciidoc/Readme.adoc (renamed from nsh/Readme.adoc)0
-rw-r--r--nsh/impl/asciidoc/Readme.adoc3
-rw-r--r--nsh/impl/pom.xml1
-rw-r--r--nsh/pom.xml15
-rw-r--r--samples/asciidoc/Readme.adoc3
-rw-r--r--samples/interfaces/asciidoc/Readme.adoc (renamed from samples/interfaces/Readme.adoc)0
-rw-r--r--samples/interfaces/mapping/asciidoc/Readme.adoc3
-rw-r--r--samples/interfaces/mapping/pom.xml1
-rw-r--r--samples/interfaces/models/asciidoc/Readme.adoc3
-rw-r--r--samples/interfaces/models/pom.xml1
-rw-r--r--samples/interfaces/pom.xml13
-rw-r--r--samples/minimal-distribution/asciidoc/Readme.adoc3
-rw-r--r--samples/minimal-distribution/pom.xml1
-rw-r--r--samples/pom.xml14
-rw-r--r--v3po/api/asciidoc/Readme.adoc3
-rw-r--r--v3po/api/pom.xml1
-rw-r--r--v3po/asciidoc/Readme.adoc (renamed from v3po/Readme.adoc)0
-rw-r--r--v3po/pom.xml15
-rw-r--r--v3po/v3po2vpp/Readme.adoc3
-rw-r--r--v3po/v3po2vpp/asciidoc/Readme.adoc103
-rw-r--r--v3po/v3po2vpp/pom.xml1
-rw-r--r--v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/Readme.adoc70
-rw-r--r--v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/Readme.adoc29
-rw-r--r--vpp-common/asciidoc/Readme.adoc3
-rw-r--r--vpp-common/minimal-distribution/asciidoc/Readme.adoc3
-rw-r--r--vpp-common/naming-context-api/asciidoc/Readme.adoc3
-rw-r--r--vpp-common/naming-context-api/pom.xml1
-rw-r--r--vpp-common/naming-context-impl/asciidoc/Readme.adoc3
-rw-r--r--vpp-common/naming-context-impl/pom.xml1
-rw-r--r--vpp-common/pom.xml16
-rw-r--r--vpp-common/vpp-impl-parent/asciidoc/Readme.adoc3
-rw-r--r--vpp-common/vpp-impl-parent/pom.xml4
-rw-r--r--vpp-common/vpp-translate-test/asciidoc/Readme.adoc3
-rw-r--r--vpp-common/vpp-translate-utils/asciidoc/Readme.adoc (renamed from vpp-common/vpp-translate-utils/Readme.adoc)0
-rw-r--r--vpp-common/vpp-translate-utils/pom.xml2
-rw-r--r--vpp-integration/asciidoc/Readme.adoc (renamed from vpp-integration/Readme.adoc)0
-rw-r--r--vpp-integration/minimal-distribution/asciidoc/Readme.adoc3
-rw-r--r--vpp-integration/minimal-distribution/pom.xml1
-rw-r--r--vpp-integration/pom.xml13
47 files changed, 212 insertions, 159 deletions
diff --git a/lisp/api/asciidoc/Readme.adoc b/lisp/api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..191cab363
--- /dev/null
+++ b/lisp/api/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= lisp-api
+
+Overview of lisp-api \ No newline at end of file
diff --git a/lisp/api/pom.xml b/lisp/api/pom.xml
index 960f88bc0..5b925137f 100755
--- a/lisp/api/pom.xml
+++ b/lisp/api/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.lisp</groupId>
<artifactId>lisp-api</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/lisp/Readme.adoc b/lisp/asciidoc/Readme.adoc
index b3a01c6d3..b3a01c6d3 100755
--- a/lisp/Readme.adoc
+++ b/lisp/asciidoc/Readme.adoc
diff --git a/lisp/lisp2vpp/asciidoc/Readme.adoc b/lisp/lisp2vpp/asciidoc/Readme.adoc
new file mode 100644
index 000000000..88c43fd4b
--- /dev/null
+++ b/lisp/lisp2vpp/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= lisp2vpp
+
+Overview of lisp2vpp \ No newline at end of file
diff --git a/lisp/lisp2vpp/pom.xml b/lisp/lisp2vpp/pom.xml
index a3b49349c..7506f1e0c 100755
--- a/lisp/lisp2vpp/pom.xml
+++ b/lisp/lisp2vpp/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.lisp</groupId>
<artifactId>lisp2vpp</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/lisp/pom.xml b/lisp/pom.xml
index 2f06d6585..7b2c3e595 100755
--- a/lisp/pom.xml
+++ b/lisp/pom.xml
@@ -17,21 +17,19 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
- <groupId>org.opendaylight.odlparent</groupId>
- <artifactId>odlparent</artifactId>
- <version>1.6.2-Beryllium-SR2</version>
- <relativePath/>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>../common/honeycomb-parent</relativePath>
</parent>
<groupId>io.fd.honeycomb.lisp</groupId>
<artifactId>lisp-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
- <name>lisp</name>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Aggregator for Honeycomb LISP plugin</description>
<modules>
<module>api</module>
diff --git a/nsh/api/asciidoc/Readme.adoc b/nsh/api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..4d78ad6c1
--- /dev/null
+++ b/nsh/api/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= vppnsh-api
+
+Overview of vppnsh-api \ No newline at end of file
diff --git a/nsh/api/pom.xml b/nsh/api/pom.xml
index 07684b1f0..a6dc0416e 100644
--- a/nsh/api/pom.xml
+++ b/nsh/api/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.vppnsh</groupId>
<artifactId>vppnsh-api</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/nsh/Readme.adoc b/nsh/asciidoc/Readme.adoc
index 1ae29484a..1ae29484a 100644
--- a/nsh/Readme.adoc
+++ b/nsh/asciidoc/Readme.adoc
diff --git a/nsh/impl/asciidoc/Readme.adoc b/nsh/impl/asciidoc/Readme.adoc
new file mode 100644
index 000000000..5c0fb4705
--- /dev/null
+++ b/nsh/impl/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= vppnsh-impl
+
+Overview of vppnsh-impl \ No newline at end of file
diff --git a/nsh/impl/pom.xml b/nsh/impl/pom.xml
index dbe3ae6ae..8a39f7fab 100644
--- a/nsh/impl/pom.xml
+++ b/nsh/impl/pom.xml
@@ -24,6 +24,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.vppnsh</groupId>
<artifactId>vppnsh-impl</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/nsh/pom.xml b/nsh/pom.xml
index 0bebc446a..52297d846 100644
--- a/nsh/pom.xml
+++ b/nsh/pom.xml
@@ -16,21 +16,20 @@
<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.opendaylight.odlparent</groupId>
- <artifactId>odlparent</artifactId>
- <version>1.6.2-Beryllium-SR2</version>
- <relativePath/>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>../common/honeycomb-parent</relativePath>
</parent>
<groupId>io.fd.honeycomb.nsh</groupId>
<artifactId>vppnsh-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
- <name>vppnsh</name>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Aggregator for Honeycomb NSH_SFC plugin</description>
+
<modules>
<module>api</module>
<module>impl</module>
diff --git a/samples/asciidoc/Readme.adoc b/samples/asciidoc/Readme.adoc
new file mode 100644
index 000000000..ed405fe3c
--- /dev/null
+++ b/samples/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= samples-aggregator
+
+Overview of samples-aggregator \ No newline at end of file
diff --git a/samples/interfaces/Readme.adoc b/samples/interfaces/asciidoc/Readme.adoc
index 1ee409164..1ee409164 100644
--- a/samples/interfaces/Readme.adoc
+++ b/samples/interfaces/asciidoc/Readme.adoc
diff --git a/samples/interfaces/mapping/asciidoc/Readme.adoc b/samples/interfaces/mapping/asciidoc/Readme.adoc
new file mode 100644
index 000000000..a89aee3b8
--- /dev/null
+++ b/samples/interfaces/mapping/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= interfaces-mapping
+
+Overview of interfaces-mapping \ No newline at end of file
diff --git a/samples/interfaces/mapping/pom.xml b/samples/interfaces/mapping/pom.xml
index e9b328dc6..1bb3a4c97 100644
--- a/samples/interfaces/mapping/pom.xml
+++ b/samples/interfaces/mapping/pom.xml
@@ -24,6 +24,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.samples.interfaces</groupId>
<artifactId>interfaces-mapping</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/samples/interfaces/models/asciidoc/Readme.adoc b/samples/interfaces/models/asciidoc/Readme.adoc
new file mode 100644
index 000000000..03d45af85
--- /dev/null
+++ b/samples/interfaces/models/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= interfaces-models
+
+Overview of interfaces-models \ No newline at end of file
diff --git a/samples/interfaces/models/pom.xml b/samples/interfaces/models/pom.xml
index 666705d58..6b61ad786 100644
--- a/samples/interfaces/models/pom.xml
+++ b/samples/interfaces/models/pom.xml
@@ -24,6 +24,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.samples.interfaces</groupId>
<artifactId>interfaces-models</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/samples/interfaces/pom.xml b/samples/interfaces/pom.xml
index f361c7480..05bb1110c 100644
--- a/samples/interfaces/pom.xml
+++ b/samples/interfaces/pom.xml
@@ -16,21 +16,18 @@
<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.opendaylight.odlparent</groupId>
- <artifactId>odlparent</artifactId>
- <version>1.6.2-Beryllium-SR2</version>
- <relativePath/>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>../../common/honeycomb-parent</relativePath>
</parent>
<groupId>io.fd.honeycomb.samples.interfaces</groupId>
<artifactId>interfaces-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
- <name>interfaces</name>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
<properties>
<sonar.skip>true</sonar.skip>
diff --git a/samples/minimal-distribution/asciidoc/Readme.adoc b/samples/minimal-distribution/asciidoc/Readme.adoc
new file mode 100644
index 000000000..1da86caab
--- /dev/null
+++ b/samples/minimal-distribution/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= minimal-distribution
+
+Overview of minimal-distribution \ No newline at end of file
diff --git a/samples/minimal-distribution/pom.xml b/samples/minimal-distribution/pom.xml
index debabe155..d3876790f 100644
--- a/samples/minimal-distribution/pom.xml
+++ b/samples/minimal-distribution/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.samples.distro</groupId>
<artifactId>minimal-distribution</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<properties>
diff --git a/samples/pom.xml b/samples/pom.xml
index d3d01b251..809e48d52 100644
--- a/samples/pom.xml
+++ b/samples/pom.xml
@@ -16,21 +16,19 @@
<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.opendaylight.odlparent</groupId>
- <artifactId>odlparent</artifactId>
- <version>1.6.2-Beryllium-SR2</version>
- <relativePath/>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>../common/honeycomb-parent</relativePath>
</parent>
<groupId>io.fd.honeycomb</groupId>
<artifactId>samples-aggregator</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
- <name>samples</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Aggregator for Honeycomb sample plugins</description>
<properties>
<sonar.skip>true</sonar.skip>
diff --git a/v3po/api/asciidoc/Readme.adoc b/v3po/api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..f9e63cf10
--- /dev/null
+++ b/v3po/api/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= v3po-api
+
+Overview of v3po-api \ No newline at end of file
diff --git a/v3po/api/pom.xml b/v3po/api/pom.xml
index 91102b86e..4f1210970 100644
--- a/v3po/api/pom.xml
+++ b/v3po/api/pom.xml
@@ -24,6 +24,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.v3po</groupId>
<artifactId>v3po-api</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/v3po/Readme.adoc b/v3po/asciidoc/Readme.adoc
index 96d1d5a9b..96d1d5a9b 100644
--- a/v3po/Readme.adoc
+++ b/v3po/asciidoc/Readme.adoc
diff --git a/v3po/pom.xml b/v3po/pom.xml
index e354e7165..83df160ad 100644
--- a/v3po/pom.xml
+++ b/v3po/pom.xml
@@ -16,21 +16,20 @@
<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.opendaylight.odlparent</groupId>
- <artifactId>odlparent</artifactId>
- <version>1.6.2-Beryllium-SR2</version>
- <relativePath/>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>../common/honeycomb-parent</relativePath>
</parent>
<groupId>io.fd.honeycomb.v3po</groupId>
<artifactId>v3po-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
- <name>v3po</name>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Aggregator for Honeycomb V3PO(VPP core APIs) plugin</description>
+
<modules>
<module>api</module>
<module>v3po2vpp</module>
diff --git a/v3po/v3po2vpp/Readme.adoc b/v3po/v3po2vpp/Readme.adoc
deleted file mode 100644
index 29e28528b..000000000
--- a/v3po/v3po2vpp/Readme.adoc
+++ /dev/null
@@ -1,3 +0,0 @@
-= Honeycomb translation layer SPI implementation for VPP
-
-Provides customizers for VPP YANG models translation. \ No newline at end of file
diff --git a/v3po/v3po2vpp/asciidoc/Readme.adoc b/v3po/v3po2vpp/asciidoc/Readme.adoc
new file mode 100644
index 000000000..d9fb563ab
--- /dev/null
+++ b/v3po/v3po2vpp/asciidoc/Readme.adoc
@@ -0,0 +1,103 @@
+= Honeycomb translation layer SPI implementation for VPP CORE
+
+Provides customizers for VPP YANG models translation.
+
+== Handlers
+
+=== Writers
+Current order of v3po-api writers is:
+
+. BridgeDomain
+. VhostUser
+. VxlanGpe
+. Tap
+. Vxlan
+. Interface
+. SubInterface
+. L2
+. Subinterface-L2
+. Ethernet
+. Routing
+. ClassifyTable
+. ClassifySession
+. Acl
+. Ipv6
+. Ipv4
+. Address
+. Neighbor
+. L2FibEntry
+. Rewrite
+. Address
+. Acl
+
+To find out current order in runtime, turn on logging for writer registry:
+
+ log:set TRACE io.fd.honeycomb.v3po.translate.util.write.registry
+
+=== Readers
+There is not a strict order for readers, but current configuration produces approx. this order:
+
+Contexts
+. VppState
+. Version
+. BridgeDomains
+. BridgeDomain
+. L2FibTable
+. L2FibEntry
+. InterfacesState
+. Interface
+. VppInterfaceStateAugmentation
+. Ethernet
+. Tap
+. VhostUser
+. Vxlan
+. VxlanGpe
+. L2
+. Acl
+. Interface2
+. Ipv4
+. Address
+. Neighbor
+. Ipv6
+. SubinterfaceStateAugmentation
+. SubInterfaces
+. SubInterface
+. L2
+. Rewrite
+. Ipv4
+. Address
+. Acl
+. VppClassifierState
+. ClassifyTable
+. ClassifySession
+. NetconfState
+
+== VPP to IETF-ACL model translation
+
+Package provides VPP translation code for draft-ietf-netmod-acl-model-08.
+Access control lists are mapped to chains of classify tables, each with single classify session.
+
+=== Available operations
+
+==== Configuration data
+Configuration data for the model is stored in Honeycomb. Corresponding classify tables and sessions
+are not created until control access list is assigned to an interface.
+
+Classify tables and sessions are removed from VPP when ACL assignment is deleted.
+
+ACLs can be shared among interfaces, but each time, new instance of classify table chain would be created in VPP.
+
+ACLs that are assigned to an interface have to be unassigned before update/removal.
+
+==== Operational state
+Operational read in terms of ietf-acl model is not supported (would require storing additional metadata in vpp).
+As a consequence, configuration data initialization based on operational state is not possible.
+
+To check how ietf-acl model was translated to classify tables/session, low-level vpp-classfier model can be used.
+
+=== Restrictions
+
+VPP classfier works in form of offsets and masks of 16B units.
+The offset always starts at the beginning of L2 Ethernet header
+of input packet. Because IP header can have variable length,
+source/destination port matching (L4 features of ietf-acl model) is not possible. \ No newline at end of file
diff --git a/v3po/v3po2vpp/pom.xml b/v3po/v3po2vpp/pom.xml
index 07210160c..9af1df1ba 100644
--- a/v3po/v3po2vpp/pom.xml
+++ b/v3po/v3po2vpp/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.v3po</groupId>
<artifactId>v3po2vpp</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/Readme.adoc b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/Readme.adoc
deleted file mode 100644
index a95c397ce..000000000
--- a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/Readme.adoc
+++ /dev/null
@@ -1,70 +0,0 @@
-= V3po2vpp
-V3po2vpp contains v3po-api's handlers (writer/reader) registration into HC infrastructure
-
-== Writers
-Current order of v3po-api writers is:
-
-. BridgeDomain
-. VhostUser
-. VxlanGpe
-. Tap
-. Vxlan
-. Interface
-. SubInterface
-. L2
-. SubInterface-L2
-. Ethernet
-. Routing
-. ClassifyTable
-. ClassifySession
-. Acl
-. Ipv6
-. Ipv4
-. Address
-. Neighbor
-. L2FibEntry
-. Rewrite
-. Address
-. Acl
-
-To find out current order in runtime, turn on logging for writer registry:
-
- log:set TRACE io.fd.honeycomb.v3po.translate.util.write.registry
-
-== Readers
-There is not a strict order for readers, but current configuration produces approx. this order:
-
-Contexts
-. VppState
-. Version
-. BridgeDomains
-. BridgeDomain
-. L2FibTable
-. L2FibEntry
-. InterfacesState
-. Interface
-. VppInterfaceStateAugmentation
-. Ethernet
-. Tap
-. VhostUser
-. Vxlan
-. VxlanGpe
-. L2
-. Acl
-. Interface2
-. Ipv4
-. Address
-. Neighbor
-. Ipv6
-. SubinterfaceStateAugmentation
-. SubInterfaces
-. SubInterface
-. L2
-. Rewrite
-. Ipv4
-. Address
-. Acl
-. VppClassifierState
-. ClassifyTable
-. ClassifySession
-. NetconfState \ No newline at end of file
diff --git a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/Readme.adoc b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/Readme.adoc
deleted file mode 100644
index 15b1b8c27..000000000
--- a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/Readme.adoc
+++ /dev/null
@@ -1,29 +0,0 @@
-= VPP to IETF-ACL model translation
-
-Package provides VPP translation code for draft-ietf-netmod-acl-model-08.
-Access control lists are mapped to chains of classify tables, each with single classify session.
-
-== Available operations
-
-=== Configuration data
-Configuration data for the model is stored in Honeycomb. Corresponding classify tables and sessions
-are not created until control access list is assigned to an interface.
-
-Classify tables and sessions are removed from VPP when ACL assignment is deleted.
-
-ACLs can be shared among interfaces, but each time, new instance of classify table chain would be created in VPP.
-
-ACLs that are assigned to an interface have to be unassigned before update/removal.
-
-=== Operational state
-Operational read in terms of ietf-acl model is not supported (would require storing additional metadata in vpp).
-As a consequence, configuration data initialization based on operational state is not possible.
-
-To check how ietf-acl model was translated to classify tables/session, low-level vpp-classfier model can be used.
-
-== Restrictions
-
-VPP classfier works in form of offsets and masks of 16B units.
-The offset always starts at the beginning of L2 Ethernet header
-of input packet. Because IP header can have variable length,
-source/destination port matching (L4 features of ietf-acl model) is not possible. \ No newline at end of file
diff --git a/vpp-common/asciidoc/Readme.adoc b/vpp-common/asciidoc/Readme.adoc
new file mode 100644
index 000000000..fc5e6b489
--- /dev/null
+++ b/vpp-common/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= vpp-common-aggregator
+
+Overview of vpp-common-aggregator \ No newline at end of file
diff --git a/vpp-common/minimal-distribution/asciidoc/Readme.adoc b/vpp-common/minimal-distribution/asciidoc/Readme.adoc
new file mode 100644
index 000000000..1da86caab
--- /dev/null
+++ b/vpp-common/minimal-distribution/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= minimal-distribution
+
+Overview of minimal-distribution \ No newline at end of file
diff --git a/vpp-common/naming-context-api/asciidoc/Readme.adoc b/vpp-common/naming-context-api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..42eeb60c9
--- /dev/null
+++ b/vpp-common/naming-context-api/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= naming-context-api
+
+Overview of naming-context-api \ No newline at end of file
diff --git a/vpp-common/naming-context-api/pom.xml b/vpp-common/naming-context-api/pom.xml
index b652df219..f197daaff 100644
--- a/vpp-common/naming-context-api/pom.xml
+++ b/vpp-common/naming-context-api/pom.xml
@@ -24,6 +24,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.vpp</groupId>
<artifactId>naming-context-api</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/vpp-common/naming-context-impl/asciidoc/Readme.adoc b/vpp-common/naming-context-impl/asciidoc/Readme.adoc
new file mode 100644
index 000000000..93e3b75c4
--- /dev/null
+++ b/vpp-common/naming-context-impl/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= naming-context-impl
+
+Overview of naming-context-impl \ No newline at end of file
diff --git a/vpp-common/naming-context-impl/pom.xml b/vpp-common/naming-context-impl/pom.xml
index e628dd1d8..68a2bc74a 100644
--- a/vpp-common/naming-context-impl/pom.xml
+++ b/vpp-common/naming-context-impl/pom.xml
@@ -26,6 +26,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.vpp</groupId>
<artifactId>naming-context-impl</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/vpp-common/pom.xml b/vpp-common/pom.xml
index f46a182cd..d6833cdd3 100644
--- a/vpp-common/pom.xml
+++ b/vpp-common/pom.xml
@@ -16,21 +16,20 @@
<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.opendaylight.odlparent</groupId>
- <artifactId>odlparent</artifactId>
- <version>1.6.2-Beryllium-SR2</version>
- <relativePath/>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>../common/honeycomb-parent</relativePath>
</parent>
<groupId>io.fd.honeycomb.vpp</groupId>
<artifactId>vpp-common-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
- <name>vpp-common</name>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Aggregator for Honeycomb common code used by Honeycomb plugins for VPP</description>
+
<modules>
<module>vpp-translate-utils</module>
<module>naming-context-api</module>
@@ -39,6 +38,7 @@
<module>vpp-impl-parent</module>
<module>vpp-translate-test</module>
</modules>
+
<!-- DO NOT install or deploy the repo root pom as it's only needed to initiate a build -->
<build>
<plugins>
diff --git a/vpp-common/vpp-impl-parent/asciidoc/Readme.adoc b/vpp-common/vpp-impl-parent/asciidoc/Readme.adoc
new file mode 100644
index 000000000..2dfc0b9a8
--- /dev/null
+++ b/vpp-common/vpp-impl-parent/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= vpp-impl-parent
+
+Overview of vpp-impl-parent \ No newline at end of file
diff --git a/vpp-common/vpp-impl-parent/pom.xml b/vpp-common/vpp-impl-parent/pom.xml
index 0d688bac8..43e038ce9 100644
--- a/vpp-common/vpp-impl-parent/pom.xml
+++ b/vpp-common/vpp-impl-parent/pom.xml
@@ -26,11 +26,13 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.vpp</groupId>
<artifactId>vpp-impl-parent</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
+ <packaging>pom</packaging>
+
<properties>
<jvpp.version>16.12-SNAPSHOT</jvpp.version>
</properties>
- <packaging>pom</packaging>
<dependencyManagement>
<dependencies>
diff --git a/vpp-common/vpp-translate-test/asciidoc/Readme.adoc b/vpp-common/vpp-translate-test/asciidoc/Readme.adoc
new file mode 100644
index 000000000..bed1891b4
--- /dev/null
+++ b/vpp-common/vpp-translate-test/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= vpp-translate-test
+
+Overview of vpp-translate-test \ No newline at end of file
diff --git a/vpp-common/vpp-translate-utils/Readme.adoc b/vpp-common/vpp-translate-utils/asciidoc/Readme.adoc
index 1aaaea181..1aaaea181 100644
--- a/vpp-common/vpp-translate-utils/Readme.adoc
+++ b/vpp-common/vpp-translate-utils/asciidoc/Readme.adoc
diff --git a/vpp-common/vpp-translate-utils/pom.xml b/vpp-common/vpp-translate-utils/pom.xml
index 3b61f5cdf..e1ed82aaa 100644
--- a/vpp-common/vpp-translate-utils/pom.xml
+++ b/vpp-common/vpp-translate-utils/pom.xml
@@ -23,8 +23,8 @@
</parent>
<modelVersion>4.0.0</modelVersion>
- <groupId>io.fd.honeycomb.vpp</groupId>
<artifactId>vpp-translate-utils</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/vpp-integration/Readme.adoc b/vpp-integration/asciidoc/Readme.adoc
index cba82974b..cba82974b 100644
--- a/vpp-integration/Readme.adoc
+++ b/vpp-integration/asciidoc/Readme.adoc
diff --git a/vpp-integration/minimal-distribution/asciidoc/Readme.adoc b/vpp-integration/minimal-distribution/asciidoc/Readme.adoc
new file mode 100644
index 000000000..420ac7210
--- /dev/null
+++ b/vpp-integration/minimal-distribution/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= vpp-integration-distribution
+
+Overview of vpp-integration-distribution \ No newline at end of file
diff --git a/vpp-integration/minimal-distribution/pom.xml b/vpp-integration/minimal-distribution/pom.xml
index 732ae4ad8..7e1aa0241 100644
--- a/vpp-integration/minimal-distribution/pom.xml
+++ b/vpp-integration/minimal-distribution/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.vpp.integration</groupId>
<artifactId>vpp-integration-distribution</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<properties>
diff --git a/vpp-integration/pom.xml b/vpp-integration/pom.xml
index 00bce2592..3cd5c09f4 100644
--- a/vpp-integration/pom.xml
+++ b/vpp-integration/pom.xml
@@ -16,20 +16,19 @@
<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.opendaylight.odlparent</groupId>
- <artifactId>odlparent</artifactId>
- <version>1.6.2-Beryllium-SR2</version>
- <relativePath/>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>../common/honeycomb-parent</relativePath>
</parent>
<groupId>io.fd.honeycomb.vpp.integration</groupId>
<artifactId>vpp-integration</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Aggregator for Honeycomb's VPP distribution. Aggregating all VPP plugins.</description>
<modules>
<module>minimal-distribution</module>