Skip to end of metadata
Go to start of metadata

Install from Binaries

As of right now, we only have binary support for 32-bit Debian and Ubuntu based distributions. If you have a distribution you want supported, or better yet, want to support a new distribution, please send us mail. Note: User flowvisor must exist.


Install from Source

Install ant and java in order to build flowvisor:

Fetch the source:

Now, build it:

(FlowVisor also works with openjdk, but you will have to adjust the commands accordingly)

If the build ends with BUILD SUCCESSFUL then install flowvisor (run as root if installing to /usr/local):

When prompted, set the prefix to /usr/local and the user/group to the user/group you want the flowvisor to run as. Next, generate a default configuration file with:

Updating from Source

Now and then, fixes will be applied to the mercurial repository, and we will want to install them. In order to get the latest and greatest, do the following:

If the build ends with BUILD SUCCESSFUL then install flowvisor again. If you would like to keep your config then simply run:

This will leave the previous existing config file and database (if any) intact.

If you would like a completely fresh install, run:

This will completely wipe out any existing configuration and restore a default setup. So you may want to backup your config.

(If you have not yet updated to 0.8.3) Updating configuration file

This section only applies if you have not yet updated to version 0.8.3 and/or you have not done a fresh install where you generated a json config file.

To run flowvisor 0.8.3 and above you will need to convert your config file from xml to json. Luckily, we have made this easy for you. Once FlowVisor is installed, simply run:

This will convert you config.xml to json by creating a new file, config.json.

FlowVisor Configuration

This version of flowvisor uses an JSON configuration file. In our installation, this file lives in /usr/local/etc/flowvisor/flowvisor-config.json and can be hand-edited, but it is recommended to edit it using fvctl as described below.

The initial config file generated with the flowvisor package contains some sample slices and flow definitions. These must be removed before flowvisor can be used in your environment. In order to make the required changes, flowvisor must be running. Example invocation is:

Then, give the following commands (deleting slices implicitly deletes the rules associated with them):

You can now define a fall-back "production" slice that will catch all flows from all switches that are not handled by higher-priority flowspace definitions. Again, in the second window on the flowvisor machine, give the following commands:

Creating an Expedient-friendly mySSLKeyStore

The Expedient aggregate manager needs a correctly built mySSLKeyStore file in the flowvisor configuration directory. To build this file, do the following:

fvconfig generateCert will use the store password set in /usr/local/etc/flowvisor/envs and the output of hostname as the cert's common name. See man fvconfig for more details.


These instructions were heavily based on instructions from Chris Tengi from Princeton. Thanks Chris!