github/terraform-provider-unifi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: improve provider documentation (#29)

Browse Source 
* docs: improve provider documentation

* fix accidentally changed type of stormctrl_ucast_rate

* docs: add badges and plans to readme
This commit is contained in:
Mateusz Filipowicz
2025-02-26 18:56:45 +01:00
committed by GitHub
parent e5e50f98c0
commit b1688313c0
49 changed files with 2454 additions and 900 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
internal/provider/routing/resource_port_forward.go
View File

@@ -3,6 +3,7 @@ package routing
import (
"context"
"errors"
"github.com/filipowm/terraform-provider-unifi/internal/provider/base"
"github.com/filipowm/terraform-provider-unifi/internal/utils"
@@ -14,7 +15,13 @@ import (
func ResourcePortForward() *schema.Resource {
return &schema.Resource{
Description: "`unifi_port_forward` manages a port forwarding rule on the gateway.",
Description: "The `unifi_port_forward` resource manages port forwarding rules on UniFi controllers.\n\n" +
"Port forwarding allows external traffic to reach services hosted on your internal network by mapping external ports to internal IP addresses and ports. " +
"This is commonly used for:\n" +
" * Hosting web servers, game servers, or other services\n" +
" * Remote access to internal services\n" +
" * Application-specific requirements\n\n" +
"Each rule can be configured with source IP restrictions, protocol selection, and logging options for enhanced security and monitoring.",
CreateContext: resourcePortForwardCreate,
ReadContext: resourcePortForwardRead,
@@ -26,19 +33,19 @@ func ResourcePortForward() *schema.Resource {
Schema: map[string]*schema.Schema{
"id": {
Description: "The ID of the port forwarding rule.",
Description: "The unique identifier of the port forwarding rule in the UniFi controller.",
Type: schema.TypeString,
Computed: true,
},
"site": {
Description: "The name of the site to associate the port forwarding rule with.",
Description: "The name of the UniFi site where the port forwarding rule should be created. If not specified, the default site will be used.",
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
},
"dst_port": {
Description: "The destination port for the forwarding.",
Description: "The external port(s) that will be forwarded. Can be a single port (e.g., '80') or a port range (e.g., '8080:8090').",
Type: schema.TypeString,
Optional: true,
ValidateFunc: utils.ValidatePortRange,
@@ -53,46 +60,53 @@ func ResourcePortForward() *schema.Resource {
"port forwarding rule you can remove it from your configuration.",
},
"fwd_ip": {
Description: "The IPv4 address to forward traffic to.",
Description: "The internal IPv4 address of the device or service that will receive the forwarded traffic (e.g., '192.168.1.100').",
Type: schema.TypeString,
Optional: true,
ValidateFunc: validation.IsIPv4Address,
},
"fwd_port": {
Description: "The port to forward traffic to.",
Description: "The internal port(s) that will receive the forwarded traffic. Can be a single port (e.g., '8080') or a port range (e.g., '8080:8090').",
Type: schema.TypeString,
Optional: true,
ValidateFunc: utils.ValidatePortRange,
},
"log": {
Description: "Specifies whether to log forwarded traffic or not.",
Description: "Enable logging of traffic matching this port forwarding rule. Useful for monitoring and troubleshooting.",
Type: schema.TypeBool,
Default: false,
Optional: true,
},
"name": {
Description: "The name of the port forwarding rule.",
Description: "A friendly name for the port forwarding rule to help identify its purpose (e.g., 'Web Server' or 'Game Server').",
Type: schema.TypeString,
Optional: true,
},
"port_forward_interface": {
Description: "The port forwarding interface. Can be `wan`, `wan2`, or `both`.",
Description: "The WAN interface to apply the port forwarding rule to. Valid values are:\n" +
" * `wan` - Primary WAN interface\n" +
" * `wan2` - Secondary WAN interface\n" +
" * `both` - Both WAN interfaces",
Type: schema.TypeString,
Optional: true,
ValidateFunc: validation.StringInSlice([]string{"wan", "wan2", "both"}, false),
},
"protocol": {
Description: "The protocol for the port forwarding rule. Can be `tcp`, `udp`, or `tcp_udp`.",
Description: "The network protocol(s) this rule applies to. Valid values are:\n" +
" * `tcp_udp` - Both TCP and UDP (default)\n" +
" * `tcp` - TCP only\n" +
" * `udp` - UDP only",
Type: schema.TypeString,
Optional: true,
Default: "tcp_udp",
ValidateFunc: validation.StringInSlice([]string{"tcp_udp", "tcp", "udp"}, false),
},
"src_ip": {
Description: "The source IPv4 address (or CIDR) of the port forwarding rule. For all traffic, specify `any`.",
Type: schema.TypeString,
Optional: true,
Default: "any",
Description: "The source IP address or network in CIDR notation that is allowed to use this port forward. Use 'any' to allow all source IPs. " +
"Examples: '203.0.113.1' for a single IP, '203.0.113.0/24' for a network, or 'any' for all IPs.",
Type: schema.TypeString,
Optional: true,
Default: "any",
ValidateFunc: validation.Any(
validation.StringInSlice([]string{"any"}, false),
validation.IsIPv4Address,

34
internal/provider/routing/resource_static_route.go
View File

@@ -15,7 +15,13 @@ import (
func ResourceStaticRoute() *schema.Resource {
return &schema.Resource{
Description: "`unifi_static_route` manages a static route.",
Description: "The `unifi_static_route` resource manages static routes on UniFi Security Gateways (USG) and UniFi Dream Machines (UDM/UDM-Pro).\n\n" +
"Static routes allow you to manually configure routing paths for specific networks. This is useful for:\n" +
" * Connecting to networks not directly connected to your UniFi gateway\n" +
" * Creating backup routes for redundancy\n" +
" * Implementing policy-based routing\n" +
" * Blocking traffic to specific networks using blackhole routes\n\n" +
"Routes can be configured to use either a next-hop IP address, a specific interface, or as a blackhole route.",
CreateContext: resourceStaticRouteCreate,
ReadContext: resourceStaticRouteRead,
@@ -27,52 +33,58 @@ func ResourceStaticRoute() *schema.Resource {
Schema: map[string]*schema.Schema{
"id": {
Description: "The ID of the static route.",
Description: "The unique identifier of the static route in the UniFi controller.",
Type: schema.TypeString,
Computed: true,
},
"site": {
Description: "The name of the site to associate the static route with.",
Description: "The name of the UniFi site where the static route should be created. If not specified, the default site will be used.",
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
},
"name": {
Description: "The name of the static route.",
Description: "A friendly name for the static route to help identify its purpose (e.g., 'Backup DC Link' or 'Cloud VPN Route').",
Type: schema.TypeString,
Required: true,
},
"network": {
Description: "The network subnet address.",
Description: "The destination network in CIDR notation that this route will direct traffic to (e.g., '10.0.0.0/16' or '192.168.100.0/24').",
Type: schema.TypeString,
Required: true,
ValidateFunc: utils.CidrValidate,
DiffSuppressFunc: utils.CidrDiffSuppress,
},
"type": {
Description: "The type of static route. Can be `interface-route`, `nexthop-route`, or `blackhole`.",
Description: "The type of static route. Valid values are:\n" +
" * `interface-route` - Route traffic through a specific interface\n" +
" * `nexthop-route` - Route traffic to a specific next-hop IP address\n" +
" * `blackhole` - Drop all traffic to this network",
Type: schema.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice([]string{"interface-route", "nexthop-route", "blackhole"}, false),
},
"distance": {
Description: "The distance of the static route.",
Description: "The administrative distance for this route. Lower values are preferred. Use this to control route selection when multiple routes to the same destination exist.",
Type: schema.TypeInt,
Required: true,
},
"next_hop": {
Description: "The next hop of the static route (only valid for `nexthop-route` type).",
Description: "The IP address of the next hop router for this route. Only used when type is set to 'nexthop-route'. This should be an IP address that is directly reachable from your UniFi gateway.",
Type: schema.TypeString,
Optional: true,
ValidateFunc: validation.IsIPAddress,
},
"interface": {
Description: "The interface of the static route (only valid for `interface-route` type). This can be `WAN1`, `WAN2`, or a network ID.",
Type: schema.TypeString,
Optional: true,
Description: "The outbound interface to use for this route. Only used when type is set to 'interface-route'. Can be:\n" +
" * `WAN1` - Primary WAN interface\n" +
" * `WAN2` - Secondary WAN interface\n" +
" * A network ID for internal networks",
Type: schema.TypeString,
Optional: true,
},
},
}