perfSONAR Mesh Config

The Mesh Config software is a framework for centrally configuring tests. It is designed to make managing a large set of testers (possibly distributed across multiple organizations) easier than managing each by hand. The process involves:

Building a configuration file that defines the tests you want run between a set of hosts
Running a script to convert the file to JSON
Publishing the JSON file to a web server
Running a script on each endpoint to read the JSON file from the web server and decide which tests to run
Optionally running a script on a host running MaDDash to build dashboards of the tests you have defined.

Getting the Code

You may checkout the code with the following command:

git clone --recursive https://github.com/perfsonar/mesh-config.git

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

Building and Installing

To install the code on your system run:

make install

Packaging

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

make dist

Running

To build a JSON file run:

/usr/lib/perfsonar/bin/build_json --input <path-to-config-file> --output <path-to-json-output-file>

To generate a test configuration run:

/usr/lib/perfsonar/bin/generate_configuration

To generate a MaDDash configuration run:

/usr/lib/perfsonar/bin/generate_gui_configuration

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