aboutsummaryrefslogtreecommitdiffstats
path: root/roles/tuned/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/tuned/README.md')
-rw-r--r--roles/tuned/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/roles/tuned/README.md b/roles/tuned/README.md
new file mode 100644
index 0000000..bc42bf0
--- /dev/null
+++ b/roles/tuned/README.md
@@ -0,0 +1,32 @@
+Tuned
+=====
+
+Description
+-----------
+
+The `tuned` role sets the host's [TuneD](https://tuned-project.org/) performance
+profile.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+----------------|-----------|------------
+`tuned_profile` | `balanced | TuneD profile name
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: set tuned profile
+ hosts: proxmox_instanced
+ roles:
+ - role: tuned
+ vars:
+ tuned_profile: virtual-guest
+````