aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/index.rst9
-rw-r--r--doc/template-override/.keep0
-rw-r--r--doc/template-override/opendaylight-source.rst38
3 files changed, 47 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
index c63a9d2ed..54e620212 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -55,3 +55,12 @@ Developer Docs
CONTRIBUTING
running-tests
bug-triage
+
+Template Override Docs
+======================
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ template-override/*
diff --git a/doc/template-override/.keep b/doc/template-override/.keep
deleted file mode 100644
index e69de29bb..000000000
--- a/doc/template-override/.keep
+++ /dev/null
diff --git a/doc/template-override/opendaylight-source.rst b/doc/template-override/opendaylight-source.rst
new file mode 100644
index 000000000..caf980774
--- /dev/null
+++ b/doc/template-override/opendaylight-source.rst
@@ -0,0 +1,38 @@
+==================
+OpenDaylight Build
+==================
+
+To build OpenDaylight, use of a template override
+`opendaylight-template-overrides.j2` is needed.
+The template override enables OpenDaylight use
+with OpenStack by installing required networking-odl
+plugin in neutron-server container.
+
+If you wish to install a different version of OpenDaylight
+then distro packages, use a source build (in most cases this is
+a prebuilt binary package).
+
+Building OpenDaylight Containers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+- For source builds append the following to kolla-build.conf,
+ selecting the version of OpenDaylight to use for your source build.
+
+- Change `opendaylight_distro` to match the folder where OpenDaylight
+ build resides. For example, if using prebuilt archive from OpenDaylight
+ downloads `distribution-karaf-0.5.3-Boron-SR3.tar.gz` becomes
+ `distribution-karaf-0.5.3-Boron-SR3`.
+
+kolla-build.conf
+________________
+.. code-block:: console
+
+ opendaylight_distro = distribution-karaf-0.5.3-Boron-SR3
+ [opendaylight]
+ type = url
+ location = https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/integration/distribution-karaf/0.5.3-Boron-SR3/distribution-karaf-0.5.3-Boron-SR3.tar.gz
+
+Build the container (source or binary) by executing the following command::
+::
+ kolla-build --template-override contrib/template-override/opendaylight-template-overrides.j2 opendaylight