Skydive is an open source real-time network topology and protocols analyzer. It aims to provide a comprehensive way of understanding what is happening in the network infrastructure.
Skydive agents collect topology informations and flows and forward them to a central agent for further analysis. All the informations are stored in an Elasticsearch database.
Skydive is SDN-agnostic but provides SDN drivers in order to enhance the topology and flows informations. Currently only the Neutron driver is provided but more drivers will come soon.
Topology Probes
Topology probes currently implemented:
- OVSDB
- NetLINK
- NetNS
- Ethtool
Topology connectors:
- Neutron
- Docker
Flow Probes
Flow probes currently implemented:
- sFlow
- PCAP
Dependencies
- Go >= 1.5
- Elasticsearch >= 2.0
Install
Make sure you have a working Go environment. See the install instructions .
Then make sure you have Godep installed. See the install instructions .
$ go get github.com/redhat-cip/skydive/cmd/skydiveGetting started
Skydive relies on two main components:
- skydive agent, has to be started on each node where the topology and flows informations will be captured
- skydive analyzer, the node collecting data captured by the agents
Configuration
For a single node setup, the configuration file is optional. For a multiple node setup, the analyzer IP/PORT need to be adapted.
Processes are bound to 127.0.0.1 by default, you can explicitly change binding address with "listen: 0.0.0.0:port" in the proper configuration sections.
See the full list of configuration parameters in the sample configuration file etc/skydive.yml.default .
Start
$ skydive agent [--conf etc/skydive.yml]$ skydive analyzer [--conf etc/skydive.yml]WebUI
To access to the WebUI of agents or analyzer:
http://<address>:<port>Skydive client
Skydive client can be used to interact with Skydive Analyzer and Agents. Running it without any command will return all the commands available.
$ skydive client
Usage:
skydive client [command]
Available Commands:
alert Manage alerts
capture Manage captures
Flags:
-h, --help[=false]: help for client
--password="": password auth parameter
--username="": username auth parameter$ skydive client captureStart Flow captures
Skydive client allows you to start flow captures on topology Nodes/Interfaces
$ skydive client capture create -p <probe path>The format of a probe path follows the links between topology nodes from a host node to a target node :
host1[Type=host]/.../node_nameN[Type=node_typeN]- a host
- an interface
- a namespace
- host
- netns
- ovsbridge
- ovsbridge
- veth
- device
- internal
- tun
- bridge
$ skydive client capture create -p "host1[Type=host]/br1[Type=ovsbridge]""$ skydive client capture create -p "*/br1[Type=ovsbridge]"To delete a capture :
$ skydive client capture delete <probe path>API
Topology informations are accessible through HTTP or a WebSocket API
HTTP endpoint:
curl http://<address>:<port>/api/topologyws://<address>:<port>/ws/graph- NodeUpdated
- NodeAdded
- NodeDeleted
- EdgeUpdated
- EdgeAdded
- EdgeDeleted
Devstack
Skydive provides a DevStack plugin that can be used in order to have Skydive Agents/Analyzer configured and started with the proper probes by DevStack.
For a single node setup adding the following lines to your local.conf file should be enough.
enable_plugin skydive https://github.com/redhat-cip/skydive.git
enable_service skydive-agent skydive-analyzer# Address on which skydive analyzer process listens for connections.
# Must be in ip:port format
#SKYDIVE_ANALYZER_LISTEN=
# Inform the agent about the address on which analyzers are listening
# Must be in ip:port format
#SKYDIVE_AGENT_ANALYZERS=
# ip:port address on which skydive agent listens for connections.
#SKYDIVE_AGENT_LISTEN=
# Configure the skydive agent with the etcd server address
# http://IP_ADDRESS:2379
#SKYDIVE_AGENT_ETCD=
# The path for the generated skydive configuration file
#SKYDIVE_CONFIG_FILE=
# List of agent probes to be used by the agent
# Ex: netns netlink ovsdb
#SKYDIVE_AGENT_PROBES=
# Remote port for ovsdb server.
#SKYDIVE_OVSDB_REMOTE_PORT=6640
# Set the default log level, default: INFO
#SKYDIVE_LOGLEVEL=DEBUG