perfSONAR Toolkit

This repository contains scripts and GUIs included with the Toolkit distribution of perfSONAR. A Toolkit includes a full operating system with a consistent environment in terms of default system tunings, firewalls, and software configurations. It also includes GUIs used to manage the Toolkit system and display measurement results.

Getting the Code

You may checkout the code with the following command:

git clone --recursive https://github.com/perfsonar/toolkit.git

Note the use of the --recursive option to ensure any submodule trees are included in the clone.

Building and Installing

It is recommended you use the provided Vagrant VM to run the software. The Vagrant VM builds an environment with the needed dependencies to build, run and test the software. Changes you make in the directory on the host system will be reflected in the /vagrant directory of the VM. You can start the VM as follows:

vagrant up

You can then login with:

vagrant ssh

As you make changes, you can deploy them as follows:

cd /vagrant
sudo make install

Packaging the Source

You may create a source tarball of this code with the following:

make dist

Building RPMs

You can build the RPMs with the following commands:

cd rpms
vagrant up
vagrant ssh
build

For more information on building and testing RPMs see shared/rpms/RPM_README.md.

Using the shared Submodule

This repository contains a git submodule to the perfSONAR shared repository. This submodule is used to access common perfSONAR libraries. You will find a number of symbolic links to these modules under lib. The use of a submodule has a few implications when working with the code in this repository:

As previously noted, when you clone the repository for the first time, you will want to use the --recursive option to make sure the submodule tree is included. If you do not, any symbolic links under lib will be broken in your local copy. If you forget the --recursive option, you can pull the submodule tree with the following commands:
```
git submodule init
git submodule update
```
When you are editing files under lib be sure to check if you are working on an actual file or whether it's a link to something under shared. In general it is better to make changes to the shared submodule by editing the shared repository directly. If however you do make changes while working in this repository, see the git submodule page for more details on pushing those changes to the server.
Keep in mind that a submodule points at a specific revision of the repository it is referencing. As such if a new commit is made to the shared submodule's repository, this project will not get the change automatically. Instead it will still point at the old revision. To update to the latest revision of the shared submodule repository run the following commands:
```
git submodule foreach git pull origin master
git commit -a -m "Updating to latest shared"
git push
```
If you want to include a new file from the shared submodule, create a symbolic link under lib. For example, if you were to add a reference to the perfSONAR_PS::Utils::DNS module you would run the following:
```
mkdir -p lib/perfSONAR_PS/Utils/
cd lib/perfSONAR_PS/Utils/
ln -s ../../../shared/lib/perfSONAR_PS/Utils/DNS.pm DNS.pm
```
For more information on using the submodule, see the shared/README.md file or access it here