diff options
author | Alexandru Avadanii <Alexandru.Avadanii@enea.com> | 2016-04-22 15:38:45 +0200 |
---|---|---|
committer | Alexandru Avadanii <Alexandru.Avadanii@enea.com> | 2016-05-02 14:38:49 +0000 |
commit | c695afba33c538032af751dd02748f83ff4c877c (patch) | |
tree | bc9e8583207ed92fdd3f35bb1b088ce39f7d9ad2 /docs/release-notes.rst | |
parent | 25ac022f9ff13907a78855e29ff6488fb2979b11 (diff) |
Copy OPNFV docs dir as documentation base.
Armband Fuel for aarch64 is very similar to amd64 in both
configuration and deployment, with a small difference in the build
process.
Therefore it makes sense to base our documentation on Jonas'
work in OPNFV Fuel.
(cherry picked from commit 719cf0300eb2c63375dde152851d6ba73ca99498)
Change-Id: I34e7b1ef7bc2f7928ebb04c39ed0a1d48c3a4b54
Diffstat (limited to 'docs/release-notes.rst')
-rw-r--r-- | docs/release-notes.rst | 232 |
1 files changed, 232 insertions, 0 deletions
diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 00000000..e731af02 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,232 @@ +============================================================================================ +OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool +============================================================================================ + +License +======= + +This work is licensed under a Creative Commons Attribution 4.0 International +License. .. http://creativecommons.org/licenses/by/4.0 .. +(c) Jonas Bjurel (Ericsson AB) and others + +Abstract +======== + +This document compiles the release notes for the Brahmaputra 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 Brahmaputra release of OPNFV. + +The goal of the Brahmaputra 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 Brahmaputra, the typical use of Fuel as an OpenStack installer is +supplemented with OPNFV unique components such as: + +- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium RC1 as" + +- `ONOS <http://onosproject.org/>`_ version "Drake" + +- `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>`_ + +As well as OPNFV-unique configurations of the Hardware- and Software stack. + +This Brahmaputra 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 Brahmaputra Fuel installer image (.iso) built by Jenkins + +- Automated deployment of Brahmaputra with running on bare metal or a nested hypervisor environment (KVM) + +- Automated validation of the Brahmaputra deployment + + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | fuel | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | brahmaputra.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Brahmaputra base release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | February 25 2016 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Brahmaputra base release | +| | | ++--------------------------------------+--------------------------------------+ + +Version change +-------------- + +Module version changes +~~~~~~~~~~~~~~~~~~~~~~ +This is the second tracked release of genesis/fuel. It is based on +following upstream versions: + +- Fuel 8.0 pre-release + +- OpenStack Liberty release + +- OpenDaylight Beryllium release + +- ONOS Drake release + +Document changes +~~~~~~~~~~~~~~~~ +This is the third tracked version of the fuel installer for OPNFV. 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:** + +`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-99?filter=11001>`_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001' + +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=11000>`_ 'https://jira.opnfv.org/issues/?filter=11000' + +Workarounds +----------- + + + +Test results +============ +The Brahmaputra release with the Fuel deployment tool has undergone QA test +runs, see separate test results. + +References +========== +For more information on the OPNFV Brahmaputra release, please see: + +OPNFV +----- + +1) `OPNFV Home Page <www.opnfv.org>`_ + +2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ + +OpenStack +--------- + +3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_ + +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 overview <https://docs.fuel-infra.org/openstack/fuel/fuel-7.0/#guides>`_ + +8) `Fuel planning guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0/planning-guide.html>`_ + +9) `Fuel user guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_ + +10) `Fuel operations guide <http://docs.mirantis.com/openstack/fuel/fuel-7.0/operations.html>`_ + +11) `Fuel Plugin Developers Guide <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>`_ + +Fuel in OPNFV +------------- + +13) OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool + +14) OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool + +15) OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool |