​

Features

• System performance benchmarking
• Network throughput and latency testing
• Disk I/O stress testing
• System information and diagnostics
• Lightweight with minimal dependecies

​

What Gets Checked

​

Operating System & Kernel

• OS name and version detection
• Kernel version and architecture
• System uptime and boot information

​

CPU Analysis

• Physical cores and logical threads
• CPU model and frequency information
• NUMA configuration
• Performance benchmarking (sysbench)

​

Memory Analysis

• Total, available, and used memory
• Swap usage and configuration
• Memory throughput benchmarking

​

Storage & Filesystem

• Disk type detection (SSD/HDD/NVMe)
• Filesystem information and mount options
• Disk usage and available space
• I/O performance testing (FIO)

​

Network Configuration

• Network interface enumeration
• IP address configuration
• DNS resolution testing
• Interconnectivity validation
• Throughput testing (iperf3)

​

Security Analysis

• SELinux: Status, mode, policy, boolean settings
• AppArmor: Profile statistics and enforcement status
• Firewall: UFW, firewalld, or iptables analysis
• SSH Configuration: Port, authentication methods, security settings
• Security Services: Status of critical security services

​

System Configuration

• ulimit values (open files, stack size)
• Important sysctl parameters
• Process limits and system constraints

​

Kernel & Journal Log Capture

• Copies dmesg and journalctl logs from hosts when present for troubleshooting
• Hardware-related message extraction and categorization are available within host scripts

​

Prerequisites & Dependencies

​

Operating System Prerequisites

• Linux-based distributions (RHEL, CentOS, Rocky, Alma, Ubuntu, Debian, Oracle Linux, etc.)
• x86-64 architecture (minimum required)

​

Dependency Management

1. Orchestrator (preFlight.sh) Dependencies - Installed on the machine running the orchestrator script.
2. Remote Host Dependencies - Installed on target hosts that PreFlight will test.
   • These can be automatically installed using --auto-install-deps (internet required).
   • If not using automatic installation, all dependencies must be manually installed beforehand.

​

Orchestrator (preFlight.sh) Dependencies

• jq - JSON processing for parsing results
• bc - mathematical calculations (compression ratios, analysis)
• tar/gzip - archive creation (for —compress option)
• ssh/scp - remote host communication
• coreutils - common utilities (find, grep, awk, sed, etc.)

​

Remote Host Dependencies

• curl
• bc
• tar
• findutils
• net-tools
• bind-utils
• iperf3 - network throughput benchmarking
• fio - disk I/O benchmarking
• sysbench - CPU and memory benchmarking

​

SSH

ssh-keygen -t ed25519 -f ~/.ssh/id_rdt -N "" && cat ~/.ssh/id_rdt.pub >> ~/.ssh/authorized_keys

​

Quick Start

# 1) Generate an inventory file with detected devices (replace user and hosts)
./util/detect_devices.sh -u <user_name> -k <path_to_ssh_key> 192.168.1.10 192.168.1.11 > hosts.json

# 2) Run the orchestrator (requires SSH access to all hosts)
./preFlight.sh -i hosts.json -r /tmp/cluster_ready -k <path_to_ssh_key> -u <user_name> 

# 3) Inspect results
ls -1 cluster_results_*/

​

All Options (Parameters) for the preFlight.sh

​

Configuration Parameters

​

Test Parameters

​

Examples

# Simple connectivity test
./preFlight.sh -i hosts.json -u <user_name> -k ~/.ssh/cluster_key -r /tmp/test

# Using multipule options
./preFlight.sh -i hosts.json -u <user_name> -k ~/.ssh/cluster_key -r /tmp/test --auto-install-deps --interconnectivity --parallel-fio --sequential-fio --network-throughput

​

Inventory File Format

{
  "hosts": {
    "192.168.1.10": {
      "devices": [
        {"path": "/dev/sda", "type": "hdd", "size_bytes": 1000000000000},
        {"path": "/dev/nvme0n1", "type": "nvme", "size_bytes": 500000000000}
      ]
    },
    "192.168.1.11": {
      "devices": [
        {"path": "/dev/sdb", "type": "ssd", "size_bytes": 2000000000000}
      ]
    }
  }
}

​

FIO Files

[global]
filename=/dev/nvme0n2   # will be overridden during the PreFlight run
kb_base=1024
ioengine=libaio
direct=1
runtime=5
stonewall
group_reporting

[rand_read_4k_1]
readwrite=randread
blocksize=4k
numjobs=1
iodepth=1

# ... more tests ...

​

Output & Results

​

File Structure Overview

├── orchestrator.log                       # Main execution log
├── cluster_summary.json                   # Aggregated report (per-host + references)
├── file_listing.json                      # Flat listing of files in results dir
├── fio_config_analysis_results.json       # FIO configuration analysis (write/safety)
├── interconnectivity_matrix.json          # Host-to-host connectivity (ping/ssh/port)
├── interconnectivity_logs/                # Detailed per-connection logs
├── network_throughput_matrix.json         # iperf3 results (matrix)
├── network_throughput_summary.json        # Stats (min/max/avg, success rate)
├── rdb_process_ready_results.json         # RDB ready checks (if enabled)
├── fio_files/                             # FIO job files used for tests (if any)
├── <host_ip_1>/                           # Per-host data (one directory per host)
│   ├── logs/                              # Per-host logs (readiness, dependencies, FIO, etc.)
│   ├── results/                           # Per-host JSON results
│   │   ├── static_gather.json             # Static system info (system_readiness subset)
│   │   ├── cpu_benchmark.json             # CPU benchmark results
│   │   ├── memory_benchmark.json          # Memory benchmark results
│   │   ├── device_check.json              # Device verification results from inventory
│   │   └── fio/
│   │       ├── merged_parallel_fio.json   # Consolidated parallel FIO results for this host
│   │       └── merged_sequential_fio.json # Consolidated sequential FIO results for this host
│   ├── dmesg_*.log                        # Kernel logs collected from each host
│   └── journalctl_*.log[.gz]              # System journal logs collected from each host
└── <host_ip_2>/                           # Same structure per host
    └── ...

​

Troubleshooting

​

SSH Connectivity Issues

# Test SSH connectivity manually
ssh -i ~/.ssh/key user@192.168.1.10

# Check SSH service on target
ssh user@192.168.1.10 "systemctl status sshd"

​

Permission Issues

# Run with sudo if needed
sudo ./host_files/system_readiness_check.sh

# Check SSH user permissions
ssh user@192.168.1.10 "sudo -l"

​

Advanced

​

Execution Flow

​

Orchestrator Machine

• Script: preFlight.sh
• Purpose: Coordinates all remote tests and aggregates results
• Libraries: All files in /lib/*.sh
• Dependencies: Primarily SSH utilities, JSON tools, and core utilities

​

Remote Hosts (Target Machines)

• Scripts: Files in /host_files/ directory
  • system_readiness_check.sh - Main remote diagnostic script
  • fio_benchmark_only.sh - FIO testing script
  • remote_fio_wrapper.sh - FIO wrapper for remote execution
  • install_dependencies.sh - Dependency installation script
• Purpose: Execute system tests and diagnostics
• Libraries: lib/common.sh (copied to hosts)
• Dependencies: Performance and system analysis tools

​

Responsibilities of Individual Scripts

​

System Readiness Check (host_files/system_readiness_check.sh)

• Invoked by the orchestrator with prepared parameters.
• Performs system diagnostics, CPU/memory benchmarks, and optional disk tests
• Outputs structured JSON consumed by the orchestrator

​

Cluster Orchestrator (preFlight.sh)

• Multi-machine coordination
• Interconnectivity tests
• Parallel and sequential FIO testing
• Network throughput benchmarks (all-to-all or server-to-all)
• Automatic dependency installation (--auto-install-deps)

​

FIO Benchmark Tool (host_files/fio_benchmark_only.sh)

• Disk I/O performance testing
• Supports basic and extensive test modes
• Automatic device detection
• Supports custom test configurations

​

License