diff options
authorOlivier Roques <oroques+fdio@cisco.com>2020-02-27 16:57:29 +0100
committerOlivier Roques <oroques+fdio@cisco.com>2020-02-28 19:22:29 +0100
commite719d88839ba074d0c98d04cd7f0812ed317c3b1 (patch)
parentbd8380012c308a79861e2e52919e9ff6326d45dc (diff)
[HICN-537] Update telemetry documentation
Change-Id: I3f6c656164b27481e029eb72a63030bb592a6f1b Signed-off-by: Olivier Roques <oroques+fdio@cisco.com>
3 files changed, 12 insertions, 6 deletions
diff --git a/README.md b/README.md
index f306903..137c259 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
hicn is an open source implementation of Cisco's hICN. It includes a network stack, that implements
ICN forwarding path in IPv6, and a transport stack that implements two main transport protocols and
-a socket API. The transport protocols provide one reliable transport service implementaton and a
+a socket API. The transport protocols provide one reliable transport service implementation and a
real-time transport service for audio/video media.
## Directory layout
diff --git a/docs/README.md b/docs/README.md
index be7f4e6..431d1b8 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -15,16 +15,20 @@ out <https://packaging.python.org/guides/installing-using-pip-and-virtualenv>
For example start with a clone of the hicn.
$ git clone <https://gerrit.fd.io/r/hicn>
$ cd hicn
# Install the virtual environment
$ python3 -m pip install --user virtualenv
$ python3 -m virtualenv env
$ source env/bin/activate
$ pip install -r docs/etc/requirements.txt
$ cd docs
Which installs all the required applications into its own, isolated,
virtual environment, so as to not interfere with other builds that may
@@ -35,7 +39,9 @@ use different versions of software.
Be sure you are in your hicn/docs directory, since that is where Sphinx will
look for your conf.py file, and build the documents into an index.html file
$ make html
# View the results
diff --git a/docs/source/telemetry.md b/docs/source/telemetry.md
index 4296f1c..5cc7515 100644
--- a/docs/source/telemetry.md
+++ b/docs/source/telemetry.md
@@ -41,18 +41,18 @@ hICN collectd plugins have been tested in:
Build dependencies:
-- VPP 20.01
- - DEB packages (can be found https://packagecloud.io/fdio/release/install):
+- VPP 20.01, Debian packages can be found on [packagecloud](https://packagecloud.io/fdio/release/install):
- vpp
- libvppinfra-dev
- vpp-dev
- hicn-plugin-dev
+- `collectd` and `collectd-dev`: `sudo apt install collectd collectd-dev`
## Getting started
-Collectd needs to be configured in order to use the hICN collectd plugins.
-The configuration can be achieved editing the file '/etc/collectd/collectd.conf'
-and adding the following lines:
+Collectd needs to be configured in order to use the hICN plugins.
+To enable the plugins, add the following lines to `/etc/collectd/collectd.conf`:
LoadPlugin vpp
LoadPlugin vpp_hicn