From c0cf8a88f87aecbc1ea35d94b09fa4406038499b Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Thu, 16 Feb 2023 19:49:26 -0500
Subject: polkit: add docs

---
 roles/polkit/README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 roles/polkit/README.md

(limited to 'roles/polkit')

diff --git a/roles/polkit/README.md b/roles/polkit/README.md
new file mode 100644
index 0000000..1d45741
--- /dev/null
+++ b/roles/polkit/README.md
@@ -0,0 +1,36 @@
+Polkit
+======
+
+Description
+-----------
+
+The `polkit` role simply adds a [polkit rule](https://www.freedesktop.org/software/polkit/docs/latest/polkit.8.html)
+to allow a given group to perform privleged operations.
+
+The only time `polkit` escalation must be used (rather than `sudo`) seems to be
+when performing privileged operations from the GNOME interface.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable                         | Default   | Description
+---------------------------------|-----------|------------
+`polkit_admin_group`             | `wheel`   | Group name for system administrators
+
+This role **exports** the following variables:
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: all
+  roles:
+    - role: polkit
+      vars:
+        polkit_admin_group: sysadmins
+````
-- 
cgit