Code Review / barometer.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
[docs] Update formatting and links
[barometer.git] / docs / release / userguide / feature.userguide.rst
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
index 6216a3a..c76e79a 100644 (file)
--- a/docs/release/userguide/feature.userguide.rst
+++ b/docs/release/userguide/feature.userguide.rst
@@ -107,7 +107,7 @@ Read Plugins/application: Intel RDT plugin, virt plugin, Open vSwitch stats plug
 Open vSwitch PMD stats application.
 
 Collectd capabilities and usage
 Open vSwitch PMD stats application.
 
 Collectd capabilities and usage
-------------------------------------
+-------------------------------
 .. Describe the specific capabilities and usage for <XYZ> feature.
 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
 
 .. Describe the specific capabilities and usage for <XYZ> feature.
 .. Provide enough information that a user will be able to operate the feature on a deployed scenario.
 
@@ -149,12 +149,12 @@ Sample configuration files can be found in '/opt/collectd/etc/collectd.conf.d'
   By default, `collectd_exec` user is used in the exec.conf provided in the sample
   configurations directory under src/collectd in the Barometer repo. These scripts *DO NOT* create this user.
   You need to create this user or modify the configuration in the sample configurations directory
   By default, `collectd_exec` user is used in the exec.conf provided in the sample
   configurations directory under src/collectd in the Barometer repo. These scripts *DO NOT* create this user.
   You need to create this user or modify the configuration in the sample configurations directory
-  under src/collectd to use another existing non root user before  running build_base_machine.sh.
+  under src/collectd to use another existing non root user before running build_base_machine.sh.
 
 .. note::
   If you are using any Open vSwitch plugins you need to run:
 
 
 .. note::
   If you are using any Open vSwitch plugins you need to run:
 
-.. code:: bash
+  .. code:: bash
 
     $ sudo ovs-vsctl set-manager ptcp:6640
 
 
     $ sudo ovs-vsctl set-manager ptcp:6640
 
@@ -179,7 +179,7 @@ Repo: https://github.com/collectd/collectd
 
 Branch: main
 
 
 Branch: main
 
-Dependencies: DPDK (https://dpdk.org/)
+Dependencies: `DPDK <https://www.dpdk.org/>`_
 
 .. note:: DPDK statistics plugin requires DPDK version 16.04 or later.
 
 
 .. note:: DPDK statistics plugin requires DPDK version 16.04 or later.
 
@@ -451,7 +451,7 @@ additional two options shown below:
     If you set XDG_CACHE_HOME to anything other than the variable above - you will need to modify
     the path for the EventList configuration.
 
     If you set XDG_CACHE_HOME to anything other than the variable above - you will need to modify
     the path for the EventList configuration.
 
-Use "Cores" option to monitor metrics only for configured cores. If an empty string is provided
+Use ``Cores`` option to monitor metrics only for configured cores. If an empty string is provided
 as value for this field default cores configuration is applied - that is all available cores
 are monitored separately. To limit monitoring to cores 0-7 set the option as shown below:
 
 as value for this field default cores configuration is applied - that is all available cores
 are monitored separately. To limit monitoring to cores 0-7 set the option as shown below:
 
@@ -479,8 +479,8 @@ Branch: main
 
 Dependencies:
 
 
 Dependencies:
 
-  * PQoS/Intel RDT library https://github.com/intel/intel-cmt-cat
-  * msr kernel module
+* PQoS/Intel RDT library https://github.com/intel/intel-cmt-cat
+* msr kernel module
 
 Building and installing PQoS/Intel RDT library:
 
 
 Building and installing PQoS/Intel RDT library:
 
@@ -531,7 +531,7 @@ Repo: https://github.com/collectd/collectd
 
 Branch: feat_ipmi_events, feat_ipmi_analog
 
 
 Branch: feat_ipmi_events, feat_ipmi_analog
 
-Dependencies: OpenIPMI library (http://openipmi.sourceforge.net/)
+Dependencies: `OpenIPMI library <https://openipmi.sourceforge.io/>`_
 
 The IPMI plugin is already implemented in the latest collectd and sensors
 like temperature, voltage, fanspeed, current are already supported there.
 
 The IPMI plugin is already implemented in the latest collectd and sensors
 like temperature, voltage, fanspeed, current are already supported there.
@@ -643,7 +643,7 @@ Repo: https://github.com/collectd/collectd
 
 Branch: main
 
 
 Branch: main
 
-Dependencies: mcelog
+Dependencies: `mcelog <http://mcelog.org/>`_
 
 Start by installing mcelog.
 
 
 Start by installing mcelog.
 
@@ -836,15 +836,15 @@ To inject corrected memory errors:
 * Check the MCE statistic: mcelog --client. Check the mcelog log for injected error details: less /var/log/mcelog.
 
 Open vSwitch Plugins
 * Check the MCE statistic: mcelog --client. Check the mcelog log for injected error details: less /var/log/mcelog.
 
 Open vSwitch Plugins
-^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^
 OvS Plugins Repo: https://github.com/collectd/collectd
 
 OvS Plugins Branch: main
 
 OvS Events MIBs: The SNMP OVS interface link status is provided by standard
 OvS Plugins Repo: https://github.com/collectd/collectd
 
 OvS Plugins Branch: main
 
 OvS Events MIBs: The SNMP OVS interface link status is provided by standard
-IF-MIB (http://www.net-snmp.org/docs/mibs/IF-MIB.txt)
+`IF-MIB <http://www.net-snmp.org/docs/mibs/IF-MIB.txt>`_
 
 
-Dependencies: Open vSwitch, Yet Another JSON Library (https://github.com/lloyd/yajl)
+Dependencies: Open vSwitch, `Yet Another JSON Library <https://github.com/lloyd/yajl>`_
 
 On Centos, install the dependencies and Open vSwitch:
 
 
 On Centos, install the dependencies and Open vSwitch:
 
@@ -915,13 +915,15 @@ For more information on the plugin parameters, please see:
 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
 
 OVS PMD stats
 https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
 
 OVS PMD stats
-^^^^^^^^^^^^^^
-Repo: https://gerrit.opnfv.org/gerrit/barometer
+^^^^^^^^^^^^^
+Repo: https://gerrit.opnfv.org/gerrit/gitweb?p=barometer.git
 
 Prequistes:
 
 Prequistes:
-1. Open vSwitch dependencies are installed.
-2. Open vSwitch service is running.
-3. Ovsdb-server manager is configured.
+
+#. Open vSwitch dependencies are installed.
+#. Open vSwitch service is running.
+#. Ovsdb-server manager is configured.
+
 You can refer `Open vSwitch Plugins`_ section above for each one of them.
 
 OVS PMD stats application is run through the exec plugin.
 You can refer `Open vSwitch Plugins`_ section above for each one of them.
 
 OVS PMD stats application is run through the exec plugin.
@@ -1097,12 +1099,12 @@ http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/
 .. _virt-plugin:
 
 virt plugin
 .. _virt-plugin:
 
 virt plugin
-^^^^^^^^^^^^
+^^^^^^^^^^^
 Repo: https://github.com/collectd/collectd
 
 Branch: main
 
 Repo: https://github.com/collectd/collectd
 
 Branch: main
 
-Dependencies: libvirt (https://libvirt.org/), libxml2
+Dependencies: `libvirt <https://libvirt.org/>`_, libxml2
 
 On Centos, install the dependencies:
 
 
 On Centos, install the dependencies:
 
@@ -1269,7 +1271,7 @@ Reload
     $ sudo systemctl status collectd.service should show success
 
 Additional useful plugins
     $ sudo systemctl status collectd.service should show success
 
 Additional useful plugins
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 **Exec Plugin** : Can be used to show you when notifications are being
 generated by calling a bash script that dumps notifications to file. (handy
 
 **Exec Plugin** : Can be used to show you when notifications are being
 generated by calling a bash script that dumps notifications to file. (handy
@@ -1342,7 +1344,7 @@ For more information on configuring and installing OpenStack plugins for
 collectd, check out the `collectd-openstack-plugins GSG`_.
 
 Security
 collectd, check out the `collectd-openstack-plugins GSG`_.
 
 Security
-^^^^^^^^^
+^^^^^^^^
 * AAA – on top of collectd there secure agents like SNMP V3, Openstack agents
   etc. with their own AAA methods.
 
 * AAA – on top of collectd there secure agents like SNMP V3, Openstack agents
   etc. with their own AAA methods.
 
@@ -1353,7 +1355,7 @@ Security
 
   * Ensuring that only one instance of the program is executed by collectd at any time
   * Forcing the plugin to check that custom programs are never executed with superuser
 
   * Ensuring that only one instance of the program is executed by collectd at any time
   * Forcing the plugin to check that custom programs are never executed with superuser
-  privileges.
+    privileges.
 
 * Protection of Data in flight:
 
 
 * Protection of Data in flight:
 
@@ -1387,8 +1389,8 @@ References
 .. [7] https://collectd.org/wiki/index.php/Meta_Data_Interface
 
 .. _Barometer OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/
 .. [7] https://collectd.org/wiki/index.php/Meta_Data_Interface
 
 .. _Barometer OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/
-.. _gnocchi plugin: https://github.com/openstack/collectd-openstack-plugins/tree/stable/ocata/
-.. _aodh plugin: https://github.com/openstack/collectd-openstack-plugins/tree/stable/ocata/
+.. _gnocchi plugin: https://opendev.org/x/collectd-openstack-plugins/src/branch/stable/ocata/
+.. _aodh plugin: https://opendev.org/x/collectd-openstack-plugins/src/branch/stable/ocata/
 .. _collectd-openstack-plugins GSG: https://opendev.org/x/collectd-openstack-plugins/src/branch/master/doc/source/GSG.rst
 .. _grafana guide: https://wiki.anuket.io/display/HOME/Installing+and+configuring+InfluxDB+and+Grafana+to+display+metrics+with+collectd 
 .. _CVE-2017-7401: https://www.cvedetails.com/cve/CVE-2017-7401/
 .. _collectd-openstack-plugins GSG: https://opendev.org/x/collectd-openstack-plugins/src/branch/master/doc/source/GSG.rst
 .. _grafana guide: https://wiki.anuket.io/display/HOME/Installing+and+configuring+InfluxDB+and+Grafana+to+display+metrics+with+collectd 
 .. _CVE-2017-7401: https://www.cvedetails.com/cve/CVE-2017-7401/
Utilities and libraries to support low latency, high performance packet processing paths through the NFVI