Optimized .mds and meta/main.yml for user-administrator

roles/user-administrator/README.md

@@ -1,9 +1,25 @@
-# Role Administrator
-This role creates an standard administrator user.
-This user needs to type in his password before executing sudo.
-For security reasons it's recommended to use this user instead of the standard root user.
-This user should not be used to login to other systems. It's just there to let administration tasks run.
-For this reason no ssh-keys are generated.
+# Administrator User
 
-## Author
-This role was created by [Kevin Veen-Birkenbach](https://www.veen.world/)
+## Description
+
+This role creates a dedicated administrator user for local administrative tasks. The administrator account is configured to require a password when executing [sudo](https://en.wikipedia.org/wiki/Sudo), ensuring secure privilege escalation. For security reasons, it is recommended to use this dedicated administrator user instead of the default root account. The role also sets up SSH-related configuration by copying an authorized_keys file from inventory data.
+
+## Overview
+
+Optimized for secure system management, this role performs the following:
+- Creates an administrator user with a home directory.
+- Configures proper permissions for the administrator’s home directory and associated scripts.
+- Sets up an SSH authorized_keys file from inventory data (if available), leveraging [SSH](https://en.wikipedia.org/wiki/Secure_Shell) best practices.
+- Grants [sudo](https://en.wikipedia.org/wiki/Sudo) privileges to the administrator user with password authentication using a dedicated sudoers file.
+
+## Purpose
+
+The primary purpose of this role is to provide a secure and dedicated administrator account solely for running local administration tasks. This approach minimizes security risks associated with using the root account and enforces best practices in user privilege management.
+
+## Features
+
+- **User Creation:** Establishes an administrator user with a home directory and generated SSH keys.
+- **Home Directory Configuration:** Sets secure permissions on the administrator’s home directory and script folder.
+- **SSH Authorized Keys:** Copies a preconfigured authorized_keys file for additional security.
+- **Sudo Privileges:** Deploys a dedicated sudoers configuration to grant the administrator user [sudo](https://en.wikipedia.org/wiki/Sudo) rights with password prompt.
+- **Modular Integration:** Integrates with common routines and roles to further enhance system security.

roles/user-administrator/meta/main.yml

@@ -1,2 +1,27 @@
+---
+galaxy_info:
+  author: "Kevin Veen-Birkenbach"
+  description: "Creates a dedicated administrator user for local administrative tasks, ensuring secure privilege escalation and proper system management. This role configures the administrator account, sets up the home directory, SSH settings, and grants sudo privileges with password authentication."
+  license: "CyMaIS NonCommercial License (CNCL)"
+  license_url: "https://s.veen.world/cncl"
+  company: |
+    Kevin Veen-Birkenbach
+    Consulting & Coaching Solutions
+    https://www.veen.world
+  min_ansible_version: "2.9"
+  platforms:
+    - name: Linux
+      versions:
+        - all
+  galaxy_tags:
+    - user
+    - administrator
+    - security
+    - sudo
+    - ssh
+    - configuration
+  repository: "https://s.veen.world/cymais"
+  issue_tracker_url: "https://s.veen.world/cymaisissues"
+  documentation: "https://s.veen.world/cymais"
 dependencies:
-- sudo
+  - sudo