summaryrefslogtreecommitdiffstats
path: root/docs/releasenotes
diff options
context:
space:
mode:
authorcristinapauna <cristina.pauna@enea.com>2016-09-08 16:38:15 +0300
committerAlexandru Avadanii <Alexandru.Avadanii@enea.com>2016-09-16 16:17:22 +0000
commit03b8df9bdd857c87aebc6f5b3ea320080fbeb72a (patch)
tree262f80f55d4a7e8242a416db546efe4d0147fe7c /docs/releasenotes
parenta05c0d1dcdf8b28a9478fed2310c3ae480bec46e (diff)
docs: Copy OPNFV docs dir as documentation base
There has been some restructuring of the documentation in fuel project. This commit copies those files, while a subsequent commit will adapt the documentation with aarch64 specifics. Change-Id: I56b52d5d16975b88fd5b26099b43046c6a5d5747 Signed-off-by: cristinapauna <cristina.pauna@enea.com> (cherry picked from commit b832a3e82070e12dff555e2a83d604de7e398acb)
Diffstat (limited to 'docs/releasenotes')
-rw-r--r--docs/releasenotes/index.rst16
-rw-r--r--docs/releasenotes/release-notes.rst250
2 files changed, 266 insertions, 0 deletions
diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
new file mode 100644
index 00000000..db97a749
--- /dev/null
+++ b/docs/releasenotes/index.rst
@@ -0,0 +1,16 @@
+.. 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
new file mode 100644
index 00000000..fa9e98e0
--- /dev/null
+++ b/docs/releasenotes/release-notes.rst
@@ -0,0 +1,250 @@
+.. 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 1.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 1.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 "Beryllium SR3" [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'
+
+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.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | Colorado 1.0 follow-up release |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | September 22 2016 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | Colorado alignment to Released |
+| | Fuel 9.0 baseline + Bug-fixes for |
+| | the following feaures/scenarios: |
+| | - NFV Hypervisors-KVM |
+| | - Open vSwitch for NFV |
+| | - OpenDaylight |
+| | - SDN distributed routing and VPN |
+| | - Service function chaining |
+| | |
++--------------------------------------+--------------------------------------+
+
+Version change
+==============
+
+Module version changes
+----------------------
+This is a follow-up release to Colorado 1.0. It is based on
+following upstream versions:
+
+- Fuel 9.0 Base release
+
+- OpenStack Mitaka release
+
+- OpenDaylight Beryllium SR3 release [1]_
+
+- ONOS Drake release
+
+Document changes
+----------------
+This is a follow-up release to Colorado 1.0. 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:**
+
+`Workarounds <https://jira.opnfv.org/issues/?filter=11121>`_ 'https://jira.opnfv.org/issues/?filter=11121'
+
+(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=11119>`_ 'https://jira.opnfv.org/issues/?filter=11119'
+
+(Also See respective Integrated feature project's bug tracking)
+
+Workarounds
+===========
+
+**JIRA TICKETS:**
+
+`Workarounds <https://jira.opnfv.org/issues/?filter=11120>`_ 'https://jira.opnfv.org/issues/?filter=11120'
+
+(Also See respective Integrated feature project's bug tracking)
+
+============
+Test results
+============
+The Colorado 1.0 release with the Fuel deployment tool has undergone QA test
+runs, see separate test results.
+
+==========
+References
+==========
+For more information on the OPNFV Colorado 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 <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/'
+
+8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html>`_ 'https://docs.fuel-infra.org/openstack/fuel/fuel-9.0/mos-planning-guide.html'
+
+9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/quickstart-guide.html'
+
+10) `Fuel reference architecture <https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html>`_ 'https://docs.mirantis.com/openstack/fuel/fuel-9.0/reference-architecture.html'
+
+11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_ 'https://wiki.openstack.org/wiki/Fuel/Plugins'
+
+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/docs/installation-instruction.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/installation-instruction.html'
+
+14) `OPNFV Build instruction for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/build-instruction.html'
+
+15) `OPNFV Release Note for the Colorado release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html>`_ 'http://artifacts.opnfv.org/fuel/colorado/docs/release-notes.html'
+
+.. [1] OpenDaylight Boron RC2 is used when Service Function Chaining is enabled in Fuel plugin.