diff options
Diffstat (limited to 'docs/release/userguide/userguide.rst')
| -rw-r--r-- | docs/release/userguide/userguide.rst | 61 |
1 files changed, 23 insertions, 38 deletions
diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst index c01886e..468dee3 100644 --- a/docs/release/userguide/userguide.rst +++ b/docs/release/userguide/userguide.rst @@ -5,60 +5,45 @@ ================================================================ -Clover User Guide (Fraser Release) +Clover User Guide (Gambia Release) ================================================================ -This document provides the Clover user guide for OPNFV Fraser release. - -.. contents:: - :depth: 3 - :local: - +This document provides the Clover user guide for the OPNFV Hunter release. 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 running in istio-system namespace. +Clover Hunter builds on previous release to further enhance the toolset for +cloud native network functions operations. The main emphasis on the release are: -What is in Fraser? -================== +#. ONAP SDC on Istio with Clover providing visibility +#. Clovisor enhancement and stability - * a sample micro-service composed VNF +What is in Hunter? +================== - * logging module: fluentd and elasticsearch Kubernetes manifests, - and fluentd installation validation + * Sample micro-service composed VNF named Service Delivery Controller (SDC) - * tracing module: jaeger Kubernetes manifest, installation validation, - jaegar tracing query tools, module for trace data output to datastore + * Istio 1.0 support - * monitoring module: prometheus Kubernetes manifest, installation - validation, sample Prometheous query of Istio related metrics + * clover-collector: gathers and collects metrics and traces from Prometheus and + Jaeger, and provides a single access point for such data - * Istio route-rules sample yaml and validation tools + * Visibility: utilizes an analytic engine to correlate and organize data + collected by clover-collector - * Test scripts + * cloverctl: Clover's new CLI - * Sample code for an A-B testing demo shown during ONS + * Clovisor: Clover's cloud native, CNI-plugin agnostic network tracing tool -Usage -===== + * Integration of HTTP Security Modules with Istio 1.0 - * Python modules to validate installation of fluentd, Jaeger, and - Prometheus + * JMeter: integrating jmeter as test client - * Installation and deployment of a sample VNF - - VNF designed and implemented with micro-service design pattern - - tested and validated via Istio service mesh tools + * Clover UI: sample UI to offer single pane view / configuration point of the + Clover system - * sample tool to validate Istio route rules: - tools/python clover_validate_route_rules.py -s <service name> -t <test id> +Usage +===== - * 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/... + * Please refer to configguildes for usage detail on various modules |