From f81feae24f7dabdccda36e40260c3dd501ef75c6 Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Fri, 17 Feb 2017 16:26:32 +0100 Subject: Doc updates for MS6 Updated the docs structure according to directives and MS6 Change-Id: I4bb888e4e997c625f7df088bc6563a54d63155db Signed-off-by: Sofia Wallin --- docs/release/release-notes/release-notes.rst | 232 +++++++++++++++++++++++++++ 1 file changed, 232 insertions(+) create mode 100644 docs/release/release-notes/release-notes.rst (limited to 'docs/release/release-notes/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 00000000..3d4f02a0 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,232 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) + + +Abstract +======== + +This document compiles the release notes for the Colorado release of +OPNFV when using JOID as a deployment tool. + +Introduction +============ + +These notes provides release information for the use of joid as deployment +tool for the Colorado release of OPNFV. + +The goal of the Colorado release and this JOID based deployment process is +to establish a lab ready platform accelerating further development +of the OPNFV infrastructure. + +Carefully follow the installation-instructions which guides a user to deploy +OPNFV using JOID which is based on MAAS and Juju. + +Summary +======= + + Colorado release with the JOID deployment toolchain will establish an OPNFV target system on a Pharos compliant lab infrastructure. +The current definition of an OPNFV target system is and OpenStack Mitaka combined with OpenDaylight Beryllium. + + The system is deployed with OpenStack High Availability (HA) for most OpenStack services. +Ceph storage is used as Cinder backend, and is the only supported storage for Colorado. Ceph is setup as 2 OSDs and 2 Monitors, one OSD+Mon per Compute node. + + User has following choices to make to do the deployment. + + - Openstack -- Mitaka + - Type -- HA, nonHA, tip (stable git branch of respective openstack) + - SDN controller -- OpenDaylight, nosdn(Openvswitch), Onos, OpenContrail + - Feature -- IPV6, DVR(distributed virtual routing), SFC(service function chaining odl only), BGPVPN(odl only) + +- Documentation is built by Jenkins +- Jenkins deploys a Brahmaputra release with the JOID deployment toolchain baremetal, + which includes 3 control+network nodes, and 2 compute nodes. + +NOTE: Detailed information on how to install in your lab can be find in installation guide + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | JOID | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | +| | stable/colorado | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Colorado release | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | September 22 2016 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Colorado release | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +------------ + +Software deliverables +~~~~~~~~~~~~~~~~~~~~~ +`JOID based installer script files `_ + +Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Installation instructions +- Release notes (This document) +- User guide + +Version change +-------------- +.. This section describes the changes made since the last version of this document. + +Module version change +~~~~~~~~~~~~~~~~~~~~~ + Colorado release with the JOID deployment toolchain. + - OpenStack (Mitaka release) + - OpenDaylight (Beryllium release) + - Ubuntu 16.04 LTS + +Document version change +~~~~~~~~~~~~~~~~~~~~~~~ +- OPNFV Installation instructions for the Colorado release using JOID deployment + toolchain - ver. 1.0.0 +- OPNFV Release Notes with the JOID deployment toolchain - ver. 1.0.0 (this document) + +Reason for new version +---------------------- + +Feature additions +~~~~~~~~~~~~~~~~~ + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-1 | use Juju and Ubuntu to deploy OPNFV | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-76 | Integrate Aodh in JOID | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-69 | OVS with DPDK | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-68 | ONOS Goldeneye Support | ++--------------------------------------+--------------------------------------+ +| JIRA: JOID-61 | Mitaka OpenStack Support | ++--------------------------------------+--------------------------------------+ + +Bug corrections +~~~~~~~~~~~~~~~ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | | +| | | ++--------------------------------------+--------------------------------------+ + + +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +------------------ +**Min jumphost requirements:** At least 16GB of RAM, 4 core cpu and 250 gb disk should support virtualization. + + +Known issues +------------ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: YARDSTICK-325 | Provide raw format yardstick vm image| +| | for nova-lxd scenario(OPNFV) | ++--------------------------------------+--------------------------------------+ +| JIRA: | | ++--------------------------------------+--------------------------------------+ + + +Workarounds +----------- +See JIRA: + + +Test Result +=========== +Colorado test result using JOID as deployment tool. +- `https://build.opnfv.org/ci/view/joid/job/functest-joid-baremetal-daily-colorado/>`_ +- `https://build.opnfv.org/ci/view/joid/job/yardstick-joid-baremetal-daily-colorado/>`_ + +Scenario Releases +================= +Name: joid-os-nosdn-nofeature-ha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-nofeature-ha-baremetal-daily-colorado/ +Notes: + +Name: joid-os-odl-nofeature-ha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-odl_l2-nofeature-ha-baremetal-daily-colorado/ +Notes: + +Name: joid-os-nosdn-lxd-ha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-ha-baremetal-daily-colorado/ +Notes: + +Name: joid-os-onos-nofeature-ha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-onos-nofeature-ha-baremetal-daily-colorado/ +Notes: + +Name: joid-os-onos-sfc-ha +Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-onos-sfc-ha-baremetal-daily-colorado/ +Notes: + +Name: joid-os-nosdn-lxd-noha +Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-colorado/ +Notes: + +Name: joid-os-nosdn-nofeature-noha +Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-nofeature-noha-baremetal-daily-colorado/ +Notes: + +Name: applies to all HA scenarios +Notes: +* 'COPPER-22 `_: + Congress service HA deployment is not yet supported/verified. + +References +========== +For more information on the OPNFV Colorado release, please visit +- `OPNFV Colorado release `_ + +Juju +---- +- `Juju Charm store `_ +- `Juju documents `_ + +MAAS +---- +- `Bare metal management (Metal-As-A-Service) `_ +- `MAAS API documents `_ + +JOID +---- +- `OPNFV JOID wiki `_ +- `OPNFV JOID User Guide `_ +- `OPNFV Release Notes `_ +- `OPNFV JOID Install Guide `_ + +OpenStack +--------- +- `OpenStack Mitaka Release artifacts `_ +- `OpenStack documentation `_ + +OpenDaylight +------------ +- `OpenDaylight artifacts `_ + -- cgit 1.2.3-korg