Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.94 KB

getting_started.md

File metadata and controls

47 lines (32 loc) · 2.94 KB
Raw

Quick Start

We want to make it as easy as possible for you to start engaging with SuzieQ. We support two ways in which you can get started with SuzieQ. The first is using pre-built Docker containers, and the second is as a regular python package.

As a Docker Container

To get started seeing the kind of analysis SuzieQ provides today, we have a demo container that has data in including the image.

    docker run -it -p 8501:8501 --name suzieq netenglabs/suzieq-demo
    suzieq-cli # for the CLI
    suzieq-gui # for the GUI. Connect to http://localhost:8501 via the browser to access the GUI

When you're within the suzieq-cli, you can run device unique columns=namespace to see the list of different scenarios, we've gathered data for. Use help inside the suzieq-cli to navigate your way around the CLI. Network operators should find the CLI easy to use as a router/bridge CLI as it provides contextual help and completions.

To start collecting data for your network, create an inventory file to gather the data from following the instructions here. Decide the directory where the data will be stored (ensure you have sufficient available space if you're going to be running the poller, say 100 MB at least). Lets call this dbdir. Now launch the suzieq docker container as follows:

    docker run -it -v dbdir:/home/suzieq/parquet --name sq-poller netenglabs/suzieq
    docker attach sq-poller # connect to the container

Launch the poller with the appropriate options. For example, sq-poller -I inventory.yml where inventory.yml is the inventory file containing all the devices to poll. See section Poller and Inventory file for further information about which arguments to use, supported NOS and how to build an inventory file.

As a Python Package

SuzieQ is also available as a standard Python package that you can install via pip. We strongly recommend the use of Python virtual environment. SuzieQ only works with Python versions 3.8.1 and above, and on Linux and MacOS. The releases are always tested with Python versions 3.8 and 3.9.

To install suzieq via pip run:

    pip install suzieq

To setup a virtual environment if you don't know how to, is as simple as:

  • Running python -m venv suzieq-env (Assuming suzieq-env is a directory in the current folder you want to create the virtual environment in. The directory name can be anything you want it to be).
  • Activating the virtual environment by changing directory to suzieq-env, and running source bin/activate

Now, you can install suzieq via pip install as described above.

Now you can use the main applications of SuzieQ:

  • sq-poller: The poller to gather the data from the various routers and bridges and Linux servers
  • suzieq-gui: The GUI front end to view, query and analyze the data
  • suzieq-cli: The CLI front end to view, query and analyze the data
  • sq-rest-server: The REST API server