aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/buildprocedure/index.rst16
-rw-r--r--docs/conf.py28
-rw-r--r--docs/development/overview/build/build.instruction.rst (renamed from docs/buildprocedure/build.instruction.rst)28
-rw-r--r--docs/development/overview/build/index.rst16
-rw-r--r--docs/installationprocedure/img/fuelmenu1.pngbin9276 -> 0 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu2.pngbin9774 -> 0 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu3.pngbin9783 -> 0 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu4.pngbin8843 -> 0 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu5.pngbin20442 -> 0 bytes
-rw-r--r--docs/installationprocedure/img/fuelmenu6.pngbin10322 -> 0 bytes
-rw-r--r--docs/installationprocedure/img/grub-1.pngbin388991 -> 0 bytes
-rw-r--r--docs/installationprocedure/index.rst15
-rw-r--r--docs/release/installation/img/addnodes.png (renamed from docs/installationprocedure/img/addnodes.png)bin24089 -> 24089 bytes
-rw-r--r--docs/release/installation/img/compute.png (renamed from docs/installationprocedure/img/compute.png)bin25978 -> 25978 bytes
-rw-r--r--docs/release/installation/img/computelist.png (renamed from docs/installationprocedure/img/computelist.png)bin67975 -> 67975 bytes
-rw-r--r--docs/release/installation/img/fuelconsole1.png (renamed from docs/installationprocedure/img/fuelconsole1.png)bin8269 -> 8269 bytes
-rw-r--r--docs/release/installation/img/fuelmenu1.pngbin0 -> 24730 bytes
-rw-r--r--docs/release/installation/img/fuelmenu2.pngbin0 -> 26118 bytes
-rw-r--r--docs/release/installation/img/fuelmenu3.pngbin0 -> 25739 bytes
-rw-r--r--docs/release/installation/img/fuelmenu4.pngbin0 -> 24365 bytes
-rw-r--r--docs/release/installation/img/fuelmenu5.pngbin0 -> 26661 bytes
-rw-r--r--docs/release/installation/img/fuelmenu6.pngbin0 -> 27230 bytes
-rw-r--r--docs/release/installation/img/grub-1.pngbin0 -> 464529 bytes
-rw-r--r--docs/release/installation/img/health.png (renamed from docs/installationprocedure/img/health.png)bin51840 -> 51840 bytes
-rw-r--r--docs/release/installation/img/interfaceconf.png (renamed from docs/installationprocedure/img/interfaceconf.png)bin25676 -> 25676 bytes
-rw-r--r--docs/release/installation/img/interfaces.png (renamed from docs/installationprocedure/img/interfaces.png)bin58851 -> 58851 bytes
-rw-r--r--docs/release/installation/img/network.png (renamed from docs/installationprocedure/img/network.png)bin55423 -> 55423 bytes
-rw-r--r--docs/release/installation/img/neutronl3.png (renamed from docs/installationprocedure/img/neutronl3.png)bin40478 -> 40478 bytes
-rw-r--r--docs/release/installation/img/newenv.png (renamed from docs/installationprocedure/img/newenv.png)bin37483 -> 37483 bytes
-rw-r--r--docs/release/installation/img/nodes.png (renamed from docs/installationprocedure/img/nodes.png)bin9155 -> 9155 bytes
-rw-r--r--docs/release/installation/img/offloadingmodes.png (renamed from docs/installationprocedure/img/offloadingmodes.png)bin23017 -> 23017 bytes
-rw-r--r--docs/release/installation/img/other.png (renamed from docs/installationprocedure/img/other.png)bin41526 -> 41526 bytes
-rw-r--r--docs/release/installation/img/plugin_install.png (renamed from docs/installationprocedure/img/plugin_install.png)bin17431 -> 17431 bytes
-rw-r--r--docs/release/installation/img/plugins.png (renamed from docs/installationprocedure/img/plugins.png)bin52382 -> 52382 bytes
-rw-r--r--docs/release/installation/img/verifynet.png (renamed from docs/installationprocedure/img/verifynet.png)bin33162 -> 33162 bytes
-rw-r--r--docs/release/installation/index.rst15
-rw-r--r--docs/release/installation/installation.instruction.rst (renamed from docs/installationprocedure/installation.instruction.rst)124
-rw-r--r--docs/release/release-notes/index.rst15
-rw-r--r--docs/release/release-notes/release-notes.rst223
-rw-r--r--docs/releasenotes/index.rst16
-rw-r--r--docs/releasenotes/release-notes.rst260
41 files changed, 318 insertions, 438 deletions
diff --git a/docs/buildprocedure/index.rst b/docs/buildprocedure/index.rst
deleted file mode 100644
index 4f88814b5..000000000
--- a/docs/buildprocedure/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. This document is protected/licensed under the following conditions
-.. (c) Jonas Bjurel (Ericsson AB)
-.. Licensed under a Creative Commons Attribution 4.0 International License.
-.. You should have received a copy of the license along with this work.
-.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-*********************************
-Build instruction for Fuel\@OPNFV
-*********************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- build.instruction.rst
-
diff --git a/docs/conf.py b/docs/conf.py
deleted file mode 100644
index 6cd69313d..000000000
--- a/docs/conf.py
+++ /dev/null
@@ -1,28 +0,0 @@
-# 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/buildprocedure/build.instruction.rst b/docs/development/overview/build/build.instruction.rst
index 1ee53a1e9..5fe38cbfa 100644
--- a/docs/buildprocedure/build.instruction.rst
+++ b/docs/development/overview/build/build.instruction.rst
@@ -1,15 +1,13 @@
-.. This document is protected/licensed under the following conditions
-.. (c) Jonas Bjurel (Ericsson AB)
-.. Licensed under a Creative Commons Attribution 4.0 International License.
-.. You should have received a copy of the license along with this work.
-.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
========
Abstract
========
This document describes how to build the Fuel deployment tool for the
-Colorado release of OPNFV build system, dependencies and required
+Danube release of OPNFV build system, dependencies and required
system resources.
============
@@ -17,7 +15,7 @@ Introduction
============
This document describes the build system used to build the Fuel
-deployment tool for the Colorado release of OPNFV, required
+deployment tool for the Danube release of OPNFV, required
dependencies and minimum requirements on the host to be used for the
build system.
@@ -120,12 +118,12 @@ Now it is time to clone the code repository:
Now you should have the OPNFV fuel repository with the Fuel
directories stored locally on your build host.
-Check out the Colorado release:
+Check out the Danube release:
.. code-block:: bash
$ cd fuel
- $ git checkout colorado.3.0
+ $ git checkout danube.1.0
Clone the OPNFV code Git repository without a SSH key
-----------------------------------------------------
@@ -205,7 +203,7 @@ Configure your build environment
================================
** Configuring the build environment should not be performed if building
-standard Colorado release **
+standard Danube release **
Select the versions of the components you want to build by editing the
fuel/build/config.mk file.
@@ -293,13 +291,3 @@ The artifacts produced are:
replaced with the build identity provided to the build system
- <OPNFV_XXXX.iso.txt> - Which holds version metadata.
-
-==========
-References
-==========
-
-1) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html
-
-2) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html
-
-3) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html
diff --git a/docs/development/overview/build/index.rst b/docs/development/overview/build/index.rst
new file mode 100644
index 000000000..240afbdd4
--- /dev/null
+++ b/docs/development/overview/build/index.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _fuel-development-overview-build-label:
+
+*********************************
+Build instruction for Fuel\@OPNFV
+*********************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ build.instruction.rst
+
diff --git a/docs/installationprocedure/img/fuelmenu1.png b/docs/installationprocedure/img/fuelmenu1.png
deleted file mode 100644
index ee7a0edb2..000000000
--- a/docs/installationprocedure/img/fuelmenu1.png
+++ /dev/null
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu2.png b/docs/installationprocedure/img/fuelmenu2.png
deleted file mode 100644
index 4dcbb6e68..000000000
--- a/docs/installationprocedure/img/fuelmenu2.png
+++ /dev/null
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu3.png b/docs/installationprocedure/img/fuelmenu3.png
deleted file mode 100644
index 23e61975b..000000000
--- a/docs/installationprocedure/img/fuelmenu3.png
+++ /dev/null
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu4.png b/docs/installationprocedure/img/fuelmenu4.png
deleted file mode 100644
index 3be29cd66..000000000
--- a/docs/installationprocedure/img/fuelmenu4.png
+++ /dev/null
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu5.png b/docs/installationprocedure/img/fuelmenu5.png
deleted file mode 100644
index e3d215459..000000000
--- a/docs/installationprocedure/img/fuelmenu5.png
+++ /dev/null
Binary files differ
diff --git a/docs/installationprocedure/img/fuelmenu6.png b/docs/installationprocedure/img/fuelmenu6.png
deleted file mode 100644
index cafbcddfc..000000000
--- a/docs/installationprocedure/img/fuelmenu6.png
+++ /dev/null
Binary files differ
diff --git a/docs/installationprocedure/img/grub-1.png b/docs/installationprocedure/img/grub-1.png
deleted file mode 100644
index e64b79373..000000000
--- a/docs/installationprocedure/img/grub-1.png
+++ /dev/null
Binary files differ
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
deleted file mode 100644
index 8e61be219..000000000
--- a/docs/installationprocedure/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. This document is protected/licensed under the following conditions
-.. (c) Jonas Bjurel (Ericsson AB)
-.. Licensed under a Creative Commons Attribution 4.0 International License.
-.. You should have received a copy of the license along with this work.
-.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-****************************************
-Installation instruction for Fuel\@OPNFV
-****************************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- installation.instruction.rst
diff --git a/docs/installationprocedure/img/addnodes.png b/docs/release/installation/img/addnodes.png
index b62405692..b62405692 100644
--- a/docs/installationprocedure/img/addnodes.png
+++ b/docs/release/installation/img/addnodes.png
Binary files differ
diff --git a/docs/installationprocedure/img/compute.png b/docs/release/installation/img/compute.png
index fc1cf0f22..fc1cf0f22 100644
--- a/docs/installationprocedure/img/compute.png
+++ b/docs/release/installation/img/compute.png
Binary files differ
diff --git a/docs/installationprocedure/img/computelist.png b/docs/release/installation/img/computelist.png
index 474196536..474196536 100644
--- a/docs/installationprocedure/img/computelist.png
+++ b/docs/release/installation/img/computelist.png
Binary files differ
diff --git a/docs/installationprocedure/img/fuelconsole1.png b/docs/release/installation/img/fuelconsole1.png
index 61703cab1..61703cab1 100644
--- a/docs/installationprocedure/img/fuelconsole1.png
+++ b/docs/release/installation/img/fuelconsole1.png
Binary files differ
diff --git a/docs/release/installation/img/fuelmenu1.png b/docs/release/installation/img/fuelmenu1.png
new file mode 100644
index 000000000..4b5097ff4
--- /dev/null
+++ b/docs/release/installation/img/fuelmenu1.png
Binary files differ
diff --git a/docs/release/installation/img/fuelmenu2.png b/docs/release/installation/img/fuelmenu2.png
new file mode 100644
index 000000000..42cd75f62
--- /dev/null
+++ b/docs/release/installation/img/fuelmenu2.png
Binary files differ
diff --git a/docs/release/installation/img/fuelmenu3.png b/docs/release/installation/img/fuelmenu3.png
new file mode 100644
index 000000000..174cb5004
--- /dev/null
+++ b/docs/release/installation/img/fuelmenu3.png
Binary files differ
diff --git a/docs/release/installation/img/fuelmenu4.png b/docs/release/installation/img/fuelmenu4.png
new file mode 100644
index 000000000..0e218fca7
--- /dev/null
+++ b/docs/release/installation/img/fuelmenu4.png
Binary files differ
diff --git a/docs/release/installation/img/fuelmenu5.png b/docs/release/installation/img/fuelmenu5.png
new file mode 100644
index 000000000..b1063d576
--- /dev/null
+++ b/docs/release/installation/img/fuelmenu5.png
Binary files differ
diff --git a/docs/release/installation/img/fuelmenu6.png b/docs/release/installation/img/fuelmenu6.png
new file mode 100644
index 000000000..16d641e9f
--- /dev/null
+++ b/docs/release/installation/img/fuelmenu6.png
Binary files differ
diff --git a/docs/release/installation/img/grub-1.png b/docs/release/installation/img/grub-1.png
new file mode 100644
index 000000000..113178948
--- /dev/null
+++ b/docs/release/installation/img/grub-1.png
Binary files differ
diff --git a/docs/installationprocedure/img/health.png b/docs/release/installation/img/health.png
index 57bd8cf70..57bd8cf70 100644
--- a/docs/installationprocedure/img/health.png
+++ b/docs/release/installation/img/health.png
Binary files differ
diff --git a/docs/installationprocedure/img/interfaceconf.png b/docs/release/installation/img/interfaceconf.png
index e00b03f03..e00b03f03 100644
--- a/docs/installationprocedure/img/interfaceconf.png
+++ b/docs/release/installation/img/interfaceconf.png
Binary files differ
diff --git a/docs/installationprocedure/img/interfaces.png b/docs/release/installation/img/interfaces.png
index 291e434f6..291e434f6 100644
--- a/docs/installationprocedure/img/interfaces.png
+++ b/docs/release/installation/img/interfaces.png
Binary files differ
diff --git a/docs/installationprocedure/img/network.png b/docs/release/installation/img/network.png
index 7bef05064..7bef05064 100644
--- a/docs/installationprocedure/img/network.png
+++ b/docs/release/installation/img/network.png
Binary files differ
diff --git a/docs/installationprocedure/img/neutronl3.png b/docs/release/installation/img/neutronl3.png
index 36291ef87..36291ef87 100644
--- a/docs/installationprocedure/img/neutronl3.png
+++ b/docs/release/installation/img/neutronl3.png
Binary files differ
diff --git a/docs/installationprocedure/img/newenv.png b/docs/release/installation/img/newenv.png
index d6bc2827f..d6bc2827f 100644
--- a/docs/installationprocedure/img/newenv.png
+++ b/docs/release/installation/img/newenv.png
Binary files differ
diff --git a/docs/installationprocedure/img/nodes.png b/docs/release/installation/img/nodes.png
index 771e4813d..771e4813d 100644
--- a/docs/installationprocedure/img/nodes.png
+++ b/docs/release/installation/img/nodes.png
Binary files differ
diff --git a/docs/installationprocedure/img/offloadingmodes.png b/docs/release/installation/img/offloadingmodes.png
index 5b3cb17bc..5b3cb17bc 100644
--- a/docs/installationprocedure/img/offloadingmodes.png
+++ b/docs/release/installation/img/offloadingmodes.png
Binary files differ
diff --git a/docs/installationprocedure/img/other.png b/docs/release/installation/img/other.png
index c088488dc..c088488dc 100644
--- a/docs/installationprocedure/img/other.png
+++ b/docs/release/installation/img/other.png
Binary files differ
diff --git a/docs/installationprocedure/img/plugin_install.png b/docs/release/installation/img/plugin_install.png
index ff50633ed..ff50633ed 100644
--- a/docs/installationprocedure/img/plugin_install.png
+++ b/docs/release/installation/img/plugin_install.png
Binary files differ
diff --git a/docs/installationprocedure/img/plugins.png b/docs/release/installation/img/plugins.png
index 8f7ea596f..8f7ea596f 100644
--- a/docs/installationprocedure/img/plugins.png
+++ b/docs/release/installation/img/plugins.png
Binary files differ
diff --git a/docs/installationprocedure/img/verifynet.png b/docs/release/installation/img/verifynet.png
index e675562c0..e675562c0 100644
--- a/docs/installationprocedure/img/verifynet.png
+++ b/docs/release/installation/img/verifynet.png
Binary files differ
diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
new file mode 100644
index 000000000..cc45cb3fa
--- /dev/null
+++ b/docs/release/installation/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _fuel-release-installation-label:
+
+****************************************
+Installation instruction for Fuel\@OPNFV
+****************************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ installation.instruction.rst
diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
index 548dff8c3..bec26ae15 100644
--- a/docs/installationprocedure/installation.instruction.rst
+++ b/docs/release/installation/installation.instruction.rst
@@ -1,14 +1,12 @@
-.. This document is protected/licensed under the following conditions
-.. (c) Jonas Bjurel (Ericsson AB)
-.. Licensed under a Creative Commons Attribution 4.0 International License.
-.. You should have received a copy of the license along with this work.
-.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
========
Abstract
========
-This document describes how to install the Colorado release of
+This document describes how to install the Danube release of
OPNFV when using Fuel as a deployment tool, covering its usage,
limitations, dependencies and required system resources.
@@ -17,14 +15,14 @@ Introduction
============
This document provides guidelines on how to install and
-configure the Colorado release of OPNFV when using Fuel as a
+configure the Danube release of OPNFV when using Fuel as a
deployment tool, including required software and hardware configurations.
Although the available installation options give a high degree of
freedom in how the system is set-up, including architecture, services
and features, etc., said permutations may not provide an OPNFV
compliant reference architecture. This instruction provides a
-step-by-step guide that results in an OPNFV Colorado compliant
+step-by-step guide that results in an OPNFV Danube compliant
deployment.
The audience of this document is assumed to have good knowledge in
@@ -34,7 +32,7 @@ networking and Unix/Linux administration.
Preface
=======
-Before starting the installation of the Colorado release of
+Before starting the installation of the Danube release of
OPNFV, using Fuel as a deployment tool, some planning must be
done.
@@ -42,25 +40,25 @@ Retrieving the ISO image
========================
First of all, the Fuel deployment ISO image needs to be retrieved, the
-Fuel .iso image of the Colorado release can be found at *Reference: 2*
+Fuel .iso image of the Danube release can be found at `OPNFV Downloads <https://www.opnfv.org/software/download>`_.
Building the ISO image
======================
Alternatively, you may build the Fuel .iso from source by cloning the
-opnfv/fuel git repository. To retrieve the repository for the Colorado
+opnfv/fuel git repository. To retrieve the repository for the Danube
release use the following command:
.. code-block:: bash
$ git clone https://gerrit.opnfv.org/gerrit/fuel
-Check-out the Colorado release tag to set the HEAD to the
-baseline required to replicate the Colorado release:
+Check-out the Danube release tag to set the HEAD to the
+baseline required to replicate the Danube release:
.. code-block:: bash
- $ git checkout colorado.3.0
+ $ git checkout danube.1.0
Go to the fuel directory and build the .iso:
@@ -68,20 +66,20 @@ Go to the fuel directory and build the .iso:
$ cd fuel/build; make all
-For more information on how to build, please see *Reference: 14*
+For more information on how to build, please see :ref:`Build instruction for Fuel\@OPNFV <fuel-development-overview-build-label>`
Other preparations
==================
Next, familiarize yourself with Fuel by reading the following documents:
-- Fuel Installation Guide, please see *Reference: 8*
+- `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_
-- Fuel User Guide, please see *Reference: 9*
+- `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
-- Fuel Developer Guide, please see *Reference: 10*
+- `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_
-- Fuel Plugin Developers Guide, please see *Reference: 11*
+- `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_
Prior to installation, a number of deployment specific parameters must be collected, those are:
@@ -110,7 +108,7 @@ Hardware requirements
=====================
The following minimum hardware requirements must be met for the
-installation of Colorado using Fuel:
+installation of Danube using Fuel:
+--------------------+------------------------------------------------------+
| **HW Aspect** | **Requirement** |
@@ -150,7 +148,7 @@ Help with Hardware Requirements
Calculate hardware requirements:
-For information on compatible hardware types available for use, please see *Reference: 11*.
+For information on compatible hardware types available for use, please see `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_.
When choosing the hardware on which you will deploy your OpenStack
environment, you should think about:
@@ -184,9 +182,9 @@ the Fuel OPNFV reference platform. All the networks involved in the OPNFV
infrastructure as well as the provider networks and the private tenant
VLANs needs to be manually configured.
-Manual configuration of the Colorado hardware platform should
-be carried out according to the OPNFV Pharos specification:
-<https://wiki.opnfv.org/display/pharos/Pharos+Specification>
+Manual configuration of the Danube hardware platform should
+be carried out according to the `OPNFV Pharos Specification
+<https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_.
==========================================
OPNFV Software installation and deployment
@@ -199,7 +197,7 @@ reference platform stack across a server cluster.
Install Fuel master
===================
-#. Mount the Colorado Fuel ISO file/media as a boot device to the jump host server.
+#. Mount the Danube Fuel ISO file/media as a boot device to the jump host server.
#. Reboot the jump host to establish the Fuel server.
@@ -231,7 +229,7 @@ Install Fuel master
#. In the "PXE Setup" section (see figure below) - Change the following fields to appropriate values (example below):
- - DHCP Pool Start 10.20.0.3
+ - DHCP Pool Start 10.20.0.4
- DHCP Pool End 10.20.0.254
@@ -526,28 +524,6 @@ Allocate nodes to environment and assign functional roles
.. figure:: img/interfaceconf.png
-OPTIONAL - Set Local Mirror Repos
-=================================
-
-The following steps must be executed if you are in an environment with
-no connection to the Internet. The Fuel server delivers a local repo
-that can be used for installation / deployment of openstack.
-
-#. In the Fuel UI of your Environment, click the Settings Tab and select General from the left pane.
-
- - Replace the URI values for the "Name" values outlined below:
-
- - "ubuntu" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty main universe multiverse"
-
- - "ubuntu-security" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-security main universe multiverse"
-
- - "ubuntu-updates" URI="deb http://<ip-of-fuel-server>:8080/mirrors/ubuntu/ trusty-updates main universe multiverse"
-
- - "mos" URI="deb http://<ip-of-fuel-server>::8080/mitaka-9.0/ubuntu/x86_64 mos9.0 main restricted"
-
- - "Auxiliary" URI="deb http://<ip-of-fuel-server>:8080/mitaka-9.0/ubuntu/auxiliary auxiliary main restricted"
-
- - Click <Save Settings> at the bottom to Save your changes
Target specific configuration
=============================
@@ -641,51 +617,33 @@ Installation health-check
.. figure:: img/health.png
-==========
-References
-==========
-OPNFV
-=====
+=============
+Release Notes
+=============
-1) `OPNFV Home Page <http://www.opnfv.org>`_: http://www.opnfv.org
+Please refer to the :ref:`Release Notes <fuel-release-notes-label>` article.
-2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_: https://www.opnfv.org/software/download
+==========
+References
+==========
OpenStack
-=========
-
-3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_: http://www.openstack.org/software/mitaka
-4) `OpenStack documentation <http://docs.openstack.org>`_: http://docs.openstack.org
+3) `OpenStack Newton Release Artifacts <http://www.openstack.org/software/newton>`_
+4) `OpenStack Documentation <http://docs.openstack.org>`_
OpenDaylight
-============
-5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_: http://www.opendaylight.org/software/downloads
+5) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
Fuel
-====
-
-6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel
-
-7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs
-
-8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html
-
-9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html
-
-10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html
-
-11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html
-
-12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list
-
-Fuel in OPNFV
-=============
-
-13) `OPNFV Installation instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html
-14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html
+6) `The Fuel OpenStack Project <https://wiki.openstack.org/wiki/Fuel>`_
+7) `Fuel Documentation Overview <http://docs.openstack.org/developer/fuel-docs>`_
+8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_
+9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_
+10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_
+11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_
+12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/software/hardware-compatibility/>`_
-15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html>`_: http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644
index 000000000..9cdc01ef0
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _fuel-release-notes-label:
+
+*****************************
+Release notes for Fuel\@OPNFV
+*****************************
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ release-notes.rst
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
new file mode 100644
index 000000000..465d0881a
--- /dev/null
+++ b/docs/release/release-notes/release-notes.rst
@@ -0,0 +1,223 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+========
+Abstract
+========
+
+This document compiles the release notes for the Danube release of
+OPNFV when using Fuel as a deployment tool.
+
+===============
+Important Notes
+===============
+
+These notes provides release information for the use of Fuel as deployment
+tool for the Danube release of OPNFV.
+
+The goal of the Danube release and this Fuel-based deployment process is
+to establish a lab ready platform accelerating further development
+of the OPNFV infrastructure.
+
+Carefully follow the installation-instructions provided in *Reference 13*.
+
+=======
+Summary
+=======
+
+For Danube, the typical use of Fuel as an OpenStack installer is
+supplemented with OPNFV unique components such as:
+
+- `OpenDaylight <http://www.opendaylight.org/software>`_
+- `Service Function Chaining <https://wiki.opnfv.org/service_function_chaining>`_
+- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_
+- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
+- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
+- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_
+- `Promise <https://wiki.opnfv.org/display/promise>`_
+- `Parser <https://wiki.opnfv.org/display/parser>`_
+- `Doctor <https://wiki.opnfv.org/display/doctor>`_
+
+As well as OPNFV-unique configurations of the Hardware and Software stack.
+
+This Danube artifact provides Fuel as the deployment stage tool in the
+OPNFV CI pipeline including:
+
+- Documentation built by Jenkins
+
+ - overall OPNFV documentation
+
+ - this document (release notes)
+
+ - installation instructions
+
+ - build-instructions
+
+- The Danube Fuel installer image (.iso) built by Jenkins
+
+- Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM)
+
+- Automated validation of the Danube deployment
+
+============
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project** | fuel |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/tag** | danube.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | Danube 1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | March 27 2017 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | Danube alignment to Released |
+| | Fuel 10.0 baseline + features and |
+| | bug-fixes for the following |
+| | feaures: |
+| | - NFV Hypervisors-KVM |
+| | - Open vSwitch for NFV |
+| | - OpenDaylight |
+| | - SDN distributed routing and VPN |
+| | - Service function chaining |
+| | - Promise |
+| | - Parser |
+| | - Doctor |
+| | - Tacker |
++--------------------------------------+--------------------------------------+
+
+Version Change
+==============
+
+Module Version Changes
+----------------------
+This is the Danube 1.0 release.
+It is based on following upstream versions:
+
+- Fuel 10.0 Base Release
+
+- OpenStack Newton Release
+
+- OpenDaylight
+
+Document Changes
+----------------
+This is the Danube 1.0 release.
+It comes with the following documentation:
+
+- Installation instructions
+
+- Build instructions
+
+- Release notes (This document)
+
+Reason for Version
+==================
+
+Feature Additions
+-----------------
+
+**JIRA TICKETS:**
+
+
+Bug Corrections
+---------------
+
+**JIRA TICKETS:**
+
+`Danube 1.0 bug fixes <https://jira.opnfv.org/issues/?filter=11406>`_
+
+(Also See respective Integrated feature project's bug tracking)
+
+Deliverables
+============
+
+Software Deliverables
+---------------------
+
+Fuel-based installer iso file found in `OPNFV Downloads <https://www.opnfv.org/software/download>`.
+
+Documentation Deliverables
+--------------------------
+
+- Installation instructions
+
+- Build instructions
+
+- Release notes(This document)
+
+=========================================
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+==================
+
+- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
+
+- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
+
+- **Storage:** Ceph is the only supported storage configuration
+
+- **Max number of networks:** 65k
+
+
+Known Issues
+============
+
+**JIRA TICKETS:**
+
+`Known issues <https://jira.opnfv.org/issues/?filter=11407>`_
+
+(Also See respective Integrated feature project's bug tracking)
+
+Workarounds
+===========
+
+**JIRA TICKETS:**
+
+`Workarounds <https://jira.opnfv.org/issues/?filter=11408>`_
+
+(Also See respective Integrated feature project's bug tracking)
+
+============
+Test Results
+============
+The Danube 1.0 release with the Fuel deployment tool has undergone QA test
+runs, see separate test results.
+
+==========
+References
+==========
+For more information on the OPNFV Danube 1.0 release, please see:
+
+OPNFV
+=====
+
+1) `OPNFV Home Page <http://www.opnfv.org>`_
+2) `OPNFV Documentation - and Software Downloads <https://www.opnfv.org/software/download>`_
+
+OpenStack
+=========
+
+3) `OpenStack Newton Release Artifacts <http://www.openstack.org/software/newton>`_
+
+4) `OpenStack Documentation <http://docs.openstack.org>`_
+
+OpenDaylight
+============
+
+5) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
+
+Fuel
+====
+
+6) `The Fuel OpenStack Project <https://wiki.openstack.org/wiki/Fuel>`_
+7) `Fuel Documentation <http://docs.openstack.org/developer/fuel-docs>`_
+
diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
deleted file mode 100644
index db97a7492..000000000
--- a/docs/releasenotes/index.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. This document is protected/licensed under the following conditions
-.. (c) Jonas Bjurel (Ericsson AB)
-.. Licensed under a Creative Commons Attribution 4.0 International License.
-.. You should have received a copy of the license along with this work.
-.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-*****************************
-Release notes for Fuel\@OPNFV
-*****************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- release-notes.rst
-
diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst
deleted file mode 100644
index b7fcc3e2e..000000000
--- a/docs/releasenotes/release-notes.rst
+++ /dev/null
@@ -1,260 +0,0 @@
-.. This document is protected/licensed under the following conditions
-.. (c) Jonas Bjurel (Ericsson AB)
-.. Licensed under a Creative Commons Attribution 4.0 International License.
-.. You should have received a copy of the license along with this work.
-.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-========
-Abstract
-========
-
-This document compiles the release notes for the Colorado 3.0 release of
-OPNFV when using Fuel as a deployment tool.
-
-===============
-Important notes
-===============
-
-These notes provides release information for the use of Fuel as deployment
-tool for the Colorado 3.0 release of OPNFV.
-
-The goal of the Colorado release and this Fuel-based deployment process is
-to establish a lab ready platform accelerating further development
-of the OPNFV infrastructure.
-
-Carefully follow the installation-instructions provided in *Reference 13*.
-
-=======
-Summary
-=======
-
-For Colorado, the typical use of Fuel as an OpenStack installer is
-supplemented with OPNFV unique components such as:
-
-- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Boron" [1]_ 'http://www.opendaylight.org/software'
-
-- `ONOS <http://onosproject.org/>`_ version "Drake" 'http://onosproject.org/'
-
-- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_ 'https://wiki.opnfv.org/service_function_chaining'
-
-- `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_ 'https://wiki.opnfv.org/sdnvpn'
-
-- `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_ 'https://wiki.opnfv.org/nfv-kvm'
-
-- `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_ 'https://wiki.opnfv.org/ovsnfv'
-
-- `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_ 'https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases'
-
-- `Promise <https://wiki.opnfv.org/display/promise>`_ 'https://wiki.opnfv.org/display/promise'
-
-- `Parser <https://wiki.opnfv.org/display/parser>`_ 'https://wiki.opnfv.org/display/parser'
-
-- `Doctor <https://wiki.opnfv.org/display/doctor>`_ 'https://wiki.opnfv.org/display/doctor'
-
-As well as OPNFV-unique configurations of the Hardware- and Software stack.
-
-This Colorado artifact provides Fuel as the deployment stage tool in the
-OPNFV CI pipeline including:
-
-- Documentation built by Jenkins
-
- - overall OPNFV documentation
-
- - this document (release notes)
-
- - installation instructions
-
- - build-instructions
-
-- The Colorado Fuel installer image (.iso) built by Jenkins
-
-- Automated deployment of Colorado with running on bare metal or a nested hypervisor environment (KVM)
-
-- Automated validation of the Colorado deployment
-
-============
-Release Data
-============
-
-+--------------------------------------+--------------------------------------+
-| **Project** | fuel |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Repo/tag** | colorado.3.0 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release designation** | Colorado 3.0 follow-up release |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Release date** | December 05 2016 |
-| | |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | Colorado alignment to Released |
-| | Fuel 9.0 baseline + features and |
-| | bug-fixes for the following |
-| | feaures: |
-| | - NFV Hypervisors-KVM |
-| | - Open vSwitch for NFV |
-| | - OpenDaylight |
-| | - ONOS |
-| | - SDN distributed routing and VPN |
-| | - Service function chaining |
-| | - Promise |
-| | - Parser |
-| | - Doctor |
-| | - Tacker |
-+--------------------------------------+--------------------------------------+
-
-Version change
-==============
-
-Module version changes
-----------------------
-This is the Colorado 3.0 follow-up release.
-It is based on following upstream versions:
-
-- Fuel 9.0 Base release
-
-- OpenStack Mitaka release
-
-- OpenDaylight Boron release [1]_
-
-- ONOS Drake release
-
-Document changes
-----------------
-This is the Colorado 3.0 follow-up release.
-It comes with the following documentation:
-
-- Installation instructions - *Reference 13* - **Changed**
-
-- Build instructions - *Reference 14* - **Changed**
-
-- Release notes - *Reference 15* - **Changed** (This document)
-
-Reason for version
-==================
-
-Feature additions
------------------
-
-**JIRA TICKETS:**
-
-
-Bug corrections
----------------
-
-**JIRA TICKETS:**
-
-`Colorado 3.0 bug fixes <https://jira.opnfv.org/issues/?filter=11406>`_ 'https://jira.opnfv.org/issues/?filter=11406'
-
-(Also See respective Integrated feature project's bug tracking)
-
-Deliverables
-============
-
-Software deliverables
----------------------
-
-Fuel-based installer iso file found in *Reference 2*
-
-Documentation deliverables
---------------------------
-
-- Installation instructions - *Reference 13*
-
-- Build instructions - *Reference 14*
-
-- Release notes - *Reference 15* (This document)
-
-=========================================
-Known Limitations, Issues and Workarounds
-=========================================
-
-System Limitations
-==================
-
-- **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
-
-- **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
-
-- **Storage:** Ceph is the only supported storage configuration
-
-- **Max number of networks:** 65k
-
-
-Known issues
-============
-
-**JIRA TICKETS:**
-
-`Known issues <https://jira.opnfv.org/issues/?filter=11407>`_ 'https://jira.opnfv.org/issues/?filter=11407'
-
-(Also See respective Integrated feature project's bug tracking)
-
-Workarounds
-===========
-
-**JIRA TICKETS:**
-
-`Workarounds <https://jira.opnfv.org/issues/?filter=11408>`_ 'https://jira.opnfv.org/issues/?filter=11408'
-
-(Also See respective Integrated feature project's bug tracking)
-
-============
-Test results
-============
-The Colorado 3.0 release with the Fuel deployment tool has undergone QA test
-runs, see separate test results.
-
-==========
-References
-==========
-For more information on the OPNFV Colorado 3.0 release, please see:
-
-OPNFV
-=====
-
-1) `OPNFV Home Page <http://www.opnfv.org>`_ 'http://www.opnfv.org'
-
-2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ 'https://www.opnfv.org/software/download'
-
-OpenStack
-=========
-
-3) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ 'http://www.openstack.org/software/mitaka'
-
-4) `OpenStack documentation <http://docs.openstack.org>`_ 'http://docs.openstack.org'
-
-OpenDaylight
-============
-
-5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ 'http://www.opendaylight.org/software/downloads'
-
-Fuel
-====
-
-6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_: https://wiki.openstack.org/wiki/Fuel
-
-7) `Fuel documentation overview <http://docs.openstack.org/developer/fuel-docs>`_: http://docs.openstack.org/developer/fuel-docs
-
-8) `Fuel Installation Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html
-
-9) `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide.html
-
-10) `Fuel Developer Guide <http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html>`_: http://docs.openstack.org/developer/fuel-docs/devdocs/develop.html
-
-11) `Fuel Plugin Developers Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html>`_: http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide.html
-
-12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_: https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list
-
-Fuel in OPNFV
-=============
-
-13) `OPNFV Installation instruction for the Colorado 3.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html'
-
-14) `OPNFV Build instruction for the Colorado 3.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html'
-
-15) `OPNFV Release Note for the Colorado 3.0 release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html'
-
-.. [1] OpenDaylight Beryllium SR3 is used when BGP VPN is enabled in Fuel plugin.