diff options
| -rw-r--r-- | docs/release-notes/index.rst | 2 | ||||
| -rw-r--r-- | docs/release-notes/release-notes.rst | 97 |
2 files changed, 82 insertions, 17 deletions
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst index c8cad46f..3180b64d 100644 --- a/docs/release-notes/index.rst +++ b/docs/release-notes/index.rst @@ -3,7 +3,7 @@ .. (c) <optionally add copywriters name> ======================= -<project> Release Notes +JOID Release Notes ======================= .. toctree:: diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst index 545e1d9b..1f3e95a1 100644 --- a/docs/release-notes/release-notes.rst +++ b/docs/release-notes/release-notes.rst @@ -13,32 +13,60 @@ Abstract ======== This document compiles the release notes for the Brahmaputra release of -OPNFV when using <XYZ> as a deployment tool. +OPNFV when using JOID as a deployment tool. Introduction ============ -Provide a breif introduction of how this release is used in OPNFV relese using <XYZ> as a deployment tool +These notes provides release information for the use of joid as deployment +tool for the Brahmaputra release of OPNFV. -Be sure to reference your installation-instructions. +The goal of the Brahmaputra 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 +======= + + Brahmaputra 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 Liberty 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 Brahmaputra. 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 -- Liberty + - 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** | | +| **Project** | JOID | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | | -| | | +| **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git | +| | stable/brahmaputra | +--------------------------------------+--------------------------------------+ -| **Release designation** | | +| **Release designation** | Brahmaputra release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | | +| **Release date** | February 25 2016 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | | +| **Purpose of the delivery** | Brahmaputra release | | | | +--------------------------------------+--------------------------------------+ @@ -47,11 +75,14 @@ Deliverables Software deliverables ~~~~~~~~~~~~~~~~~~~~~ -<XYZ>-based installer iso file <iso file version> +`JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=summary>`_ Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- + +- Installation instructions +- Release notes (This document) +- User guide Version change -------------- @@ -59,9 +90,16 @@ Version change Module version change ~~~~~~~~~~~~~~~~~~~~~ + Brahmaputra release with the JOID deployment toolchain. + - OpenStack (Liberty release) + - OpenDaylight (Beryllium release) + - Ubuntu 14.04 LTS Document version change ~~~~~~~~~~~~~~~~~~~~~~~ +- OPNFV Installation instructions for the Brahmaputra 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 ---------------------- @@ -73,11 +111,11 @@ Feature additions | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | | +| JIRA: JOID-1 | use Juju and Ubuntu to deploy OPNFV | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | +| JIRA: JOID-23 | explain how to deploy OPNFV R2 | +| | using JOID | +--------------------------------------+--------------------------------------+ Bug corrections @@ -99,6 +137,8 @@ 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 ------------ @@ -122,11 +162,36 @@ See JIRA: <link> Test Result =========== -Brahmaputra test result using <XYZ> as deployment tool. +Brahmaputra test result using JOID as deployment tool. <link> References ========== For more information on the OPNFV Brahmaputra release, please visit -http://www.opnfv.org/brahmaputra +- `OPNFV Brahmaputra release <http://www.opnfv.org/brahmaputra>`_ + +Juju +---- +- `Juju Charm store <https://jujucharms.com/>`_ +- `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_ + +MAAS +---- +- `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_ +- `MAAS API documents <http://maas.ubuntu.com/docs/>`_ + +JOID +---- +- `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_ +- `OPNFV JOID User Guide <https://wiki.opnfv.org/joid/b_userguide>`_ +- `OPNFV JOID Install Guide <https://wiki.opnfv.org/joid/b_installguide>`_ + +OpenStack +--------- +- `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_ +- `OpenStack documentation <http://docs.openstack.org>`_ + +OpenDaylight +------------ +- `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ |