ansible/router
ansible/router
2
0
Fork 0
Code Issues 1 Pull requests Activity

docs: standardize readme format

Browse source
This commit is contained in:
Simon Cornet 2026-04-10 09:00:17 +02:00
commit 5e6551d87b
1 changed files with 24 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

66
readme.md
View file

@ -1,74 +1,56 @@
# Overview # Ansible Role: Router
This role configures router functionality on Alpine Linux. Configure router functionality with NAT, firewall, and routing on Alpine Linux.
## Supported Operating Systems ## Variables
| Operating System | Version | ### Network Interfaces
| --- | ----- |
| Alpine | 3.23 | | Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `wan_interface` | Yes | `eth0` | WAN network interface |
| `lan_interface` | Yes | `eth1` | LAN network interface |
### Firewall Rules
| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `incoming_firewall_rules` | No | `[]` | List of incoming firewall rules |
### NAT Configuration
| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `nat_port_forwards` | No | `[]` | List of NAT port forwarding rules |
## Tags ## Tags
| Tag | Purpose | | Tag | Description |
| --- | -------- | |-----|-------------|
| `full` | Execute all tasks | | `full` | Execute all tasks |
| `routing` | Configure routing and iptables | | `routing` | Configure routing and iptables |
| `firewall` | Configure firewall rules | | `firewall` | Configure firewall rules |
| `performance` | Configure performance tuning | | `performance` | Configure performance tuning |
## Role Variables ## Example
### Interfaces
```yaml ```yaml
wan_interface: "eth0" wan_interface: "eth0"
lan_interface: "eth1" lan_interface: "eth1"
```
### Incoming Firewall Rules
```yaml
incoming_firewall_rules: incoming_firewall_rules:
- name: "allow ssh from lan" - name: "allow ssh from lan"
source: "192.168.1.0/24" source: "192.168.1.0/24"
protocol: "tcp" protocol: "tcp"
port: 22 port: 22
- name: "allow https from lan"
source: "192.168.1.0/24"
protocol: "tcp"
port: 443
- name: "allow dns from lan" - name: "allow dns from lan"
source: "192.168.1.0/24" source: "192.168.1.0/24"
protocol: "udp" protocol: "udp"
port: 53 port: 53
- name: "allow ping from lan"
source: "192.168.1.0/24"
protocol: "icmp"
port: 0
```
### NAT Port Forwards
```yaml
nat_port_forwards: nat_port_forwards:
- name: "forward http to web server"
dst: "192.168.1.10"
port: 80
protocol: "tcp"
- name: "forward https to web server" - name: "forward https to web server"
dst: "192.168.1.10" dst: "192.168.1.10"
port: 443 port: 443
protocol: "tcp" protocol: "tcp"
- name: "forward ssh to internal server"
dst: "192.168.1.20"
port: 2222
protocol: "tcp"
``` ```