aboutsummaryrefslogtreecommitdiffstats
path: root/roles/common
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-10 21:07:32 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-10 21:07:32 -0500
commit372501cceb3b096c9df38c36d82c843a64d24cc7 (patch)
treecfdcf560dad550107094907dff467cf3af6c797b /roles/common
parent300f985dabc76969f210db71fb3624bc9388a6b7 (diff)
downloadselfhosted-372501cceb3b096c9df38c36d82c843a64d24cc7.tar.gz
selfhosted-372501cceb3b096c9df38c36d82c843a64d24cc7.zip
add docs for common role
Diffstat (limited to 'roles/common')
-rw-r--r--roles/common/README.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/roles/common/README.md b/roles/common/README.md
new file mode 100644
index 0000000..26cdf01
--- /dev/null
+++ b/roles/common/README.md
@@ -0,0 +1,55 @@
+Common
+======
+
+Description
+-----------
+
+The `common` role is a meta-role that performs base configuration common to all
+Rocky Linux hosts.
+
+This role pulls in the following roles as dependencies:
+
+
+Role | Description
+--------------------------------------------------------------|-------------
+[proxmox\_instance](../proxmox_instance/) | Builds a Proxmox VM if host is a member of `proxmox_instances`
+[dns\_records](../dns_records/) | Creates A, PTR, and CNAME records for the host in FreeIPA
+[gather\_facts](../gather_facts/) | Runs the Ansible `setup` module once the host is reachable.
+[udev](../udev/) | Configures `udev` rules
+[root\_authorized\_keys](../root_authorized_keys/) | Sets `authorized_keys` for the root user
+[root\_password](../root_password/) | Sets password for the root user
+[polkit](../polkit/) | Adds a `polkit` rule for the specified admin group
+[grub](../grub/) | Configures kernel command line in `grub`
+[sudo](../sudo/) | Configures `sudo`
+[hostname](../hostname/) | Sets the hostname
+[timezone](../timezone/) | Sets the timezone
+[journald](../journald/) | Configures systemd journal
+[yum\_disable\_default\_repos](../yum_disable_default_repos/) | Disables upstream Rocky Linux yum repos
+[yum](../yum/) | Configures internal yum repos
+[dnsmasq](../dnsmasq/) | Configures `dnsmasq` for local DNS caching
+[locale](../locale/) | Sets the locale
+[selinux](../selinux/) | Enables SELinux and `setroubleshootd`
+[qemu\_guest\_agent](../qemu_guest_agent/) | Enables `qemu-guest-agent` for Proxmox VMs
+[firewalld](../firewalld/) | Enables local firewall with `firewalld`
+[chrony](../chrony/) | Enables `chrony` NTP client
+[dnf\_automatic](../dnf_automatic/) | Configures automatic package updates and reboots
+[ssh](../ssh/) | Generates global `ssh_config`
+[tuned](../tuned/) | Configures `tuned` profile
+[motd](../motd/) | Disables `cockpit` MOTD message
+[packages](../packages/) | Installs common packages
+[postfix\_client](../postfix_client/) | Configures `postfix` client for internal mailserver
+[freeipa\_client](../freeipa_client/) | Joins host to FreeIPA domain
+[rsyslog\_client](../rsyslog_client/) | Configures `rsyslog` forwarding to internal syslog server
+[nagios\_client](../nagios_client/) | Configures `nagios` user and plugin scripts
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: apply base configuration
+ hosts: all
+ roles:
+ - common
+````