aboutsummaryrefslogtreecommitdiffstats
path: root/roles
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-14 21:10:49 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-14 21:10:49 -0500
commit1d939f352305248dd94900492ceb1d70dbf956b4 (patch)
treeb5efa6426a9c0069108b886ec079c0ee580ac67b /roles
parent9eb258711af30eb03c84532c457138999d105c25 (diff)
downloadselfhosted-1d939f352305248dd94900492ceb1d70dbf956b4.tar.gz
selfhosted-1d939f352305248dd94900492ceb1d70dbf956b4.zip
packages: add docs
Diffstat (limited to 'roles')
-rw-r--r--roles/packages/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/roles/packages/README.md b/roles/packages/README.md
new file mode 100644
index 0000000..af495cb
--- /dev/null
+++ b/roles/packages/README.md
@@ -0,0 +1,32 @@
+Packages
+========
+
+Description
+-----------
+
+The `packages` role installs a given set of packages.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+-------------------|----------|------------
+`packages_install` | `[]` | List of packages to install
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: all
+ roles:
+ - role: packages
+ vars:
+ packages_install:
+ - tmux
+ - less
+ - man
+````