Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • fejao/c3infodesk-deployment-role-docker-containers
1 result
Show changes
Commits on Source (6)
Showing with 989 additions and 69 deletions
*OLD*
---
###
### VARIABLES
###
variables:
AUTHOR: fejao
IMAGE_NAME_LINT: python:3.10.15-bullseye
PATH_ENV_DIR: "/builds/fejao/c3infodesk-deployment-role-docker-containers"
PATH_PYTHON_REQ_FILE: "/builds/fejao/c3infodesk-deployment-role-docker-containers/ci-cd/python_requirements.txt"
PATH_PLAYBOOK: "/builds/fejao/c3infodesk-deployment-role-docker-containers/ci-cd/playbook_role_test.yml"
###
### STAGES
###
stages:
- yamllint
- upstream-trigger
###
### SCRIPTS
###
.install_dependencies: &install_dependencies
# Install python and it's requirements
- apt-get update && apt-get install -y python3-pip && apt-get clean && rm -rf /var/lib/apt/lists/*
- pip3 install -r $PYTHON_REQ_FILE_PATH
### Correct the permissions on the build environment directory.
### See https://github.com/ansible/ansible/pull/42142/files
- chmod 700 $PATH_ENV_DIR
yamllint-test:
stage: yamllint
image: $IMAGE_NAME_LINT
variables:
PYTHON_REQ_FILE_PATH: $PATH_PYTHON_REQ_FILE
PLAYBOOK_PATH: $PATH_PLAYBOOK
before_script:
- *install_dependencies
script:
- echo "This is the 'yamllint' test from the 'test' role"
- yamllint .
trigger-pipeline:
stage: upstream-trigger
variables:
RUN_UPSTREAM_FOR_ROLE_DOCKER_IMAGES: true
trigger:
project: fejao/c3infodesk-deployment
branch: main
strategy: depend
---
# https://ansible.readthedocs.io/projects/lint/rules/yaml/
yaml-files:
- '*.yaml'
- '*.yml'
- '.yamllint'
rules:
anchors: enable
# braces: enable
# braces: disable
braces:
max-spaces-inside: 1
brackets: enable
colons: enable
commas: enable
comments:
level: warning
min-spaces-from-content: 1
comments-indentation: false
document-end: disable
document-start:
level: warning
empty-lines: enable
empty-values: disable
float-values: disable
hyphens: enable
# indentation: enable
indentation: disable
key-duplicates: enable
key-ordering: disable
# line-length: enable
line-length:
# max: 160
### roles/dependencies/defaults/main.yml:72 --> 232 characters
max: 240
new-line-at-end-of-file: enable
new-lines: enable
# octal-values: disable
quoted-strings: disable
trailing-spaces: enable
truthy:
level: warning
####
# var_naming_pattern: "^[a-z_][a-z0-9_]*$"
# var-naming: disable
# var-naming:
# no-role-prefix: disable
# c3infodesk-deployment-role-docker-containers
# docker-containers role
This is a ansible-role for dealing with the containers from **c3infodesk**.
## Requirements
- To have [ansible](https://docs.ansible.com/ansible/latest/installation_guide/installation_distros.html) installed at your system.
## Configuration
You need to set some configuration for this to work
- ### ansible.cfg
You have to edit the **ansible.cfg** file to your needs for accessing your target.
- #### remote_user
You need to set the **remote_user** configuration for accessing the target host.
Example: [remote_user](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/ansible.cfg#L227)
## Getting started
- ### HOST_VARS
In order to access your target host, you need to create/edit your **inventories/host_vars/<YOUR_HOST_NAME>.yml**
- #### ansible_become_pass
You need to set the **sudo** password from the user setted on **remote_user** for installing packages and etc. at the target.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Example: [ansible_become_pass](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/host_vars/example_server.yml#L5)
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
- ### HOSTS
You need to provide a group in which your target belongs to with the same name setted for **inventories/host_vars/<YOUR_HOST_NAME>.yml**.
## Add your files
There you can add/edit the target address/IP.
Example: [hosts](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/hosts)
## Role Variables
Here are the variables to setted from this role:
- ### From: inventories/host_vars/<TARGET_NAME>
Here are the variables that you should be changing for your own deployment.
- #### CUPS
Here you can set the variables if you want to **disable** and/or **mask** the CUPS service at the target.
- **c3infodesk_printer_host_cups_disable**: DEFAULT=<NOT_SETTED>
- **c3infodesk_printer_host_cups_mask**: DEFAULT=<NOT_SETTED>
- #### COMPOSE
Here you can set the variables if you want to set the **docker compose command** to up/stop/restart/down
- **c3infodesk_printer_docker_compose_up**: DEFAULT=<NOT_SETTED>
- **c3infodesk_printer_docker_compose_stop**: DEFAULT=<NOT_SETTED>
- **c3infodesk_printer_docker_compose_restart**: DEFAULT=<NOT_SETTED>
- **c3infodesk_printer_docker_compose_down**: DEFAULT=<NOT_SETTED>
- ### 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.
At the moment, there's **NO VARIABLES** setted at the **group_vars** for this role.
- ### 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
- #### CUPS
- **c3infodesk_printer_host_cups_disable**: DEFAULT=false
- If you want to disable the CUPS service at the target system
- **c3infodesk_printer_host_cups_disable_debug**: DEFAULT=false
- If you want to debug disabling CUPS at the target system
- **c3infodesk_printer_host_cups_mask**: DEFAULT=false
- If you want to mask the CUPS service at the target system
- #### COMPOSE UP
- **c3infodesk_printer_docker_compose_up**: DEFAULT=false
- If you want to run the command: "docker compose up" at the target host
- **c3infodesk_printer_docker_compose_up_debug**: DEFAULT=false
- If you want to debug running the command: "docker compose up" at the target host
- #### COMPOSE STOP
- **c3infodesk_printer_docker_compose_stop**: DEFAULT=false
- If you want to run the command: "docker compose stop" at the target host
- **c3infodesk_printer_docker_compose_stop_debug**: DEFAULT=false
- If you want to debug running the command: "docker compose stop" at the target host
- #### COMPOSE RESTART
- **c3infodesk_printer_docker_compose_restart**: DEFAULT=false
- If you want to run the command: "docker compose restart" at the target host
- **c3infodesk_printer_docker_compose_restart_debug**: DEFAULT=false
- If you want to debug running the command: "docker compose restart" at the target host
- #### COMPOSE DOWN
- **c3infodesk_printer_docker_compose_down**: DEFAULT=false
- If you want to run the command: "docker compose down" at the target host
- **c3infodesk_printer_docker_compose_down_debug**: DEFAULT=false
- If you want to debug running the command: "docker compose down" at the target host
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://git.cccv.de/fejao/c3infodesk-deployment-role-docker-containers.git
git branch -M main
git push -uf origin main
```
## Dependencies
The role dependencies are:
- [dependencies(role)](https://git.cccv.de/fejao/c3infodesk-deployment-role-dependencies)
- [clone_repositories](https://git.cccv.de/fejao/c3infodesk-deployment-role-clone-repositories)
- [docker_images](https://git.cccv.de/fejao/c3infodesk-deployment-role-docker-images)
## Example Playbook
- ### What this example will deploy
This role will deploy all the containers setted on the [docker-compose.yml](https://git.cccv.de/fejao/c3infodesk-printer/-/blob/main/docker/docker-compose.yml) file.
**PLEASE CHANGE THE VALEUS** setted at this file on the target to your own.
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 example playbook **[playbooks/examples/example_05_docker_containers.yml](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/playbooks/examples/example_05_docker_containers.yml)** file you only need to:
- Change the user at the **[ansible.cfg](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/ansible.cfg)** file at the field **[remote_user](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/ansible.cfg#L227)** for acessing your target.
- Update the file **[inventories/host_vars/example_server.yml](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/host_vars/example_server.yml)** and change the value for **[ansible_become_pass](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/host_vars/example_server.yml#L5)** from the **[remote_user](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/ansible.cfg#L227)**
- Update the **[inventories/hosts](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/hosts)** file and change the **[example_server](https://git.cccv.de/fejao/c3infodesk-deployment/-/blob/main/inventories/hosts#L2)** with the IP address from your target.
## Integrate with your tools
- [ ] [Set up project integrations](https://git.cccv.de/fejao/c3infodesk-deployment-role-docker-containers/-/settings/integrations)
And run the command:
```bash
ansible-playbook -i inventories/hosts playbooks/examples/05_docker_containers.yml
```
- ### Setting your own example
- #### Deploying a new system example
After setting your variables at **inventories/host_vars/<HOST_NAME>**, you can add this role to your playbook as a regular role.
Here is an example using the **<HOST_NAME>** as **test_servers**
You will need to set this variables fro a new deployment:
- **c3infodesk_printer_host_cups_disable**: true
- **c3infodesk_printer_host_cups_mask**: true
- **c3infodesk_printer_docker_compose_up**: true
```yaml
- hosts:
- example_servers_group
roles:
- role: roles/c3infodesk-deployment-role-docker-containers
vars:
c3infodesk_printer_host_cups_disable: true
c3infodesk_printer_host_cups_mask: true
c3infodesk_printer_docker_compose_up: true
```
And call the playbook as:
```bash
ansible-playbook -i <INVENTORY> <PLAYBOOK_NAME>.yml
```
- #### Restarting the containers example
Here is an example for adding this role for your playbook for **restarting** the **c3infodesk-printer** containers:
We are using the **<HOST_NAME>** as **test_servers** for example.
```yaml
- hosts:
- test_servers
roles:
- role: roles/c3infodesk-deployment-role-docker-containers
vars:
printer_docker_compose_restart: true
```
And call the playbook as:
```bash
ansible-playbook -i <INVENTORY> <PLAYBOOK_NAME>.yml
```
Or you can also pass it using the **role variables**. So your playbook file should looks like:
```yaml
- hosts:
- test_servers
roles:
- roles/c3infodesk-deployment-role-docker-containers
```
## Collaborate with your team
And call it passing the variable, for example, restarting the containers from **c3infodesk-printer**.
```bash
ansible-playbook -i <INVENTORY> <PLAYBOOK_NAME>.yml --extra-vars "printer_docker_compose_restart=true"
```
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
## 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/)
Use the built-in continuous integration in GitLab.
- ### Testing requirements
You need docker installed at your system and the [ansible molecule](https://ansible.readthedocs.io/projects/molecule/installation/).
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
You might have to set DIND at your system, for linux, you can create the file **/etc/docker/daemon.json**
***
And add the content and restart docker.
# Editing this README
```json
{
"exec-opts": ["native.cgroupdriver=systemd"],
"features": {
"buildkit": true
},
"experimental": true,
"cgroup-parent": "docker.slice"
}
```
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
- ### Using molecule
Just go to the root of the role **roles/dependencies** and run the command:
## Suggestions for a good README
```bash
molecule test
```
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## License
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
MIT / BSD
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
## Author Information
[https://chaos.social/@fejao](https://chaos.social/@fejao)
yamllint
---
# defaults file for docker-containers
# c3infodesk_project_src: "PLEASE SET THIS VARIABLE"
###
### c3InfoDesk Printer
###
### CUPS
c3infodesk_printer_host_cups_disable: false
c3infodesk_printer_host_cups_disable_debug: false
c3infodesk_printer_host_cups_mask: false
### COMPOSE UP
c3infodesk_printer_docker_compose_up: false
c3infodesk_printer_docker_compose_up_debug: false
### COMPOSE STOP
c3infodesk_printer_docker_compose_stop: false
c3infodesk_printer_docker_compose_stop_debug: false
### COMPOSE RESTART
c3infodesk_printer_docker_compose_restart: false
c3infodesk_printer_docker_compose_restart_debug: false
### COMPOSE DOWN
c3infodesk_printer_docker_compose_down: false
c3infodesk_printer_docker_compose_down_debug: false
---
galaxy_info:
role_name: docker_containers
description: Role to work with the containers for the c3InfoDesk sytems
author: fejao
company: cccv.de
license: "MIT / BSD"
min_ansible_version: '2.10'
galaxy_tags: []
# dependencies: []
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
# if you add dependencies to this list.
dependencies:
# - role: dependencies
# - role: clone_repositories
# - role: docker_images
- role: c3infodesk-deployment-role-dependencies
- role: c3infodesk-deployment-role-clone-repositories
- role: c3infodesk-deployment-role-docker-images
## ansible molecule tests for role: docker_containers
## Why to use it
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
You need to have [ansible molecule](https://ansible.readthedocs.io/projects/molecule/installation/) installed.
- ### DIND (docker in docker)
For using the tests, you will to have **docker** installed locally and and set it for using **DIND (docker in docker)**
- ### DIND linux
You have to create/edit the file **/etc/docker/daemon.json** with the content:
```json
{
"exec-opts": ["native.cgroupdriver=systemd"],
"features": {
"buildkit": true
},
"experimental": true,
"cgroup-parent": "docker.slice"
}
```
## 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
```
---
- name: MOLECULE | Cleanup
hosts: all
vars:
package_name_docker: 'docker'
package_name_docker_ce: 'docker-ce'
package_name_docker_compose: 'docker-compose'
package_name_docker_compose_plugin: 'docker-compose-plugin'
container_name_cups: 'c3printing-cups'
container_name_app: 'c3printing-app'
container_name_proxy: 'c3printing-proxy'
container_name_influxdb: 'c3printing-influxdb'
pre_tasks:
###
### VARIABLES
###
- name: MOLECULE | CLEANUP | PRE-TASKS | VARIABLES | From -> ../../defaults
ansible.builtin.include_vars:
dir: ../../defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | CLEANUP | PRE-TASKS | VARIABLES | From -> ../../../../roles/dependencies/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/dependencies/defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | CLEANUP | PRE-TASKS | VARIABLES | From -> ../../../../roles/clone_repositories/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/clone_repositories/defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | CLEANUP | PRE-TASKS | VARIABLES | From -> ../../../../roles/docker_images/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/docker_images/defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | CLEANUP | PRE-TASKS | VARIABLES | From -> ../../../../inventories/group_vars
ansible.builtin.include_vars:
dir: ../../../../inventories/group_vars
extensions:
- 'yml'
- name: MOLECULE | CLEANUP | PRE-TASKS | VARIABLES | From -> ../../../../inventories/host_vars
ansible.builtin.include_vars:
dir: ../../../../inventories/host_vars
extensions:
- 'yml'
###
### DOCKER COMPOSE
###
- name: MOLECULE | CLEANUP | PRE-TASKS | DOCKER | Remove all running containers.
community.docker.docker_compose_v2:
project_src: "{{ c3infodesk_printer_folder_docker }}"
# state: absent
state: absent
register: ret_docker_compose_down
- name: MOLECULE | CLEANUP | PRE-TASKS | DOCKER | Output from removing all containers.
ansible.builtin.debug:
var: ret_docker_compose_down
when: c3infodesk_printer_docker_compose_up_debug | bool
# - name: MOLECULE | CLEANUP | PRE-TASKS | DOCKER | raise error.
# ansible.builtin.debug:
# msg: "ERROR RAISED"
# failed_when: true
---
- name: MOLECULE | Converge
hosts: all
pre_tasks:
###
### VARIABLES
###
- name: MOLECULE | COVERGE | PRE-TASKS | VARIABLES | From -> ../../defaults
ansible.builtin.include_vars:
dir: ../../defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | CONVERGE | PRE-TASKS | VARIABLES | From -> ../../../../roles/c3infodesk-deployment-role-dependencies/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/c3infodesk-deployment-role-dependencies/defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | CONVERGE | PRE-TASKS | VARIABLES | From -> ../../../../roles/c3infodesk-deployment-role-clone-repositories/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/c3infodesk-deployment-role-clone-repositories/defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | CONVERGE | PRE-TASKS | VARIABLES | From -> ../../../../roles/c3infodesk-deployment-role-docker-images/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/c3infodesk-deployment-role-docker-images/defaults
depth: 1
extensions:
- 'yml'
# - name: MOLECULE | CONVERGE | PRE-TASKS | VARIABLES | From -> ../../../../roles/dependencies/defaults
# ansible.builtin.include_vars:
# dir: ../../../../roles/dependencies/defaults
# depth: 1
# extensions:
# - 'yml'
# - name: MOLECULE | CONVERGE | PRE-TASKS | VARIABLES | From -> ../../../../roles/clone_repositories/defaults
# ansible.builtin.include_vars:
# dir: ../../../../roles/clone_repositories/defaults
# depth: 1
# extensions:
# - 'yml'
# - name: MOLECULE | CONVERGE | PRE-TASKS | VARIABLES | From -> ../../../../roles/docker_images/defaults
# ansible.builtin.include_vars:
# dir: ../../../../roles/docker_images/defaults
# depth: 1
# extensions:
# - 'yml'
- name: MOLECULE | COVERGE | PRE-TASKS | VARIABLES | From -> ../../../../inventories/group_vars
ansible.builtin.include_vars:
dir: ../../../../inventories/group_vars
extensions:
- 'yml'
- name: MOLECULE | COVERGE | PRE-TASKS | VARIABLES | From -> ../../../../inventories/host_vars
ansible.builtin.include_vars:
dir: ../../../../inventories/host_vars
extensions:
- 'yml'
- name: MOLECULE | COVERGE | PRE-TASKS | Install python 'requests' package
ansible.builtin.pip:
name: requests
tasks:
- name: MOLECULE | CONVERGE | Call the 'clone_repositories' role for starting the containers.
vars:
c3infodesk_printer_host_cups_disable: true
c3infodesk_printer_host_cups_mask: true
c3infodesk_printer_docker_compose_up: true
ansible.builtin.include_role:
# name: docker_containers
name: c3infodesk-deployment-role-docker-containers
---
dependency:
name: galaxy
driver:
name: docker
platforms:
- name: molecule_docker_containers
### At the moment I'm not running at the latest kernel, please use always with a older kernel than the host
# image: docker.io/geerlingguy/docker-ubuntu2204-ansible
image: geerlingguy/docker-ubuntu2204-ansible:latest
command: /usr/sbin/init
pre_build_image: true
cgroupns_mode: host
privileged: true
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:rw
- /var/lib/containerd
provisioner:
name: ansible
lint: |
ansible-lint --exclude molecule/default/
scenario:
name: default
create_sequence:
- dependency
- create
- prepare
check_sequence:
- dependency
- cleanup
- destroy
- create
- prepare
- converge
- check
- destroy
converge_sequence:
- dependency
- create
- prepare
- converge
destroy_sequence:
- dependency
- cleanup
- destroy
test_sequence:
# - lint
# - dependency
# - cleanup
- destroy
- syntax
- create
# - prepare
- converge
- verify
- idempotence
# - side_effect
- cleanup
- destroy
verifier:
name: ansible
---
- name: MOLECULE | Verify
hosts: all
vars:
package_name_docker: 'docker'
package_name_docker_ce: 'docker-ce'
package_name_docker_compose: 'docker-compose'
package_name_docker_compose_plugin: 'docker-compose-plugin'
container_name_cups: 'c3printing-cups'
container_name_app: 'c3printing-app'
container_name_proxy: 'c3printing-proxy'
# container_name_influxdb: 'c3printing-influxdb'
pre_tasks:
- name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../defaults
ansible.builtin.include_vars:
dir: ../../defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../../../roles/c3infodesk-deployment-role-dependencies/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/c3infodesk-deployment-role-dependencies/defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../../../roles/c3infodesk-deployment-role-clone-repositories/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/c3infodesk-deployment-role-clone-repositories/defaults
depth: 1
extensions:
- 'yml'
- name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../../../roles/c3infodesk-deployment-role-docker-images/defaults
ansible.builtin.include_vars:
dir: ../../../../roles/c3infodesk-deployment-role-docker-images/defaults
depth: 1
extensions:
- 'yml'
# - name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../../../roles/dependencies/defaults
# ansible.builtin.include_vars:
# dir: ../../../../roles/dependencies/defaults
# depth: 1
# extensions:
# - 'yml'
# - name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../../../roles/clone_repositories/defaults
# ansible.builtin.include_vars:
# dir: ../../../../roles/clone_repositories/defaults
# depth: 1
# extensions:
# - 'yml'
# - name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../../../roles/docker_images/defaults
# ansible.builtin.include_vars:
# dir: ../../../../roles/docker_images/defaults
# depth: 1
# extensions:
# - 'yml'
- name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../../../inventories/group_vars
ansible.builtin.include_vars:
dir: ../../../../inventories/group_vars
extensions:
- 'yml'
- name: MOLECULE | VERIFY | PRE-TASKS | VARIABLES | From -> ../../../../inventories/host_vars
ansible.builtin.include_vars:
dir: ../../../../inventories/host_vars
extensions:
- 'yml'
tasks:
###
### POPULATE
###
- name: MOLECULE | VERIFY | POPULATE | Gather the package facts
ansible.builtin.package_facts:
manager: auto
- name: MOLECULE | VERIFY | POPULATE | Gather service facts
ansible.builtin.service_facts:
###
### TESTS - PACKAGES
###
- name: MOLECULE | VERIFY | TEST | Check that the packages from 'os_dependencies_packages' are installed.
ansible.builtin.debug:
msg: "Package: '{{ package_name }}' is installed"
loop: "{{ os_dependencies_packages }}"
loop_control:
loop_var: package_name
failed_when: package_name not in ansible_facts.packages
- name: MOLECULE | VERIFY | TEST | Check that docker is installed.
ansible.builtin.debug:
msg: "Package: 'docker' is installed"
failed_when:
- package_name_docker not in ansible_facts.packages
- package_name_docker_ce not in ansible_facts.packages
- name: MOLECULE | VERIFY | TEST | Check that docker-compose is installed.
ansible.builtin.debug:
msg: "Package: 'docker-cokmpose' is installed"
failed_when:
- package_name_docker_compose not in ansible_facts.packages
- package_name_docker_compose_plugin not in ansible_facts.packages
###
### TESTS - DOCKER
###
- name: MOLECULE | VERIFY | TEST | Get docker service state.
ansible.builtin.systemd:
name: "docker"
register: docker_service
- name: MOLECULE | VERIFY | TEST | Check that docker is running.
ansible.builtin.debug:
msg: "Docker IS running..."
failed_when: "'active' != docker_service.status.ActiveState"
###
### TESTS - ADDED USERS
###
- name: MOLECULE | VERIFY | TEST | Get added users infos.
ansible.builtin.user:
name: "{{ item }}"
loop: "{{ docker_users }}"
check_mode: true
register: test_users
- name: MOLECULE | VERIFY | TEST | Check if users exists
ansible.builtin.debug:
msg: "User {{ item.item }} {{ 'exists' if item.state | d('') == 'present' else 'does not exist' }}"
loop: "{{ test_users.results }}"
loop_control:
label: "{{ item.item }}"
- name: MOLECULE | VERIFY | TEST | Get the groups that the users belongs to.
ansible.builtin.command:
cmd: "id -Gn {{ item.item }}"
loop: "{{ test_users.results }}"
loop_control:
label: "{{ item.item }}"
register: user_groups
changed_when: false
- name: MOLECULE | VERIFY | TEST | Check that the users are at the 'docker' group.
ansible.builtin.debug:
msg: "User '{{ item.item.item }}' belongs to the docker group"
with_items: "{{ user_groups.results }}"
failed_when: "'docker' not in item.stdout"
###
### TESTS - CLONE REPOSITORY - PRINTER
###
- name: MOLECULE | VERIFY | TEST | Get if the repository was cloned.
ansible.builtin.git:
repo: "{{ c3infodesk_printer_repo_url }}"
dest: "{{ c3infodesk_printer_folder }}"
version: main
clone: false
update: false
register: check_repository
- name: MOLECULE | VERIFY | TEST | Checking if the repository was cloned.
ansible.builtin.debug:
msg: "Repository: '{{ c3infodesk_printer_repo_url }}' cloned..."
failed_when: check_repository.changed | bool
###
### TESTS - DOCKER IMAGES
###
- name: MOLECULE | VERIFY | TEST | Get if the image is created for 'cups'.
community.docker.docker_image_info:
name: "{{ c3infodesk_printer_docker_img_cups_name }}"
register: result_check_image_cups
- name: MOLECULE | VERIFY | TEST | Check the image creation from 'cups'.
ansible.builtin.debug:
msg: "Image for 'cups' exists"
when: result_check_image_cups.images | length > 0
- name: MOLECULE | VERIFY | TEST | Get if the image is created for 'app'.
community.docker.docker_image_info:
name: "{{ c3infodesk_printer_docker_img_app_name }}"
register: result_check_image_app
- name: MOLECULE | VERIFY | TEST | Check the image creation from 'app'.
ansible.builtin.debug:
msg: "Image for 'app' exists"
when: result_check_image_app.images | length > 0
- name: MOLECULE | VERIFY | TEST | Get if the image is created for 'proxy'.
community.docker.docker_image_info:
name: "{{ c3infodesk_printer_docker_img_proxy_name }}"
register: result_check_image_proxy
- name: MOLECULE | VERIFY | TEST | Check the image creation from 'proxy'.
ansible.builtin.debug:
msg: "Image for 'proxy' exists"
when: result_check_image_proxy.images | length > 0
###
### TESTS - DOCKER CONTAINERS - CUPS DISABLE
###
- name: MOLECULE | VERIFY | TEST | Get that the CUPS service is disable.
ansible.builtin.debug:
msg: "The service: 'cups.service' is not setted"
failed_when: "'cups.service' in ansible_facts.services"
###
### TESTS - DOCKER CONTAINERS - CUPS
###
- name: MOLECULE | VERIFY | TEST | CONTAINER CUPS | Get infos on the container.
community.docker.docker_container_info:
name: "{{ container_name_cups }}"
register: ret_container_cups
- name: MOLECULE | VERIFY | TEST | CONTAINER CUPS | Check that the container exists.
ansible.builtin.debug:
msg: "The container '{{ container_name_cups }}' {{ 'exists' if ret_container_cups.exists else 'does not exist' }}"
failed_when: ret_container_cups.exists | bool is not true
- name: MOLECULE | VERIFY | TEST | CONTAINER CUPS | Check that the container is running.
ansible.builtin.debug:
msg: "The container '{{ container_name_cups }}' is running"
failed_when: ret_container_cups.container.State.Status != 'running'
###
### TESTS - DOCKER CONTAINERS - APP
###
- name: MOLECULE | VERIFY | TEST | CONTAINER APP | Get infos on the container.
community.docker.docker_container_info:
name: "{{ container_name_app }}"
register: ret_container_app
- name: MOLECULE | VERIFY | TEST | CONTAINER APP | Check that the container exists.
ansible.builtin.debug:
msg: "The container '{{ container_name_app }}' {{ 'exists' if ret_container_app.exists else 'does not exist' }}"
failed_when: ret_container_app.exists | bool is not true
- name: MOLECULE | VERIFY | TEST | CONTAINER APP | Check that the container is running.
ansible.builtin.debug:
msg: "The container '{{ container_name_app }}' is running"
failed_when: ret_container_app.container.State.Status != 'running'
###
### TESTS - DOCKER CONTAINERS - PROXY
###
- name: MOLECULE | VERIFY | TEST | CONTAINER PROXY | Get infos on the container.
community.docker.docker_container_info:
name: "{{ container_name_proxy }}"
register: ret_container_proxy
- name: MOLECULE | VERIFY | TEST | CONTAINER PROXY | Check that the container exists.
ansible.builtin.debug:
msg: "The container '{{ container_name_proxy }}' {{ 'exists' if ret_container_proxy.exists else 'does not exist' }}"
failed_when: ret_container_proxy.exists | bool is not true
- name: MOLECULE | VERIFY | TEST | CONTAINER PROXY | Check that the container is running.
ansible.builtin.debug:
msg: "The container '{{ container_name_proxy }}' is running"
failed_when: ret_container_proxy.container.State.Status != 'running'
---
# tasks file for docker-containers
- name: Disabling CUPS on target host
ansible.builtin.import_tasks: printer_host_cups_disable.yml
when: c3infodesk_printer_host_cups_disable | bool
- name: Running printer compose up
ansible.builtin.import_tasks: printer_compose_up.yml
when: c3infodesk_printer_docker_compose_up | bool
- name: Running printer compose stop
ansible.builtin.import_tasks: printer_compose_stop.yml
when: c3infodesk_printer_docker_compose_stop | bool
- name: Running printer compose restart
ansible.builtin.import_tasks: printer_compose_restart.yml
when: c3infodesk_printer_docker_compose_restart | bool
- name: Running printer compose down
ansible.builtin.import_tasks: printer_compose_down.yml
when: c3infodesk_printer_docker_compose_down | bool
---
# tasks file for docker-compose down
- name: COMPOSE DOWN | Run `docker compose down`
community.docker.docker_compose_v2:
project_src: "{{ c3infodesk_project_src }}"
state: absent
register: ret_docker_compose_down
- name: COMPOSE DOWN | Output compose down
ansible.builtin.debug:
var: ret_docker_compose_down
when: c3infodesk_printer_docker_compose_down_debug | bool
---
# tasks file for docker-compose restart
- name: COMPOSE RESTART | Run `docker compose restart`
community.docker.docker_compose_v2:
project_src: "{{ c3infodesk_project_src }}"
state: restarted
register: ret_docker_compose_restart
- name: COMPOSE RESTART | Output compose restart
ansible.builtin.debug:
var: ret_docker_compose_restart
when: c3infodesk_printer_docker_compose_restart_debug | bool
---
# tasks file for docker-compose stop
- name: COMPOSE STOP | Run `docker compose stop`
community.docker.docker_compose_v2:
project_src: "{{ c3infodesk_project_src }}"
state: stopped
register: ret_docker_compose_stop
- name: COMPOSE STOP | Output compose stop
ansible.builtin.debug:
var: ret_docker_compose_stop
when: c3infodesk_printer_docker_compose_stop_debug | bool
---
# tasks file for docker-compose up
- name: COMPOSE UP | Run `docker compose up`
community.docker.docker_compose_v2:
project_src: "{{ c3infodesk_printer_folder_docker }}"
state: present
register: ret_docker_compose_up
- name: COMPOSE UP | Output compose up
ansible.builtin.debug:
var: ret_docker_compose_up
when: c3infodesk_printer_docker_compose_up_debug | bool
---
# tasks file for disabling CUPS on target system
- name: DISABLE CUPS | Populate service facts
ansible.builtin.service_facts:
- name: DISABLE CUPS | Setting fact from cups status
ansible.builtin.set_fact:
cups_status: "{{ ansible_facts.services['cups.service'].status }}"
when: ansible_facts.services['cups.service'].status is defined
- name: DISABLE CUPS | Stop the running CUPS on target
ansible.builtin.command:
cmd: systemctl stop cups
become: true
when:
- cups_status is defined
- cups_status != 'masked'
register: ret_stop_cups
changed_when: ret_stop_cups.rc != 0
- name: DISABLE CUPS | Disable the running CUPS on target
ansible.builtin.command:
cmd: systemctl disable cups
become: true
when:
- cups_status is defined
- cups_status != 'masked'
register: ret_disable_cups
changed_when: ret_disable_cups.rc != 0
- name: DISABLE CUPS | Mask the running CUPS on target
ansible.builtin.command:
cmd: systemctl mask cups
become: true
when:
- cups_status is defined
- cups_status != 'masked'
register: ret_mask_cups
changed_when: ret_mask_cups.rc != 0