perfSONAR User Guide

perfSONAR is a collection of software for performing and sharing end-to-end network measurements. This document guides you through the process of installing, configuring and using the perfSONAR on one or more hosts.

perfSONAR Installation Options

• perfSONAR Installation Options
  • System Requirements
  • CentOS Toolkit ISO Installation
  • CentOS Bundle Installation
  • Debian Bundle Installation

perfSONAR Toolkit

Installation

• Toolkit Installation Quick Start
• Toolkit System Requirements
• Getting the Toolkit Software
  • Choosing a Toolkit Installation Method
  • Downloads
  • Alternative installation methods
• Toolkit NetInstall Guide
  • Downloading installation media and booting the system
  • Step-by-Step Guide using graphical installer
  • Step-by-Step Guide using text mode
• Toolkit Full Install Guide
  • Downloading installation media and booting the system
  • Step-by-Step Guide using graphical installer
  • Step-by-Step Guide using text mode
• Configuring the Toolkit for the First Time
  • Your First Login
  • Accessing the Web Interface
  • Updating Your Administrative Information
  • Managing Toolkit Security
  • Scheduling Regular Measurements
  • What next?

Managing the perfSONAR Toolkit

• Choosing a Management Method
  • Standalone Node
  • Centrally Managed Node
  • Combination Node
• Configuring Regular Tests
  • Accessing the Configuration interface
  • Types of Regular Tests
  • Adding Regular Tests
  • Editing Regular Tests
  • Disabling/Enabling Regular Tests
  • Deleting Regular Tests
• Updating Administrative Information
  • Accessing the Administrative Info Interface
  • Editing Host Information
  • Adding Node Metadata
  • Deleting Node Metadata
  • Adding a Community
  • Deleting a Community
• Managing Services
  • List of Services
  • Choosing Services to Enable
  • Enabling/Disabling Services
• Configuring NTP
  • Accessing the NTP Interface
  • Selecting the Closest Servers
  • Manually Selecting a Known Server
  • Manually Adding a Server
  • Deselecting a Server
  • Deleting a Known Server
• Reading Log Files
  • Important Log Files
  • Accessing Log Files Through the Web Interface
  • Determining Who Is Testing to Your Host
• Updating the Toolkit
  • Manually Updating with Yum
  • Automatic Updates
  • Special Upgrade Notes
• Managing Users
  • Adding a User
  • Deleting a User
  • Changing a User’s Password
• Host Tuning
• Configuring a Host with Multiple Interfaces
  • IP Addressing Strategy
  • Host Routing Table Configuration
• Firewalls and Security Software
  • Default Firewall Rules
  • Adding Your Own Firewall Rules
  • Fail2ban Intrusion Detection System
• Installing Additional Tools
  • perfsonarUI
  • MaDDash

Using the perfSONAR Toolkit

• Regular Testing Graphs
• Network Diagnostic Tool (NDT)
• Network Path and Application Diagnostics (NPAD)
• External Tools

Additional Installation Options

• Installation of CentOS Bundles
  • System Requirements
  • Installation
• Installation on Debian
  • System Requirements
  • Installation Instructions
  • Support
  • Beta packages
• perfSONAR on Low Cost Nodes
  • pi-class Devices
  • $200-class devices
  • 1RU half-depth devices
• System Requirements
  • Installation Instructions
  • Support
• Low Cost Nodes Configuration
  • Introduction
  • Configuration
  • Mesh Configuration

Additional perfSONAR Tools

perfSONAR UI

• perfsonarUI Installation Guide
  • Introduction
  • Installation process
  • Installing on Linux using repositotry
  • Installing on Linux manually by downloading binary packages
  • Testing the installation
  • Optional configuration
  • Logging and usage statistics
• perfsonarUI User Guide
  • Introduction
  • Access To the Application
  • Content Organization
  • perfSONAR Service Selection Panel
  • Working With Measurements
  • Configuration Of the UI
  • Configuring Authentication With Identity Provider

Managing Multiple perfSONAR Hosts

Introduction to Central Management

• Central Configuration Overview
  • Defining Tests for Multiple Hosts
  • Storing Your Measurements
  • Visualizing the Results

Central Test Configuration

• Publishing a Central Configuration File
  • Installing the Required Software
  • Generating the Configuration
  • Converting to JSON
  • Publishing
• Reading a Central Configuration File
  • Finding a Test Mesh
  • Configuring a Host To Participate in a Mesh
• Automatic Test Configuration
  • Introducing Host Classes and Tags
  • Testing to a Fixed Set of Target Hosts
  • Testing to a Dynamic Set of Target Hosts
  • Examples of Common Host Class Configurations

Central Measurement Archive

• Deploying a Central Measurement Archive
  • Installing the Measurement Archive Software
  • Authenticating Measurement Hosts
  • Configuring Measurement Hosts
• Clustering a Measurement Archive
  • Clustering Cassandra
  • Clustering PostgreSQL
  • Clustering Apache httpd
• Managing Measurement Archive Data
  • Backing-up and Restoring Data
  • Migrating Data
  • Deleting Old Data

Central Logging

• Central Logging Configuration
  • Introduction
  • System Requirements
  • Configuration

Managing Nodes with Puppet

• Puppet management overview
  • Introduction
  • Architecture
• Installing Puppet
  • System Requirements
  • Server Installation
  • Client Installation
• Configuring the puppet master (server)
  • Notes
  • Introduction
  • Installing the Puppet Module
  • Declaring your nodes
• Configuring the puppet clients
  • Notes
  • Configuring the client nodes

Accessing Raw Data

• perfSONAR Client API

Configuration Reference

Listing of perfSONAR Files

• Listing of Important perfSONAR Files
  • BWCTL
  • esmond
  • LS Registration Daemon
  • MeshConfig
  • OWAMP
  • Regular Testing
  • Toolkit

BWCTL

• BWCTL Server Configuration File
• BWCTL Limits File

Lookup Service Registration Daemon

• Lookup Service Registration Daemon Configuration File

MeshConfig

• Mesh Configuration (.conf) file
• MeshConfig Agent Configuration File
• MeshConfig GUI Agent Configuration File
• Dynamic Host Lookup Configuration File

OPPD

• OPPD

OWAMP

• OWAMP Server Configuration File
• OWAMP Limits Configuration File

Regular Testing

• Regular Testing Configuration File

Previous Releases

• Previous Release Documentation

Future Releases

• Testing Release Candidates

Further Information

• Project Homepage
• Source Code Repository
• Issue Tracker
• Project Wiki
• Frequently Asked Questions (FAQs)
• Mailing Lists
  • User Mailing List - Forum where users may ask and answer questions about their perfSONAR deployments
  • Announcement Mailing List - List where important announcements such as new releases and security updates are posted.

Related Projects

• esmond
• iperf3
• Lookup Service
• MaDDash
• NDT
• psUI

Search

• Search Page