From 160fc330df2f553228caa5d312104c2adb247378 Mon Sep 17 00:00:00 2001
From: fejao <mail@fejao.de>
Date: Mon, 10 Mar 2025 20:05:00 +0100
Subject: [PATCH] Updated the README.md file
---
README.md | 37 ++-----------------------------------
molecule/README.md | 28 +++++++++++++++++++++++-----
2 files changed, 25 insertions(+), 40 deletions(-)
diff --git a/README.md b/README.md
index 3a1dfcb..a123f58 100644
--- a/README.md
+++ b/README.md
@@ -103,7 +103,7 @@ The role dependencies are:
And run the command:
```bash
- ansible-playbook -i inventories/hosts playbooks/examples/example_04_docker_images.yml
+ ansible-playbook -i inventories/hosts playbooks/example_c3infodesk_printer/c3infodesk_printer_04_docker_xtras.yml
```
- ### Setting your own example
@@ -126,40 +126,7 @@ The role dependencies are:
## Testing
-You can test this locally using **DIND (docker in docker)** at your own computer using [ansible molecule](https://ansible.readthedocs.io/projects/molecule/installation/)
-
-- ### Testing requirements
- You need docker installed at your system and the [ansible molecule](https://ansible.readthedocs.io/projects/molecule/installation/).
-
- - #### Setting *DIND (docker in docker)*
- You might have to set *DIND (docker in docker)* at your system, for linux, you can create the file **/etc/docker/daemon.json**
-
- - ##### Enabling DIND at your system
- And add the content and restart docker.
-
- ```json
- {
- "exec-opts": ["native.cgroupdriver=systemd"],
- "features": {
- "buildkit": true
- },
- "experimental": true,
- "cgroup-parent": "docker.slice"
- }
- ```
-
-- ### Using the molecule tests
-
- - #### Configuring the *HOST_VAR_FILE_NAME* variable
- For using the molecule tests you should pass the **HOST_VAR_FILE_NAME** environment variable, or the default value for testing is: **example_printer.yml**
-
- For the values that can be used, you can lool at the files at the **inventories/host_vars** folder.
-
- - ##### Molecule test example
- Just go to the root of the role **roles/x3infodesk-deployment-role-dependencies** and run the command, here is an example for using the **HOST_VAR_FILE_NAME** as *example_buttons.yml*:
- ```bash
- HOST_VAR_FILE_NAME="example_buttons.yml" molecule test
- ```
+For testing this role, please reference [how to use molecule tests](https://git.cccv.de/fejao/c3infodesk-deployment-role-docker-xtras/-/tree/main/molecule)
## License
diff --git a/molecule/README.md b/molecule/README.md
index 4e02fc3..f274c76 100644
--- a/molecule/README.md
+++ b/molecule/README.md
@@ -1,4 +1,4 @@
-## ansible molecule tests for role: docker_containers
+# ansible molecule tests for role: docker_xtras
@@ -7,6 +7,7 @@ It's allways a good idea to test your things.
With **ansible molecule** you can test your role locally without the need of using a **real server** but a local **docker container**.
+
## Dependencies
- ### molecule
@@ -34,9 +35,26 @@ With **ansible molecule** you can test your role locally without the need of usi
## Configuration
There's not much for configuring for using the tests
+
## Running the tests
-For running the **molecule tests** you just need to run the command:
-```bash
-molecule test
-```
+- #### Configuring the *HOST_VAR_FILE_NAME* variable
+ For using the molecule tests you should pass the **HOST_VAR_FILE_NAME** environment variable, or the default value for testing is: **example_printer.yml**
+
+ For the values that can be used, you can lool at the files at the **inventories/host_vars** folder.
+
+- ##### Molecule test example
+ Just go to the root of the role **roles/x3infodesk-deployment-role-dependencies** and run the command, here is an example for using the **HOST_VAR_FILE_NAME** as *example_buttons.yml*:
+ ```bash
+ HOST_VAR_FILE_NAME="example_buttons.yml" molecule test
+ ```
+
+
+## License
+
+MIT / BSD
+
+
+## Author Information
+
+[https://chaos.social/@fejao](https://chaos.social/@fejao)
--
GitLab