Intro

Install and set up the Mosquitto MQTT broker.

Requirements

There are no specific roles required, but the target machine should be able to run Docker. The geerlingguy.docker Ansible role is a good option for this.

Additionally, you may need a way to deploy and manage SSL certificates, but this is not included in this role.

This role will also create a user and group named mosquitto on the host, both with the ID 1883. This user/group will manage all directories and files shared with the service container. This is set in the Eclipse Docker images, so customization is limited.

Role Variables

Check the comment in the default variables file for configuration details.

Dependencies

None.

Example Playbook

- hosts: whatever
  roles:
    - triplepoint.mosquitto

Role Testing

This role is tested using molecule, with pipenv managing dependencies and the Python testing setup.

Setting Up Your Execution Environment

pip install pipenv

After installing pipenv, you can create the execution virtual environment with:

pipenv install --dev

Running Tests

Once your environment is set up, run molecule with:

pipenv run molecule test

Regenerating the Lock File

You typically won't need to do this often, but if you update any Python package requirements using pipenv install {some_package} or by editing the Pipfile directly, or if your dependencies are outdated, you may need to regenerate the Pipfile.lock.

pipenv update --dev

Make sure to check in the new Pipfile.lock after this is done.

License

MIT