summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortimirnich <tim.irnich@ericsson.com>2016-02-25 02:08:07 -0800
committertimirnich <tim.irnich@ericsson.com>2016-02-25 02:47:25 -0800
commit0eccc38cee2881d311381d81635dd00fb3870117 (patch)
treec1b2fbff058f5b77e2c625b15b35e5c7b4d6e1ea /docs
parent5ee78029ab664252b617978b8553261275914ffe (diff)
Changing filenames to match convention and update index.rst.
Some additional content for feature config guide. Fixing a typo in userguide. Change-Id: I1f3056535052e74ec893b9f3264a154a145c2350
Diffstat (limited to 'docs')
-rw-r--r--docs/configguide/featureconfig.rst11
-rwxr-xr-xdocs/index.rst4
-rw-r--r--docs/userguide/featureusage.rst (renamed from docs/userguide/userguide.rst)2
3 files changed, 11 insertions, 6 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
index ad41c22..b5c5f7b 100644
--- a/docs/configguide/featureconfig.rst
+++ b/docs/configguide/featureconfig.rst
@@ -6,10 +6,15 @@ Configuring SDNVPN features
---------------------------
Fuel installer configuration
-<Niko: explain which settings have to / can be chosen in Fuel to get SDN VPN
-deployed.>
-Feature configuration
+In order to install the BGPVPN feature, the corresponding checkbox in Fuel has to be
+selected. This will trigger installation of the OpenStack BGPVPN API extension for
+Neutron (set up for using the ODL driver).
+
+In addition, ODL has to be installed, see the corresponding section on how to
+install ODL. If the BGPVPN feature is installed, ODL will automatically be installed
+with VPN Service karaf feature activated.
+
No post-deploy configuration is necessary. The Fuel BGPVPN plugin and the ODL
plugin should set up the cluster in a way that it is ready for BGPVPNs being
created. This includes the set-up of internal VxLAN transport tunnels between
diff --git a/docs/index.rst b/docs/index.rst
index afd4625..63817ce 100755
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,8 +10,8 @@ SDNVPN Brahmaputra documentation
:maxdepth: 2
./platformoverview/platformoverview.rst
- ./configguide/configguide.rst
- ./userguide/userguide.rst
+ ./configguide/featureconfig.rst
+ ./userguide/featureusage.rst
Indices
=======
diff --git a/docs/userguide/userguide.rst b/docs/userguide/featureusage.rst
index 8d09397..672a009 100644
--- a/docs/userguide/userguide.rst
+++ b/docs/userguide/featureusage.rst
@@ -16,7 +16,7 @@ Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are
mapped onto the ODL VPN Service REST API through the BGPVPN ODL driver and the
ODL Neutron Northbound module.
-<Feature and API usage guidelines and example>
+Feature and API usage guidelines and example
-----------------------------------------------
For the details of using OpenStack BGPVPN API, please refer to the documentation