storage-benchmark

#!/bin/bash

###############################################################################
############################## README #########################################
#
# This script will execute a series of fio based IO tests against a targeted
# directory specified in its execution. This test will create a very large
# file that is double (2x) the size of the physical RAM on this system to
# ensure that we are not just testing the caching at the OS level of the
# storage.
#
# NOTE: We recommend you stop all services before executing this script and
# will be prompoted to do so.
#
# RESULTS: This test is meant to provide guidance and is not a hard-and-fast
# indicator of how your Satellite will perform. For more information please
# see this KCS here:
#
# https://access.redhat.com/solutions/3397771
#
# Generally you wish to see on average 100MB/sec or higher in the READ test.
#  - Local SSD based storage should values of 600MB/sec or higher.
#  - Spinning disks should see values in the range of 100-200MB/sec or higher.
#  - Note that the random READ/WRITE results are expected to be much slower.
#  - If you see values below this, please open a support ticket for assistance.
#
###############################################################################


# Exit on any error
set -e

testlocation(){
  mkdir -p $TESTDIRECTORY
  echo ""
  echo "Starting IO tests via the 'fio' command. This may take up to an hour or more"
  echo "depending on the size of the files being tested. Be patient!"
  echo ""
  echo "************* Running READ test via fio:"
  echo ""
  fio --name=read-test --rw=read --size="$FILEGB"G --directory=$TESTDIRECTORY --unlink=1
  echo ""
  echo "************* Running WRITE test via fio:"
  fio --name=write-test --rw=write --size="$FILEGB"G --directory=$TESTDIRECTORY --unlink=1
  echo ""
  echo "************* Running Random READ/WRITE test via fio:"
  fio --name=randrw-test --rw=randrw --size="$FILEGB"G --directory=$TESTDIRECTORY --rwmixread=80 --unlink=1
  echo ""
  echo "Test complete! There is still a directory located : $TESTDIRECTORY that you"
  echo "will need to remove to run this test again."
}

usage(){
  echo "Please specify a path to test file IO against:"
  echo ""
  echo "  # ./storage-benchmark /var/lib/pulp/"
  echo ""
}

TESTPATH=$1

if [ -z $TESTPATH ]
then
  usage
  exit 1
fi

RAMGB=$(awk '/^MemTotal:/ {printf "%d\n", $2 / 1024 / 1024}' /proc/meminfo)
FILEGB="$(($RAMGB * 2))"
TESTDIRECTORY=$TESTPATH/storage-benchmark

echo "This test creates a test file that is double (2X) the size of this system's"
echo "RAM in GB. This benchmark will create a test file of size.. "
echo ""
echo  -e "\033[33;5;7m$FILEGB Gigabytes\033[0m"
echo ""
echo ".. in the: [$TESTDIRECTORY] location. This is to ensure that the test utilizes"
echo "a combination of cached and non-cached data during the test."
echo ""
echo "**** WARNING! Please verify you have enough free space to create a $FILEGB GB"
echo "file in this location before proceeding. "
echo ""
echo "Do you wish to proceed? (Y/N) "
read PROCEED
if [[ ! $PROCEED =~ ^[Yy]$ ]]
then
    echo "** cancelled **"
    exit 1
fi


if [[ ! -x /usr/bin/fio ]]; then
    echo "This benchmark requires the 'fio' command be installed"
    echo "Would you like to install it? (Y/n)"
    read INSTALLFIO
    if [[ ! $INSTALLFIO =~ ^[Yy]$ ]]; then
        echo "** cancelled **"
        exit 1
    else
        echo "** Installing fio **"
        if [[ ! -x "$(command -v foreman-maintain)" ]]; then
            echo "foreman-maintain not installed. Installing 'fio' using yum."
            yum install -y fio
        else
            foreman-maintain packages install -y fio
        fi
    fi
fi

echo ""
echo "**** WARNING! We recommend you stop all Satellite 6 services to ensure no "
echo "interruption to critical processes."
echo ""

echo "Do you wish to stop Satellite 6 services? (Y/N) "
read STOPSERVICES
if [[ $STOPSERVICES =~ ^[Yy]$ ]]
then
    if ! [ -x "$(command -v foreman-maintain)" ]; then
        echo "foreman-maintain not installed. Continuing."
    else
        echo ""
        echo "Stopping services."
        echo ""
        foreman-maintain service stop
    fi
fi

testlocation

if [[ $STOPSERVICES =~ ^[Yy]$ ]]
then
    if ! [ -x "$(command -v foreman-maintain)" ]; then
        echo "foreman-maintain not installed. Continuing."
    else
        echo ""
        echo "Starting services."
        echo ""
        foreman-maintain service start
    fi
fi

echo "Finished."