Skip to content

Add perfSONAR Toolkit (RPM) installation guide#55

Merged
ShawnMcKee merged 1 commit intomasterfrom
add-perfsonar-toolkit-installation-guide
Dec 10, 2025
Merged

Add perfSONAR Toolkit (RPM) installation guide#55
ShawnMcKee merged 1 commit intomasterfrom
add-perfsonar-toolkit-installation-guide

Conversation

@ShawnMcKee
Copy link
Contributor

Overview

This PR adds a comprehensive installation guide for perfSONAR Toolkit using RPM packages, complementing the existing container-based Testpoint guide. Sites can now choose between two deployment models based on their requirements.

What's New

New Documentation

  • docs/personas/quick-deploy/install-perfsonar-toolkit.md (1,305 lines)
    • Complete toolkit installation guide adapted from testpoint
    • RPM-based installation using dnf install perfsonar-toolkit
    • Native systemd service management
    • Web UI setup at https://hostname/toolkit
    • Local measurement archive configuration
    • All commands adapted from container to native filesystem/service access

Updated Documentation

  • docs/personas/quick-deploy/landing.md: Added deployment type comparison with feature lists
  • mkdocs.yml: Restructured navigation with 'Installation Guides' submenu
  • docs/index.md: Updated to mention both deployment options
  • docs/perfsonar-in-osg.md: Added links to both installation guides
  • docs/perfsonar/deployment-models.md: Enhanced Toolkit vs Testpoint comparison
  • docs/perfsonar/installation.md: Updated legacy notice to reference both guides

Key Differences: Testpoint vs Toolkit

Feature Testpoint (Container) Toolkit (RPM)
Installation Container images RPM packages
Web UI None https://hostname/toolkit
Archive Remote only Local OpenSearch + Logstash
Updates Container pulls dnf-automatic
Management podman exec Direct systemctl
Resources Lightweight Full-featured

Structure

The toolkit guide follows the same 8-step structure as testpoint:

  1. Step 1: Install and Harden EL9 (unchanged)
  2. Step 2: ✨ Rewritten - RPM installation instead of containers
  3. Step 3: Configure PBR (unchanged - works for both)
  4. Step 4: Security configuration (noted as pre-configured by toolkit)
  5. Step 5: ✨ Rewritten - Service verification and web UI setup
  6. Step 6: pSConfig enrollment (adapted with web UI option)
  7. Step 7: WLCG/OSG registration (adapted with web UI option)
  8. Step 8: Validation (adapted all container commands to native)

Testing

✅ Site builds successfully: check_site_for_backticks.py --build returns OK
✅ No visible backticks in generated HTML
✅ All navigation links updated and working
✅ 1,418 insertions across 7 files

Reviewers

Please review:

  • Technical accuracy of RPM installation steps
  • Consistency with upstream perfSONAR docs at https://docs.perfsonar.net/install_el.html
  • Clarity of deployment type comparison on landing page
  • Navigation structure in mkdocs.yml

Related Issues

This addresses the need for clear documentation of both deployment models, allowing sites to choose the appropriate option based on their requirements (lightweight testpoint vs full-featured toolkit).

This commit adds a comprehensive installation guide for perfSONAR Toolkit
using RPM packages, complementing the existing container-based Testpoint guide.

New content:
- docs/personas/quick-deploy/install-perfsonar-toolkit.md: Complete toolkit
  installation guide adapted from testpoint guide with RPM-specific instructions
  * Step 2: DNF repo configuration and perfsonar-toolkit bundle installation
  * Step 5: Native service management, web UI setup, and dnf-automatic updates
  * Steps 6-8: Adapted all container commands to native systemctl/filesystem access

Updated documentation:
- docs/personas/quick-deploy/landing.md: Added deployment type comparison
  (Testpoint vs Toolkit) with feature lists and links to both guides
- mkdocs.yml: Restructured navigation with 'Installation Guides' submenu
- docs/index.md: Updated to mention both deployment options
- docs/perfsonar-in-osg.md: Added links to both installation guides
- docs/perfsonar/deployment-models.md: Enhanced Toolkit vs Testpoint comparison
  with installation guide links
- docs/perfsonar/installation.md: Updated legacy notice to reference both guides

Key differences in toolkit guide:
- RPM package installation instead of containers
- Local web UI at https://hostname/toolkit
- Local measurement archive (OpenSearch + Logstash)
- Native systemd service management
- dnf-automatic for updates instead of container image pulls
- All /opt/perfsonar-tp paths changed to /opt/perfsonar-toolkit

Site builds successfully with no rendering issues (verified with
check_site_for_backticks.py).

Addresses the need for clear documentation of both deployment models,
allowing sites to choose between lightweight container-based testpoints
and full-featured RPM-based toolkit installations.
@ShawnMcKee ShawnMcKee merged commit 5f8fc74 into master Dec 10, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant