Added some documentation

jjneely · Sep 9, 2015 · 0c213c9 · 0c213c9
1 parent fba7d90
commit 0c213c9
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/Dockerfile b/Dockerfile
diff --git a/docs/templates.md b/docs/templates.md
@@ -239,6 +239,16 @@ Alias for the strings.Join function.
 services: {{join $services ","}}
 ```
 
+### lookupIP
+
+Wrapper for net.LookupIP function. The wrapper also sorts (alphabeticaly) the IP addresses. This is crucial since in dynamic environments DNS servers typically shuffle the addresses linked to domain name. And that would cause unnecessary config reloads.
+
+```
+{{range lookupIP "some.host.local"}}
+    server {{.}};
+{{end}}
+```
+
 ## Example Usage
 
 ```Bash
@@ -380,4 +390,3 @@ server {
 ```
 
 Go's [`text/template`](http://golang.org/pkg/text/template/) package is very powerful. For more details on it's capabilities see its [documentation.](http://golang.org/pkg/text/template/)
-
diff --git a/src/github.com/kelseyhightower/confd/resource/template/template_funcs.go b/src/github.com/kelseyhightower/confd/resource/template/template_funcs.go
@@ -51,6 +51,7 @@ func LookupIP(data string) ([]string) {
 	if(err != nil) {
 		return nil
 	}
+	// "Cast" IPs into strings and sort the array
 	ipStrings := make([]string, len(ips))
 
 	for i, ip := range ips {