diff options
Diffstat (limited to 'docs/release/userguide/userguide.rst')
| -rw-r--r-- | docs/release/userguide/userguide.rst | 55 |
1 files changed, 22 insertions, 33 deletions
diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst index d99359b..468dee3 100644 --- a/docs/release/userguide/userguide.rst +++ b/docs/release/userguide/userguide.rst @@ -5,56 +5,45 @@ ================================================================ -Clover User Guide (Fraser Release) +Clover User Guide (Gambia Release) ================================================================ -This document provides the Clover user guide for the OPNFV Fraser release. +This document provides the Clover user guide for the OPNFV Hunter release. Description =========== -As project Clover's first release, the Fraser release includes installation and simple -validation of foundational upstream projects including Istio, fluentd, Jaeger, and -Prometheus. The Clover Fraser release also provides a sample set of web-oriented network -services, which follow a micro-service design pattern, its Kubernetes manifest, and an -automated script to demonstrate a sample A-B testing use-case. The A-B sample script -validates performance criteria using Istio request routing functionality leveraging -the sample services deployed within Istio and the tracing data available within Jaeger. +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 + +What is in Hunter? ================== * Sample micro-service composed VNF named Service Delivery Controller (SDC) - * Logging module: fluentd and elasticsearch Kubernetes manifests, - and fluentd installation validation - - * Tracing module: Jaeger Kubernetes manifest, installation validation, - Jaegar tracing query tools, and module for trace data output to datastore + * Istio 1.0 support - * Monitoring module: Prometheus Kubernetes manifest, installation - validation, and 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 North America 2018 + * 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 logging, Jaeger tracing, and - Prometheus monitoring. Deployment and validation instructions can be found at: - :ref:`logging`, :ref:`tracing`, and :ref:`monitoring` respectively. + * JMeter: integrating jmeter as test client - * Deployment and usage of SDC sample - - Services designed and implemented with micro-service design pattern - - Tested and validated via Istio service mesh tools - Detailed usage instructions for the sample can be found at :ref:`sdc_config_guide` + * Clover UI: sample UI to offer single pane view / configuration point of the + Clover system - * An example use-case for A-B testing. Detailed usage instructions for this sample A-B - validation can be found at: :ref:`a_b_config_guide` +Usage +===== - * Sample tool to validate Istio route rules: - tools/python clover_validate_route_rules.py -s <service name> -t <test id> + * Please refer to configguildes for usage detail on various modules |