Red Hat PSAP TOPSAIL test orchestration framework

General

• TOPSAIL
  • Dependencies
  • TOPSAIL orchestration and toolbox
  • TOPSAIL projects organization
• Contributing
  • Pull Request Guidelines
  • Review Guidelines
  • Style Guidelines
    • YAML style
    • Ansible style
  • Coding guidelines

Understanding The Architecture

• The Test Orchestrations Layer
• The CI job launchers
  • Cluster creation
  • Cluster from pool
  • Bare-metal clusters
  • Launching TOPSAIL jobs on the CI engines
• TOPSAIL Configuration System
  • A bit of history
  • A bit of apology
  • How it actually works
  • Configuring the configuration with presets
• Calling the toolbox commands
  • Creating dedicated directories
  • Running toolbox commands in parallel
• The Reusable Toolbox Layer
• The Post-mortem Processing & Visualization Layer

Extending The Architecture

• Creating a New Orchestration
  • Prepare the environment
    • Prepare the test.py, config.yaml and command_args.yaml.j2
    • Copy the clusters.sh and configure.sh
    • Create test_....py and prepare_....py
  • Start building your test orchestration
    • Core helper modules
    • The projects.rhods.library.prepare_rhoai library module
    • The projects.gpu_operator.library.prepare_gpu_operator library module
    • The projects.local_ci.library.prepare_user_pods library module
    • The projects.matrix_benchmarking.library.visualize library module
• How roles are organized
• How default parameters are generated
  • Including new roles in Topsail’s CLI
    • 1. Creating a Python class for the new role
    • 2. Including the new toolbox class in the Toolbox
    • 3. Rendering the default parameters
    • 4. Executing the new toolbox command
• Creating a new visualization module
  • The store module
    • The store parsers
  • The store and models LTS and KPI modules
  • The plotting visualization module
  • The analyze regression analyze module

TOPSAIL's Toolbox

• Toolbox Documentation
  • cluster
  • configure
  • container_bench
  • crc
  • fine_tuning
  • run
  • gpu_operator
  • jump_ci
  • kserve
  • llm_load_test
  • llmd
  • local_ci
  • mac_ai
  • nfd
  • nfd_operator
  • pipelines
  • remote
  • repo
  • rhods
  • server
  • storage

Documentation generated on Apr 15, 2026 from git-main/f1f126e7.