diff --git a/README.md b/README.md index 8c0517565398a6b3da8f3e4a700de7a06cb15816..85cbe4916749ba974d993af84a645e60d9af8893 100644 --- a/README.md +++ b/README.md @@ -33,43 +33,34 @@ You need to set some configuration for this to work ## Role Variables Here are the variables setted: -- ### From: inventories/host_vars/<TARGET_NAME> - Here are the variables that you should be changing for your own deployment. - - **c3infodesk_printer_debug_create_image_cups**: DEFAULT=<NOT_SETTED> - - If you want to debug the output from creating the image for CUPS - - **c3infodesk_printer_debug_create_image_app**: DEFAULT=<NOT_SETTED> - - If you want to debug the output from creating the image for the APP - - **c3infodesk_printer_debug_create_image_proxy**: DEFAULT=<NOT_SETTED> - - If you want to debug the output from creating the image for the PROXY - -- ### From: inventories/group_vars/<TARGET_GROUP> - Please don't cahnge the default values at this file. If you need to update them, use the **inventories/host_vars/<TARGET_NAME>** file. - - **c3infodesk_printer_folder_docker**: DEFAULT="Coding/c3infodesk-printer/docker" - - The folder where the configuration from docker used for the system - - **c3infodesk_printer_folder_docker_cups**: DEFAULT="Coding/c3infodesk-printer/docker/cups" - - The folder where the configuration from docker CUPS used for the system - - **c3infodesk_printer_folder_docker_app**: DEFAULT="Coding/c3infodesk-printer/docker/app" - - The folder where the configuration from docker APP used for the system - - **c3infodesk_printer_folder_docker_proxy**: DEFAULT="Coding/c3infodesk-printer/docker/proxy" - - The folder where the configuration from docker PROXY used for the system - - **c3infodesk_printer_docker_img_cups_name**: DEFAULT="c3printing-cups" - - The name of the image to be set for the CUPS - - **c3infodesk_printer_docker_img_cups_tag**: DEFAULT="latest" - - The tag name/number to be setted for the CUPS image - - **c3infodesk_printer_docker_img_app_name**: DEFAULT="c3printing-app" - - The name of the image to be set for the APP - - **c3infodesk_printer_docker_img_app_tag**: DEFAULT="latest" - - The tag name/number to be setted for the APP image - - **c3infodesk_printer_docker_img_proxy_name**: DEFAULT="c3printing-proxy" - - The name of the image to be set for the PROXY - - **c3infodesk_printer_docker_img_proxy_tag**: DEFAULT="latest" - - The tag name/number to be setted for the PROXY image - -- ### From: roles/clone-repositories/defaults/main.yml - Don't change the values at this file, if you need to change them, change it at the **inventories/host_vars/<TARGET_NAME>** file - - **c3infodesk_printer_debug_create_image_cups**: DEFAULT=false - - **c3infodesk_printer_debug_create_image_app**: DEFAULT=false - - **c3infodesk_printer_debug_create_image_proxy**: DEFAULT=false +- ### c3infodesk_deployment_paht_docker_folder + - This should be a **string** entry with the path of the folder where is located the docker folder from the setted beforehand cloned repository. + - **DEFAULT**: *"Coding/c3infodesk-printer/docker"* + +- ### c3infodesk_deployment_docker_images_list + - This should be a **list** entry with the the information of the images that should be builded/created from this role. + - This list include entries with the default keys: + - **docker_file_path** + - The path from the location of the **Dockerfile** for the image to be builded. + - **docker_image_name** + - The name of the image to be builded. + - **docker_image_tag** + - The tag of the image to be builded. + - **DEFAULT**: The default values are seeted for the [c3InfoDesk-Printer](https://git.cccv.de/fejao/c3infodesk-printer) project. + ```yaml + c3infodesk_deployment_docker_images_list: + - docker_file_path: docker/cups/Dockerfile + docker_image_name: c3printing-cups + docker_image_tag: latest + + - docker_file_path: docker/app/Dockerfile + docker_image_name: c3printing-app + docker_image_tag: latest + + - docker_file_path: docker/proxy/Dockerfile + docker_image_name: c3printing-proxy + docker_image_tag: latest + ``` ## Dependencies @@ -117,27 +108,35 @@ You can test this locally using **DIND (docker in docker)** at your own computer - ### Testing requirements You need docker installed at your system and the [ansible molecule](https://ansible.readthedocs.io/projects/molecule/installation/). - You might have to set DIND at your system, for linux, you can create the file **/etc/docker/daemon.json** + - #### 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** - And add the content and restart docker. + - ##### 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" - } - ``` + ```json + { + "exec-opts": ["native.cgroupdriver=systemd"], + "features": { + "buildkit": true + }, + "experimental": true, + "cgroup-parent": "docker.slice" + } + ``` -- ### Using molecule - Just go to the root of the role **roles/dependencies** and run the command: +- ### Using the molecule tests - ```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