Fraser official docs simplification

[TBD]: link to configguide for sample VNF, link to A-B testing configguide

Change-Id: I89adbef74aa74071a055dcdf62aa0925e263ffe3
Signed-off-by: Stephen Wong <stephen.kf.wong@gmail.com>

3 files changed, 165 insertions, 181 deletions

diff --git a/docs/release/release-notes/Fraser-release-notes.rst b/docs/release/release-notes/release-notes.rst
index becd2da..2ce7fef 100644
--- a/docs/release/release-notes/Fraser-release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -1,100 +1,101 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.

-.. http://creativecommons.org/licenses/by/4.0

-.. SPDX-License-Identifier CC-BY-4.0

-.. (c) optionally add copywriters name

-

-

-This document provides Clover project's release notes for the OPNFV Fraser release.

-

-.. contents::

-   :depth: 3

-   :local:

-

-

-Version history

----------------

-

-+--------------------+--------------------+--------------------+--------------------+

-| **Date**           | **Ver.**           | **Author**         | **Comment**        |

-|                    |                    |                    |                    |

-+--------------------+--------------------+--------------------+--------------------+

-| 2018-03-14         | Fraser 1.0         | Stephen Wong       | First draft        |

-|                    |                    |                    |                    |

-+--------------------+--------------------+--------------------+--------------------+

-

-Important notes

-===============

-

-The Clover project for OPNFV Fraser can ONLY be run on Kubernetes version 1.9.3 or

-later

-

-Summary

-=======

-

-Clover provides tools to help run cloud native virtual network functions. These

-tools include service-mesh and associated policy-based-routing config (via

-Istio), logging (via fluentd), monitoring (via Prometheus), and tracing (via

-OpenTracing and Jaeger).

-

-Release Data

-============

-

-+--------------------------------------+--------------------------------------+

-| **Project**                          | Clover                               |

-|                                      |                                      |

-+--------------------------------------+--------------------------------------+

-| **Repo/commit-ID**                   |                                      |

-|                                      |                                      |

-+--------------------------------------+--------------------------------------+

-| **Release designation**              | Fraser                               |

-|                                      |                                      |

-+--------------------------------------+--------------------------------------+

-| **Release date**                     | 2018-04-xx                           |

-|                                      |                                      |

-+--------------------------------------+--------------------------------------+

-| **Purpose of the delivery**          | OPNFV Fraser release                 |

-|                                      |                                      |

-+--------------------------------------+--------------------------------------+

-

-Version change

-^^^^^^^^^^^^^^^^

-

-Module version changes

-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-OPNFV Fraser marks the first release for Clover

-

-Document version changes

-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-OPNFV Fraser marks the first release for Clover

-

-Reason for version

-^^^^^^^^^^^^^^^^^^^^

-

-Feature additions

-~~~~~~~~~~~~~~~~~~~~~~~

-<None> (no backlog)

-

-Bug corrections

-~~~~~~~~~~~~~~~~~~~~~

-<None>

-

-Known Limitations, Issues and Workarounds

-=========================================

-

-System Limitations

-^^^^^^^^^^^^^^^^^^^^

-TBD

-

-Known issues

-^^^^^^^^^^^^^^^

-TBD

-

-Workarounds

-^^^^^^^^^^^^^^^^^

-

-Test Result

-===========

-

-

-References

-==========

+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier CC-BY-4.0
+.. (c) Authors of Clover
+
+
+This document provides Clover project's release notes for the OPNFV Fraser release.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2018-03-14         | Fraser 1.0         | Stephen Wong       | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+Important notes
+===============
+
+The Clover project for OPNFV Fraser can ONLY be run on Kubernetes version 1.9 or
+later
+
+Summary
+=======
+
+Clover Fraser release provides tools for installation and validation of various
+upstream cloud native projects including Istio, fluentd, Jaegar, and Prometheus.
+In addition, the Fraser release also includes a sample VNF, its Kubernetes
+manifest, simple tools to validate route rules from Istio, as well as an
+example A-B testing framework.
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | Clover                               |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | Fraser                               |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2018-04-27
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | OPNFV Fraser release                 |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Version change
+^^^^^^^^^^^^^^^^
+
+odule version changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+OPNFV Fraser marks the first release for Clover
+
+Document version changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+OPNFV Fraser marks the first release for Clover
+
+Reason for version
+^^^^^^^^^^^^^^^^^^^^
+
+Feature additions
+~~~~~~~~~~~~~~~~~~~~~~~
+<None> (no backlog)
+
+Bug corrections
+~~~~~~~~~~~~~~~~~~~~~
+<None>
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+^^^^^^^^^^^^^^^^^^^^
+TBD
+
+Known issues
+^^^^^^^^^^^^^^^
+TBD
+
+Workarounds
+^^^^^^^^^^^^^^^^^
+
+Test Result
+===========
+
+
+References
+==========
diff --git a/docs/release/userguide/Fraser-userguide.rst b/docs/release/userguide/Fraser-userguide.rst
deleted file mode 100644
index a15fdc1..0000000
--- a/docs/release/userguide/Fraser-userguide.rst
+++ /dev/null
@@ -1,81 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. SPDX-License-Identifier CC-BY-4.0
-.. (c) optionally add copywriters name
-
-
-================================================================
-Clover User Guide (Fraser Release)
-================================================================
-
-This document provides the Clover user guide for OPNFV Fraser release.
-
-.. contents::
-   :depth: 3
-   :local:
-
-
-Description
-===========
-
-Project Clover was established to investigate best practices to implement,
-build, deploy, and operate virtual network functions as cloud native
-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.
-
-The strength of cloud native applications is their operablity and
-scalability. Essential to achieve these qualities is the use of service
-mesh. As such, in Fraser release, Clover's emphasis is on demonstrating
-running a sample micro-service composed VNF on Istio, the service mesh
-platform of Clover's choice in Fraser, and how to maximize visibility
-of this sample running in a service mesh.
-
-What is in Fraser?
-==================
-
- * a sample micro-service composed VNF
-
- * logging module: fluentd and elasticsearch Kubernetes manifests,
-   installation validation, log data correlation in datastore
-
- * tracing module: jaeger Kubernetes manifest, installation validation,
-   jaegar tracing query tools, trace data correlation in datastore
-
- * monitoring module: prometheus Kubernetes manifest, installation
-   validation, prometheous query tools for Istio related metrics,
-   metrics correlation in datastore
-
- * Istio route-rules and circuit breaking sample yaml and validation
-   tools
-
- * Test scripts
-
- * Reference for a demo shown during ONS
-
-Usage
-=====
-
- * 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
-   python clover_validate_route_rules.py -s <service name> -n <number of tests>
-   [more TBD]
-
- * an example scenario:
-   - version 2 (v2) of a micro-service component is deployed
-   - Istio route rule is applied to send 50% traffic to v2
-   - Clover tool validates traffic conformance with route rules
-   - 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% 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
-   - The same A-B testing script is invoked, this time, performance
-     test now fails
-   - The "rollback" action is invoked to move 100% traffic back to v1
diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst
new file mode 100644
index 0000000..20237f0
--- /dev/null
+++ b/docs/release/userguide/userguide.rst
@@ -0,0 +1,64 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier CC-BY-4.0
+.. (c) Authors of Clover
+
+
+================================================================
+Clover User Guide (Fraser Release)
+================================================================
+
+This document provides the Clover user guide for OPNFV Fraser release.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Description
+===========
+
+As project Clover's first release, Fraser release includes installation
+and simple validation of foundational upstream projects including Istio,
+fluentd, Jaeger, and Prometheus. Clover Fraser release also provides a
+sample VNF which follows micro-service design pattern, its Kubernetes
+manifest, and an automatic scipt to demonstrate a sample A-B testing use
+case using the sample VNF running on Istio with trace data exposed to
+Jaeger.
+
+What is in Fraser?
+==================
+
+ * a sample micro-service composed VNF
+
+ * logging module: fluentd and elasticsearch Kubernetes manifests,
+   and fluentd installation validation
+
+ * tracing module: jaeger Kubernetes manifest, installation validation,
+   jaegar tracing query tools, module for trace data output to datastore
+
+ * monitoring module: prometheus Kubernetes manifest, installation
+   validation, sample Prometheous query of Istio related metrics
+
+ * Istio route-rules sample yaml and validation tools
+
+ * Test scripts
+
+ * Sample code for an A-B testing demo shown during ONS
+
+Usage
+=====
+
+ * Python modules to validate installation of fluentd, Jaeger, and
+   Prometheus
+
+ * Installation and deployment of a sample VNF
+   - VNF designed and implemented with micro-service design pattern
+   - tested and validated via Istio service mesh tools
+
+ * sample tool to validate Istio route rules:
+   tools/python clover_validate_route_rules.py -s <service name> -t <test id>
+
+ * an example use case: A-B testing:
+   test/fraser_a_b_test.py -t yaml/fraser_a_b_test.yaml -p <tracing port num>
+   *** detail procedure to run sample A-B testing at docs/configguide/...