.. (c) optionally add copywriters name\r
\r
\r
-This document provides the release notes for Fraser of OPNFV Clover.\r
+This document provides Clover project's release notes for the OPNFV Fraser release.\r
\r
.. contents::\r
:depth: 3\r
Important notes\r
===============\r
\r
-The OPNFV Clover project for Fraser can ONLY be run on Kubernetes version 1.9.3 or\r
-above\r
+The Clover project for OPNFV Fraser can ONLY be run on Kubernetes version 1.9.3 or\r
+later\r
\r
Summary\r
=======\r
\r
Module version changes\r
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-Fraser marks the first release of OPNFV Clover\r
+OPNFV Fraser marks the first release for Clover\r
\r
Document version changes\r
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r
-Fraser marks the first release of OPNFV Clover\r
+OPNFV Fraser marks the first release for Clover\r
\r
Reason for version\r
^^^^^^^^^^^^^^^^^^^^\r
Clover User Guide (Fraser Release)
================================================================
-This document provides the user guide for Fraser release of Clover.
+This document provides the Clover user guide for OPNFV Fraser release.
.. contents::
:depth: 3
Description
===========
-Project Clover was established to investigate best practice to implement,
+Project Clover was established to investigate best practices to implement,
build, deploy, and operate virtual network functions as cloud native
-applications. "Cloud native" has a ever evolving and expanding definition,
+applications. "Cloud native" has an ever evolving and expanding definition,
and in Clover, the focus is effectively running and operating VNFs built
in a micro-service design pattern running on Docker containers and
orchestrated by Kubernetes.
Usage
=====
- * each modules (service mesh, logging, tracing, monitoring) are Python
- modules with their own set of library calls / API exposed. The descriptions
+ * each module (service mesh, logging, tracing, monitoring) is a Python
+ module with its own set of library calls/ API exposed. The descriptions
of these library calls are under doc/developer (TBD)
* tools directory contains Python tools for generic use
- user specify via yaml the "success" expectation of v2 (latency,
performance, session loss...etc)
- Clover tool validates sessions conformance with user defined expectations
- - The "commit" action is invoked to move 100% traffic to v2
+ - The "commit" action is invoked to move 100% of the traffic to v2
- Clover tool validates traffic conformance with route rules
- A fault is injected for the path to the extra service of v2 which adds
a one second delay onto the path