1
0
Fork 0
mirror of https://github.com/roles-ansible/ansible_role_iperf.git synced 2024-08-16 13:09:49 +02:00

improve role docs

This commit is contained in:
L3D 2021-08-19 12:44:19 +02:00
parent 42131e479f
commit 1b4188c6f6
Signed by: l3d
GPG key ID: CD08445BFF4313D1
3 changed files with 20 additions and 12 deletions

View file

@ -1,17 +1,25 @@
# ansible_role_iperf
ansible_role_iperf
====================
Ansible role to install, run and configure a iperf3 server.
```
WORK IN PROGRESS
EVERYTHING CAN CHANGE ANY TIME
```
variables
------------
RTFM
https://iperf.fr/iperf-doc.php
| variable | default value | description |
| -------- | ------------- | ----------- |
| ``iperf__systemd_enable`` | ``true`` | enable and run or stop and mask the systemd iperf.service |
| ``iperf__options`` | ``'--server'`` | The option for the iperf3 Server |
| ``iperf__packages`` | ``iperf3`` | Packages to install by this role |
| ``iperf__package_state`` | ``present`` | package state. use latest for upgrading installed "{{ iperf__packages }}" |
| ``iperf__user`` | ``iperf`` | User that will run iperf3 as systemd service |
| ``iperf__group`` | ``iperf`` | Group for "{{ iperf__user }}" |
| ``submodules_versioncheck`` | ``false`` | Perform a optional simple versionscheck to prevent running a old version of this role *(recomended)* |
DOCS
------
Have a look at https://iperf.fr/iperf-doc.php for iperf Dokumentation
Testing
----------
This role is tested with [these github-action](https://github.com/search?q=topic%3Acheck-ansible+topic%3Agithub-actions+org%3Aroles-ansible&type=Repositories) tests for different versions of differen linux systems. Linting is tested via travis-ci and the [ansible-lint action](https://github.com/marketplace/actions/ansible-lint).
If you want to find out more about our tests, please have a look at the github marketplace.
Linting of this role is tested using github actions. If you know a great way to test systemd stuff via github-actions please leave a note!

View file

@ -1,7 +1,7 @@
---
# run systemd service with an iperf3 server (Y/n)
iperf__systemd_enable: true
iperf__options: '-s'
iperf__options: '--server'
iperf__packages:
- iperf3

View file

@ -1,4 +1,4 @@
---
# versionscheck
playbook_version_number: 5 # should be a integer
playbook_version_number: 6 # should be a integer
playbook_version_path: 'role-do1jlr.iperf.version'