Hyperfoil Test Runner

This tool processes a template for the Hyperfoil benchmark, uploads it to the Hyperfoil Controller, starts the test, and waits for it to finish.

Requirements

Make sure Hyperfoil is already set up. You can refer to the hyperfoil-setup role for this.

Role Variables

• You need to have your Ansible hosts in the hyperfoil_controller and hyperfoil_agent groups.
• test_name (required): This is the name of the test located in the benchmarks folder, with a yaml.j2 extension. The name must match the benchmark name in the file.
• hyperfoil_controller_group (optional): The Ansible group that contains the controller. The default is hyperofoil-controller.
• hyperfoil_controller_host (optional): Use this to specify the hostname for access.
• hyperfoil_controller_port (optional): Define the port on which Hyperfoil listens.
• hyperfoil_controller_protocol (optional): Choose the access protocol for the Hyperfoil controller. Options are http (default) or https.
• hyperfoil_validate_certs (optional): If you want to validate server certificates when using HTTPS. The default value is true.
• hyperfoil_deployer (optional): Specify the deployment method. Options are ssh (default) or k8s.
• hyperfoil_agent_group (optional): The Ansible group that includes the agents. The default is hyperofoil-agent.
• hyperfoil_agent_port (optional): SSH port for the agent, defaulting to 22.

License

Apache License, Version 2.0

Example

Before using this example, install all necessary Hyperfoil roles via Ansible:

ansible-galaxy install hyperfoil.hyperfoil_setup
ansible-galaxy install hyperfoil.hyperfoil_shutdown
ansible-galaxy install hyperfoil.hyperfoil_test

This example sets up Hyperfoil on your local machine (with the controller and agent running as separate instances), uploads a simple benchmark that sends a request to the GitHub main page, and will report the number of requests based on the statistics.

ansible-playbook -i hosts.example example.yml