aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-11 09:38:52 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-11 09:38:52 -0500
commit7d01d3caf307953672a212b5d8e34d3fa51bc77d (patch)
tree17b7a38952d699c1bde794479a457a7d5a19c98f
parentf132eb66318f5779bb88b179c46237dc3aaf8a46 (diff)
downloadselfhosted-7d01d3caf307953672a212b5d8e34d3fa51bc77d.tar.gz
selfhosted-7d01d3caf307953672a212b5d8e34d3fa51bc77d.zip
dns_records: add docs
-rw-r--r--roles/dns_records/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/roles/dns_records/README.md b/roles/dns_records/README.md
new file mode 100644
index 0000000..d834daf
--- /dev/null
+++ b/roles/dns_records/README.md
@@ -0,0 +1,32 @@
+DNS Records
+===========
+
+Description
+-----------
+
+The `dns_records` role adds A, PTR, and CNAME records for the host in FreeIPA.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+------------------------------|------------
+`dns_ip` | `{{ ip }}` | IP of the host
+`dns_fqdn` | `{{ fqdn }}` | FQDN of the host
+`dns_cnames` | `{{ cnames }}` | FQDN aliases of the host
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: add DNS records
+ hosts: all
+ roles:
+ - dns_records
+````