kud/tests/vnfs/comp-app/collection/app2/helm/prometheus-operator/charts/prometheus-node-exporter/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# Prometheus Node Exporter

* Installs prometheus [node exporter](https://github.com/prometheus/node_exporter)

## TL;DR;

```console
$ helm install stable/prometheus-node-exporter
```

## Introduction

This chart bootstraps a prometheus [node exporter](http://github.com/prometheus/node_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.

## Installing the Chart

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

```console
$ helm install --name my-release stable/prometheus-node-exporter
```

The command deploys node exporter on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

## Uninstalling the Chart

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

```console
$ helm delete my-release
```

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

## Configuration

The following table lists the configurable parameters of the Node Exporter chart and their default values.

|             Parameter                 |                                                          Description                                                          |                 Default                          |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| `image.repository`                    | Image repository                                                                                                              | `quay.io/prometheus/node-exporter`               |
| `image.tag`                           | Image tag                                                                                                                     | `v1.0.0`                                         |
| `image.pullPolicy`                    | Image pull policy                                                                                                             | `IfNotPresent`                                   |
| `extraArgs`                           | Additional container arguments                                                                                                | `[]`                                             |
| `extraHostVolumeMounts`               | Additional host volume mounts                                                                                                 | `[]`                                             |
| `podAnnotations`                      | Annotations to be added to node exporter pods                                                                                 | `{}`                                             |
| `podLabels`                           | Additional labels to be added to pods                                                                                         | `{}`                                             |
| `rbac.create`                         | If true, create & use RBAC resources                                                                                          | `true`                                           |
| `rbac.pspEnabled`                     | Specifies whether a PodSecurityPolicy should be created.                                                                      | `true`                                           |
| `resources`                           | CPU/Memory resource requests/limits                                                                                           | `{}`                                             |
| `service.type`                        | Service type                                                                                                                  | `ClusterIP`                                      |
| `service.port`                        | The service port                                                                                                              | `9100`                                           |
| `service.targetPort`                  | The target port of the container                                                                                              | `9100`                                           |
| `service.nodePort`                    | The node port of the service                                                                                                  |                                                  |
| `service.listenOnAllInterfaces`       | If true, listen on all interfaces using IP `0.0.0.0`. Else listen on the IP address pod has been assigned by Kubernetes.      | `true`                                           |
| `service.annotations`                 | Kubernetes service annotations                                                                                                | `{prometheus.io/scrape: "true"}`                 |
| `serviceAccount.create`               | Specifies whether a service account should be created.                                                                        | `true`                                           |
| `serviceAccount.name`                 | Service account to be used. If not set and `serviceAccount.create` is `true`, a name is generated using the fullname template |                                                  |
| `serviceAccount.imagePullSecrets`     | Specify image pull secrets                                                                                                    | `[]`                                             |
| `securityContext`                     | SecurityContext                                                                                                               | See values.yaml                                  |
| `affinity`                            | A group of affinity scheduling rules for pod assignment                                                                       | `{}`                                             |
| `nodeSelector`                        | Node labels for pod assignment                                                                                                | `{}`                                             |
| `tolerations`                         | List of node taints to tolerate                                                                                               | `- effect: NoSchedule operator: Exists`          |
| `priorityClassName`                   | Name of Priority Class to assign pods                                                                                         | `nil`                                            |
| `endpoints`                           | list of addresses that have node exporter deployed outside of the cluster                                                     | `[]`                                             |
| `hostNetwork`                         | Whether to expose the service to the host network                                                                             | `true`                                           |
| `prometheus.monitor.enabled`          | Set this to `true` to create ServiceMonitor for Prometheus operator                                                           | `false`                                          |
| `prometheus.monitor.additionalLabels` | Additional labels that can be used so ServiceMonitor will be discovered by Prometheus                                         | `{}`                                             |
| `prometheus.monitor.namespace`        | namespace where servicemonitor resource should be created                                                                     | `the same namespace as prometheus node exporter` |
| `prometheus.monitor.scrapeTimeout`    | Timeout after which the scrape is ended                                                                                       | `10s`                                            |
| `configmaps`                          | Allow mounting additional configmaps.                                                                                         | `[]`                                             |
| `namespaceOverride`                   | Override the deployment namespace                                                                                             | `""` (`Release.Namespace`)                       |
| `updateStrategy`                      | Configure a custom update strategy for the daemonset                                                                          | `Rolling update with 1 max unavailable`          |
| `sidecars`               | Additional containers for export metrics to text file     | `[]`           |  |
| `sidecarVolumeMount`               | Volume for sidecar containers     | `[]`           |  |

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

```console
$ helm install --name my-release \
  --set serviceAccount.name=node-exporter  \
    stable/prometheus-node-exporter
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

```console
$ helm install --name my-release -f values.yaml stable/prometheus-node-exporter
```