From 1677337c3ab78095e8ebc5e3aa284f12b9648fbc Mon Sep 17 00:00:00 2001
From: fejao <mail@fejao.de>
Date: Tue, 28 Jan 2025 00:01:20 +0100
Subject: [PATCH] Moved files

---
 .gitlab-ci.yml                                       | 10 +++++-----
 README.md                                            |  6 +++---
 playbooks/examples/example_01_test.yml               |  8 ++++++++
 playbooks/examples/example_02_dependencies.yml       |  8 ++++++++
 playbooks/examples/example_03_clone_repositories.yml |  8 ++++++++
 playbooks/examples/example_04_docker_images.yml      |  8 ++++++++
 playbooks/examples/example_05_docker_containers.yml  | 11 +++++++++++
 roles/clone_repositories/README.md                   |  4 ++--
 roles/clone_repositories/meta/main.yml               |  2 +-
 roles/dependencies/README.md                         |  4 ++--
 roles/dependencies/meta/main.yml                     |  2 +-
 roles/docker_containers/README.md                    |  6 +++---
 roles/docker_containers/meta/main.yml                |  2 +-
 roles/docker_images/README.md                        |  4 ++--
 roles/docker_images/meta/main.yml                    |  2 +-
 15 files changed, 64 insertions(+), 21 deletions(-)
 create mode 100644 playbooks/examples/example_01_test.yml
 create mode 100644 playbooks/examples/example_02_dependencies.yml
 create mode 100644 playbooks/examples/example_03_clone_repositories.yml
 create mode 100644 playbooks/examples/example_04_docker_images.yml
 create mode 100644 playbooks/examples/example_05_docker_containers.yml

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 990a64f..bbd7344 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -19,7 +19,7 @@ stages:
 ###
 ### SYNTAX-CHECK
 ###
-systax-check-test:
+syntax-check-test:
   stage: syntax-check
   before_script:
     - apt-get update && apt-get install -y python3-pip && apt-get clean && rm -rf /var/lib/apt/lists/*
@@ -29,7 +29,7 @@ systax-check-test:
     - ansible-playbook --syntax-check -i $INVENTORIES_PATH $PLAYBOOK_PATH_FOR_ROLE_TEST
   allow_failure: false
 
-systax-check-dependencies:
+syntax-check-dependencies:
   stage: syntax-check
   before_script:
     - apt-get update && apt-get install -y python3-pip && apt-get clean && rm -rf /var/lib/apt/lists/*
@@ -39,7 +39,7 @@ systax-check-dependencies:
     - ansible-playbook --syntax-check -i $INVENTORIES_PATH $PLAYBOOK_PATH_FOR_ROLE_DEPENDENCIES
   allow_failure: false
 
-systax-check-clone-repositories:
+syntax-check-clone-repositories:
   stage: syntax-check
   before_script:
     - apt-get update && apt-get install -y python3-pip && apt-get clean && rm -rf /var/lib/apt/lists/*
@@ -49,7 +49,7 @@ systax-check-clone-repositories:
     - ansible-playbook --syntax-check -i $INVENTORIES_PATH $PLAYBOOK_PATH_FOR_ROLE_CLONE_REPOSITORIES
   allow_failure: false
 
-systax-check-docker-images:
+syntax-check-docker-images:
   stage: syntax-check
   before_script:
     - apt-get update && apt-get install -y python3-pip && apt-get clean && rm -rf /var/lib/apt/lists/*
@@ -59,7 +59,7 @@ systax-check-docker-images:
     - ansible-playbook --syntax-check -i $INVENTORIES_PATH $PLAYBOOK_PATH_FOR_ROLE_DOCKER_IMAGES
   allow_failure: false
 
-systax-check-docker-containers:
+syntax-check-docker-containers:
   stage: syntax-check
   before_script:
     - apt-get update && apt-get install -y python3-pip && apt-get clean && rm -rf /var/lib/apt/lists/*
diff --git a/README.md b/README.md
index 7e13159..b073eec 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
     - [x] clone_repositories
     - [x] docker_images
     - [x] docker_containers
-- [ ] Set ansible-lint for the roles.
+- [x] Set ansible-lint for the roles.
 
 
 ## What is this?
@@ -31,9 +31,9 @@ Here are the used roles:
 - 3. Run the playbooks
     - Example for deploying the containers at the target:
     ```bash
-    ansible-playbook -i inventories/hosts playbook_example_05_docker_containers.yml
+    ansible-playbook -i inventories/hosts playbooks/examples/example_05_docker_containers.yml
     ```
-- 4. Change the default environment variables setted from the [docker-compose.yml](https://git.cccv.de/fejao/c3infodesk-printer/-/blob/main/docker/docker-compose.yml) file to your needs and recreate the containers.
+- 4. Change the default environment variables setted from the [docker-compose.yml](https://git.cccv.de/fejao/c3infodesk-printer/-/blob/main/docker/docker-compose.yml) file to your needs and recreate the containers. You might need to login at the **target** for doing it so.
 
 ## License
 
diff --git a/playbooks/examples/example_01_test.yml b/playbooks/examples/example_01_test.yml
new file mode 100644
index 0000000..6580445
--- /dev/null
+++ b/playbooks/examples/example_01_test.yml
@@ -0,0 +1,8 @@
+---
+# Runs the role test
+
+- name: Example playbook for running the role 'test'
+  hosts:
+    - example_servers_group
+  roles:
+    - roles/test
diff --git a/playbooks/examples/example_02_dependencies.yml b/playbooks/examples/example_02_dependencies.yml
new file mode 100644
index 0000000..9d881c1
--- /dev/null
+++ b/playbooks/examples/example_02_dependencies.yml
@@ -0,0 +1,8 @@
+---
+# Runs example for
+
+- name: Example playbook for running the role 'dependencies'
+  hosts:
+    - example_servers_group
+  roles:
+    - roles/dependencies
diff --git a/playbooks/examples/example_03_clone_repositories.yml b/playbooks/examples/example_03_clone_repositories.yml
new file mode 100644
index 0000000..e0fd12f
--- /dev/null
+++ b/playbooks/examples/example_03_clone_repositories.yml
@@ -0,0 +1,8 @@
+---
+# Runs example for
+
+- name: Example playbook for running the role 'clone_repositories'
+  hosts:
+    - example_servers_group
+  roles:
+    - roles/clone_repositories
diff --git a/playbooks/examples/example_04_docker_images.yml b/playbooks/examples/example_04_docker_images.yml
new file mode 100644
index 0000000..154d3d3
--- /dev/null
+++ b/playbooks/examples/example_04_docker_images.yml
@@ -0,0 +1,8 @@
+---
+# Runs example for
+
+- name: Example playbook for running the role 'docker_images'
+  hosts:
+    - example_servers_group
+  roles:
+    - docker_images
diff --git a/playbooks/examples/example_05_docker_containers.yml b/playbooks/examples/example_05_docker_containers.yml
new file mode 100644
index 0000000..54c92cd
--- /dev/null
+++ b/playbooks/examples/example_05_docker_containers.yml
@@ -0,0 +1,11 @@
+---
+
+- name: Example playbook for running the role 'docker_containers'
+  hosts:
+    - example_servers_group
+  roles:
+    - role: roles/docker_containers
+      vars:
+        c3infodesk_printer_host_cups_disable: true
+        c3infodesk_printer_host_cups_mask: true
+        c3infodesk_printer_docker_compose_up: true
diff --git a/roles/clone_repositories/README.md b/roles/clone_repositories/README.md
index 515d8e2..c0fcdfa 100644
--- a/roles/clone_repositories/README.md
+++ b/roles/clone_repositories/README.md
@@ -36,14 +36,14 @@ The role dependencies are:
 ## Example Playbook
 
 - ### Using the provided example
-  For using the playbook **playbook_example_03_clone_repositories.yml** file you only nned to:
+  For using the playbook **playbooks/examples/example_03_clone_repositories.yml** file you only need to:
   - Change the user at the **ansible.cfg** file at the field **remote_user** for acessing your target.
   - Update the file **inventories/host_vars/example_server.yml** and change the value for **ansible_become_pass** from the **remote_user**
   - Update the **inventories/hosts** file and change the **example_server** with the IP address from your target.
 
   And run the command:
 ```bash
-ansible-playbook -i inventories/hosts playbook_example_03_clone_repositories.yml
+ansible-playbook -i inventories/hosts playbooks/examples/example_03_clone_repositories.yml
 ```
 
 - ### Setting your own example
diff --git a/roles/clone_repositories/meta/main.yml b/roles/clone_repositories/meta/main.yml
index 3488600..5d54698 100644
--- a/roles/clone_repositories/meta/main.yml
+++ b/roles/clone_repositories/meta/main.yml
@@ -5,7 +5,7 @@ galaxy_info:
   description: Role to clone the repositories used from c3InfoDesk sytems
   author: fejao
   company: cccv.de
-  license: MIT
+  license: "MIT / BSD"
   min_ansible_version: '2.10'
   galaxy_tags: []
 
diff --git a/roles/dependencies/README.md b/roles/dependencies/README.md
index ac95b38..7ebf647 100644
--- a/roles/dependencies/README.md
+++ b/roles/dependencies/README.md
@@ -78,14 +78,14 @@ This role have no dependency from any another role.
 ## Example Playbook
 
 - ### Using the provided example
-  For using the playbook **playbook_example_02_dependencies.yml** file you only nned to:
+  For using the example playbook **playbooks/examples/example_02_dependencies.yml** file you only need to:
   - Change the user at the **ansible.cfg** file at the field **remote_user** for acessing your target.
   - Update the file **inventories/host_vars/example_server.yml** and change the value for **ansible_become_pass** from the **remote_user**
   - Update the **inventories/hosts** file and change the **example_server** with the IP address from your target.
 
   And run the command:
 ```bash
-ansible-playbook -i inventories/hosts playbook_example_02_dependencies.yml
+ansible-playbook -i inventories/hosts playbooks/examples/example_02_dependencies.yml
 ```
 
 - ### Setting your own example
diff --git a/roles/dependencies/meta/main.yml b/roles/dependencies/meta/main.yml
index 69e69d0..38d2833 100644
--- a/roles/dependencies/meta/main.yml
+++ b/roles/dependencies/meta/main.yml
@@ -5,7 +5,7 @@ galaxy_info:
   description: Role to install the dependencies from the c3InfoDesk sytems
   author: fejao
   company: cccv.de
-  license: MIT
+  license: "MIT / BSD"
   min_ansible_version: '2.10'
   galaxy_tags: []
 
diff --git a/roles/docker_containers/README.md b/roles/docker_containers/README.md
index cf87bd9..416d0db 100644
--- a/roles/docker_containers/README.md
+++ b/roles/docker_containers/README.md
@@ -75,14 +75,14 @@ The role dependencies are:
   The **docker-compose.yml** file can be founded at the location setted from the **c3infodesk_printer_folder** path variable. The default is: **"~/Coding/c3infodesk-printer"** folder
 
 - ### Using the provided example
-  For using the playbook **playbook_example_05_docker_containers.yml** file you only nned to:
+  For using the playbook **playbooks/examples/playbook_example_05_docker_containers.yml** file you only need to:
   - Change the user at the **ansible.cfg** file at the field **remote_user** for acessing your target.
   - Update the file **inventories/host_vars/example_server.yml** and change the value for **ansible_become_pass** from the **remote_user**.
   - Update the **inventories/hosts** file and change the **example_server** with the IP address from your target.
 
   And run the command:
   ```bash
-  ansible-playbook -i inventories/hosts playbook_example_05_docker_containers.yml
+  ansible-playbook -i inventories/hosts playbooks/examples/05_docker_containers.yml
   ```
 
 - ### Setting your own example
@@ -134,7 +134,7 @@ The role dependencies are:
     ansible-playbook -i <INVENTORY> <PLAYBOOK_NAME>.yml
     ```
 
-      Or you can also pass it using the **role variables**. So your playbook file should looks like:
+    Or you can also pass it using the **role variables**. So your playbook file should looks like:
 
     ```yaml
     - hosts:
diff --git a/roles/docker_containers/meta/main.yml b/roles/docker_containers/meta/main.yml
index 9b2e1cd..d5ec064 100644
--- a/roles/docker_containers/meta/main.yml
+++ b/roles/docker_containers/meta/main.yml
@@ -5,7 +5,7 @@ galaxy_info:
   description: Role to work with the containers for the c3InfoDesk sytems
   author: fejao
   company: cccv.de
-  license: MIT
+  license: "MIT / BSD"
   min_ansible_version: '2.10'
   galaxy_tags: []
 
diff --git a/roles/docker_images/README.md b/roles/docker_images/README.md
index 39568d4..f83f5c6 100644
--- a/roles/docker_images/README.md
+++ b/roles/docker_images/README.md
@@ -58,14 +58,14 @@ The role dependencies are:
 ## Example Playbook
 
 - ### Using the provided example
-  For using the playbook **playbook_example_04_docker_images.yml** file you only nned to:
+  For using the playbook **playbook/examples/example_04_docker_images.yml** file you only need to:
   - Change the user at the **ansible.cfg** file at the field **remote_user** for acessing your target.
   - Update the file **inventories/host_vars/example_server.yml** and change the value for **ansible_become_pass** from the **remote_user**
   - Update the **inventories/hosts** file and change the **example_server** with the IP address from your target.
 
   And run the command:
 ```bash
-ansible-playbook -i inventories/hosts playbook_example_04_docker_images.yml
+ansible-playbook -i inventories/hosts playbooks/examples/example_04_docker_images.yml
 ```
 
 - ### Setting your own example
diff --git a/roles/docker_images/meta/main.yml b/roles/docker_images/meta/main.yml
index dc928c1..42a845a 100644
--- a/roles/docker_images/meta/main.yml
+++ b/roles/docker_images/meta/main.yml
@@ -5,7 +5,7 @@ galaxy_info:
   description: Role to clone the repositories used from c3InfoDesk sytems
   author: fejao
   company: cccv.de
-  license: MIT
+  license: "MIT / BSD"
   min_ansible_version: '2.10'
   galaxy_tags: []
 
-- 
GitLab