Skip to content

Commit

Permalink
[HICN-537] Update telemetry documentation
Browse files Browse the repository at this point in the history
Change-Id: I3f6c656164b27481e029eb72a63030bb592a6f1b
Signed-off-by: Olivier Roques <[email protected]>
  • Loading branch information
Olivier Roques committed Feb 28, 2020
1 parent bd83800 commit e719d88
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,20 @@ out <https://packaging.python.org/guides/installing-using-pip-and-virtualenv>

For example start with a clone of the hicn.

```bash
$ git clone <https://gerrit.fd.io/r/hicn>
$ cd hicn
```

# Install the virtual environment

```bash
$ 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
Expand All @@ -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

```bash
$ make html
```

# View the results

Expand Down
10 changes: 5 additions & 5 deletions docs/source/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e719d88

Please sign in to comment.