Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unifi-utilities/ansible-udmp
Ansible Playbook for UDM/P on_boot-Script
https://github.com/unifi-utilities/ansible-udmp
Last synced: about 2 months ago
JSON representation
Ansible Playbook for UDM/P on_boot-Script
- Host: GitHub
- URL: https://github.com/unifi-utilities/ansible-udmp
- Owner: unifi-utilities
- License: gpl-3.0
- Created: 2021-09-21T11:08:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-22T08:22:31.000Z (almost 2 years ago)
- Last Synced: 2024-06-11T19:09:34.107Z (7 months ago)
- Language: Shell
- Homepage:
- Size: 38.1 KB
- Stars: 44
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Ansible UDMP Role
Customize your Ubiquiti UDM (Pro) with ansible and [udm-utilities](https://github.com/boostchicken/udm-utilities).
Because the Ubiquiti UDM and Pro have not valid python installation, raw commands must be used to do all the changes.
## Sample Playbook
With this playbook:
* your custom SSL certificate is loaded to the UDM (Pro)
* [unifios-utilities](https://github.com/unifi-utilities/unifios-utilities) gets installed
* ssh keys are loaded from the Unifi Controller to the UDM (Pro)
* node exporter for prometheus scraping gets setup as container via podman
```yaml
---
- name: udmp setup
hosts: unifi-udmp-gateway
gather_facts: false
roles:
- role: mabunixda.ansible_udmp
certificate:
certificate_key:
```
## UDM Kernel Tools
On default the [UDM Kernel tools](https://github.com/fabianishere/udm-kernel-tools) get not installed. When you enable the variable ```install_kernel_tools``` the tools and the latest kernel get installed. On default also the auto boot into the custom kernel is enabled. This can be switched off by ```udm_kernel_tools_autoboot```.
At the moment it is not supported to install an older kernel. If you have already installed an older kernel, you can switch to this kernel again by setting ```udm_kernel_tools_kernel_version``` manually to a version that is available. The role verifies that this actual version exists before applying the change and booting into this previous kernel.
Please read more about the kernel switch at [UDM Kernel tools](https://github.com/fabianishere/udm-kernel-tools) before giving it a try!
```yaml
---
- name: udmp setup
hosts: unifi-udmp-gateway
gather_facts: false
roles:
- role: mabunixda.ansible_udmp
install_kernel_tools: true
```
## You can configure following services:
Except the nodeexporter all services require configuration tasks after deploying the services. This configuration tasks must be done manually or by other roles/plays.
### nodeexporter_enabled
Starts a nodeexporter instance via podman on the gateway to scrape metrics via prometheus
### frr_enabled
FRR is a service to enable BGP routing ( e.g. when running kubernetes with Metallb, or nomad with calico )
### rsyncd_enabled
This services enabled you to offload your configuration/backup by rsync via port 2202
### openvpn_enabled
Openvpn Service to connect the UDM(Pro) to a certain OpenVPN tunnel.
### zerotier_enabled
Launches a zerotier container on the UDM(Pro) and connects to a certain zerotier network
### force_external_dns
Enables iptables rules to force dns queries redirected to a certain external dns server. This server can be defined by *udmp_external_dns_server_ipv4* and/or *udmp_external_dns_server_ipv6*. But to enable this setup there must be set also on which devices this setup should be established. This is related to the bridge names on the UDM(P). The default is *br0*, the naming convention is here br ( e.g. br20 for vlan 20 ). The configuration must be defined as this sample by *udmp_external_dns_devices*:
```yaml
---
- name: udmp setup
hosts: unifi-udmp-gateway
gather_facts: false
roles:
- role: mabunixda.ansible_udmp
force_external_dns: yes
udmp_external_dns_server_ipv4: "192.168.99.100" # e.g. pihole
udmp_external_dns_devices:
- br10 # vlan 10
- br20 # vlan 20
```