From 7d01d3caf307953672a212b5d8e34d3fa51bc77d Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Sat, 11 Feb 2023 09:38:52 -0500
Subject: dns_records: add docs

---
 roles/dns_records/README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 roles/dns_records/README.md

(limited to 'roles')

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
+````
-- 
cgit