summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGerard Damm <gerard.damm@wipro.com>2018-05-22 18:48:52 -0500
committerGerard Damm <gerard.damm@wipro.com>2018-05-22 18:48:52 -0500
commitf19ad7f768a1fd6f7523a8e418b30bce2088ebce (patch)
treef594320d29742c31c448621e1cc254b9cc031e7b
parentb718a43380376d2b19222c4203c97a95ca849ae8 (diff)
Auto document updates for Fraser release 6.1
Updated: Release Notes and Configuration Guide. Reviewed User Guides, but no changes for 6.1. Change-Id: I9c800650d0fdae5e05ddcec60c518fffa193ee78 Signed-off-by: Gerard Damm <gerard.damm@wipro.com>
-rw-r--r--docs/release/configguide/Auto-featureconfig.rst14
-rw-r--r--docs/release/configguide/auto-OS-config4ONAP.pngbin0 -> 134668 bytes
-rw-r--r--docs/release/release-notes/Auto-release-notes.rst73
3 files changed, 58 insertions, 29 deletions
diff --git a/docs/release/configguide/Auto-featureconfig.rst b/docs/release/configguide/Auto-featureconfig.rst
index 4e9705f..af16a9b 100644
--- a/docs/release/configguide/Auto-featureconfig.rst
+++ b/docs/release/configguide/Auto-featureconfig.rst
@@ -14,9 +14,7 @@ and provides guidelines on how to perform configurations and additional installa
Goal
====
-The goal of `Auto <http://docs.opnfv.org/en/latest/release/release-notes.html>`_ installation and configuration is to prepare
-an environment where the `Auto use cases <http://docs.opnfv.org/en/latest/submodules/auto/docs/release/userguide/index.html#auto-userguide>`_
-can be assessed, i.e. where the corresponding test cases can be executed and their results can be collected.
+The goal of `Auto <http://docs.opnfv.org/en/latest/submodules/auto/docs/release/release-notes/index.html#auto-releasenotes>`_ installation and configuration is to prepare an environment where the `Auto use cases <http://docs.opnfv.org/en/latest/submodules/auto/docs/release/userguide/index.html#auto-userguide>`_ can be assessed, i.e. where the corresponding test cases can be executed and their results can be collected.
An instance of ONAP needs to be present, as well as a number of deployed VNFs, in the scope of the use cases.
@@ -57,8 +55,14 @@ server with the OpenStack instance.
.. image:: auto-installTarget-initial.jpg
-Jenkins will be used for Continuous Integration in OPNFV releases, to ensure that the latest master
-branch of Auto is always working.
+The OpenStack instance running VNFs may need to be configured as per ONAP expectations, for example creating instances of ONAP projects/tenants, users, security groups, networks (private, public), connected to the Internet by a Router, and making sure expected VM images and flavors are present. A script (using OpenStack SDK, or OpenStack CLI, or even OpenStack Heat templates) would populate the OpenStack instance, as illustrated below:
+
+.. image:: auto-OS-config4ONAP.png
+
+
+
+Jenkins (or more precisely JJB: Jenkins Job Builder) will be used for Continuous Integration in OPNFV releases, to ensure that the latest master
+branch of Auto is always working. The first 3 tasks in the pipeline would be: install OpenStack instance via OPNFV installer (Fuel/MCP for example), configure the OpenStack instance for ONAP, install ONAP (using the OpenStack instance network IDs in the ONAP YAMP file).
Moreover, Auto will offer an API, which can be imported as a module, and can be accessed for example
by a web application. The following diagram shows the planned structure for the Auto Git repository,
diff --git a/docs/release/configguide/auto-OS-config4ONAP.png b/docs/release/configguide/auto-OS-config4ONAP.png
new file mode 100644
index 0000000..ecde147
--- /dev/null
+++ b/docs/release/configguide/auto-OS-config4ONAP.png
Binary files differ
diff --git a/docs/release/release-notes/Auto-release-notes.rst b/docs/release/release-notes/Auto-release-notes.rst
index eab68cc..5318d09 100644
--- a/docs/release/release-notes/Auto-release-notes.rst
+++ b/docs/release/release-notes/Auto-release-notes.rst
@@ -7,13 +7,13 @@
Auto Release Notes
==================
-This document provides the release notes for Fraser release of Auto.
+This document provides the release notes for the Fraser release of Auto.
Important notes for this release
================================
-Initial release (project inception: July 2017).
+The initial release for Auto was in Fraser 6.0 (project inception: July 2017). This is the first point release, in Fraser 6.1.
Summary
@@ -54,29 +54,34 @@ Testability:
Auto’s goals include the standup and tests for integrated ONAP-Cloud platforms (“Cloud” here being OPNFV “scenarios” or other cloud environments). Thus, the artifacts would be tools to deploy ONAP (leveraging OOM whenever possible (starting with Beijing release of ONAP), and a preference for the containerized version of ONAP), to integrate it with clouds, to onboard and deploy test VNFs, to configure policies and closed-loop controls, and to run use-case defined tests against that integrated environment. OPNFV scenarios would be a possible component in the above.
-Auto currently defines three use cases: Edge Cloud, Resiliency Improvements, and Enterprise vCPE. These use cases aim to show:
+Auto currently defines three use cases: Edge Cloud (UC1), Resiliency Improvements (UC2), and Enterprise vCPE (UC3). These use cases aim to show:
-* increased autonomy of Edge Cloud management (automation, catalog-based deployment)
-* increased resilience (i.e. fast VNF recovery in case of failure or problem, thanks to closed-loop control), including end-to-end composite services of which a Cloud Manager may not be aware
+* increased autonomy of Edge Cloud management (automation, catalog-based deployment). This use case relates to the `OPNFV Edge Cloud <https://wiki.opnfv.org/display/PROJ/Edge+cloud>`_ initiative.
+* increased resilience (i.e. fast VNF recovery in case of failure or problem, thanks to closed-loop control), including end-to-end composite services of which a Cloud Manager may not be aware.
* enterprise-grade performance of vCPEs (certification during onboarding, then real-time performance assurance with SLAs and HA as well as scaling).
-The use cases define test cases, which initially will be independent, but which might eventually be integrated to FuncTest.
+The use cases define test cases, which initially will be independent, but which might eventually be integrated to `FuncTest <https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing>`_.
-Additional use cases can be added in the future, such as vIMS (example: project Clearwater).
+Additional use cases can be added in the future, such as vIMS (example: project Clearwater) or residential vHGW (virtual Home Gateways). The interest for vHGW is to reduce overall power consumption: even in idle mode, physical HGWs in residential premises consume a lot of energy. Virtualizing that service to the Service Provider edge data center would allow to minimize that consumption.
-Target architectures include x86 and Arm.
+Target architectures for all Auto use cases and test cases include x86 and Arm. Power consumption analysis will be performed, leveraging Functest tools.
+
+An ONAP instance (without DCAE) has been installed over Kubernetes on bare metal on an x86 pod of 6 servers at UNH IOL. A transition is in progress, to leverage OPNFV LaaS (Lab-as-a-Service) pods (`Pharos <https://labs.opnfv.org/>`_). These pods can be booked for 3 weeks only (with an extension for a maximum of 2 weeks), so are not a permanent resource. A repeatable automated installation procedure is being developed. An installation of ONAP on Kubernetes in a public OpenStack cloud on an Arm server has been done, and demonstrated during OpenStack Summit in Vancouver on May 21st 2018 (see link in references below).
-An ONAP instance (without DCAE) has been installed over Kubernetes on bare metal on an x86 pod of 6 servers at UNH IOL. A transition is in progress, to leverage OPNFV LaaS (Lab-as-a-Service) pods (`Pharos <https://labs.opnfv.org/>`_).
ONAP-based onboarding and deployment of VNFs is in progress (ONAP pre-loading of VNFs must still done outside of ONAP: for VM-based VNFs, need to prepare OpenStack stacks (using Heat templates), then make an instance snapshot which serves as the binary image of the VNF).
+An initial version of a script to prepare an OpenStack instance for ONAP (creation of a public and a private network, with a router) has been developed.
+
Integration with Arm servers has started (exploring binary compatibility):
* Openstack is currently installed on a 6-server pod of Arm servers
* A set of 14 additional Arm servers was deployed at UNH, for increased capacity
-* Arm-compatible Docker images are in the process of being developed
+* Arm-compatible Docker images are in the process of being developed (they were used in the OpenStack Summit demo)
Test case implementation for the three use cases has started.
+OPNFV CI/CD integration with JJD (Jenkins Job Description) has started: see the Auto plan description `here <https://wiki.opnfv.org/display/AUTO/CI+Plan+for+Auto>`_. The permanent resource for that is a 6-server Arm pod, hosted at UNH.
+
Finally, the following figure illustrates Auto in terms of project activities:
.. image:: auto-project-activities.png
@@ -87,16 +92,16 @@ Release Data
============
+--------------------------------------+--------------------------------------+
-| **Project** | Fraser/auto/auto@opnfv |
+| **Project** | Auto |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | |
+| **Repo/commit-ID** | auto/opnfv-6.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Fraser 6.0 |
+| **Release designation** | Fraser 6.1 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 2018-04-20 |
+| **Release date** | 2018-05-25 |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | Official OPNFV release |
@@ -122,7 +127,23 @@ Reason for version
Feature additions
~~~~~~~~~~~~~~~~~
-Initial release, with use case descriptions, release plan, and in-progress test cases and ONAP installations.
+Initial release 6.0:
+
+* Fraser release plan
+* use case descriptions
+* test case descriptions
+* in-progress test case development
+* lab: OPNFV and ONAP (Amsterdam) installations
+
+Point release 6.1:
+
+* added Gambia release plan
+* started integration with CI/CD (JJB) on permanent Arm pod
+* Arm demo at OpenStack Summit
+* initial script for configuring OpenStack instance for ONAP, using OpenStack SDK
+* initial attempts to install ONAP Beijing
+* alignment with OPNFV Edge Cloud
+* initial contacts with Functest
**JIRA TICKETS:**
@@ -140,15 +161,15 @@ Initial release, with use case descriptions, release plan, and in-progress test
| AUTO-7, UC3 definition | Define Auto-UC-03 Enterprise vCPE |
| | |
+--------------------------------------+--------------------------------------+
+| AUTO-3, UC1 test case definition | Develop test cases for Auto-UC-01 |
+| | SP's Management of Edge Cloud |
++--------------------------------------+--------------------------------------+
| AUTO-4, UC2 test case definition | Develop test cases for Auto-UC-02 |
| | Resilience Improvements through ONAP |
+--------------------------------------+--------------------------------------+
| AUTO-8, UC3 test case definition | Develop test cases for Auto-UC-03 |
| | Enterprise vCPE |
+--------------------------------------+--------------------------------------+
-| (UC1 test case definition is done, | |
-| but no associated JIRA ticket) | |
-+--------------------------------------+--------------------------------------+
| AUTO-5, install ONAP | Getting ONAP running onto Pharos |
| | deployment (without DCAE) |
+--------------------------------------+--------------------------------------+
@@ -187,18 +208,19 @@ Deliverables
Software deliverables
^^^^^^^^^^^^^^^^^^^^^
-Initial release: in-progress install scripts and test case implementations.
+6.0 and 6.1 releases: in-progress install scripts and test case implementations.
Documentation deliverables
^^^^^^^^^^^^^^^^^^^^^^^^^^
-Initial versions of:
+Updated versions of:
-* Release notes (this document)
-* User guide `OPNFV User and Configuration Guide <http://docs.opnfv.org/en/latest/release/userguide.introduction.html>`_
-* Configuration Guide (same landing page as User Guide)
+* Release Notes (this document)
+* User Guide
+* Configuration Guide
+(see links in References section)
@@ -271,7 +293,7 @@ Auto Wiki pages:
OPNFV documentation on Auto:
-* `Auto release notes <http://docs.opnfv.org/en/latest/release/release-notes.html>`_
+* `Auto release notes <http://docs.opnfv.org/en/latest/submodules/auto/docs/release/release-notes/index.html#auto-releasenotes>`_
* `Auto use case user guides <http://docs.opnfv.org/en/latest/submodules/auto/docs/release/userguide/index.html#auto-userguide>`_
* `Auto configuration guide <http://docs.opnfv.org/en/latest/submodules/auto/docs/release/configguide/index.html#auto-configguide>`_
@@ -282,4 +304,7 @@ Git&Gerrit Auto repositories:
* `Gerrit for Auto project <https://gerrit.opnfv.org/gerrit/#/admin/projects/auto>`_
+Demo at OpenStack summit May 2018 (Vancouver, BC, Canada):
+
+* YouTube video (10min 52s): `Integration testing on an OpenStack public cloud <https://youtu.be/BJ05YuusNYw>`_