From bc335de41876acd8720dce1030a79b3a7b39c3b1 Mon Sep 17 00:00:00 2001 From: Maros Marsalek Date: Wed, 21 Sep 2016 13:51:57 +0200 Subject: 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 --- .gitignore | 2 + asciidoc/Readme.adoc | 13 ++ common/api-parent/asciidoc/Readme.adoc | 3 + common/api-parent/pom.xml | 1 + common/asciidoc/Readme.adoc | 3 + common/checkstyle/asciidoc/Readme.adoc | 6 + common/checkstyle/pom.xml | 23 +- common/checkstyle/src/main/resources/README.adoc | 6 - common/honeycomb-parent/asciidoc/Readme.adoc | 3 + common/honeycomb-parent/pom.xml | 244 ++++++++++++++++++++- common/honeycomb-parent/site.xml | 39 ++++ common/impl-parent/asciidoc/Readme.adoc | 3 + common/impl-parent/pom.xml | 1 + .../asciidoc/Readme.adoc | 3 + common/minimal-assembly-descriptor/pom.xml | 8 +- .../asciidoc/Readme.adoc | 3 + common/minimal-distribution-parent/pom.xml | 2 +- common/pom.xml | 14 +- infra/Readme.adoc | 67 ------ infra/asciidoc/Readme.adoc | 67 ++++++ infra/cfg-init/asciidoc/Readme.adoc | 3 + infra/cfg-init/pom.xml | 1 + infra/data-api/Readme.adoc | 10 - infra/data-api/asciidoc/Readme.adoc | 10 + infra/data-api/pom.xml | 1 + infra/data-impl/Readme.adoc | 43 ---- infra/data-impl/asciidoc/Readme.adoc | 43 ++++ infra/data-impl/pom.xml | 1 + infra/impl/asciidoc/Readme.adoc | 3 + infra/impl/pom.xml | 1 + infra/it/asciidoc/Readme.adoc | 3 + infra/it/it-test/asciidoc/Readme.adoc | 3 + infra/it/it-test/pom.xml | 15 +- infra/it/pom.xml | 12 +- infra/it/test-model/asciidoc/Readme.adoc | 3 + infra/it/test-model/pom.xml | 3 +- infra/minimal-distribution/asciidoc/Readme.adoc | 3 + infra/minimal-distribution/pom.xml | 6 +- infra/notification/api/asciidoc/Readme.adoc | 3 + infra/notification/api/pom.xml | 1 + infra/notification/asciidoc/Readme.adoc | 3 + infra/notification/impl/asciidoc/Readme.adoc | 3 + infra/notification/impl/pom.xml | 1 + infra/notification/pom.xml | 13 +- infra/pom.xml | 14 +- infra/translate-api/Readme.adoc | 9 - infra/translate-api/asciidoc/Readme.adoc | 9 + infra/translate-api/pom.xml | 1 + infra/translate-impl/Readme.adoc | 9 - infra/translate-impl/asciidoc/Readme.adoc | 9 + infra/translate-impl/pom.xml | 1 + infra/translate-spi/Readme.adoc | 4 - infra/translate-spi/asciidoc/Readme.adoc | 4 + infra/translate-spi/pom.xml | 1 + infra/translate-utils/Readme.adoc | 3 - infra/translate-utils/asciidoc/Readme.adoc | 3 + infra/translate-utils/pom.xml | 1 + lisp/Readme.adoc | 3 - lisp/api/asciidoc/Readme.adoc | 3 + lisp/api/pom.xml | 1 + lisp/asciidoc/Readme.adoc | 3 + lisp/lisp2vpp/asciidoc/Readme.adoc | 3 + lisp/lisp2vpp/pom.xml | 1 + lisp/pom.xml | 14 +- nsh/Readme.adoc | 14 -- nsh/api/asciidoc/Readme.adoc | 3 + nsh/api/pom.xml | 1 + nsh/asciidoc/Readme.adoc | 14 ++ nsh/impl/asciidoc/Readme.adoc | 3 + nsh/impl/pom.xml | 1 + nsh/pom.xml | 15 +- pom.xml | 30 +-- samples/asciidoc/Readme.adoc | 3 + samples/interfaces/Readme.adoc | 8 - samples/interfaces/asciidoc/Readme.adoc | 8 + samples/interfaces/mapping/asciidoc/Readme.adoc | 3 + samples/interfaces/mapping/pom.xml | 1 + samples/interfaces/models/asciidoc/Readme.adoc | 3 + samples/interfaces/models/pom.xml | 1 + samples/interfaces/pom.xml | 13 +- samples/minimal-distribution/asciidoc/Readme.adoc | 3 + samples/minimal-distribution/pom.xml | 1 + samples/pom.xml | 14 +- tools/archetype/Readme.adoc | 13 -- tools/archetype/asciidoc/Readme.adoc | 13 ++ tools/archetype/pom.xml | 8 +- .../__rootArtifactId__-impl/Readme.adoc | 3 - .../archetype-resources/asciidoc/Readme.adoc | 3 + .../src/main/resources/archetype-resources/pom.xml | 12 +- tools/asciidoc/Readme.adoc | 3 + tools/pom.xml | 9 +- v3po/Readme.adoc | 7 - v3po/api/asciidoc/Readme.adoc | 3 + v3po/api/pom.xml | 1 + v3po/asciidoc/Readme.adoc | 7 + v3po/pom.xml | 15 +- v3po/v3po2vpp/Readme.adoc | 3 - v3po/v3po2vpp/asciidoc/Readme.adoc | 103 +++++++++ v3po/v3po2vpp/pom.xml | 1 + .../io/fd/honeycomb/translate/v3po/Readme.adoc | 70 ------ .../translate/v3po/interfaces/acl/Readme.adoc | 29 --- vpp-common/asciidoc/Readme.adoc | 3 + .../minimal-distribution/asciidoc/Readme.adoc | 3 + vpp-common/naming-context-api/asciidoc/Readme.adoc | 3 + vpp-common/naming-context-api/pom.xml | 1 + .../naming-context-impl/asciidoc/Readme.adoc | 3 + vpp-common/naming-context-impl/pom.xml | 1 + vpp-common/pom.xml | 16 +- vpp-common/vpp-impl-parent/asciidoc/Readme.adoc | 3 + vpp-common/vpp-impl-parent/pom.xml | 4 +- vpp-common/vpp-translate-test/asciidoc/Readme.adoc | 3 + vpp-common/vpp-translate-utils/Readme.adoc | 3 - .../vpp-translate-utils/asciidoc/Readme.adoc | 3 + vpp-common/vpp-translate-utils/pom.xml | 2 +- vpp-integration/Readme.adoc | 3 - vpp-integration/asciidoc/Readme.adoc | 3 + .../minimal-distribution/asciidoc/Readme.adoc | 3 + vpp-integration/minimal-distribution/pom.xml | 1 + vpp-integration/pom.xml | 13 +- 119 files changed, 859 insertions(+), 449 deletions(-) create mode 100644 asciidoc/Readme.adoc create mode 100644 common/api-parent/asciidoc/Readme.adoc create mode 100644 common/asciidoc/Readme.adoc create mode 100644 common/checkstyle/asciidoc/Readme.adoc delete mode 100644 common/checkstyle/src/main/resources/README.adoc create mode 100644 common/honeycomb-parent/asciidoc/Readme.adoc create mode 100644 common/honeycomb-parent/site.xml create mode 100644 common/impl-parent/asciidoc/Readme.adoc create mode 100644 common/minimal-assembly-descriptor/asciidoc/Readme.adoc create mode 100644 common/minimal-distribution-parent/asciidoc/Readme.adoc delete mode 100644 infra/Readme.adoc create mode 100644 infra/asciidoc/Readme.adoc create mode 100644 infra/cfg-init/asciidoc/Readme.adoc delete mode 100644 infra/data-api/Readme.adoc create mode 100644 infra/data-api/asciidoc/Readme.adoc delete mode 100644 infra/data-impl/Readme.adoc create mode 100644 infra/data-impl/asciidoc/Readme.adoc create mode 100644 infra/impl/asciidoc/Readme.adoc create mode 100644 infra/it/asciidoc/Readme.adoc create mode 100644 infra/it/it-test/asciidoc/Readme.adoc create mode 100644 infra/it/test-model/asciidoc/Readme.adoc create mode 100644 infra/minimal-distribution/asciidoc/Readme.adoc create mode 100644 infra/notification/api/asciidoc/Readme.adoc create mode 100644 infra/notification/asciidoc/Readme.adoc create mode 100644 infra/notification/impl/asciidoc/Readme.adoc delete mode 100644 infra/translate-api/Readme.adoc create mode 100644 infra/translate-api/asciidoc/Readme.adoc delete mode 100644 infra/translate-impl/Readme.adoc create mode 100644 infra/translate-impl/asciidoc/Readme.adoc delete mode 100644 infra/translate-spi/Readme.adoc create mode 100644 infra/translate-spi/asciidoc/Readme.adoc delete mode 100644 infra/translate-utils/Readme.adoc create mode 100644 infra/translate-utils/asciidoc/Readme.adoc delete mode 100755 lisp/Readme.adoc create mode 100644 lisp/api/asciidoc/Readme.adoc create mode 100755 lisp/asciidoc/Readme.adoc create mode 100644 lisp/lisp2vpp/asciidoc/Readme.adoc delete mode 100644 nsh/Readme.adoc create mode 100644 nsh/api/asciidoc/Readme.adoc create mode 100644 nsh/asciidoc/Readme.adoc create mode 100644 nsh/impl/asciidoc/Readme.adoc create mode 100644 samples/asciidoc/Readme.adoc delete mode 100644 samples/interfaces/Readme.adoc create mode 100644 samples/interfaces/asciidoc/Readme.adoc create mode 100644 samples/interfaces/mapping/asciidoc/Readme.adoc create mode 100644 samples/interfaces/models/asciidoc/Readme.adoc create mode 100644 samples/minimal-distribution/asciidoc/Readme.adoc delete mode 100644 tools/archetype/Readme.adoc create mode 100644 tools/archetype/asciidoc/Readme.adoc delete mode 100644 tools/archetype/src/main/resources/archetype-resources/__rootArtifactId__-impl/Readme.adoc create mode 100644 tools/archetype/src/main/resources/archetype-resources/asciidoc/Readme.adoc create mode 100644 tools/asciidoc/Readme.adoc delete mode 100644 v3po/Readme.adoc create mode 100644 v3po/api/asciidoc/Readme.adoc create mode 100644 v3po/asciidoc/Readme.adoc delete mode 100644 v3po/v3po2vpp/Readme.adoc create mode 100644 v3po/v3po2vpp/asciidoc/Readme.adoc delete mode 100644 v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/Readme.adoc delete mode 100644 v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/interfaces/acl/Readme.adoc create mode 100644 vpp-common/asciidoc/Readme.adoc create mode 100644 vpp-common/minimal-distribution/asciidoc/Readme.adoc create mode 100644 vpp-common/naming-context-api/asciidoc/Readme.adoc create mode 100644 vpp-common/naming-context-impl/asciidoc/Readme.adoc create mode 100644 vpp-common/vpp-impl-parent/asciidoc/Readme.adoc create mode 100644 vpp-common/vpp-translate-test/asciidoc/Readme.adoc delete mode 100644 vpp-common/vpp-translate-utils/Readme.adoc create mode 100644 vpp-common/vpp-translate-utils/asciidoc/Readme.adoc delete mode 100644 vpp-integration/Readme.adoc create mode 100644 vpp-integration/asciidoc/Readme.adoc create mode 100644 vpp-integration/minimal-distribution/asciidoc/Readme.adoc diff --git a/.gitignore b/.gitignore index 06b920b8a..855ab0e1f 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 000000000..60ad69432 --- /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 000000000..b156b414a --- /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 6937fb6ee..531e47009 100644 --- a/common/api-parent/pom.xml +++ b/common/api-parent/pom.xml @@ -24,6 +24,7 @@ 4.0.0 api-parent + ${project.artifactId} 1.16.12-SNAPSHOT pom diff --git a/common/asciidoc/Readme.adoc b/common/asciidoc/Readme.adoc new file mode 100644 index 000000000..f97755af3 --- /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/asciidoc/Readme.adoc b/common/checkstyle/asciidoc/Readme.adoc new file mode 100644 index 000000000..7b1d0767f --- /dev/null +++ b/common/checkstyle/asciidoc/Readme.adoc @@ -0,0 +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-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 3dbf26855..b33341d9e 100644 --- a/common/checkstyle/pom.xml +++ b/common/checkstyle/pom.xml @@ -1,15 +1,24 @@ 4.0.0 - - org.opendaylight.odlparent - odlparent-lite - 1.6.2-Beryllium-SR2 - - - io.fd.honeycomb.common honeycomb-checkstyle + ${project.artifactId} 1.16.12-SNAPSHOT + + + + + org.apache.maven.plugins + maven-site-plugin + + true + true + + + + + + diff --git a/common/checkstyle/src/main/resources/README.adoc b/common/checkstyle/src/main/resources/README.adoc deleted file mode 100644 index d33f39efc..000000000 --- a/common/checkstyle/src/main/resources/README.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= 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-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/honeycomb-parent/asciidoc/Readme.adoc b/common/honeycomb-parent/asciidoc/Readme.adoc new file mode 100644 index 000000000..39341884f --- /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 5aa4fb3c4..6660360fd 100644 --- a/common/honeycomb-parent/pom.xml +++ b/common/honeycomb-parent/pom.xml @@ -16,11 +16,16 @@ --> + 4.0.0 io.fd.honeycomb.common honeycomb-parent + ${project.artifactId} 1.16.12-SNAPSHOT pom + + 3.1.1 + http://nexus.fd.io/content @@ -62,6 +67,24 @@ APACHE_HEADER.txt + + + + false + 2.9 + 2.6 + 3.4 + + 1.5.3 + 1.3.1 + 2.0 + += ${project.artifactId} + +Overview of ${project.artifactId} + + https://nexus.fd.io/content/sites/site + io/fd/honeycomb @@ -86,6 +109,15 @@ https://jenkins.fd.io/ + + + HC dev + honeycomb-dev@fd.io + https://lists.fd.io/mailman/listinfo/honeycomb-dev + https://lists.fd.io/pipermail/honeycomb-dev/ + + + @@ -175,9 +207,17 @@ honeycomb-checkstyle.xml true - + + **\/*.java,**\/*.xml,**\/*.ini,**\/*.sh,**\/*.bat,**\/*.yang + **\/target\/, + **\/bin\/, + **\/target-ide\/, + **\/src/main/yang-gen-config\/, org/opendaylight/yang/gen/**, - + **\/src/main/yang-gen-sal\/, + **\/src/main/xtend-gen\/, + **\/src/main/yang\/, + **\/archetype-resources\/ @@ -209,10 +249,6 @@ true true ${project.basedir} - **\/*.java,**\/*.xml,**\/*.ini,**\/*.sh,**\/*.bat,**\/*.yang - - **\/target\/,**\/bin\/,**\/target-ide\/,**\/src/main/yang-gen-config\/,**\/src/main/yang-gen-sal\/,**\/src/main/xtend-gen\/,**\/src/main/yang\/ - ${project.build.directory}/checkstyle-logging-result.xml @@ -247,6 +283,14 @@ -Xdoclint:none + + + attach-javadocs + + jar + + + @@ -336,12 +380,136 @@ ${maven.bundle.version} true + + + org.apache.maven.plugins + maven-source-plugin + + + attach-sources + + jar + + + + + + + + org.apache.maven.plugins + maven-site-plugin + ${maven.site.version} + + true + true + false + en + UTF-8 + UTF-8 + ${project.basedir} + false + + + asciidoctor-diagram + + + + coderay + style + ${project.build.directory}/site/images + left + 2 + font + true + + - + + + + + **/_*.adoc + + + + + org.asciidoctor + asciidoctor-maven-plugin + ${asciidoctor.maven.plugin.version} + + + org.asciidoctor + asciidoctorj-diagram + ${asciidoctorj.diagram.version} + + + + + org.codehaus.gmaven + groovy-maven-plugin + ${maven.groovy.version} + + + + generate-adoc + generate-resources + + execute + + + + + 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", "") + } + + + + + + fix-generated-site + site + + execute + + + + + 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") + } + + + + + maven-enforcer-plugin + + maven-source-plugin + + + maven-javadoc-plugin + maven-checkstyle-plugin @@ -359,9 +527,69 @@ org.apache.felix maven-bundle-plugin + + org.codehaus.gmaven + groovy-maven-plugin + + + + + + org.apache.maven.wagon + wagon-webdav-jackrabbit + 2.9 + + + + + + org.apache.maven.plugins + maven-project-info-reports-plugin + ${project.info.report.version} + + + + index + summary + modules + cim + dependencies + distribution-management + mailing-list + issue-tracking + license + scm + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + ${maven.javadoc.version} + + + default + + javadoc-no-fork + + + + + -Xdoclint:none + + + + org.apache.maven.plugins + maven-resources-plugin + ${maven.resources.version} + + + + fdio-release @@ -371,6 +599,10 @@ fdio-snapshot ${nexusproxy}/repositories/fd.io.snapshot/ + + fdio-site + dav:${docs.base.url}/${docs.hc.folder}/${project.version} + diff --git a/common/honeycomb-parent/site.xml b/common/honeycomb-parent/site.xml new file mode 100644 index 000000000..b0ed4c977 --- /dev/null +++ b/common/honeycomb-parent/site.xml @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + org.apache.maven.skins + maven-fluido-skin + 1.5 + + \ 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 000000000..da4d32570 --- /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 0bd874a6c..535d638df 100644 --- a/common/impl-parent/pom.xml +++ b/common/impl-parent/pom.xml @@ -25,6 +25,7 @@ 4.0.0 impl-parent + ${project.artifactId} 1.16.12-SNAPSHOT pom diff --git a/common/minimal-assembly-descriptor/asciidoc/Readme.adoc b/common/minimal-assembly-descriptor/asciidoc/Readme.adoc new file mode 100644 index 000000000..a42a18ec0 --- /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 166464391..bd9f34193 100644 --- a/common/minimal-assembly-descriptor/pom.xml +++ b/common/minimal-assembly-descriptor/pom.xml @@ -15,7 +15,13 @@ --> - io.fd.honeycomb.common + + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../honeycomb-parent + + minimal-assembly-descriptor 1.16.12-SNAPSHOT ${project.artifactId} diff --git a/common/minimal-distribution-parent/asciidoc/Readme.adoc b/common/minimal-distribution-parent/asciidoc/Readme.adoc new file mode 100644 index 000000000..4e6bb77f7 --- /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 41367b2a7..b003231c3 100644 --- a/common/minimal-distribution-parent/pom.xml +++ b/common/minimal-distribution-parent/pom.xml @@ -26,6 +26,7 @@ 4.0.0 minimal-distribution-parent + ${project.artifactId} 1.16.12-SNAPSHOT pom @@ -169,7 +170,6 @@ done org.codehaus.gmaven groovy-maven-plugin - 2.0 package diff --git a/common/pom.xml b/common/pom.xml index d50d326a4..32588812c 100644 --- a/common/pom.xml +++ b/common/pom.xml @@ -15,15 +15,19 @@ --> -io.fd.honeycomb.common + + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + honeycomb-parent + + honeycomb-common-aggregator 1.16.12-SNAPSHOT - honeycomb-common + ${project.artifactId} pom 4.0.0 - - 3.1.1 - + Aggregator for common maven parents providing base configuration for Honeycomb modules checkstyle diff --git a/infra/Readme.adoc b/infra/Readme.adoc deleted file mode 100644 index 33e882f8c..000000000 --- a/infra/Readme.adoc +++ /dev/null @@ -1,67 +0,0 @@ -= Honeycomb - -Honeycomb is an VPP agent that runs the same host as a VPP instance -and exposes YANG models via NETCONF and RESTCONF to allow management of that VPP instance. -Honeycomb uses jAPI to communicate with the VPP. - -[ditaa, "hc-architecture"] -.... - /------------------\ - ODL | RESTCONF/NETCONF | - \-+--------------+-/ - | ^ ----------------------|--------------|--------------------- - v | - /------------------\ - | Data layer | - \-+--------------+-/ - | ^ - Honeycomb v | - /-----+--------------+-----\ - | Translation layer | - \----+----------------+----+ - | VPP SPI impl | - +---+------+-----+ - | ^ -------------------------|------|-------------------------- - v | - ++------++ - | jAPI | - VPP /----+--------+------\ - | VPP | - \--------------------/ - -.... - -== NETCONF/RESTCONF layer - -NETCONF and RESTCONF support is provided by ODL (Honeycomb is an ODL application). -In the future we plan to minimize ODL dependencies or completely remove karaf. - -Transaction functionality is provided by the data layer. - -== Data layer - -Models CONFIG data store as a DataTree. - -OPERATIONAL data store reads are passed directly to the translation layer. - -Provides transaction functionality for NETCONF/RESTCONF layer. - - -== Translation layer - -Extensible API for translation between Binding Aware data and actual device data. -Consists of readers and writers responsible for communication with the device. - -Provides registry of readers and writers for the data layer. - -== Supported features - -List of supported requests for RESTCONF northbound interface can be found in -postman_rest_collection.json within the codebase. -It is a POSTMAN compatible collection and can be imported into POSTMAN application. - - - - diff --git a/infra/asciidoc/Readme.adoc b/infra/asciidoc/Readme.adoc new file mode 100644 index 000000000..33e882f8c --- /dev/null +++ b/infra/asciidoc/Readme.adoc @@ -0,0 +1,67 @@ += Honeycomb + +Honeycomb is an VPP agent that runs the same host as a VPP instance +and exposes YANG models via NETCONF and RESTCONF to allow management of that VPP instance. +Honeycomb uses jAPI to communicate with the VPP. + +[ditaa, "hc-architecture"] +.... + /------------------\ + ODL | RESTCONF/NETCONF | + \-+--------------+-/ + | ^ +---------------------|--------------|--------------------- + v | + /------------------\ + | Data layer | + \-+--------------+-/ + | ^ + Honeycomb v | + /-----+--------------+-----\ + | Translation layer | + \----+----------------+----+ + | VPP SPI impl | + +---+------+-----+ + | ^ +------------------------|------|-------------------------- + v | + ++------++ + | jAPI | + VPP /----+--------+------\ + | VPP | + \--------------------/ + +.... + +== NETCONF/RESTCONF layer + +NETCONF and RESTCONF support is provided by ODL (Honeycomb is an ODL application). +In the future we plan to minimize ODL dependencies or completely remove karaf. + +Transaction functionality is provided by the data layer. + +== Data layer + +Models CONFIG data store as a DataTree. + +OPERATIONAL data store reads are passed directly to the translation layer. + +Provides transaction functionality for NETCONF/RESTCONF layer. + + +== Translation layer + +Extensible API for translation between Binding Aware data and actual device data. +Consists of readers and writers responsible for communication with the device. + +Provides registry of readers and writers for the data layer. + +== Supported features + +List of supported requests for RESTCONF northbound interface can be found in +postman_rest_collection.json within the codebase. +It is a POSTMAN compatible collection and can be imported into POSTMAN application. + + + + diff --git a/infra/cfg-init/asciidoc/Readme.adoc b/infra/cfg-init/asciidoc/Readme.adoc new file mode 100644 index 000000000..ad514b960 --- /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 1a0098dd0..605d7c208 100644 --- a/infra/cfg-init/pom.xml +++ b/infra/cfg-init/pom.xml @@ -25,6 +25,7 @@ 4.0.0 io.fd.honeycomb cfg-init + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/data-api/Readme.adoc b/infra/data-api/Readme.adoc deleted file mode 100644 index a13c5094f..000000000 --- a/infra/data-api/Readme.adoc +++ /dev/null @@ -1,10 +0,0 @@ -= Honeycomb Data layer. API - -Provides data tree abstraction for data store modeling. -ModifiableDataTree can be used to model CONFIG data store. -ReadableDataTree can be used to model OPERATIONAL data store. - - - - - diff --git a/infra/data-api/asciidoc/Readme.adoc b/infra/data-api/asciidoc/Readme.adoc new file mode 100644 index 000000000..a13c5094f --- /dev/null +++ b/infra/data-api/asciidoc/Readme.adoc @@ -0,0 +1,10 @@ += Honeycomb Data layer. API + +Provides data tree abstraction for data store modeling. +ModifiableDataTree can be used to model CONFIG data store. +ReadableDataTree can be used to model OPERATIONAL data store. + + + + + diff --git a/infra/data-api/pom.xml b/infra/data-api/pom.xml index c2d8465a3..eb615a8d1 100644 --- a/infra/data-api/pom.xml +++ b/infra/data-api/pom.xml @@ -26,6 +26,7 @@ 4.0.0 io.fd.honeycomb data-api + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/data-impl/Readme.adoc b/infra/data-impl/Readme.adoc deleted file mode 100644 index 61b2653b3..000000000 --- a/infra/data-impl/Readme.adoc +++ /dev/null @@ -1,43 +0,0 @@ -= Honeycomb Data layer. Implementation - -Models CONFIG data store as a DataTree. - -Every read transaction reads directly from the DataTree. -Every write transaction is validated, then passed to the translation layer. -After successful update, config data tree is updated. - -OPERATIONAL data store reads are passed directly to the translation layer. - -Data transaction functionality for higher layers (i.e NETCONF/RESTCONF layer) is provided by DataBroker. - -[ditaa, "data-layer-architecture"] -.... - /------------------\ - | RESTCONF/NETCONF | - \--------+---------/ - | -----------------------------|------------------------------------ - v - /------------------\ - | DataBroker | - \-+--------------+-/ - | | - | read | read/write - Honeycomb v v - data layer /------+------\ /--+--------\ /----------\ - | | | | | | - | Operational | | Config +------>+ DataTree + - | DataTree | | DataTree | | | - | | | | \----------/ - \------+------/ \--+--------/ - | | ----------------------|--------------|---------------------------- - v v - /-----+--------------+-----\ - | Translation layer | - \--------------------------/ -.... - - - - diff --git a/infra/data-impl/asciidoc/Readme.adoc b/infra/data-impl/asciidoc/Readme.adoc new file mode 100644 index 000000000..61b2653b3 --- /dev/null +++ b/infra/data-impl/asciidoc/Readme.adoc @@ -0,0 +1,43 @@ += Honeycomb Data layer. Implementation + +Models CONFIG data store as a DataTree. + +Every read transaction reads directly from the DataTree. +Every write transaction is validated, then passed to the translation layer. +After successful update, config data tree is updated. + +OPERATIONAL data store reads are passed directly to the translation layer. + +Data transaction functionality for higher layers (i.e NETCONF/RESTCONF layer) is provided by DataBroker. + +[ditaa, "data-layer-architecture"] +.... + /------------------\ + | RESTCONF/NETCONF | + \--------+---------/ + | +----------------------------|------------------------------------ + v + /------------------\ + | DataBroker | + \-+--------------+-/ + | | + | read | read/write + Honeycomb v v + data layer /------+------\ /--+--------\ /----------\ + | | | | | | + | Operational | | Config +------>+ DataTree + + | DataTree | | DataTree | | | + | | | | \----------/ + \------+------/ \--+--------/ + | | +---------------------|--------------|---------------------------- + v v + /-----+--------------+-----\ + | Translation layer | + \--------------------------/ +.... + + + + diff --git a/infra/data-impl/pom.xml b/infra/data-impl/pom.xml index 8b4e29918..2d6f9fd61 100644 --- a/infra/data-impl/pom.xml +++ b/infra/data-impl/pom.xml @@ -26,6 +26,7 @@ 4.0.0 io.fd.honeycomb data-impl + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/impl/asciidoc/Readme.adoc b/infra/impl/asciidoc/Readme.adoc new file mode 100644 index 000000000..d629eaf0b --- /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 572a079bf..feb0cbc4d 100644 --- a/infra/impl/pom.xml +++ b/infra/impl/pom.xml @@ -25,6 +25,7 @@ 4.0.0 io.fd.honeycomb + ${project.artifactId} honeycomb-impl 1.16.12-SNAPSHOT bundle diff --git a/infra/it/asciidoc/Readme.adoc b/infra/it/asciidoc/Readme.adoc new file mode 100644 index 000000000..4a8ef58e1 --- /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 000000000..b22db5807 --- /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 bd2f9c0d6..2bbdff1a1 100644 --- a/infra/it/it-test/pom.xml +++ b/infra/it/it-test/pom.xml @@ -24,20 +24,25 @@ 4.0.0 - io.fd.honeycomb + io.fd.honeycomb.it honeycomb-it-test + ${project.artifactId} 1.16.12-SNAPSHOT + + 1.16.12-SNAPSHOT + + - ${project.groupId} + io.fd.honeycomb data-impl - ${project.version} + ${hc.infra.version} - ${project.groupId} + io.fd.honeycomb translate-impl - ${project.version} + ${hc.infra.version} org.opendaylight.controller diff --git a/infra/it/pom.xml b/infra/it/pom.xml index 8ebbd7e21..5e1173413 100644 --- a/infra/it/pom.xml +++ b/infra/it/pom.xml @@ -15,15 +15,19 @@ --> - io.fd.honeycomb.common + + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../../common/honeycomb-parent + + + io.fd.honeycomb.it honeycomb-it-aggregator 1.16.12-SNAPSHOT honeycomb-it pom 4.0.0 - - 3.1.1 - test-model diff --git a/infra/it/test-model/asciidoc/Readme.adoc b/infra/it/test-model/asciidoc/Readme.adoc new file mode 100644 index 000000000..a1a3715ea --- /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 a2f47aa3c..909c4866f 100644 --- a/infra/it/test-model/pom.xml +++ b/infra/it/test-model/pom.xml @@ -22,8 +22,9 @@ 4.0.0 - io.fd.honeycomb + io.fd.honeycomb.it honeycomb-test-model + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/minimal-distribution/asciidoc/Readme.adoc b/infra/minimal-distribution/asciidoc/Readme.adoc new file mode 100644 index 000000000..1da86caab --- /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 82f1cd1ad..6e935b09b 100644 --- a/infra/minimal-distribution/pom.xml +++ b/infra/minimal-distribution/pom.xml @@ -25,12 +25,8 @@ 4.0.0 io.fd.honeycomb minimal-distribution - 1.16.12-SNAPSHOT - ${project.artifactId} - - 3.1.1 - + 1.16.12-SNAPSHOT io.fd.honeycomb.infra.distro.Main diff --git a/infra/notification/api/asciidoc/Readme.adoc b/infra/notification/api/asciidoc/Readme.adoc new file mode 100644 index 000000000..676a76b54 --- /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 0220dc1fd..8aa4b6b70 100644 --- a/infra/notification/api/pom.xml +++ b/infra/notification/api/pom.xml @@ -25,6 +25,7 @@ 4.0.0 io.fd.honeycomb notification-api + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/notification/asciidoc/Readme.adoc b/infra/notification/asciidoc/Readme.adoc new file mode 100644 index 000000000..483018110 --- /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 000000000..684cf3fe5 --- /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 f289f75d1..4767fc958 100644 --- a/infra/notification/impl/pom.xml +++ b/infra/notification/impl/pom.xml @@ -25,6 +25,7 @@ 4.0.0 io.fd.honeycomb notification-impl + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/notification/pom.xml b/infra/notification/pom.xml index 6d4c15fa0..e8e9e5cc5 100644 --- a/infra/notification/pom.xml +++ b/infra/notification/pom.xml @@ -16,21 +16,18 @@ - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../../common/honeycomb-parent io.fd.honeycomb notification-aggregator 1.16.12-SNAPSHOT - notification + ${project.artifactId} pom 4.0.0 - - 3.1.1 - api diff --git a/infra/pom.xml b/infra/pom.xml index 37ab3b42b..b21fe44ef 100644 --- a/infra/pom.xml +++ b/infra/pom.xml @@ -16,21 +16,19 @@ - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../common/honeycomb-parent io.fd.honeycomb infra-aggregator 1.16.12-SNAPSHOT - infra + ${project.artifactId} pom 4.0.0 - - 3.1.1 - + Aggregator for Honeycomb core (aka infrastructure/framework) data-api diff --git a/infra/translate-api/Readme.adoc b/infra/translate-api/Readme.adoc deleted file mode 100644 index 9e208744a..000000000 --- a/infra/translate-api/Readme.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Honeycomb translation layer API - -Extensible API for translation between Binding Aware data and actual device data. -Consists of readers and writers responsible for communication with the device. - -Provides registry of readers and writers for the data layer. -For every supported YANG model there should be at least one reader and writer registered. -Readers and writers form two tree structures matching corresponding YANG models. -Readers and writers can be attached to any non-leaf YANG node. \ No newline at end of file diff --git a/infra/translate-api/asciidoc/Readme.adoc b/infra/translate-api/asciidoc/Readme.adoc new file mode 100644 index 000000000..9e208744a --- /dev/null +++ b/infra/translate-api/asciidoc/Readme.adoc @@ -0,0 +1,9 @@ += Honeycomb translation layer API + +Extensible API for translation between Binding Aware data and actual device data. +Consists of readers and writers responsible for communication with the device. + +Provides registry of readers and writers for the data layer. +For every supported YANG model there should be at least one reader and writer registered. +Readers and writers form two tree structures matching corresponding YANG models. +Readers and writers can be attached to any non-leaf YANG node. \ No newline at end of file diff --git a/infra/translate-api/pom.xml b/infra/translate-api/pom.xml index 594057284..374ed6c3e 100644 --- a/infra/translate-api/pom.xml +++ b/infra/translate-api/pom.xml @@ -25,6 +25,7 @@ 4.0.0 io.fd.honeycomb translate-api + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/translate-impl/Readme.adoc b/infra/translate-impl/Readme.adoc deleted file mode 100644 index 1e5c63604..000000000 --- a/infra/translate-impl/Readme.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Honeycomb translation layer implementation - -Provides composite implementations of child, list and root readers/writers. - -Root readers/writers can be used to provide data translation at root node level. -List readers/writers help with data translation for nodes modeled as YANG lists. -Child readers/writers can be used to provide data translation for non-leaf nodes. - -Readers and writers can be easily extended using customizers defined in the translate-spi module. \ No newline at end of file diff --git a/infra/translate-impl/asciidoc/Readme.adoc b/infra/translate-impl/asciidoc/Readme.adoc new file mode 100644 index 000000000..1e5c63604 --- /dev/null +++ b/infra/translate-impl/asciidoc/Readme.adoc @@ -0,0 +1,9 @@ += Honeycomb translation layer implementation + +Provides composite implementations of child, list and root readers/writers. + +Root readers/writers can be used to provide data translation at root node level. +List readers/writers help with data translation for nodes modeled as YANG lists. +Child readers/writers can be used to provide data translation for non-leaf nodes. + +Readers and writers can be easily extended using customizers defined in the translate-spi module. \ No newline at end of file diff --git a/infra/translate-impl/pom.xml b/infra/translate-impl/pom.xml index 2a9280b87..7aff0a00f 100644 --- a/infra/translate-impl/pom.xml +++ b/infra/translate-impl/pom.xml @@ -25,6 +25,7 @@ 4.0.0 io.fd.honeycomb translate-impl + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/translate-spi/Readme.adoc b/infra/translate-spi/Readme.adoc deleted file mode 100644 index 755538c07..000000000 --- a/infra/translate-spi/Readme.adoc +++ /dev/null @@ -1,4 +0,0 @@ -= Honeycomb translation layer SPI - -Provides root, child and list customizer interfaces for extending readers/writers. -Customizers can be used to implement actual data reads and writes. \ No newline at end of file diff --git a/infra/translate-spi/asciidoc/Readme.adoc b/infra/translate-spi/asciidoc/Readme.adoc new file mode 100644 index 000000000..755538c07 --- /dev/null +++ b/infra/translate-spi/asciidoc/Readme.adoc @@ -0,0 +1,4 @@ += Honeycomb translation layer SPI + +Provides root, child and list customizer interfaces for extending readers/writers. +Customizers can be used to implement actual data reads and writes. \ No newline at end of file diff --git a/infra/translate-spi/pom.xml b/infra/translate-spi/pom.xml index 8fb2cd1cb..0f630d065 100644 --- a/infra/translate-spi/pom.xml +++ b/infra/translate-spi/pom.xml @@ -25,6 +25,7 @@ 4.0.0 io.fd.honeycomb translate-spi + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/infra/translate-utils/Readme.adoc b/infra/translate-utils/Readme.adoc deleted file mode 100644 index 17ebb6c6a..000000000 --- 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 000000000..569fc713c --- /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 d05f6b7ba..ea1ece1de 100644 --- a/infra/translate-utils/pom.xml +++ b/infra/translate-utils/pom.xml @@ -25,6 +25,7 @@ 4.0.0 io.fd.honeycomb translate-utils + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/lisp/Readme.adoc b/lisp/Readme.adoc deleted file mode 100755 index b3a01c6d3..000000000 --- a/lisp/Readme.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Honeycomb translation layer SPI implementation for VPP's LISP APIs - -Provides customizers translating lisp.yang model into VPP's LISP API calls \ No newline at end of file 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 @@ 4.0.0 io.fd.honeycomb.lisp lisp-api + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/lisp/asciidoc/Readme.adoc b/lisp/asciidoc/Readme.adoc new file mode 100755 index 000000000..b3a01c6d3 --- /dev/null +++ b/lisp/asciidoc/Readme.adoc @@ -0,0 +1,3 @@ += Honeycomb translation layer SPI implementation for VPP's LISP APIs + +Provides customizers translating lisp.yang model into VPP's LISP API calls \ No newline at end of file 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 @@ 4.0.0 io.fd.honeycomb.lisp lisp2vpp + ${project.artifactId} 1.16.12-SNAPSHOT bundle 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"> - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../common/honeycomb-parent io.fd.honeycomb.lisp lisp-aggregator 1.16.12-SNAPSHOT - lisp + ${project.artifactId} pom 4.0.0 - - 3.1.1 - + Aggregator for Honeycomb LISP plugin api diff --git a/nsh/Readme.adoc b/nsh/Readme.adoc deleted file mode 100644 index 1ae29484a..000000000 --- a/nsh/Readme.adoc +++ /dev/null @@ -1,14 +0,0 @@ -= nsh - -This is a Honeycomb plugin providing mapping code between HC and NSH_SFC Plugin APIs. - -== Usage - -Refer to nsh_postman_collection.json for sample requests. All capabilities of NSH_SFC are demo-ed there. - -In order to make HC NSH plugin work, need to start vpp and load nsh_sfc plugin first. - -Please follow the right order to support NSH_SFC feature: -(1). Creates vxlan-gpe interface. -(2). Creates nsh-entry. -(3). Creates nsh-map. \ No newline at end of file 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 @@ 4.0.0 io.fd.honeycomb.vppnsh vppnsh-api + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/nsh/asciidoc/Readme.adoc b/nsh/asciidoc/Readme.adoc new file mode 100644 index 000000000..1ae29484a --- /dev/null +++ b/nsh/asciidoc/Readme.adoc @@ -0,0 +1,14 @@ += nsh + +This is a Honeycomb plugin providing mapping code between HC and NSH_SFC Plugin APIs. + +== Usage + +Refer to nsh_postman_collection.json for sample requests. All capabilities of NSH_SFC are demo-ed there. + +In order to make HC NSH plugin work, need to start vpp and load nsh_sfc plugin first. + +Please follow the right order to support NSH_SFC feature: +(1). Creates vxlan-gpe interface. +(2). Creates nsh-entry. +(3). Creates nsh-map. \ No newline at end of file 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 @@ 4.0.0 io.fd.honeycomb.vppnsh vppnsh-impl + ${project.artifactId} 1.16.12-SNAPSHOT bundle 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 @@ - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../common/honeycomb-parent io.fd.honeycomb.nsh vppnsh-aggregator 1.16.12-SNAPSHOT - vppnsh + ${project.artifactId} pom 4.0.0 - - 3.1.1 - + Aggregator for Honeycomb NSH_SFC plugin + api impl diff --git a/pom.xml b/pom.xml index 2d06472c1..83b834da4 100644 --- a/pom.xml +++ b/pom.xml @@ -15,20 +15,25 @@ --> - - http://nexus.fd.io/content - + + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + common/honeycomb-parent + - io.fd.honeycomb + io.fd.honeycomb honeycomb-aggregator 1.16.12-SNAPSHOT honeycomb pom 4.0.0 - - 3.1.1 - + Honeycomb project root aggregator + + + https://git.fd.io/cgit/honeycomb/tree/ + common @@ -41,15 +46,4 @@ samples tools - - - - fdio-release - ${nexusproxy}/repositories/fd.io.release/ - - - fdio-snapshot - ${nexusproxy}/repositories/fd.io.snapshot/ - - 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/Readme.adoc deleted file mode 100644 index 1ee409164..000000000 --- a/samples/interfaces/Readme.adoc +++ /dev/null @@ -1,8 +0,0 @@ -= Openconfig-interfaces sample -This is a sample Honeycomb plugin implementing mapping for openconfig interfaces yang model - -== Data -Only sample data are used, that are not actually handled - -== Notifications -A sample notification was added to the models to showcase notification capabilities diff --git a/samples/interfaces/asciidoc/Readme.adoc b/samples/interfaces/asciidoc/Readme.adoc new file mode 100644 index 000000000..1ee409164 --- /dev/null +++ b/samples/interfaces/asciidoc/Readme.adoc @@ -0,0 +1,8 @@ += Openconfig-interfaces sample +This is a sample Honeycomb plugin implementing mapping for openconfig interfaces yang model + +== Data +Only sample data are used, that are not actually handled + +== Notifications +A sample notification was added to the models to showcase notification capabilities 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 @@ 4.0.0 io.fd.honeycomb.samples.interfaces interfaces-mapping + ${project.artifactId} 1.16.12-SNAPSHOT bundle 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 @@ 4.0.0 io.fd.honeycomb.samples.interfaces interfaces-models + ${project.artifactId} 1.16.12-SNAPSHOT bundle 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 @@ - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../../common/honeycomb-parent io.fd.honeycomb.samples.interfaces interfaces-aggregator 1.16.12-SNAPSHOT - interfaces + ${project.artifactId} pom 4.0.0 - - 3.1.1 - true 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 @@ 4.0.0 io.fd.honeycomb.samples.distro minimal-distribution + ${project.artifactId} 1.16.12-SNAPSHOT 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 @@ - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../common/honeycomb-parent io.fd.honeycomb samples-aggregator + ${project.artifactId} 1.16.12-SNAPSHOT - samples pom 4.0.0 - - 3.1.1 - + Aggregator for Honeycomb sample plugins true diff --git a/tools/archetype/Readme.adoc b/tools/archetype/Readme.adoc deleted file mode 100644 index e5528d7ee..000000000 --- a/tools/archetype/Readme.adoc +++ /dev/null @@ -1,13 +0,0 @@ -Honeycomb Plugin Archetype - - This is archetype for creating plugins for Honeycomb platform - -How to use it : - - archetype:generate -DarchetypeGroupId=io.fd.honeycomb.tools -DarchetypeArtifactId=honeycomb-plugin-archetype -DarchetypeVersion=1.16.12-SNAPSHOT - -This will generate main aggregator project containing two sub-projects - - -api - project that should contain yang model files for restconf/netconf DTO classes - -impl - implementation project that should contain plugin translation code + wiring - diff --git a/tools/archetype/asciidoc/Readme.adoc b/tools/archetype/asciidoc/Readme.adoc new file mode 100644 index 000000000..e5528d7ee --- /dev/null +++ b/tools/archetype/asciidoc/Readme.adoc @@ -0,0 +1,13 @@ +Honeycomb Plugin Archetype + + This is archetype for creating plugins for Honeycomb platform + +How to use it : + + archetype:generate -DarchetypeGroupId=io.fd.honeycomb.tools -DarchetypeArtifactId=honeycomb-plugin-archetype -DarchetypeVersion=1.16.12-SNAPSHOT + +This will generate main aggregator project containing two sub-projects + + -api - project that should contain yang model files for restconf/netconf DTO classes + -impl - implementation project that should contain plugin translation code + wiring + diff --git a/tools/archetype/pom.xml b/tools/archetype/pom.xml index 38dbcc81f..1bb56074d 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"> - honeycomb-tools - io.fd.honeycomb.tools + io.fd.honeycomb.common + honeycomb-parent 1.16.12-SNAPSHOT + ../../common/honeycomb-parent - 4.0.0 io.fd.honeycomb.tools honeycomb-plugin-archetype + ${project.artifactId} 1.16.12-SNAPSHOT jar + 4.0.0 true diff --git a/tools/archetype/src/main/resources/archetype-resources/__rootArtifactId__-impl/Readme.adoc b/tools/archetype/src/main/resources/archetype-resources/__rootArtifactId__-impl/Readme.adoc deleted file mode 100644 index 8b4288e55..000000000 --- a/tools/archetype/src/main/resources/archetype-resources/__rootArtifactId__-impl/Readme.adoc +++ /dev/null @@ -1,3 +0,0 @@ ---Documentation for ${rootArtifactId} -- - -TODO Replace with general description whats the purpose of ${rootArtifactId} and how it works diff --git a/tools/archetype/src/main/resources/archetype-resources/asciidoc/Readme.adoc b/tools/archetype/src/main/resources/archetype-resources/asciidoc/Readme.adoc new file mode 100644 index 000000000..8b4288e55 --- /dev/null +++ b/tools/archetype/src/main/resources/archetype-resources/asciidoc/Readme.adoc @@ -0,0 +1,3 @@ +--Documentation for ${rootArtifactId} -- + +TODO Replace with general description whats the purpose of ${rootArtifactId} and how it works diff --git a/tools/archetype/src/main/resources/archetype-resources/pom.xml b/tools/archetype/src/main/resources/archetype-resources/pom.xml index 5445d6e7f..0b69b9b68 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. ---> - - - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - +--> + ${groupId} ${rootArtifactId}-aggregator @@ -26,9 +21,6 @@ ${rootArtifactId}-aggregator pom 4.0.0 - - 3.1.1 - ${rootArtifactId}-api diff --git a/tools/asciidoc/Readme.adoc b/tools/asciidoc/Readme.adoc new file mode 100644 index 000000000..c76ce615a --- /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 f5a1371b2..78fae3aaa 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"> - honeycomb-aggregator - io.fd.honeycomb + io.fd.honeycomb.common + honeycomb-parent 1.16.12-SNAPSHOT + ../common/honeycomb-parent - 4.0.0 io.fd.honeycomb.tools honeycomb-tools + ${project.artifactId} pom 1.16.12-SNAPSHOT + 4.0.0 + Aggregator for various Honeycomb tools true diff --git a/v3po/Readme.adoc b/v3po/Readme.adoc deleted file mode 100644 index 96d1d5a9b..000000000 --- a/v3po/Readme.adoc +++ /dev/null @@ -1,7 +0,0 @@ -= V3po - -This is a Honeycomb plugin providing mapping code between HC and VPP core APIs. - -== Usage - -Refer to postman_rest_collection.json for sample requests. All capabilities of V3po are demo-ed there \ No newline at end of file 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 @@ 4.0.0 io.fd.honeycomb.v3po v3po-api + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/v3po/asciidoc/Readme.adoc b/v3po/asciidoc/Readme.adoc new file mode 100644 index 000000000..96d1d5a9b --- /dev/null +++ b/v3po/asciidoc/Readme.adoc @@ -0,0 +1,7 @@ += V3po + +This is a Honeycomb plugin providing mapping code between HC and VPP core APIs. + +== Usage + +Refer to postman_rest_collection.json for sample requests. All capabilities of V3po are demo-ed there \ No newline at end of file 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 @@ - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../common/honeycomb-parent io.fd.honeycomb.v3po v3po-aggregator 1.16.12-SNAPSHOT - v3po + ${project.artifactId} pom 4.0.0 - - 3.1.1 - + Aggregator for Honeycomb V3PO(VPP core APIs) plugin + api v3po2vpp 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 @@ 4.0.0 io.fd.honeycomb.v3po v3po2vpp + ${project.artifactId} 1.16.12-SNAPSHOT bundle 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 @@ 4.0.0 io.fd.honeycomb.vpp naming-context-api + ${project.artifactId} 1.16.12-SNAPSHOT bundle 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 @@ 4.0.0 io.fd.honeycomb.vpp naming-context-impl + ${project.artifactId} 1.16.12-SNAPSHOT bundle 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 @@ - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../common/honeycomb-parent io.fd.honeycomb.vpp vpp-common-aggregator 1.16.12-SNAPSHOT - vpp-common + ${project.artifactId} pom 4.0.0 - - 3.1.1 - + Aggregator for Honeycomb common code used by Honeycomb plugins for VPP + vpp-translate-utils naming-context-api @@ -39,6 +38,7 @@ vpp-impl-parent vpp-translate-test + 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 @@ 4.0.0 io.fd.honeycomb.vpp vpp-impl-parent + ${project.artifactId} 1.16.12-SNAPSHOT + pom + 16.12-SNAPSHOT - pom 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/Readme.adoc deleted file mode 100644 index 1aaaea181..000000000 --- a/vpp-common/vpp-translate-utils/Readme.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Honeycomb. VPP translation layer utils - -Provides utility classes useful in translation layer implementation for the VPP. \ No newline at end of file diff --git a/vpp-common/vpp-translate-utils/asciidoc/Readme.adoc b/vpp-common/vpp-translate-utils/asciidoc/Readme.adoc new file mode 100644 index 000000000..1aaaea181 --- /dev/null +++ b/vpp-common/vpp-translate-utils/asciidoc/Readme.adoc @@ -0,0 +1,3 @@ += Honeycomb. VPP translation layer utils + +Provides utility classes useful in translation layer implementation for the VPP. \ No newline at end of file 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 @@ 4.0.0 - io.fd.honeycomb.vpp vpp-translate-utils + ${project.artifactId} 1.16.12-SNAPSHOT bundle diff --git a/vpp-integration/Readme.adoc b/vpp-integration/Readme.adoc deleted file mode 100644 index cba82974b..000000000 --- a/vpp-integration/Readme.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= VPP-integration - -This is an integration project building HC distribution for VPP, including all available HC plugins for VPP diff --git a/vpp-integration/asciidoc/Readme.adoc b/vpp-integration/asciidoc/Readme.adoc new file mode 100644 index 000000000..cba82974b --- /dev/null +++ b/vpp-integration/asciidoc/Readme.adoc @@ -0,0 +1,3 @@ += VPP-integration + +This is an integration project building HC distribution for VPP, including all available HC plugins for VPP 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 @@ 4.0.0 io.fd.honeycomb.vpp.integration vpp-integration-distribution + ${project.artifactId} 1.16.12-SNAPSHOT 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 @@ - org.opendaylight.odlparent - odlparent - 1.6.2-Beryllium-SR2 - + io.fd.honeycomb.common + honeycomb-parent + 1.16.12-SNAPSHOT + ../common/honeycomb-parent io.fd.honeycomb.vpp.integration vpp-integration + ${project.artifactId} 1.16.12-SNAPSHOT pom 4.0.0 - - 3.1.1 - + Aggregator for Honeycomb's VPP distribution. Aggregating all VPP plugins. minimal-distribution -- cgit 1.2.3-korg