index.rst

User Guide for perfSONAR |release|

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 perfSONAR on one or more hosts.

Getting Started

.. toctree::
   :maxdepth: 1

   intro_about

Planning for Installation

.. toctree::
   :maxdepth: 1

   install_options
   install_hardware
   install_small_node_details

Installation

.. toctree::
   :maxdepth: 1

   install_getting
   install_quick_start
   install_config_first_time
   install_el
   install_centos
   install_debian
   install_docker
   install_ansible
   manage_update

perfSONAR Toolkit

.. toctree::
   :maxdepth: 1

   manage_choose
   manage_regular_tests
   manage_admin_info
   manage_ntp
   manage_logs
   manage_update
   manage_users
   manage_tuning
   manage_dual_xface
   manage_security
   manage_limits
   manage_daemons
   using_graphs
   using_ext_tools
   grafana_cookbook

Running Measurements with pScheduler

.. toctree::
   :maxdepth: 1

   pscheduler_intro
   pscheduler_client_tasks
   pscheduler_client_schedule
   pscheduler_server_running
   pscheduler_batch
   config_pscheduler_limits
   pscheduler_ref_tests_tools
   pscheduler_ref_archivers
   pscheduler_ref_contexts
   pscheduler_ref_bwctl
   pscheduler_disk_to_disk

Managing Multiple Hosts with pSConfig

.. toctree::
   :maxdepth: 1

   psconfig_intro
   psconfig_quickstart
   psconfig_templates_intro
   psconfig_publish
   psconfig_pscheduler_agent
   psconfig_maddash_agent
   pwa
   psconfig_templates_vars
   psconfig_templates_advanced

Archiving Measurements with OpenSearch

.. toctree::
   :maxdepth: 1

   multi_ma_install
   legacy_archive_esmond

Displaying Measurements with MaDDash

.. toctree::
   :maxdepth: 1

   maddash_intro
   MaDDash Quick Install Guide <https://docs.google.com/document/d/1k7FT66MKPy3JjpD5k0OFAFlTpSdFmZ6huhTUDQ2rGGY/edit?usp=sharing>
   maddash_install
   maddash_config_server
   maddash_running
   maddash_config_webui
   maddash_admin_ui
   maddash_api_intro

Configuration Reference

.. toctree::
   :maxdepth: 1

   config_files
   config_ls_registration
   config_pscheduler
   config_pscheduler_limits
   config_owamp
   config_owamp_limits

Troubleshooting

.. toctree::
   :maxdepth: 1

   troubleshooting_overview
   FAQ

Accessing Raw Data

.. toctree::
   :maxdepth: 1

   client_tools
   client_apis
   esmond_api_rest

Previous Releases

.. toctree::
   :maxdepth: 1

   previous_releases

Future Releases

.. toctree::
   :maxdepth: 1

   install_rcs

Further Information

• Project Homepage
• Source Code Repository
• Issue Tracker
• Project Wiki
• 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.

Deployment Examples

.. toctree::
   :maxdepth: 1

   deployment_examples

Related Projects

• iperf3
• Lookup Service

Search

• :ref:`search`