Merge pull request #64 from seeker89/bump-major-version

Add info on how to use the DNS features

Makefile

@@ -1,5 +1,5 @@
 name ?= goldpinger
-version ?= 1.5.1
+version ?= 2.0.0
 bin ?= goldpinger
 pkg ?= "github.com/bloomberg/goldpinger"
 tag = $(name):$(version)

README.md

@@ -18,6 +18,7 @@ Oh, and it gives you the graph below for your cluster. Check out the [video expl
 - [Installation](#installation)
   - [Authentication with Kubernetes API](#authentication-with-kubernetes-api)
   - [Example YAML](#example-yaml)
+  - [Note on DNS](#note-on-dns)
 - [Usage](#usage)
   - [UI](#ui)
   - [API](#api)
@@ -203,6 +204,28 @@ subjects:
 
 You can also see [an example of using `kubeconfig` in the `./extras`](./extras/example-with-kubeconfig.yaml).
 
+### Note on DNS
+
+Note, that on top of resolving the other pods, all instances can also try to resolve arbitrary DNS. This allows you to test your DNS setup.
+
+From `--help`:
+
+```sh
+--host-to-resolve=      A host to attempt dns resolve on (space delimited) [$HOSTS_TO_RESOLVE]
+```
+
+So in order to test two domains, we could add an extra env var to the example above:
+
+```yaml
+            - name: HOSTS_TO_RESOLVE
+              value: "www.bloomberg.com one.two.three"
+```
+
+and `goldpinger` should show something like this:
+
+![screenshot-DNS-resolution](./extras/dns-screenshot.png)
+
+
 ## Usage
 
 ### UI

pkg/goldpinger/config.go

@@ -32,5 +32,5 @@ var GoldpingerConfig = struct {
 	KubernetesClient *kubernetes.Clientset
 	*PodSelecter
 
-	DnsHosts         []string `long:"host-to-resolve" description:"A host to attempt dns resolve on" env:"HOSTS_TO_RESOLVE" env-delim:" "`
+	DnsHosts         []string `long:"host-to-resolve" description:"A host to attempt dns resolve on (space delimited)" env:"HOSTS_TO_RESOLVE" env-delim:" "`
 }{}