aboutsummaryrefslogtreecommitdiffstats
path: root/roles/timezone/README.md
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-20 20:45:48 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-20 20:45:48 -0500
commit849ceda40fdec039ec68c2b37b98bcec6d97a7b9 (patch)
treec0767808385bdd3e437dbf43e5fb15b49a293692 /roles/timezone/README.md
parent73b9f37fa88251108e9de95e51aaf2a9a1b39da6 (diff)
downloadselfhosted-849ceda40fdec039ec68c2b37b98bcec6d97a7b9.tar.gz
selfhosted-849ceda40fdec039ec68c2b37b98bcec6d97a7b9.zip
timezone: add docs
Diffstat (limited to 'roles/timezone/README.md')
-rw-r--r--roles/timezone/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/roles/timezone/README.md b/roles/timezone/README.md
new file mode 100644
index 0000000..d04b473
--- /dev/null
+++ b/roles/timezone/README.md
@@ -0,0 +1,32 @@
+Timezone
+========
+
+Description
+-----------
+
+The `timezone` role sets the system timezone, and ensures the system clock
+uses UTC.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+-----------|-----------|------------
+`timezone` | `Etc/UTC` | System timezone
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: set timezone
+ hosts: all
+ roles:
+ - role: timezone
+ vars:
+ timezone: America/New_York
+````