From 8c2dccad6652a535a6c549a2c4133afd9eb251ed Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Mon, 13 Feb 2023 20:05:25 -0500
Subject: add docs

---
 roles/hostname/README.md         | 30 ++++++++++++++++++++++++++++++
 roles/hostname/defaults/main.yml |  2 +-
 2 files changed, 31 insertions(+), 1 deletion(-)
 create mode 100644 roles/hostname/README.md

(limited to 'roles/hostname')

diff --git a/roles/hostname/README.md b/roles/hostname/README.md
new file mode 100644
index 0000000..057bce0
--- /dev/null
+++ b/roles/hostname/README.md
@@ -0,0 +1,30 @@
+Hostname
+========
+
+Description
+-----------
+
+The `hostname` role sets the local hostname and generates `/etc/hosts`.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable         | Default                                 | Description
+-----------------|-----------------------------------------|------------
+`hostname_fqdn`  | `{{ inventory_hostname }}.{{ domain }}` | Fully qualified domain name
+`hostname_short` | `{{ inventory_hostname }}`              | Short hostname
+`hostname_ip`    | `{{ ip }}`                              | IPv4 address
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: set hostname
+  hosts: all
+  roles:
+    - hostname
+````
diff --git a/roles/hostname/defaults/main.yml b/roles/hostname/defaults/main.yml
index c884565..8fc7757 100644
--- a/roles/hostname/defaults/main.yml
+++ b/roles/hostname/defaults/main.yml
@@ -1,3 +1,3 @@
-hostname_fqdn: '{{ fqdn }}'
+hostname_fqdn: '{{ inventory_hostname }}.{{ domain }}'
 hostname_short: '{{ inventory_hostname }}'
 hostname_ip: '{{ ip }}'
-- 
cgit