aboutsummaryrefslogtreecommitdiffstats
path: root/roles/yum
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-21 22:05:28 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-21 22:05:35 -0500
commit51d4b0bd8430d31d2bfeb08222cc2168d126612f (patch)
tree9868fcc1b66639412d4ca0866d64ebb7f950ab05 /roles/yum
parent2f8ea80af31ae914d7a73113208b2e42ed69d35e (diff)
downloadselfhosted-51d4b0bd8430d31d2bfeb08222cc2168d126612f.tar.gz
selfhosted-51d4b0bd8430d31d2bfeb08222cc2168d126612f.zip
yum: add docs
Diffstat (limited to 'roles/yum')
-rw-r--r--roles/yum/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/roles/yum/README.md b/roles/yum/README.md
new file mode 100644
index 0000000..aed46ab
--- /dev/null
+++ b/roles/yum/README.md
@@ -0,0 +1,42 @@
+Yum
+===
+
+Description
+-----------
+
+The `yum` role is used to add a local RPM repository as a package source.
+Repository names are configured in the [vars file](vars/main.yml).
+
+It should be used in conjunction with local Yum server built using the
+[yum\_mirror](../yum_mirror/) role.
+
+There is one special case hardcoded: enabling the `epel` repository will always
+enable the `rocky-powertools` or `rocky-crb` repo as well.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+---------------------------------|-----------|------------
+`yum_host` | &nbsp; | Hostname of the local Yum server
+`yum_add_repositories` | &nbsp; | List of repository names to enable
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: enable extra yum repositories
+ hosts: linux_desktops
+ roles:
+ - role: yum
+ yum_repositories:
+ - epel
+ - rpmfusion-free
+ - rpmfusion-free-tainted
+ - rpmfusion-nonfree
+ - rpmfusion-nonfree-tainted
+````