https://github.com/borisskert/ansible-avahi
Ansible role to install an avahi-daemon on your debian-based machine
https://github.com/borisskert/ansible-avahi
Last synced: 7 months ago
JSON representation
Ansible role to install an avahi-daemon on your debian-based machine
- Host: GitHub
- URL: https://github.com/borisskert/ansible-avahi
- Owner: borisskert
- License: mit
- Created: 2020-04-18T10:12:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-17T12:46:02.000Z (10 months ago)
- Last Synced: 2024-12-17T13:34:17.193Z (10 months ago)
- Language: Jinja
- Size: 18.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ansible-avahi
Installs an avahi daemon on an ubuntu server.
## Tested operating systems
* Ubuntu:
* 24.04 (noble)
* 22.04 (jammy)
* 20.04 (focal)
* Debian
* 12 (bookworm)
* 11 (bullseye)
## System requirements
* Python 3
## Tasks
* Installs package `avahi-daemon`
* Setup avahi services
* Reload service (if necessary)
* Start service (if not started)
## Role parameters
| Variable | Type | Mandatory? | Default | Description |
|--------------------------|--------------------------|------------|---------|----------------------------------------------|
| avahi_published_services | array of publish_service | no | [] | The services to be published by avahi daemon |
### Definition publish_service
| Property | Type | Mandatory? | Description |
|----------|------------------|------------|------------------------------------------------|
| name | text | yes | The published name of the service |
| file | text | yes | The filename of the service in your config |
| services | array of service | yes | The avahi services defined in service xml file |
### Definition service
| Property | Type | Mandatory? | Description |
|-------------|----------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| type | text | yes | The avahi type of the service. See [avahi service type database @ github](https://github.com/lathiat/avahi/blob/master/service-type-database/service-types) for further information |
| port | number (port) | yes | The port number of the service to be published |
| txt_records | array of texts | no | Avahi txt records to be published |
## Usage
### requirements.yml
```yaml
- name: install-avahi
src: https://github.com/borisskert/ansible-avahi.git
scm: git
```
### Playbook
minimal playbook:
```yaml
- hosts: servers
- role: install-avahi
```
Typical playbook:
```yaml
- hosts: servers
- role: install-avahi
avahi_published_services:
- name: timemachine
file: afpd
services:
- type: _afpovertcp._tcp
port: 548
- type: _device-info._tcp
port: 0
txt_records:
- model=TimeCapsule
```
## Testing
Requirements:
* [Vagrant](https://www.vagrantup.com/)
* [VirtualBox](https://www.virtualbox.org/)
* [libvirt](https://libvirt.org/)
* [Ansible](https://docs.ansible.com/)
* [Molecule](https://molecule.readthedocs.io/en/latest/index.html)
* [yamllint](https://yamllint.readthedocs.io/en/stable/#)
* [ansible-lint](https://docs.ansible.com/ansible-lint/)
* [Docker](https://docs.docker.com/)
### Run within docker
```shell script
molecule test
```
### Run within Vagrant
```shell script
molecule test --scenario-name vagrant --parallel
```
I recommend to use [pyenv](https://github.com/pyenv/pyenv) for local testing.
Within the GitHub Actions pipeline I use [my own molecule action](https://github.com/borisskert/molecule-action).