From 0b21168a78c695416c2bfdd7c45508402f5369d7 Mon Sep 17 00:00:00 2001
From: Kevin Veen-Birkenbach <kevin@veen.world>
Date: Sat, 2 Dec 2023 14:41:08 +0100
Subject: [PATCH] Refactored docker role

---
 playbook.yml                                  |  2 +-
 roles/pc-docker/README.md                     | 32 +++++++++++++++++++
 .../tasks/main.yml                            |  2 +-
 3 files changed, 34 insertions(+), 2 deletions(-)
 create mode 100644 roles/pc-docker/README.md
 rename roles/{application-docker => pc-docker}/tasks/main.yml (72%)

diff --git a/playbook.yml b/playbook.yml
index 5b26991b..bdf83291 100644
--- a/playbook.yml
+++ b/playbook.yml
@@ -329,7 +329,7 @@
   hosts: docker
   become: true
   roles:
-    - application-docker
+    - pc-docker
 
 
 - name: setup backup to swappable
diff --git a/roles/pc-docker/README.md b/roles/pc-docker/README.md
new file mode 100644
index 00000000..4d8731b9
--- /dev/null
+++ b/roles/pc-docker/README.md
@@ -0,0 +1,32 @@
+# README for PC-Docker Playbook
+
+## Overview
+This playbook, `pc-docker`, is part of a larger collection housed within the `computer-playbook` repository. It is specifically tailored for setting up Docker and Docker Compose on personal computers (PCs) used for development purposes. The primary goal is to facilitate a development environment on individual workstations rather than configuring servers for hosting or distributing Docker images.
+
+## Contents
+The `main.yml` file in the `pc-docker` role consists of two primary tasks:
+
+1. **Install Docker**: This task uses the `community.general.pacman` module to install `docker` and `docker-compose` on the system. It ensures that these packages are present on the PC.
+
+2. **User Group Configuration**: This task adds a specified user (denoted as `{{client_username}}`) to the Docker user group. This is crucial for allowing the specified user to interact with Docker without needing superuser permissions.
+
+## Use Case
+The playbook is designed for developers who require Docker in their local development environments. It simplifies the process of Docker installation and configuration, making it straightforward for developers to start containerizing their applications without the complexities often encountered in a server or production environment.
+
+## Prerequisites
+- Ansible: Ensure that Ansible is installed on your system to run this playbook.
+- Arch Linux-based System: This playbook uses the `pacman` package manager, indicating it's designed for Arch Linux-based systems.
+
+## Running the Playbook
+To run this playbook:
+1. Clone the `computer-playbook` repository.
+2. Navigate to the `roles/pc-docker` directory.
+3. Run the playbook using the appropriate Ansible commands, ensuring that you have the necessary privileges.
+
+## Important Notes
+- **Not for Server Use**: This playbook is not designed for server environments. It is optimized for individual development machines.
+- **Customization**: You may need to customize the playbook, especially the `{{client_username}}` variable, to suit your specific setup.
+- **Security Considerations**: While adding a user to the Docker group provides ease of use, be aware of the security implications. It grants the user elevated privileges which, if misused, can affect the entire system.
+
+## Support & Contribution
+For support, suggestions, or contributions, please raise an issue or a pull request in the `computer-playbook` repository. This project welcomes contributions from the developer community.
\ No newline at end of file
diff --git a/roles/application-docker/tasks/main.yml b/roles/pc-docker/tasks/main.yml
similarity index 72%
rename from roles/application-docker/tasks/main.yml
rename to roles/pc-docker/tasks/main.yml
index d45a5d61..c51ba883 100644
--- a/roles/application-docker/tasks/main.yml
+++ b/roles/pc-docker/tasks/main.yml
@@ -5,7 +5,7 @@
       - docker-compose
     state: present
 
-- name: Adding user {{client_username}} to relevant arduino usergroups  
+- name: Adding user {{client_username}} to relevant docker usergroup  
   user: name={{client_username}}
         groups=docker
         append=yes