Skip to content

Commit

Permalink
Add readme for node-dns-exporter (#127)
Browse files Browse the repository at this point in the history
  • Loading branch information
StianHaugland1 committed Aug 17, 2021
1 parent 6679df1 commit 3d345c9
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions node-dns-exporter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Node-DNS-Exporter

[Node-dns-exporter](https://github.com/evry-ace/node-dns-exporter) is a prometheus exporter for node level DNS metrics. This is intended to run as a DaemonSet in your Kubernetes cluster to report DNS client metrics from each node.

## TL;DR

```console
helm repo add evry-ace https://evry-ace.github.io/helm-charts/
helm install my-release evry-ace/node-dns-exporter --set nodeDns.testHosts='vg.no\,bt.no'
```

## Installing the Chart

To install the chart with the release name `my-release`:

```bash
Add testHosts to the valuefile
$ helm repo add evry-ace https://evry-ace.github.io/helm-charts/
$ helm install my-release evry-ace/node-dns-exporter -f path/to/values.yaml
```

These commands deploy a node-dns-exporter deamonset in the Kubernetes cluster with the default configuration.

> **Tip**: List all releases using `helm list`
## Uninstalling the Chart

To uninstall/delete the `my-release` deployment:

```bash
$ helm delete my-release
```

The command removes all the Kubernetes components associated with the chart and deletes the release.


### nodeDns parameters (see values for examples)

| Name | Description | Value |
| ------------------------- | ----------------------------------------------------------- | ---------------------------- |
| `nodeDns.testHosts` | A string with targets to resolve, splitted by commas | `""` |
| `nodeDns.requiredSearcdomains` | A string with searchdomains, splitted by commas | `""` |
| `nodeDns.testInterval` | Frequency to resolve test host | `120` |

0 comments on commit 3d345c9

Please sign in to comment.