docs/release/scenarios/os-nosdn-openbaton-ha/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) <optionally add copywriters name>
   4
   5
   6 Abstract
   7 ========
   8
   9 This document compiles the release notes for the Fraser release of
  10 OPNFV when using JOID as a deployment tool with the Open Baton NFV MANO framework
  11  provided by the OPNFV orchestra project.
  12
  13 Introduction
  14 ============
  15
  16 These notes provides release information for the use of joid as deployment
  17 tool for the Fraser release of OPNFV for orchestra
  18 scenario.
  19
  20 The goal of the Fraser release and this JOID based deployment process is
  21 to establish a lab ready platform accelerating further development
  22 of the OPNFV infrastructure.
  23
  24 Carefully follow the installation-instructions which guides a user to deploy
  25 OPNFV using JOID which is based on MAAS and Juju.
  26
  27 Summary
  28 =======
  29
  30 The OPNFV Orchestra project integrates the upstream open source Open Baton project within OPNFV.
  31 Open Baton is the result of an agile design process having as major objective the development
  32 of an extensible and customizable framework capable of orchestrating network services across
  33 heterogeneous NFV Infrastructures.
  34
  35 Fraser release with the JOID deployment enables deployment of orchestra
  36  on a Pharos compliant lab infrastructure.
  37
  38 The current definition of an OPNFV target system is based on OpenStack Ocata.
  39
  40     The system is deployed with OpenStack High Availability (HA) for most OpenStack services.
  41
  42     User has following choices to make to do the deployment.
  43
  44     - Openstack      -- Ocata
  45     - Type           -- HA, nonHA, tip (stable git branch of respective openstack)
  46     - Feature        -- Open Baton (NFV MANO framework)
  47
  48 NOTE: Detailed information on how to install in your lab can be find in installation guide
  49 command to deploy orchestra feature is:
  50
  51 #Orchestra deployment with no HA Openstack
  52 ./deploy.sh -o ocata -m openstack -f openbaton -s nosdn -t nonha
  53
  54 #Orchestra deployment with no HA Openstack
  55 ./deploy.sh -o ocata -m openstack -f openbaton -s nosdn -t ha
  56
  57
  58 Using Openstack
  59 ===============
  60
  61 admin-openrc file have been placed under ~/joid_config/
  62 Please source the same and use OpenStack API to do rest of the configuration.
  63
  64 Using Orchestra (Open Baton) after Deployment
  65 =============================================
  66
  67 Considering that there are no major differences between the Open Baton installed within
  68 OPNFV platform and the upstream one, feel free to follow the upstram documentation provided
  69 by the Open Baton project to learn more advanced use cases: http://openbaton.github.io/documentation/
  70
  71 Release Data
  72 ============
  73
  74 +--------------------------------------+--------------------------------------+
  75 | **Project**                          | JOID                                 |
  76 |                                      |                                      |
  77 +--------------------------------------+--------------------------------------+
  78 | **Repo/tag**                         | gerrit.opnfv.org/gerrit/joid.git     |
  79 |                                      | stable/hrates                     |
  80 +--------------------------------------+--------------------------------------+
  81 | **Release designation**              | Fraser release                       |
  82 |                                      |                                      |
  83 +--------------------------------------+--------------------------------------+
  84 | **Release date**                     | March 31 2018                        |
  85 |                                      |                                      |
  86 +--------------------------------------+--------------------------------------+
  87 | **Purpose of the delivery**          | Fraser release                       |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90
  91 Deliverables
  92 ------------
  93
  94 Software deliverables
  95 ~~~~~~~~~~~~~~~~~~~~~
  96 `JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=summary>`_
  97
  98 Known Limitations, Issues and Workarounds
  99 =========================================
 100
 101 Known issues
 102 ------------
 103
 104 **JIRA TICKETS:**
 105
 106 +--------------------------------------+--------------------------------------+
 107 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 108 |                                      |                                      |
 109 +--------------------------------------+--------------------------------------+
 110 | JIRA:                                |                                      |
 111 +--------------------------------------+--------------------------------------+
 112
 113
 114 Scenario Releases
 115 =================
 116
 117 Name:      os-nosdn-openbaton-ha
 118 Test Link: https://build.opnfv.org/ci/job/joid-deploy-baremetal-daily-hrates
 119 Notes:
 120
 121 References
 122 ==========
 123 KVM
 124 ---
 125 - `JUJU Openstack charm <https://jujucharms.com/openstack-telemetry/>`_
 126 - `KVM hypervisor <https://help.ubuntu.com/community/KVM/Installation>`_
 127
 128 Juju
 129 ----
 130 - `Juju Charm store <https://jujucharms.com/>`_
 131 - `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
 132
 133 MAAS
 134 ----
 135 - `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
 136 - `MAAS API documents <http://maas.ubuntu.com/docs/>`_
 137
 138 JOID
 139 ----
 140 - `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
 141 - `OPNFV JOID Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_
 142
 143 OpenStack
 144 ---------
 145 - `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_
 146 - `OpenStack documentation <http://docs.openstack.org>`_
 147
 148 Orchestra
 149 ---------
 150 - `Orchestra Release Notes <http://docs.opnfv.org/en/stable-hrates/submodules/orchestra/docs/release/release-notes/index.html#orchestra-releasenotes>`_
 151 - `Open Baton documentation <http://openbaton.github.io/documentation/>`_
 152