Refactor

slococo/playground/roles/ssh_config/README.md

@@ -1,17 +1,21 @@
 Role Name
 =========
 
-Ansible Role to check the SSH configuration...
+An Ansible Role to manage SSH configuration on Linux systems.
 
-Requirements
+## Requirements
-------------
 
-...
+None.
 
-Role Variables
+## Role Variables
---------------
 
-...
+```yaml
+options:
+  PasswordAuthentication: 'yes'       # Allow password authentication (default: yes)
+  PermitEmptyPasswords: 'no'          # Permit users to have empty passwords (default: no)
+  PermitRootLogin: 'no'               # Permit root login (default: no)
+  # Add more SSH options as needed
+```
 
 
 Example Playbook
@@ -19,6 +23,9 @@ Example Playbook
 
 ```yaml
     - hosts: servers
+      vars:
+        sshd_options:
+          PasswordAuthentication: 'no'
 
       roles:
          - { role: slococo.playground.ssh_config }

slococo/playground/roles/ssh_config/defaults/main.yml

@@ -1,5 +1,5 @@
 ---
-sshd_options:
+options:
   PasswordAuthentication: 'yes'
   PermitEmptyPasswords: 'no'
-  PermitRootLogin: 'no'
+  PermitRootLogin: 'no'

slococo/playground/roles/ssh_config/handlers/main.yml

@@ -2,4 +2,4 @@
 - name: Restart SSH service
   ansible.builtin.service:
     name: sshd
-    state: restarted
+    state: restarted

slococo/playground/roles/ssh_config/meta/argument_specs.yml

@@ -0,0 +1,13 @@
+---
+argument_specs:
+  main:
+    short_description: Ansible Role to manage SSH configuration
+    options:
+      options:
+        type: dict
+        required: false
+        default:
+          PasswordAuthentication: 'yes'
+          PermitEmptyPasswords: 'no'
+          PermitRootLogin: 'no'
+        description: Dictionary containing SSH configuration options to be set.

slococo/playground/roles/ssh_config/meta/main.yml

@@ -1,9 +1,9 @@
 galaxy_info:
   author: Santiago Lo Coco
-  description: Ansible Role to check SSH configuration
+  description: Ansible Role to manage SSH configuration
   company: cloudWerkstatt
   license: MIT
   min_ansible_version: 2.12.0
-  galaxy_tags: ['ssh_config']
+  galaxy_tags: ['ssh', 'config']
 
-dependencies: []
+dependencies: []

slococo/playground/roles/ssh_config/tasks/main.yml

@@ -7,5 +7,5 @@
     state: present
     validate: "sshd -t -f %s"
     mode: 0644
-  loop: "{{ sshd_options | dict2items }}"
+  loop: "{{ options | dict2items }}"
-  become: true
+  notify: Restart SSH service

slococo/playground/roles/ssh_config/tests/test.yml

@@ -3,6 +3,13 @@
   hosts: localhost
   connection: local
   gather_facts: no
+  become: true
+
+  vars:
+    options:
+      PasswordAuthentication: 'yes'
+      PermitEmptyPasswords: 'no'
+      PermitRootLogin: 'no'
 
   roles:
-    - {role: ../..}
+    - {role: ../..}