aboutsummaryrefslogtreecommitdiffstats
path: root/docs/reference
diff options
context:
space:
mode:
authorJohn DeNisco <jdenisco@cisco.com>2018-08-17 14:25:15 -0400
committerDamjan Marion <dmarion@me.com>2018-08-17 19:40:10 +0000
commita5db42f366798034e464442c92a90529fc947f08 (patch)
treeae96e6b332a7f5585a94a4ae069511f9fe07add9 /docs/reference
parentbf21dc85053931bc597e0fab1112061aa60e986b (diff)
docs: Moved installing up a level, removed guides.
Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/index.rst1
-rw-r--r--docs/reference/jvpp.rst47
2 files changed, 48 insertions, 0 deletions
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
index 23ddecdc280..521caedca25 100644
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@@ -8,6 +8,7 @@ Reference
:maxdepth: 2
vppvagrant/index.rst
+ jvpp.rst
readthedocs/index.rst
github/index.rst
cmdreference/index.rst
diff --git a/docs/reference/jvpp.rst b/docs/reference/jvpp.rst
new file mode 100644
index 00000000000..7dab4876782
--- /dev/null
+++ b/docs/reference/jvpp.rst
@@ -0,0 +1,47 @@
+.. _jvpp:
+
+.. toctree::
+
+Getting jvpp jar
+================
+
+VPP provides java bindings which can be downloaded at:
+
+* https://nexus.fd.io/content/repositories/fd.io.release/io/fd/vpp/jvpp-core/18.01/jvpp-core-18.01.jar
+
+Getting jvpp via maven
+------------------------------------
+
+**1. Add the following to the repositories section in your ~/.m2/settings.xml to pick up the fd.io maven repo:**
+
+.. code-block:: console
+
+ <repository>
+ <id>fd.io-release</id>
+ <name>fd.io-release</name>
+ <url>https://nexus.fd.io/content/repositories/fd.io.release/</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+
+For more information on setting up maven repositories in settings.xml, please look at:
+
+* https://maven.apache.org/guides/mini/guide-multiple-repositories.html
+
+**2. Then you can get jvpp by putting in the dependencies section of your pom.xml file:**
+
+.. code-block:: console
+
+ <dependency>
+ <groupId>io.fd.vpp</groupId>
+ <artifactId>jvpp-core</artifactId>
+ <version>17.10</version>
+ </dependency>
+
+For more information on maven dependency managment, please look at:
+
+* https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html