aboutsummaryrefslogtreecommitdiffstats
path: root/roles/yum_mirror
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-25 21:27:30 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-25 21:27:30 -0500
commit5e481cedfe00922e79ffd0ed34c4fc0e8b40dabf (patch)
tree21c077ab16e7af64a53db6cef74bccfb13a3b6a1 /roles/yum_mirror
parent644c1878b51ae70a954ba8906f1c220a7cc68174 (diff)
downloadselfhosted-5e481cedfe00922e79ffd0ed34c4fc0e8b40dabf.tar.gz
selfhosted-5e481cedfe00922e79ffd0ed34c4fc0e8b40dabf.zip
yum_mirror: add readme
Diffstat (limited to 'roles/yum_mirror')
-rw-r--r--roles/yum_mirror/README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/roles/yum_mirror/README.md b/roles/yum_mirror/README.md
new file mode 100644
index 0000000..56b692f
--- /dev/null
+++ b/roles/yum_mirror/README.md
@@ -0,0 +1,47 @@
+Yum Mirror
+==========
+
+Description
+-----------
+
+The `yum_mirro` role configures a local Yum repository that mirrors packages
+from different upstream repositories.
+
+Mirrored repositories are configured in the [vars file](vars/main.yml).
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+-------------------------|------------------|------------
+`yum_sync_on_calendar` | `22,23,10,11:00` | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for syncing repositories
+`yum_mirrorlist_country` | `US` | Country code for remote mirrorlists
+
+This role **exports** the following variables:
+
+Variable | Description
+---------------------|------------
+`yum_mirror_webroot` | Path to repository directory
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: configure yum mirrors
+ hosts: yum_servers
+ roles:
+ - role: yum_mirror
+ vars:
+ yum_mirrorlist_country: US
+
+ - role: apache_vhost
+ vars:
+ apache_default_vhost: yes
+ apache_document_root: '{{ yum_mirror_webroot }}'
+ apache_autoindex: yes
+ apache_redirect_to_https: no
+````