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
commitbc335de41876acd8720dce1030a79b3a7b39c3b1 (patch)
treec3b1b99c72fbcc36db5b7ff3e4c4e37680481eb0
parent09df17bb630b5bf594efbd9f869ef17da5e2b6ac (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--.gitignore2
-rw-r--r--asciidoc/Readme.adoc13
-rw-r--r--common/api-parent/asciidoc/Readme.adoc3
-rw-r--r--common/api-parent/pom.xml1
-rw-r--r--common/asciidoc/Readme.adoc3
-rw-r--r--common/checkstyle/asciidoc/Readme.adoc (renamed from common/checkstyle/src/main/resources/README.adoc)2
-rw-r--r--common/checkstyle/pom.xml23
-rw-r--r--common/honeycomb-parent/asciidoc/Readme.adoc3
-rw-r--r--common/honeycomb-parent/pom.xml244
-rw-r--r--common/honeycomb-parent/site.xml39
-rw-r--r--common/impl-parent/asciidoc/Readme.adoc3
-rw-r--r--common/impl-parent/pom.xml1
-rw-r--r--common/minimal-assembly-descriptor/asciidoc/Readme.adoc3
-rw-r--r--common/minimal-assembly-descriptor/pom.xml8
-rw-r--r--common/minimal-distribution-parent/asciidoc/Readme.adoc3
-rw-r--r--common/minimal-distribution-parent/pom.xml2
-rw-r--r--common/pom.xml14
-rw-r--r--infra/asciidoc/Readme.adoc (renamed from infra/Readme.adoc)0
-rw-r--r--infra/cfg-init/asciidoc/Readme.adoc3
-rw-r--r--infra/cfg-init/pom.xml1
-rw-r--r--infra/data-api/asciidoc/Readme.adoc (renamed from infra/data-api/Readme.adoc)0
-rw-r--r--infra/data-api/pom.xml1
-rw-r--r--infra/data-impl/asciidoc/Readme.adoc (renamed from infra/data-impl/Readme.adoc)0
-rw-r--r--infra/data-impl/pom.xml1
-rw-r--r--infra/impl/asciidoc/Readme.adoc3
-rw-r--r--infra/impl/pom.xml1
-rw-r--r--infra/it/asciidoc/Readme.adoc3
-rw-r--r--infra/it/it-test/asciidoc/Readme.adoc3
-rw-r--r--infra/it/it-test/pom.xml15
-rw-r--r--infra/it/pom.xml12
-rw-r--r--infra/it/test-model/asciidoc/Readme.adoc3
-rw-r--r--infra/it/test-model/pom.xml3
-rw-r--r--infra/minimal-distribution/asciidoc/Readme.adoc3
-rw-r--r--infra/minimal-distribution/pom.xml6
-rw-r--r--infra/notification/api/asciidoc/Readme.adoc3
-rw-r--r--infra/notification/api/pom.xml1
-rw-r--r--infra/notification/asciidoc/Readme.adoc3
-rw-r--r--infra/notification/impl/asciidoc/Readme.adoc3
-rw-r--r--infra/notification/impl/pom.xml1
-rw-r--r--infra/notification/pom.xml13
-rw-r--r--infra/pom.xml14
-rw-r--r--infra/translate-api/asciidoc/Readme.adoc (renamed from infra/translate-api/Readme.adoc)0
-rw-r--r--infra/translate-api/pom.xml1
-rw-r--r--infra/translate-impl/asciidoc/Readme.adoc (renamed from infra/translate-impl/Readme.adoc)0
-rw-r--r--infra/translate-impl/pom.xml1
-rw-r--r--infra/translate-spi/asciidoc/Readme.adoc (renamed from infra/translate-spi/Readme.adoc)0
-rw-r--r--infra/translate-spi/pom.xml1
-rw-r--r--infra/translate-utils/Readme.adoc3
-rw-r--r--infra/translate-utils/asciidoc/Readme.adoc3
-rw-r--r--infra/translate-utils/pom.xml1
-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--pom.xml30
-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--tools/archetype/asciidoc/Readme.adoc (renamed from tools/archetype/Readme.adoc)0
-rw-r--r--tools/archetype/pom.xml8
-rw-r--r--tools/archetype/src/main/resources/archetype-resources/asciidoc/Readme.adoc (renamed from tools/archetype/src/main/resources/archetype-resources/__rootArtifactId__-impl/Readme.adoc)0
-rw-r--r--tools/archetype/src/main/resources/archetype-resources/pom.xml12
-rw-r--r--tools/asciidoc/Readme.adoc3
-rw-r--r--tools/pom.xml9
-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
104 files changed, 658 insertions, 248 deletions
diff --git a/.gitignore b/.gitignore
index 06b920b..855ab0e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -14,3 +14,5 @@ target
META-INF
maven-metadata-local.xml
*.log
+.asciidoctor/
+**/asciidoc/*.png
diff --git a/asciidoc/Readme.adoc b/asciidoc/Readme.adoc
new file mode 100644
index 0000000..60ad694
--- /dev/null
+++ b/asciidoc/Readme.adoc
@@ -0,0 +1,13 @@
+= Honeycomb
+
+A generic, model driven(YANG) management agent
+
+== Northbound interfaces:
+* RESTCONF
+* NETCONF
+
+=== Components
+Honeycomb consists of multiple components. Per component documentation can be found per component.
+
+=== Wiki
+Some additional information can be found on wiki: https://wiki.fd.io/view/Honeycomb
diff --git a/common/api-parent/asciidoc/Readme.adoc b/common/api-parent/asciidoc/Readme.adoc
new file mode 100644
index 0000000..b156b41
--- /dev/null
+++ b/common/api-parent/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= api-parent
+
+Overview of api-parent \ No newline at end of file
diff --git a/common/api-parent/pom.xml b/common/api-parent/pom.xml
index 6937fb6..531e470 100644
--- a/common/api-parent/pom.xml
+++ b/common/api-parent/pom.xml
@@ -24,6 +24,7 @@
<modelVersion>4.0.0</modelVersion>
<artifactId>api-parent</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>pom</packaging>
diff --git a/common/asciidoc/Readme.adoc b/common/asciidoc/Readme.adoc
new file mode 100644
index 0000000..f97755a
--- /dev/null
+++ b/common/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= Common maven parents
+
+Modules under common provide common maven parents for Honeycomb modules. \ No newline at end of file
diff --git a/common/checkstyle/src/main/resources/README.adoc b/common/checkstyle/asciidoc/Readme.adoc
index d33f39e..7b1d076 100644
--- a/common/checkstyle/src/main/resources/README.adoc
+++ b/common/checkstyle/asciidoc/Readme.adoc
@@ -1,6 +1,6 @@
= Honeycomb coding resources
* intellij-java-coding-style.xml Can be imported into Intellij IDEA to ensure Honeycomb coding style during development
-* checkstyle.xml Checkstyle config ensuring above HOneycomb coding style
+* checkstyle.xml Checkstyle config ensuring above Honeycomb coding style
* checkstyle-license.xml Checkstyle config ensuring Honeycomb license (in HONEYCOMB_LICENSE.txt) header presence
* checkstyle-logging.xml Checkstyle config ensuring ODL logging standards \ No newline at end of file
diff --git a/common/checkstyle/pom.xml b/common/checkstyle/pom.xml
index 3dbf268..b33341d 100644
--- a/common/checkstyle/pom.xml
+++ b/common/checkstyle/pom.xml
@@ -1,15 +1,24 @@
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.opendaylight.odlparent</groupId>
- <artifactId>odlparent-lite</artifactId>
- <version>1.6.2-Beryllium-SR2</version>
- <relativePath/>
- </parent>
-
<groupId>io.fd.honeycomb.common</groupId>
<artifactId>honeycomb-checkstyle</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
+ <build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <configuration>
+ <skip>true</skip>
+ <skipDeploy>true</skipDeploy>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+ </build>
+
</project>
diff --git a/common/honeycomb-parent/asciidoc/Readme.adoc b/common/honeycomb-parent/asciidoc/Readme.adoc
new file mode 100644
index 0000000..3934188
--- /dev/null
+++ b/common/honeycomb-parent/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= honeycomb-parent
+
+Overview of honeycomb-parent \ No newline at end of file
diff --git a/common/honeycomb-parent/pom.xml b/common/honeycomb-parent/pom.xml
index 5aa4fb3..6660360 100644
--- a/common/honeycomb-parent/pom.xml
+++ b/common/honeycomb-parent/pom.xml
@@ -16,11 +16,16 @@
-->
<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>
<groupId>io.fd.honeycomb.common</groupId>
<artifactId>honeycomb-parent</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>pom</packaging>
+ <prerequisites>
+ <maven>3.1.1</maven>
+ </prerequisites>
<properties>
<nexusproxy>http://nexus.fd.io/content</nexusproxy>
@@ -62,6 +67,24 @@
<!-- checkstyle -->
<checkstyle.header.file>APACHE_HEADER.txt</checkstyle.header.file>
+
+ <!-- site -->
+ <!-- skip location check = makes site exec faster -->
+ <dependency.locations.enabled>false</dependency.locations.enabled>
+ <project.info.report.version>2.9</project.info.report.version>
+ <maven.resources.version>2.6</maven.resources.version>
+ <maven.site.version>3.4</maven.site.version>
+ <!-- adoc -->
+ <asciidoctor.maven.plugin.version>1.5.3</asciidoctor.maven.plugin.version>
+ <asciidoctorj.diagram.version>1.3.1</asciidoctorj.diagram.version>
+ <maven.groovy.version>2.0</maven.groovy.version>
+ <readme.default>
+= ${project.artifactId}
+
+Overview of ${project.artifactId}
+ </readme.default>
+ <docs.base.url>https://nexus.fd.io/content/sites/site</docs.base.url>
+ <docs.hc.folder>io/fd/honeycomb</docs.hc.folder>
</properties>
<organization>
@@ -86,6 +109,15 @@
<url>https://jenkins.fd.io/</url>
</ciManagement>
+ <mailingLists>
+ <mailingList>
+ <name>HC dev</name>
+ <post>honeycomb-dev@fd.io</post>
+ <subscribe>https://lists.fd.io/mailman/listinfo/honeycomb-dev</subscribe>
+ <archive>https://lists.fd.io/pipermail/honeycomb-dev/</archive>
+ </mailingList>
+ </mailingLists>
+
<dependencyManagement>
<dependencies>
<!-- ODL -->
@@ -175,9 +207,17 @@
<configLocation>honeycomb-checkstyle.xml</configLocation>
<includeTestResources>true</includeTestResources>
<!--TODO HONEYCOMB-155 enable fail on violation after issues are resolved + set in as errors in checkstyle xml-->
- <excludes>
+
+ <includes>**\/*.java,**\/*.xml,**\/*.ini,**\/*.sh,**\/*.bat,**\/*.yang</includes>
+ <excludes>**\/target\/,
+ **\/bin\/,
+ **\/target-ide\/,
+ **\/src/main/yang-gen-config\/,
org/opendaylight/yang/gen/**,
- </excludes>
+ **\/src/main/yang-gen-sal\/,
+ **\/src/main/xtend-gen\/,
+ **\/src/main/yang\/,
+ **\/archetype-resources\/</excludes>
</configuration>
<executions>
@@ -209,10 +249,6 @@
<consoleOutput>true</consoleOutput>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<sourceDirectory>${project.basedir}</sourceDirectory>
- <includes>**\/*.java,**\/*.xml,**\/*.ini,**\/*.sh,**\/*.bat,**\/*.yang</includes>
- <excludes>
- **\/target\/,**\/bin\/,**\/target-ide\/,**\/src/main/yang-gen-config\/,**\/src/main/yang-gen-sal\/,**\/src/main/xtend-gen\/,**\/src/main/yang\/
- </excludes>
<outputFile>${project.build.directory}/checkstyle-logging-result.xml</outputFile>
</configuration>
</execution>
@@ -247,6 +283,14 @@
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
+ <executions>
+ <execution>
+ <id>attach-javadocs</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
</plugin>
<!-- jacoco test coverage for sonar -->
<plugin>
@@ -336,6 +380,124 @@
<version>${maven.bundle.version}</version>
<extensions>true</extensions>
</plugin>
+ <!-- Source jar -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-source-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>attach-sources</id>
+ <goals>
+ <goal>jar</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <!-- Site (from https://github.com/asciidoctor/asciidoctor-maven-examples/blob/master/asciidoc-maven-site-example/pom.xml) -->
+ <!-- + https://github.com/asciidoctor/asciidoctor-maven-plugin -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>${maven.site.version}</version>
+ <configuration>
+ <generateReports>true</generateReports>
+ <generateSitemap>true</generateSitemap>
+ <relativizeDecorationLinks>false</relativizeDecorationLinks>
+ <locales>en</locales>
+ <inputEncoding>UTF-8</inputEncoding>
+ <outputEncoding>UTF-8</outputEncoding>
+ <siteDirectory>${project.basedir}</siteDirectory>
+ <relativizeDecorationLinks>false</relativizeDecorationLinks>
+ <asciidoc>
+ <requires>
+ <require>asciidoctor-diagram</require>
+ </requires>
+ <!-- optional site-wide AsciiDoc attributes -->
+ <attributes>
+ <source-highlighter>coderay</source-highlighter>
+ <coderay-css>style</coderay-css>
+ <imagesdir>${project.build.directory}/site/images</imagesdir>
+ <toc>left</toc>
+ <toclevels>2</toclevels>
+ <icons>font</icons>
+ <sectanchors>true</sectanchors>
+ <idprefix/>
+ <idseparator>-</idseparator>
+ </attributes>
+ </asciidoc>
+ <!-- Exclude partial docs that are included elsewhere -->
+ <moduleExcludes>
+ <asciidoc>**/_*.adoc</asciidoc>
+ </moduleExcludes>
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ <version>${asciidoctor.maven.plugin.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctorj-diagram</artifactId>
+ <version>${asciidoctorj.diagram.version}</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ <plugin>
+ <groupId>org.codehaus.gmaven</groupId>
+ <artifactId>groovy-maven-plugin</artifactId>
+ <version>${maven.groovy.version}</version>
+ <executions>
+ <!-- Generate Readme.adoc if not present -->
+ <execution>
+ <id>generate-adoc</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>execute</goal>
+ </goals>
+ <configuration>
+ <!-- Generate module adoc documentation -->
+ <source>
+ import java.nio.file.Files
+ import java.nio.file.Paths
+
+ log.info "Checking asciidoc/Readme.adoc"
+ def asciidoc = Paths.get(project.getBasedir().toString(), "asciidoc")
+ def readme = Paths.get(asciidoc.toString(), "Readme.adoc")
+ if (!Files.exists(readme)) {
+ log.info "Generating ${readme}"
+ Files.createDirectories(asciidoc)
+ Files.createFile(readme)
+ readme.toFile().text = properties.getOrDefault("readme.default", "")
+ }
+ </source>
+ </configuration>
+ </execution>
+ <!-- Fix generated html -->
+ <execution>
+ <id>fix-generated-site</id>
+ <phase>site</phase>
+ <goals>
+ <goal>execute</goal>
+ </goals>
+ <configuration>
+ <!-- Site generates wrong link to Readme.html, trying to point to Readme.html at root -->
+ <source>
+ import java.nio.file.Files
+ import java.nio.file.Paths
+
+ def index = Paths.get(project.build.directory.toString(), "site", "index.html")
+ if (Files.exists(index)) {
+ log.info "Fixing links in generated site"
+ def html = index.toFile().text
+ log.info "Fixing asciidoc Readme link"
+ index.toFile().text = html.replaceAll("[./]*Readme\\.html", "Readme.html")
+ }
+ </source>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</pluginManagement>
<plugins>
@@ -343,6 +505,12 @@
<artifactId>maven-enforcer-plugin</artifactId>
</plugin>
<plugin>
+ <artifactId>maven-source-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
+ <plugin>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
<plugin>
@@ -359,9 +527,69 @@
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
</plugin>
+ <plugin>
+ <groupId>org.codehaus.gmaven</groupId>
+ <artifactId>groovy-maven-plugin</artifactId>
+ </plugin>
</plugins>
+
+ <!-- To support site push-->
+ <extensions>
+ <extension>
+ <groupId>org.apache.maven.wagon</groupId>
+ <artifactId>wagon-webdav-jackrabbit</artifactId>
+ <version>2.9</version>
+ </extension>
+ </extensions>
</build>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>${project.info.report.version}</version>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>index</report>
+ <report>summary</report>
+ <report>modules</report>
+ <report>cim</report>
+ <report>dependencies</report>
+ <report>distribution-management</report>
+ <report>mailing-list</report>
+ <report>issue-tracking</report>
+ <report>license</report>
+ <report>scm</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${maven.javadoc.version}</version>
+ <reportSets>
+ <reportSet>
+ <id>default</id>
+ <reports>
+ <report>javadoc-no-fork</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ <configuration>
+ <additionalparam>-Xdoclint:none</additionalparam>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-resources-plugin</artifactId>
+ <version>${maven.resources.version}</version>
+ </plugin>
+ </plugins>
+ </reporting>
+
<distributionManagement>
<repository>
<id>fdio-release</id>
@@ -371,6 +599,10 @@
<id>fdio-snapshot</id>
<url>${nexusproxy}/repositories/fd.io.snapshot/</url>
</snapshotRepository>
+ <site>
+ <id>fdio-site</id>
+ <url>dav:${docs.base.url}/${docs.hc.folder}/${project.version}</url>
+ </site>
</distributionManagement>
<repositories>
diff --git a/common/honeycomb-parent/site.xml b/common/honeycomb-parent/site.xml
new file mode 100644
index 0000000..b0ed4c9
--- /dev/null
+++ b/common/honeycomb-parent/site.xml
@@ -0,0 +1,39 @@
+<!--
+ ~ Copyright (c) 2016 Cisco and/or its affiliates.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file 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.
+ -->
+
+<project>
+ <poweredBy>
+ <logo name="fd.io" href="http://fd.io" img="https://fd.io/sites/cpstandard/files/logo_fdio_top.png" alt="fd.io"/>
+ </poweredBy>
+
+ <body>
+ <menu name="Documentation root" inherit="top">
+ <item href="./honeycomb-aggregator/index.html" name="Root"/>
+ </menu>
+ <menu name="Documentation" inherit="top">
+ <item href="Readme.html" name="Overview"/>
+ </menu>
+ <menu name="General information" ref="reports" inherit="top"/>
+ <menu ref="modules" inherit="top"/>
+ <menu name="Maven parent" ref="parent" inherit="top"/>
+ </body>
+
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.5</version>
+ </skin>
+</project> \ No newline at end of file
diff --git a/common/impl-parent/asciidoc/Readme.adoc b/common/impl-parent/asciidoc/Readme.adoc
new file mode 100644
index 0000000..da4d325
--- /dev/null
+++ b/common/impl-parent/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= impl-parent
+
+Overview of impl-parent \ No newline at end of file
diff --git a/common/impl-parent/pom.xml b/common/impl-parent/pom.xml
index 0bd874a..535d638 100644
--- a/common/impl-parent/pom.xml
+++ b/common/impl-parent/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<artifactId>impl-parent</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>pom</packaging>
diff --git a/common/minimal-assembly-descriptor/asciidoc/Readme.adoc b/common/minimal-assembly-descriptor/asciidoc/Readme.adoc
new file mode 100644
index 0000000..a42a18e
--- /dev/null
+++ b/common/minimal-assembly-descriptor/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= minimal-assembly-descriptor
+
+Overview of minimal-assembly-descriptor \ No newline at end of file
diff --git a/common/minimal-assembly-descriptor/pom.xml b/common/minimal-assembly-descriptor/pom.xml
index 1664643..bd9f341 100644
--- a/common/minimal-assembly-descriptor/pom.xml
+++ b/common/minimal-assembly-descriptor/pom.xml
@@ -15,7 +15,13 @@
-->
<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">
- <groupId>io.fd.honeycomb.common</groupId>
+ <parent>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>../honeycomb-parent</relativePath>
+ </parent>
+
<artifactId>minimal-assembly-descriptor</artifactId>
<version>1.16.12-SNAPSHOT</version>
<name>${project.artifactId}</name>
diff --git a/common/minimal-distribution-parent/asciidoc/Readme.adoc b/common/minimal-distribution-parent/asciidoc/Readme.adoc
new file mode 100644
index 0000000..4e6bb77
--- /dev/null
+++ b/common/minimal-distribution-parent/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= minimal-distribution-parent
+
+Overview of minimal-distribution-parent \ No newline at end of file
diff --git a/common/minimal-distribution-parent/pom.xml b/common/minimal-distribution-parent/pom.xml
index 41367b2..b003231 100644
--- a/common/minimal-distribution-parent/pom.xml
+++ b/common/minimal-distribution-parent/pom.xml
@@ -26,6 +26,7 @@
<modelVersion>4.0.0</modelVersion>
<artifactId>minimal-distribution-parent</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>pom</packaging>
@@ -169,7 +170,6 @@ done
<plugin>
<groupId>org.codehaus.gmaven</groupId>
<artifactId>groovy-maven-plugin</artifactId>
- <version>2.0</version>
<executions>
<execution>
<phase>package</phase>
diff --git a/common/pom.xml b/common/pom.xml
index d50d326..3258881 100644
--- a/common/pom.xml
+++ b/common/pom.xml
@@ -15,15 +15,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">
-<groupId>io.fd.honeycomb.common</groupId>
+ <parent>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
+ <version>1.16.12-SNAPSHOT</version>
+ <relativePath>honeycomb-parent</relativePath>
+ </parent>
+
<artifactId>honeycomb-common-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
- <name>honeycomb-common</name>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Aggregator for common maven parents providing base configuration for Honeycomb modules</description>
<modules>
<module>checkstyle</module>
diff --git a/infra/Readme.adoc b/infra/asciidoc/Readme.adoc
index 33e882f..33e882f 100644
--- a/infra/Readme.adoc
+++ b/infra/asciidoc/Readme.adoc
diff --git a/infra/cfg-init/asciidoc/Readme.adoc b/infra/cfg-init/asciidoc/Readme.adoc
new file mode 100644
index 0000000..ad514b9
--- /dev/null
+++ b/infra/cfg-init/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= cfg-init
+
+Overview of cfg-init \ No newline at end of file
diff --git a/infra/cfg-init/pom.xml b/infra/cfg-init/pom.xml
index 1a0098d..605d7c2 100644
--- a/infra/cfg-init/pom.xml
+++ b/infra/cfg-init/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>cfg-init</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/data-api/Readme.adoc b/infra/data-api/asciidoc/Readme.adoc
index a13c509..a13c509 100644
--- a/infra/data-api/Readme.adoc
+++ b/infra/data-api/asciidoc/Readme.adoc
diff --git a/infra/data-api/pom.xml b/infra/data-api/pom.xml
index c2d8465..eb615a8 100644
--- a/infra/data-api/pom.xml
+++ b/infra/data-api/pom.xml
@@ -26,6 +26,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>data-api</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/data-impl/Readme.adoc b/infra/data-impl/asciidoc/Readme.adoc
index 61b2653..61b2653 100644
--- a/infra/data-impl/Readme.adoc
+++ b/infra/data-impl/asciidoc/Readme.adoc
diff --git a/infra/data-impl/pom.xml b/infra/data-impl/pom.xml
index 8b4e299..2d6f9fd 100644
--- a/infra/data-impl/pom.xml
+++ b/infra/data-impl/pom.xml
@@ -26,6 +26,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>data-impl</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/impl/asciidoc/Readme.adoc b/infra/impl/asciidoc/Readme.adoc
new file mode 100644
index 0000000..d629eaf
--- /dev/null
+++ b/infra/impl/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= honeycomb-impl
+
+Overview of honeycomb-impl \ No newline at end of file
diff --git a/infra/impl/pom.xml b/infra/impl/pom.xml
index 572a079..feb0cbc 100644
--- a/infra/impl/pom.xml
+++ b/infra/impl/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
+ <name>${project.artifactId}</name>
<artifactId>honeycomb-impl</artifactId>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/it/asciidoc/Readme.adoc b/infra/it/asciidoc/Readme.adoc
new file mode 100644
index 0000000..4a8ef58
--- /dev/null
+++ b/infra/it/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= honeycomb-it-aggregator
+
+Overview of honeycomb-it-aggregator \ No newline at end of file
diff --git a/infra/it/it-test/asciidoc/Readme.adoc b/infra/it/it-test/asciidoc/Readme.adoc
new file mode 100644
index 0000000..b22db58
--- /dev/null
+++ b/infra/it/it-test/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= honeycomb-it-test
+
+Overview of honeycomb-it-test \ No newline at end of file
diff --git a/infra/it/it-test/pom.xml b/infra/it/it-test/pom.xml
index bd2f9c0..2bbdff1 100644
--- a/infra/it/it-test/pom.xml
+++ b/infra/it/it-test/pom.xml
@@ -24,20 +24,25 @@
</parent>
<modelVersion>4.0.0</modelVersion>
- <groupId>io.fd.honeycomb</groupId>
+ <groupId>io.fd.honeycomb.it</groupId>
<artifactId>honeycomb-it-test</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
+ <properties>
+ <hc.infra.version>1.16.12-SNAPSHOT</hc.infra.version>
+ </properties>
+
<dependencies>
<dependency>
- <groupId>${project.groupId}</groupId>
+ <groupId>io.fd.honeycomb</groupId>
<artifactId>data-impl</artifactId>
- <version>${project.version}</version>
+ <version>${hc.infra.version}</version>
</dependency>
<dependency>
- <groupId>${project.groupId}</groupId>
+ <groupId>io.fd.honeycomb</groupId>
<artifactId>translate-impl</artifactId>
- <version>${project.version}</version>
+ <version>${hc.infra.version}</version>
</dependency>
<dependency>
<groupId>org.opendaylight.controller</groupId>
diff --git a/infra/it/pom.xml b/infra/it/pom.xml
index 8ebbd7e..5e11734 100644
--- a/infra/it/pom.xml
+++ b/infra/it/pom.xml
@@ -15,15 +15,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">
- <groupId>io.fd.honeycomb.common</groupId>
+ <parent>
+ <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.it</groupId>
<artifactId>honeycomb-it-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
<name>honeycomb-it</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
<modules>
<module>test-model</module>
diff --git a/infra/it/test-model/asciidoc/Readme.adoc b/infra/it/test-model/asciidoc/Readme.adoc
new file mode 100644
index 0000000..a1a3715
--- /dev/null
+++ b/infra/it/test-model/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= honeycomb-test-model
+
+Overview of honeycomb-test-model \ No newline at end of file
diff --git a/infra/it/test-model/pom.xml b/infra/it/test-model/pom.xml
index a2f47aa..909c486 100644
--- a/infra/it/test-model/pom.xml
+++ b/infra/it/test-model/pom.xml
@@ -22,8 +22,9 @@
</parent>
<modelVersion>4.0.0</modelVersion>
- <groupId>io.fd.honeycomb</groupId>
+ <groupId>io.fd.honeycomb.it</groupId>
<artifactId>honeycomb-test-model</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/minimal-distribution/asciidoc/Readme.adoc b/infra/minimal-distribution/asciidoc/Readme.adoc
new file mode 100644
index 0000000..1da86ca
--- /dev/null
+++ b/infra/minimal-distribution/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= minimal-distribution
+
+Overview of minimal-distribution \ No newline at end of file
diff --git a/infra/minimal-distribution/pom.xml b/infra/minimal-distribution/pom.xml
index 82f1cd1..6e935b0 100644
--- a/infra/minimal-distribution/pom.xml
+++ b/infra/minimal-distribution/pom.xml
@@ -25,12 +25,8 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>minimal-distribution</artifactId>
- <version>1.16.12-SNAPSHOT</version>
-
<name>${project.artifactId}</name>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <version>1.16.12-SNAPSHOT</version>
<properties>
<main.class>io.fd.honeycomb.infra.distro.Main</main.class>
diff --git a/infra/notification/api/asciidoc/Readme.adoc b/infra/notification/api/asciidoc/Readme.adoc
new file mode 100644
index 0000000..676a76b
--- /dev/null
+++ b/infra/notification/api/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= notification-api
+
+Overview of notification-api \ No newline at end of file
diff --git a/infra/notification/api/pom.xml b/infra/notification/api/pom.xml
index 0220dc1..8aa4b6b 100644
--- a/infra/notification/api/pom.xml
+++ b/infra/notification/api/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>notification-api</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/notification/asciidoc/Readme.adoc b/infra/notification/asciidoc/Readme.adoc
new file mode 100644
index 0000000..4830181
--- /dev/null
+++ b/infra/notification/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= notification-aggregator
+
+Overview of notification-aggregator \ No newline at end of file
diff --git a/infra/notification/impl/asciidoc/Readme.adoc b/infra/notification/impl/asciidoc/Readme.adoc
new file mode 100644
index 0000000..684cf3f
--- /dev/null
+++ b/infra/notification/impl/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= notification-impl
+
+Overview of notification-impl \ No newline at end of file
diff --git a/infra/notification/impl/pom.xml b/infra/notification/impl/pom.xml
index f289f75..4767fc9 100644
--- a/infra/notification/impl/pom.xml
+++ b/infra/notification/impl/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>notification-impl</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/notification/pom.xml b/infra/notification/pom.xml
index 6d4c15f..e8e9e5c 100644
--- a/infra/notification/pom.xml
+++ b/infra/notification/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</groupId>
<artifactId>notification-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
- <name>notification</name>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
<modules>
<module>api</module>
diff --git a/infra/pom.xml b/infra/pom.xml
index 37ab3b4..b21fe44 100644
--- a/infra/pom.xml
+++ b/infra/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>infra-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
- <name>infra</name>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Aggregator for Honeycomb core (aka infrastructure/framework)</description>
<modules>
<module>data-api</module>
diff --git a/infra/translate-api/Readme.adoc b/infra/translate-api/asciidoc/Readme.adoc
index 9e20874..9e20874 100644
--- a/infra/translate-api/Readme.adoc
+++ b/infra/translate-api/asciidoc/Readme.adoc
diff --git a/infra/translate-api/pom.xml b/infra/translate-api/pom.xml
index 5940572..374ed6c 100644
--- a/infra/translate-api/pom.xml
+++ b/infra/translate-api/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>translate-api</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/translate-impl/Readme.adoc b/infra/translate-impl/asciidoc/Readme.adoc
index 1e5c636..1e5c636 100644
--- a/infra/translate-impl/Readme.adoc
+++ b/infra/translate-impl/asciidoc/Readme.adoc
diff --git a/infra/translate-impl/pom.xml b/infra/translate-impl/pom.xml
index 2a9280b..7aff0a0 100644
--- a/infra/translate-impl/pom.xml
+++ b/infra/translate-impl/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>translate-impl</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/translate-spi/Readme.adoc b/infra/translate-spi/asciidoc/Readme.adoc
index 755538c..755538c 100644
--- a/infra/translate-spi/Readme.adoc
+++ b/infra/translate-spi/asciidoc/Readme.adoc
diff --git a/infra/translate-spi/pom.xml b/infra/translate-spi/pom.xml
index 8fb2cd1..0f630d0 100644
--- a/infra/translate-spi/pom.xml
+++ b/infra/translate-spi/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>translate-spi</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/infra/translate-utils/Readme.adoc b/infra/translate-utils/Readme.adoc
deleted file mode 100644
index 17ebb6c..0000000
--- a/infra/translate-utils/Readme.adoc
+++ /dev/null
@@ -1,3 +0,0 @@
-= Honeycomb translation layer utils
-
-Provides utility classes useful in translation layer implementation. \ No newline at end of file
diff --git a/infra/translate-utils/asciidoc/Readme.adoc b/infra/translate-utils/asciidoc/Readme.adoc
new file mode 100644
index 0000000..569fc71
--- /dev/null
+++ b/infra/translate-utils/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= translate-utils
+
+Overview of translate-utils \ No newline at end of file
diff --git a/infra/translate-utils/pom.xml b/infra/translate-utils/pom.xml
index d05f6b7..ea1ece1 100644
--- a/infra/translate-utils/pom.xml
+++ b/infra/translate-utils/pom.xml
@@ -25,6 +25,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb</groupId>
<artifactId>translate-utils</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>bundle</packaging>
diff --git a/lisp/api/asciidoc/Readme.adoc b/lisp/api/asciidoc/Readme.adoc
new file mode 100644
index 0000000..191cab3
--- /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 960f88b..5b92513 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 b3a01c6..b3a01c6 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 0000000..88c43fd
--- /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 a3b4934..7506f1e 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 2f06d65..7b2c3e5 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 0000000..4d78ad6
--- /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 07684b1..a6dc041 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 1ae2948..1ae2948 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 0000000..5c0fb47
--- /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 dbe3ae6..8a39f7f 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 0bebc44..52297d8 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/pom.xml b/pom.xml
index 2d06472..83b834d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -15,20 +15,25 @@
-->
<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">
- <properties>
- <nexusproxy>http://nexus.fd.io/content</nexusproxy>
- </properties>
+ <parent>
+ <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>
+ <groupId>io.fd.honeycomb</groupId>
<artifactId>honeycomb-aggregator</artifactId>
<version>1.16.12-SNAPSHOT</version>
<name>honeycomb</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
+ <description>Honeycomb project root aggregator</description>
+
+ <scm>
+ <url>https://git.fd.io/cgit/honeycomb/tree/</url>
+ </scm>
<modules>
<module>common</module>
@@ -41,15 +46,4 @@
<module>samples</module>
<module>tools</module>
</modules>
-
- <distributionManagement>
- <repository>
- <id>fdio-release</id>
- <url>${nexusproxy}/repositories/fd.io.release/</url>
- </repository>
- <snapshotRepository>
- <id>fdio-snapshot</id>
- <url>${nexusproxy}/repositories/fd.io.snapshot/</url>
- </snapshotRepository>
- </distributionManagement>
</project>
diff --git a/samples/asciidoc/Readme.adoc b/samples/asciidoc/Readme.adoc
new file mode 100644
index 0000000..ed405fe
--- /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 1ee4091..1ee4091 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 0000000..a89aee3
--- /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 e9b328d..1bb3a4c 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 0000000..03d45af
--- /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 666705d..6b61ad7 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 f361c74..05bb111 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 0000000..1da86ca
--- /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 debabe1..d387679 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 d3d01b2..809e48d 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/tools/archetype/Readme.adoc b/tools/archetype/asciidoc/Readme.adoc
index e5528d7..e5528d7 100644
--- a/tools/archetype/Readme.adoc
+++ b/tools/archetype/asciidoc/Readme.adoc
diff --git a/tools/archetype/pom.xml b/tools/archetype/pom.xml
index 38dbcc8..1bb5607 100644
--- a/tools/archetype/pom.xml
+++ b/tools/archetype/pom.xml
@@ -3,16 +3,18 @@
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>
- <artifactId>honeycomb-tools</artifactId>
- <groupId>io.fd.honeycomb.tools</groupId>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
<version>1.16.12-SNAPSHOT</version>
+ <relativePath>../../common/honeycomb-parent</relativePath>
</parent>
- <modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.tools</groupId>
<artifactId>honeycomb-plugin-archetype</artifactId>
+ <name>${project.artifactId}</name>
<version>1.16.12-SNAPSHOT</version>
<packaging>jar</packaging>
+ <modelVersion>4.0.0</modelVersion>
<properties>
<sonar.skip>true</sonar.skip>
diff --git a/tools/archetype/src/main/resources/archetype-resources/__rootArtifactId__-impl/Readme.adoc b/tools/archetype/src/main/resources/archetype-resources/asciidoc/Readme.adoc
index 8b4288e..8b4288e 100644
--- a/tools/archetype/src/main/resources/archetype-resources/__rootArtifactId__-impl/Readme.adoc
+++ b/tools/archetype/src/main/resources/archetype-resources/asciidoc/Readme.adoc
diff --git a/tools/archetype/src/main/resources/archetype-resources/pom.xml b/tools/archetype/src/main/resources/archetype-resources/pom.xml
index 5445d6e..0b69b9b 100644
--- a/tools/archetype/src/main/resources/archetype-resources/pom.xml
+++ b/tools/archetype/src/main/resources/archetype-resources/pom.xml
@@ -12,13 +12,8 @@
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.
---><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>
- </parent>
+-->
+<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">
<groupId>${groupId}</groupId>
<artifactId>${rootArtifactId}-aggregator</artifactId>
@@ -26,9 +21,6 @@
<name>${rootArtifactId}-aggregator</name>
<packaging>pom</packaging>
<modelVersion>4.0.0</modelVersion>
- <prerequisites>
- <maven>3.1.1</maven>
- </prerequisites>
<modules>
<module>${rootArtifactId}-api</module>
diff --git a/tools/asciidoc/Readme.adoc b/tools/asciidoc/Readme.adoc
new file mode 100644
index 0000000..c76ce61
--- /dev/null
+++ b/tools/asciidoc/Readme.adoc
@@ -0,0 +1,3 @@
+= honeycomb-tools
+
+Overview of honeycomb-tools \ No newline at end of file
diff --git a/tools/pom.xml b/tools/pom.xml
index f5a1371..78fae3a 100644
--- a/tools/pom.xml
+++ b/tools/pom.xml
@@ -3,16 +3,19 @@
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>
- <artifactId>honeycomb-aggregator</artifactId>
- <groupId>io.fd.honeycomb</groupId>
+ <groupId>io.fd.honeycomb.common</groupId>
+ <artifactId>honeycomb-parent</artifactId>
<version>1.16.12-SNAPSHOT</version>
+ <relativePath>../common/honeycomb-parent</relativePath>
</parent>
- <modelVersion>4.0.0</modelVersion>
<groupId>io.fd.honeycomb.tools</groupId>
<artifactId>honeycomb-tools</artifactId>
+ <name>${project.artifactId}</name>
<packaging>pom</packaging>
<version>1.16.12-SNAPSHOT</version>
+ <modelVersion>4.0.0</modelVersion>
+ <description>Aggregator for various Honeycomb tools</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 0000000..f9e63cf
--- /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 91102b8..4f12109 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 96d1d5a..96d1d5a 100644
--- a/v3po/Readme.adoc
+++ b/v3po/asciidoc/Readme.adoc
diff --git a/v3po/pom.xml b/v3po/pom.xml
index e354e71..83df160 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 29e2852..0000000
--- 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 0000000..d9fb563
--- /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 0721016..9af1df1 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 a95c397..0000000
--- 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 15b1b8c..0000000
--- 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 0000000..fc5e6b4
--- /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 0000000..1da86ca
--- /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 0000000..42eeb60
--- /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 b652df2..f197daa 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 0000000..93e3b75
--- /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 e628dd1..68a2bc7 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 f46a182..d6833cd 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 0000000..2dfc0b9
--- /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 0d688ba..43e038c 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 0000000..bed1891
--- /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 1aaaea1..1aaaea1 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 3b61f5c..e1ed82a 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 cba8297..cba8297 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 0000000..420ac72
--- /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 732ae4a..7e1aa02 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 00bce25..3cd5c09 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>