From 4502257eefd9654f7ea8279f753b2b9be1c8ddd5 Mon Sep 17 00:00:00 2001 From: Stephen Wong Date: Tue, 24 Apr 2018 16:15:24 -0700 Subject: Simplification of Clover Fraser official docs (Double commit from master:I89adbef74aa74071a055dcdf62aa0925e263ffe3, gerrit 56167) Change-Id: I45071c2d7f3e4264596b9fbe5d8e086e3842fe37 Signed-off-by: Stephen Wong --- .../release/release-notes/Fraser-release-notes.rst | 100 -------------------- docs/release/release-notes/index.rst | 2 +- docs/release/release-notes/release-notes.rst | 101 +++++++++++++++++++++ 3 files changed, 102 insertions(+), 101 deletions(-) delete mode 100644 docs/release/release-notes/Fraser-release-notes.rst create mode 100644 docs/release/release-notes/release-notes.rst (limited to 'docs/release/release-notes') diff --git a/docs/release/release-notes/Fraser-release-notes.rst b/docs/release/release-notes/Fraser-release-notes.rst deleted file mode 100644 index 3e864fb..0000000 --- a/docs/release/release-notes/Fraser-release-notes.rst +++ /dev/null @@ -1,100 +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 - - -This document provides the release notes for Fraser of OPNFV Clover. - -.. contents:: - :depth: 3 - :local: - - -Version history ---------------- - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2018-03-14 | Fraser 1.0 | Stephen Wong | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ - -Important notes -=============== - -The OPNFV Clover project for Fraser can ONLY be run on Kubernetes version 1.9.3 or -above - -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 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Fraser marks the first release of OPNFV Clover - -Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Fraser marks the first release of OPNFV Clover - -Reason for version -^^^^^^^^^^^^^^^^^^^^ - -Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ - (no backlog) - -Bug corrections -~~~~~~~~~~~~~~~~~~~~~ - - -Known Limitations, Issues and Workarounds -========================================= - -System Limitations -^^^^^^^^^^^^^^^^^^^^ -TBD - -Known issues -^^^^^^^^^^^^^^^ -TBD - -Workarounds -^^^^^^^^^^^^^^^^^ - -Test Result -=========== - - -References -========== diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst index 1c41113..c7f8f6c 100644 --- a/docs/release/release-notes/index.rst +++ b/docs/release/release-notes/index.rst @@ -12,4 +12,4 @@ OPNFV Clover Design Specification .. toctree:: :maxdepth: 1 - Fraser-release-notes + release-notes diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..f345f61 --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +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) 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 +^^^^^^^^^^^^^^^^ + +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 +~~~~~~~~~~~~~~~~~~~~~~~ + (no backlog) + +Bug corrections +~~~~~~~~~~~~~~~~~~~~~ + + +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +^^^^^^^^^^^^^^^^^^^^ +TBD + +Known issues +^^^^^^^^^^^^^^^ +TBD + +Workarounds +^^^^^^^^^^^^^^^^^ + +Test Result +=========== + + +References +========== -- cgit 1.2.3-korg