summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/build-instruction.rst9
-rw-r--r--docs/conf.py28
-rw-r--r--docs/configguide/installerconfig.rst10
-rw-r--r--docs/index.rst22
-rw-r--r--docs/installation-instruction.rst5
-rw-r--r--docs/release-notes.rst21
6 files changed, 49 insertions, 46 deletions
diff --git a/docs/build-instruction.rst b/docs/build-instruction.rst
index d5721af0b..254c0d3f2 100644
--- a/docs/build-instruction.rst
+++ b/docs/build-instruction.rst
@@ -1,9 +1,6 @@
-================================================================================================
+=================================================================================================
OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
-================================================================================================
-
-.. contents:: Table of Contents
- :backlinks: none
+=================================================================================================
License
=======
@@ -87,7 +84,7 @@ Then restart docker:
.. code-block:: console
-$ sudo service docker restart
+ $ sudo service docker restart
Setting up OPNFV Gerrit in order to being able to clone the code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 000000000..6cd69313d
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,28 @@
+# SPDX-license-identifier: Apache-2.0
+##############################################################################
+# Copyright (c) 2016 Linux Foundation and others.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+# Copied from releng/docs/etc/conf.py
+extensions = ['sphinxcontrib.httpdomain',
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.napoleon']
+
+needs_sphinx = '1.3'
+master_doc = 'index'
+pygments_style = 'sphinx'
+
+html_use_index = False
+numfig = True
+html_logo = 'opnfv-logo.png'
+
+latex_domain_indices = False
+latex_logo = 'opnfv-logo.png'
+
+# addtional config
+latex_elements = {'figure_align': 'H'}
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
index ea08b6d31..60ffadf1f 100644
--- a/docs/configguide/installerconfig.rst
+++ b/docs/configguide/installerconfig.rst
@@ -69,7 +69,7 @@ Following high level hardware requirements must be met:
+--------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
-+--------------------+------------------------------------------------------+
++====================+======================================================+
| **# of nodes** | Minimum 5 (3 for non redundant deployment): |
| | |
| | - 1 Fuel deployment master (may be virtualized) |
@@ -155,7 +155,7 @@ developed by OPNFV:
+--------------------+------------------------------------------------------+
| **Plugin name** | **Short description** |
| | |
-+--------------------+------------------------------------------------------+
++====================+======================================================+
| OpenDaylight | OpenDaylight provides an open-source SDN Controller |
| | providing networking features such as L2 and L3 |
| | network control, "Service Function Chaining", |
@@ -212,8 +212,8 @@ developed by OPNFV:
*Additional third-party plugins can be found here:*
*https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/*
-**Note: Plugins are not necessarilly compatible with each other, see <TODO>
-for compatibility information**
+**Note: Plugins are not necessarilly compatible with each other, see section
+"Configuration options, OPNFV scenarios" for compatibility information**
The plugins come prepackaged, ready to install. To do so follow the
installation instructions provided in *Reference 13* provided in section
@@ -237,7 +237,7 @@ The plugins of your choice need to be enabled and configured.
To enable a plugin, follow the installation instructions found in
*Reference 13*, provided in section *"Fuel associated references"* below.
-For configuration of the plugins, please refer to the corresponding feature in the ????? <TODO>
+For configuration of the plugins, please see section "Feature Configuration".
Networking
^^^^^^^^^^
diff --git a/docs/index.rst b/docs/index.rst
index fd61a5201..6bba3aaf1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,32 +4,16 @@
.. You should have received a copy of the license along with this work.
.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
-.. OPNFV Release Engineering documentation, created by
- sphinx-quickstart on Tue Jun 9 19:12:31 2015.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-.. image:: opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-
+**********
Fuel@OPNFV
-=======================================
-
-Contents:
+**********
.. toctree::
:maxdepth: 4
- :titlesonly:
build-instruction.rst
installation-instruction.rst
release-notes.rst
-* :ref:`search`
-
-Revision: _sha1_
+.. :titlesonly:
-Build date: |today|
diff --git a/docs/installation-instruction.rst b/docs/installation-instruction.rst
index aaf96becb..f7125816d 100644
--- a/docs/installation-instruction.rst
+++ b/docs/installation-instruction.rst
@@ -2,9 +2,6 @@
OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
========================================================================================================
-.. contents:: Table of Contents
- :backlinks: none
-
License
=======
@@ -111,7 +108,7 @@ installation of Brahmaputra using Fuel:
+--------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
| | |
-+--------------------+------------------------------------------------------+
++====================+======================================================+
| **# of nodes** | Minimum 5 (3 for non redundant deployment): |
| | |
| | - 1 Fuel deployment master (may be virtualized) |
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 253859bfe..e731af02c 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -2,9 +2,6 @@
OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool
============================================================================================
-.. contents:: Table of Contents
- :backlinks: none
-
License
=======
@@ -104,7 +101,7 @@ following upstream versions:
- OpenStack Liberty release
-- OpenDaylight Beryllium pre-release <TODO>
+- OpenDaylight Beryllium release
- ONOS Drake release
@@ -121,19 +118,20 @@ comes with the following documentation:
Reason for version
------------------
+
Feature additions
~~~~~~~~~~~~~~~~~
**JIRA TICKETS:**
-`New features <https://jira.opnfv.org/browse/FUEL-81?jql=project%20%3D%20FUEL%20AND%20issuetype%20in%20%28Improvement%2C%20%22New%20Feature%22%2C%20Story%2C%20Sub-task%29%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_
+`New features <https://jira.opnfv.org/issues/?filter=11002>`_ 'https://jira.opnfv.org/issues/?filter=11002'
Bug corrections
~~~~~~~~~~~~~~~
**JIRA TICKETS:**
-`Bug-fixes <https://jira.opnfv.org/browse/FUEL-96?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Resolved%2C%20Closed%29%20AND%20resolution%20%3D%20Fixed%20AND%20labels%20in%20%28Fuel-B-WP1%2C%20R2%2C%20brahmaputra%29>`_
+`Bug-fixes <https://jira.opnfv.org/browse/FUEL-99?filter=11001>`_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001'
Deliverables
------------
@@ -162,7 +160,7 @@ System Limitations
- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
-- **Storage:** Ceph is the only supported storage configuration.
+- **Storage:** Ceph is the only supported storage configuration
- **Max number of networks:** 65k
@@ -172,22 +170,21 @@ Known issues
**JIRA TICKETS:**
-`Known issues <https://jira.opnfv.org/browse/FUEL-99?jql=project%20%3D%20FUEL%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29>`_
+`Known issues <https://jira.opnfv.org/issues/?filter=11000>`_ 'https://jira.opnfv.org/issues/?filter=11000'
Workarounds
-----------
--
+
Test results
============
The Brahmaputra release with the Fuel deployment tool has undergone QA test
-runs with the following results:
-<TODO>
+runs, see separate test results.
References
==========
-For more information on the OPNFV Brahmaputra release, please see
+For more information on the OPNFV Brahmaputra release, please see:
OPNFV
-----