Skip to content

skydive-project/skydive

Folders and files

NameName
Last commit message
Last commit date
Jul 30, 2019
May 14, 2019
Jul 30, 2019
Jul 30, 2019
Jul 30, 2019
Jul 30, 2019
Aug 8, 2019
Sep 12, 2019
Apr 18, 2019
Sep 6, 2019
Aug 8, 2019
Jul 30, 2019
Jun 5, 2019
Sep 8, 2019
Jul 30, 2019
Sep 2, 2019
Jul 30, 2019
Jul 30, 2019
May 15, 2019
Jun 21, 2019
Jul 15, 2019
Jul 30, 2019
Apr 18, 2019
Jul 15, 2019
Aug 5, 2019
Apr 2, 2019
Sep 10, 2019
Jun 5, 2019
Aug 1, 2019
Jul 15, 2019
Sep 3, 2019
Sep 5, 2019
Jul 30, 2019
Jun 19, 2019
Sep 8, 2019
Nov 9, 2017
Sep 8, 2019
Jul 3, 2017
Aug 18, 2018
Dec 6, 2017
Sep 10, 2019
Jul 26, 2017
Oct 4, 2016
Sep 9, 2019
Jul 17, 2019
May 14, 2018
Jan 30, 2019
Jun 6, 2019

Repository files navigation

Go Report Card GitHub license StackShare PyPI IRC

Skydive

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 information and flows and forward them to a central agent for further analysis. All the information is stored in an Elasticsearch database.

Skydive is SDN-agnostic but provides SDN drivers in order to enhance the topology and flows information.

Key features

  • Captures network topology and flows
  • Full history of network topology and flows
  • Distributed
  • Ability to follow a flow along a path in the topology
  • Supports VMs and Containers infrastructure
  • Unified query language for topology and flows (Gremlin)
  • Web and command line interfaces
  • REST API
  • Easy to deploy (standalone executable)
  • Connectors to OpenStack, Docker, OpenContrail

Quick start

All-in-one

The easiest way to get started is to download the latest binary and to run it using the all-in-one mode :

curl -Lo skydive https://github.com/skydive-project/skydive-binaries/raw/jenkins-builds/skydive-latest && \
chmod +x skydive && sudo mv skydive /usr/local/bin/

SKYDIVE_ETCD_DATA_DIR=/tmp SKYDIVE_ANALYZER_LISTEN=0.0.0.0:8082 sudo -E /usr/local/bin/skydive allinone

Open a browser to http://localhost:8082 to access the analyzer Web UI.

Docker

docker run -d --privileged --pid=host --net=host -p 8082:8082 -p 8081:8081 \
    -e SKYDIVE_ANALYZER_LISTEN=0.0.0.0:8082 \
    -v /var/run/docker.sock:/var/run/docker.sock -v /run/netns:/var/run/netns \
    skydive/skydive allinone

Open a browser to http://localhost:8082 to access the analyzer Web UI.

Docker Compose

To quick set up a more complete working environment (with history support), Docker Compose can be used to automatically start an Elasticsearch container, a Skydive analyzer container and a Skydive agent container.

curl -o docker-compose.yml https://raw.githubusercontent.com/skydive-project/skydive/master/contrib/docker/docker-compose.yml
docker-compose up

You can also use the Skydive command line client with:

docker run --net=host -ti skydive/skydive client query "g.V()"

Open a browser to http://localhost:8082 to access the analyzer Web UI.

Documentation

Skydive documentation can be found here:

Tutorials

Skydive tutorials can be found here:

Contributing

Your contributions are more than welcome. Please check https://github.com/skydive-project/skydive/blob/master/CONTRIBUTING.md to know about the process.

Contact

License

This software is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.