Microsoft Azure is a web service that provides secure, resizable compute capacity in the cloud. It is designed to make web-scale cloud computing easier for developers.
The documentation below explains how to configure Microsoft Azure cloud provider.
Before trying to configure Microsoft Azure, make sure you have:
- A Microsoft Azure Account with a valid subscription.
The resource group is a container that holds related Azure resources.
How to create a resource group
- Go to Resource Groups,
- Click on
Basicssection, select the subscription and enter
octoperfin Resource group name,
- Select the region where the group should be located (Here in
(Europe) France Central),
- Click on
Review + Create.
The resource group must be named
octoperf (all lowercase characters).
The next step is to create Azure application credentials so OctoPerf can programmatically start and stop virtual machines on Microsoft Azure. Please see How to Use Azure to create an application that can access resources.
Basically, you need to:
- Create an Azure Application Registration in
App Registrationswith the name you want (Example:
OctoPerf), Application type
Web app / APIand no sign-on URL needed,
- Assign the newly created application a
Contributoror equivalent so the application can create, start and stop virtual machines,
- Create an Application
Client Secretlater used to authenticate from OctoPerf.
Once done, please keep a-side:
(Client) Application Id,
Those information are needed to allow OctoPerf to connect to your Microsoft Azure account.
A virtual network for each Azure Location is required. Virtual machines spinned up by octoperf are configured with this virtual network.
Creating a virtual network
- Go to
- Click on
- Name the virtual network with
octoperf-prefix followed by the location id. Example:
octoperf-francecentralin France Central,
Address Space. Example:
- Select the location where to create the virtual network. Example:
- Enter the
Address Range. Example:
DDos Protectionset at your convenience. Defaults to
- Service Endpoints and Firewall can be left as
Make sure the name of the virtual network starts with
octoperf-. Create a virtual network per location, preferrably named
location by the actual location).
Public IP Addresses¶
Public IP addresses must be configured per virtual network.
Creating Public IP Addresses
Public IP Addresses,
- Click on
- Name it with
octoperf-prefix, followed by the location id (Example:
- Select SKU, IP Version and
IP address Assignmentrelevant to you case,
- Assign it to
- Select the location.
Repeat this operation for each location in which you would like to start / stop virtual machines from OctoPerf.
Virtual Machine Images¶
OctoPerf requires that you setup a virtual machine image per location. This virtual machine image should preferrably have:
- Operating System: Ubuntu
- Disk Space: at least 20GB (to avoid disk space issues),
- Software: docker-ce must be installed,
- Docker Images: we strongly suggest to pre-pull OctoPerf Docker Images, especially JMeter Standard and Docker Agent images.
Creating A Virtual Machine Image
- Start a virtual machine with Ubuntu operating system in the target location where the image will be stored,
- SSH into the virtual machine,
- Install Docker, pull docker images,
- From Azure portal, create the virtual machine image and name it with
This step is mandatory: OctoPerf needs a custom linux image to create and start virtual machines on Azure.
The final step is to create the Microsoft Azure provider from OctoPerf UI:
- Click on your account menu, then
- Click on
+ Add Providerbutton, then
- Enter the relevant information being asked.
Azure requires the following settings:
- Application (client) ID: id of the application,
- Client Secret: the secret password generated when creating the Azure enterprise application,
- Directory (tenant) ID: tenant ID,
- Subscription ID: id of the subscription to use,
- Resource Group:
- SSH: virtual machines created by OctoPerf can be sshed using the settings provided here,
- SSH User: username to use to ssh into the virtual machine instance from outside,
- SSH Password or Public Key: Either a password or an SSH public key.
The following Instances are available:
- SMALL: cloud instance with about
2GB RAM, (
- MEDIUM: cloud instance with about
4GB RAM, (
- LARGE: cloud instance with about
8GB RAM, (
- XLARGE: cloud instance with about
16GB RAM. (
Select the instance which suits your needs. Smaller instances can simulate less concurrent users.
The shutdown policy specifies the minimum amount of time a cloud instance should be running before being eligible for automatic shutdown.
Example: shutdown specified after
Only idle machines (not running load tests) are eligible for shutdown. OctoPerf waits until the test ends before shutting the instance down.
These settings are the same as for the self-hosted provider.
OctoPerf automatically detected your Azure locations based on a naming convention. OctoPerf expects that you have in each location you want to use:
- a virtual machine image prefixed with
- a virtual network prefixed with
- a subnet with the name of your choice, usually
- a public IP address prefixed with
If no location is being pre-configured, make sure you followed all the steps in
Azure Setup prior to trying to configure Azure in OctoPerf.