Requirements¶

The requirements is to have docker and docker-compose installed on your Linux server/machine. Instructions to install are available below

• docker
• docker-compose

It’s also available for:

• Mac
• Windows

How to Install/Start¶

OpenNTI is available on DockerCloud and this project provide scripts to easily download/start/stop it.

git clone https://github.com/Juniper/open-nti.git
cd open-nti
make start

By default it will start 3 containers and it’s working in non-persistent mode, once you stop it all data are gone. It’s possible to start the main container in persistent mode to save the database outside the container, b y using the startup script make start-persistent. Persistent mode on Mac OS requires at least v1.12

How to update¶

It’s recommended to upgrade the project periodically, both the files from github.com and the containers from Docker Hub. You can update easily with

make update

Customize container’s name and ports¶

All port numbers and names used by start/stop scripts are centralized in one file : open-nti.params, you can easily adapt this file with your own port numbers or names.

Customize the container itself¶

If you want to make some modifications, you can always build the container yourself using the script make build.

Docker compose¶

All containers are started using docker-compose.yaml

./docker.start.sh

You can create your own docker-compose file and pass it

./docker.start.sh <my docker compose file>

List of available Plugins¶

JTI

Event / Syslog

Input plugin container

• https://github.com/Juniper/open-nti-input-syslog
• https://github.com/Juniper/open-nti-input-jti

Configuration¶

data/hosts.yaml In data/hosts.yaml you need to provide the list of devices you want to pull information from For each device, you need to indicate the name ane one or multiple tags (at least one). Tags will be used later to know which credentials should be used for this device and which commands need to be executed

<hostA>: <tag1> <tag4>
<hostB>: <tag1> <tag4>
<hostC>: <tag2> <tag4> <tag5>
<hostD>: <tag1> <tag4>  <--- Those tags relate the Hosts with the credentials and the commands to use with

Example

mx-edge011: edge mx madrid bgp mpls
mx-agg011: agg mx madrid bgp isis
qfx-agg022: agg qfx munich bgp
qfx5100-02: tor qfx madrid isis

data/credentials.yaml

You need to provide at least one credential profile for your devices

jdi_lab:
  username: '*login*'         (Single quote is to force to be imported as string)
  password: '*password*'      (Single quote is to force to be imported as string)
  method: password            (other supported methods 'key' and 'enc_key' for ssh Key-Based Authentication)
  key_file: ./data/*key_file* (optional: only appies if method key or enc_key is used, it must be located at data directory)
  tags: tag1 tag2

data/commands.yaml

generic_commands:  <--- You can name the group as best fits you
   commands: |
      show version | display xml  <--- There is no limit on how many commands can be added into a group
      show isis statistics | display xml <-- Before adding a command, confirm that there is a related parser
      show system buffers
      show system statistics icmp | display xml
      show route summary | display xml
   tags: tag1 tag2

Execution periodic¶

To collect data periodically with the Data Collection Agent, you need to setup a cron job inside the container. As part of the project, open-nti is providing some scripts to easily add/remove cron jobs inside the container from the host.

Scripts provided:

• make cron-add: Create a new cron job inside the container
• make cron-show: Show all cron jobs configured inside the container
• make cron-delete: Delete a cron job inside the container for a specific tag

To start cron job to execute commands specified above for specific tag every minute:

make cron-add TAG=lab

To start cron job for more than one tag at the same time:

make cron-add TAG='lab prod'

To start cron job to execute commands specified above for specific tag every 5 minutes:

make cron-add TAG=tag1 TIME=5m

To start cron job to execute commands specified above for specific tag every hour:

make cron-add TAG=tag1 TIME=1h

To stop cron job for specific tag:

make cron-show TAG=tag1

Junos Parsers¶

statsd interface¶

open-nti is using telegraf to support statsd Statsd is a popular tool to send metrics over the network, it has been designed by etsy.

More information below:

• https://github.com/etsy/statsd/blob/master/docs/metric_types.md
• https://github.com/influxdata/telegraf/tree/master/plugins/inputs/statsd

Here is an example of how to insert statsd data into the Database

root@d3e82264a08b:/# echo "opennti,device=qfx5100,type=int.rx:100|g" | nc -w 1 -u 127.0.0.1 8125

opennti define the serie device=qfx5100,type=int.rx will be converted as tag1 100 is the value g indicate gauge

Insert events via syslog¶

open-nti will access events in the syslog format on port UDP/6000. The goal is not to send all syslog but only relevant information like Commit or Protocol Flaps

To send only one syslog at commit time you can use the configuration below

set system syslog host 192.168.99.100 any any
set system syslog host 192.168.99.100 match UI_COMMIT_COMPLETED
set system syslog host 192.168.99.100 port 6000

Insert events in the database directly¶

It’s possible to insert events with just a HTTP POST request to the database, here is an example using curl

curl -i -XPOST 'http://10.92.71.225:8086/write?db=juniper' --data-binary 'events,type=Error text="BGP Flap"'
curl -i -XPOST 'http://10.92.71.225:8086/write?db=juniper' --data-binary 'events,device=qfx5100-01,type=Commit text="Change applied"'

Graphs¶

Rows¶

Annotations¶

Templatings¶

Data Collection Agent¶

make cron-debug TAG=lab

Data Streaming Collector¶

On Unix/Mac
tcpdump -i <ingress interface> -n dst port <dest port number>

./docker.cli.sh
tcpdump -i eth0 -n dst port <dest port number>

RPF check might be a problem if you see incoming packets in A but not in B.
If you e.g. use Src IP for which there is no route entry on host OS (Ubuntu
does RPF check as default), packets would be discarded.

docker logs opennti_input_jti