diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release/configguide/clovisor_config_guide.rst | 33 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 40 | ||||
| -rw-r--r-- | docs/release/userguide/userguide.rst | 16 |
3 files changed, 46 insertions, 43 deletions
diff --git a/docs/release/configguide/clovisor_config_guide.rst b/docs/release/configguide/clovisor_config_guide.rst index 9b5f4a3..e486e3e 100644 --- a/docs/release/configguide/clovisor_config_guide.rst +++ b/docs/release/configguide/clovisor_config_guide.rst @@ -17,10 +17,10 @@ No Configuration ================ If redis server isn't running as service name **redis** in namespace -**clover-system** or there isn't any configuration related to Clovisor in that +**clovisor** or there isn't any configuration related to Clovisor in that redis service, then Clovisor would monitor all pods under the **default** namespace. The traces would be sent to **jaeger-collector** service under the -**clover-system** namespace +**clovisor** namespace Using redis-cli =============== @@ -29,7 +29,7 @@ Install ``redis-cli`` on the client machine, and look up redis IP address: .. code-block:: bash - $ kubectl get services -n clover-system + $ kubectl get services -n clovisor which one may get something like the following: @@ -51,13 +51,13 @@ plugin): and one can connect to redis via:: - redis-cli -h 10.244.0.187 -p 6379 + kubectl exec -n clovisor -it redis redis-cli Jaeger Collector Configuration ============================== Clovisor allows user to specify the Jaeger service for which Clovisor would send -the network traces to. This is configured via setting the values for +the network traces to, by default it is Jaegar service running in **clovisor** namespace. To change, user can configure via setting the values for keys **clovisor_jaeger_collector** and **clovisor_jaeger_agent**:: redis> SET clovisor_jaeger_collector "jaeger-collector.istio-system:14268" @@ -154,3 +154,26 @@ applied:: the command above will cause Clovisor to trace packets going out of pods under monitoring which have name starting with the string "proxy" that match destination TCP port 3456 + +Clovisor in Hunter release supports the ability to run user-defined protocol analyzer as a plugin library --- and the corresponding traces will be sent to Jaeger just like all the default Clovisor network tracing. User needs to implement the following interface (only golang is supported at this time):: + + type Parser interface { + Parse(session_key string, is_req bool, + data []byte)([]byte, map[string]string) + } + +and compile it with the following command:: + + go build --buildmode=plugin -o <something>.so <something>.go + +then, for Hunter, one needs to push the .so to each Clovisor instance:: + + kubectl cp <something>.so clovisor/clovisor-bnh2v:/proto/<something>.so + +do that for each Clovisor pods, and afterward, configure via:: + + redis> HSET clovisor_proto_cfg <protocol> "/proto/<something>.so" + (integer) 1 + redis> PUBLISH clovisor_proto_plugin_cfg_chan <protocol> + (integer) 6 + diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 9dd15b5..5f9154d 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -4,7 +4,7 @@ .. (c) Authors of Clover -This document provides Clover project's release notes for the OPNFV Gambia release. +This document provides Clover project's release notes for the OPNFV Hunter release. .. contents:: :depth: 3 @@ -18,37 +18,24 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 2018-03-14 | Gambia 1.0 | Stephen Wong | First draft | +| 2019-04-30 | Hunter 1.0 | Stephen Wong | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ Important notes =============== -The Clover project for OPNFV Gambia is tested on Kubernetes version 1.9 and +The Clover project for OPNFV Hunter is tested on Kubernetes version 1.9 and 1.11. It is only tested on Istio 1.0. Summary ======= -Clover Gambia release further enhances the Fraser release by providing various -tools to help operators deploy cloud native network functions. These tools -include - -#. Collector: gathers and collects metrics and traces from Prometheus and - Jaeger, respectively, and provides a single access point for such data -#. Visibility: utilizes an analytic engine to correlate and organize data - gathered by the collector -#. CLI: comprehensive Clover CLI called cloverctl, offering a single management - tool for operating Clover toolset -#. Network Tracing: CNI plugin agnostic network tracing tool -#. Extended HTTP Security: integrate modsecurity (Web Application Firewall) and - Snort with Istio gateway via Istio newly added mechanisms to redirect and - mirror traffic to the network functions -#. HTTP Test Client: bundle JMeter as test client for testing -#. UI: developmental / sample UI to offer single pane view of Clover system -#. Spinnaker Integration: provides automated / programmable cloud provider - add/update/delete; sample pipeline and installation scripts +Clover Hunter release further enhances the Gambia release by: + +#. Integration with ONAP SDC, running on Istio, to demonstrate Clover's + visibility engine +#. Network Tracing: Clovisor has significant stability and feature enhancements Release Data ============ @@ -60,13 +47,13 @@ Release Data | **Repo/commit-ID** | | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Gambia | +| **Release designation** | Hunter | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2018-11-09 +| **Release date** | 2019-05-10 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Gambia release | +| **Purpose of the delivery** | OPNFV Hunter release | | | | +--------------------------------------+--------------------------------------+ @@ -75,13 +62,10 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Clover Gambia release will no longer support Istio 0.6, the version of Istio -supported by Clover Gambia release Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Clover Gambia has updated the config guide and user guide accordingly, including -new documents for the new features +Clover Hunter has updated the config guide and user guide accordingly Reason for version ^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst index 942c8f3..468dee3 100644 --- a/docs/release/userguide/userguide.rst +++ b/docs/release/userguide/userguide.rst @@ -8,18 +8,18 @@ Clover User Guide (Gambia Release) ================================================================ -This document provides the Clover user guide for the OPNFV Gambia release. +This document provides the Clover user guide for the OPNFV Hunter release. Description =========== -Clover Gambia builds on previous release to further enhance the toolset for -cloud native network functions operations. The two emphasis on the release are: +Clover Hunter builds on previous release to further enhance the toolset for +cloud native network functions operations. The main emphasis on the release are: -#. Integration of Spinnaker to support continuous delivery -#. Centralizing Operational Data for Visibility +#. ONAP SDC on Istio with Clover providing visibility +#. Clovisor enhancement and stability -What is in Gambia? +What is in Hunter? ================== * Sample micro-service composed VNF named Service Delivery Controller (SDC) @@ -43,10 +43,6 @@ What is in Gambia? * Clover UI: sample UI to offer single pane view / configuration point of the Clover system - * Spinnaker Integration: add ability to add/update/delete cloud provider via - cloverctl, and sample pipeline utilized by Clover project to deploy SDC - - Usage ===== |