The following steps assume that only a single node participates in the benchmark run. If you want a multi-node setup, you have to read up on the --remote options of various commands (in particular, pbench-register-tool-set)

Customize the agent for your server environment. This will vary from installation to installation, but it fundamentally involves copying two files that should be made available to you somehow by an administrator: an ssh private key file to allow the client(s) to send results to the server and a configuration file that should be installed in /opt/pbench-agent/config/pbench-agent.cfg. There is an example configuration file in that location, which allows you to run benchmarks normally and gather results; but you need the "real" one for your environment in order to send results to the server, since among other things, the config file specifies who the server is.

Run your benchmark with a default set of tools:

. /etc/profile.d/pbench-agent.sh #or log out and log back in

pbench-register-tool-set

pbench-user-benchmark -C test1 -- ./your_cmd.sh

pbench-move-results

Visit the Results URL in your browser to see the results: the URL depends on who the server is; assuming that the server is "pbench.example.com" and assuming you ran the above on a host named "myhost", the results will be found at (N.B.: this is a fake link serving as an example only - talk to your local administrator to find out what server to use to get to Pbench results): http://pbench.example.com/results/myhost/pbench-user-benchmark_test1_yyyy-mm-dd_HH:MM:SS

Don't see what you need here?

The inventory file can be named anything and placed anywhere, but for definiteness, we will assume it is in ~/.config/Inventory/myhosts.inv.

The following inventory is only an example: your administrator should provide a local version with the appropriate values for the second section filled in (the section after the "DO NOT CHANGE ANYTHING BELOW THIS LINE" comment, which is meant for users: users should not change that section, except for testing and debugging purposes). The following paragraphs should be read in the context where that has already been done (see the "Administrator responsibility: Config file and ssh key file" below for more details on this).

Copy the following configuration to your inventory file, changing only the first section to specify all the hosts where you want to install the agent.

													[servers]
													host1
													host2
													host3

													# DO NOT CHANGE ANYTHING BELOW THIS LINE
													[servers:vars]
													pbench_repo_url_prefix = https://copr-be.cloud.fedoraproject.org/results/ndokos

													# where to get the key
													pbench_key_url = http://example.com/some/path/to/agent/{{ pbench_configuration_environment }}/ssh

													# where to get the config file
													pbench_config_url = http://example.com/some/path/to/agent/{{ pbench_configuration_environment }}/config

The above spec covers three hosts. Please make sure that the hosts are correct. A useful way to make sure that you are touching the correct set of hosts is the following command:

cd /path/to/some/directory/pbench/agent/ansible ansible-playbook -i ~/.config/Inventory/myhosts.inv --list-hosts pbench_agent_install.yml

If you want to install on the local machine, the inventory file should include localhost in the [servers] section. Note that you need to be able to ssh to the localhost as root as well, so you might need to do ssh-copy-id root@localhost.

All the commands take a --help option and produce a terse uasage message

The default set of tools for data collection can be enabled with

pbench-register-tool-set

You can then run a built-in benchmark by invoking its Pbench script - Pbench will install the benchmark if necessary1:

pbench-fio

When the benchmark finishes, the tools will be stopped as well. The results can be collected and shipped to the standard storage location2 with:

pbench-move-results

pbench-copy-results

Introduction

Boostrapping a new system

Installing Using Ansible

Install ansible and ansible-galaxy (one-time task)

Install the pbench.agent Roles from Galaxy (one-time task)

Make Roles Available

Create a Playbook (one-time task)

Create an Inventory File (one-time task for a given set of hosts)

Run the Playbook

Administrator responsibility: Config file and ssh private key file

Clear Results

Kill tools

Clear tools

First steps with pbench-user-benchmark

First steps with remote hosts and pbench-user-benchmark

Clear results

Kill tools

Clear tools

Register tools

Using --dir

Using --remote

Using --label