https://github.com/tinx/locust_slave

Ansible role for Locust.io slaves
https://github.com/tinx/locust_slave

Last synced: 2 months ago
JSON representation

Ansible role for Locust.io slaves

• Host: GitHub
• URL: https://github.com/tinx/locust_slave
• Owner: tinx
• Created: 2017-12-03T22:03:24.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-03T22:03:31.000Z (about 7 years ago)
• Last Synced: 2024-08-04T02:07:52.466Z (6 months ago)
• Language: Python
• Size: 32.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-locust - locust_slave - An Ansible role to manage Locust slave instances. (Tools / Configuration Management)

README

        
# Ansible Role `locust_slave`

Manages locust.io slaves.

## Requirements

Locust.io requires ZeroMQ. This role will therefor install

zeromq-devel and gcc system-wide to compile the necessary python

pips for Locust.io. The upstream ZeroMQ yum repository will be

registered and enabled to do this.

All python related software requirements will be auto-installed

inside a virtualenv.

## Role Variables

| Variable        | Default   | Comments (type)                              |

| :---            | :---      | :---                                         |

| `instance_name` | `slave`   | Name to distiguish between instances.        |

| `instance_data` |           | Path to data to be copied into instance dir  |

| `locust_classes`| `[]`      | List of client classes to run                |

| `master_host`   |           | IP, hostname or FQDN of the Locust.io master |

| `master_port`   | 5557      | TCP port number of the Locust.io master      |

| `locustfile`    |           | The Locust.io scenario file to play          |

| `state`         | `started` | State of Locust.io on the host.              |

| `enabled`       | `false`   | If true, start this instance after reboots   |

| `csv`           |           | Base name of CVS report files                |

| `logfile`       |           | Filename of the Locust.io logfile            |

| `loglevel`      |           | Locust.io log level                          |

| `run_as_user`   |           | Which unix user to launch Locust.io as       |

| `run_as_group`  |           | Which unix group to launch Locust.io under   |

The `state` parameter can be one of:

* `started` - Locust.io should be up and running

* `restarted` - Locust.io should be freshly restarted

* `stopped` - Locust.io should be present but should not be running

* `absent` - Locust.io should not be installed

A directory named `/opt/locust.io` will be created. Inside of it, a

subdirectory per instance will be created. If `state` is set to `absent`,

this directory will be removed.

The `instance_data` parameter can point to a file or directory to

be copied into the instance subdirectory. For example, `instance_data: data/`

would copy the `data/` directory inside your playbook's `files/` directory

to the instance subfolder.

You can specify the `locustfile` parameter as a path relative to the

`instance_data` content root. (see example below)

## Operating Systems

This role was developed and tested for CentOS 7.4.

## Dependencies

None

## Example Playbook

To have a running Locust.io slave you could do this:

    - hosts: locust_slaves

      tasks:

      - include_role:

           name: tinx.locust_slave

        vars:

           master_host: 'locust_master.example.com'

           instance_data: data/

           locustfile: 'stress-test-prod.py'

## Testing

Molecule tests are provided. Naturally, they require additional dependencies.

## License

BSD

## Author Information

 - [Andreas Jaekel](https://github.com/tinx/)