vnfs/DAaaS/collection/charts/prometheus-node-exporter/README.md

   1 # Prometheus Node Exporter
   2
   3 * Installs prometheus [node exporter](https://github.com/prometheus/node_exporter)
   4
   5 ## TL;DR;
   6
   7 ```console
   8 $ helm install stable/prometheus-node-exporter
   9 ```
  10
  11 ## Introduction
  12
  13 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.
  14
  15 ## Installing the Chart
  16
  17 To install the chart with the release name `my-release`:
  18
  19 ```console
  20 $ helm install --name my-release stable/prometheus-node-exporter
  21 ```
  22
  23 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.
  24
  25 ## Uninstalling the Chart
  26
  27 To uninstall/delete the `my-release` deployment:
  28
  29 ```console
  30 $ helm delete my-release
  31 ```
  32
  33 The command removes all the Kubernetes components associated with the chart and deletes the release.
  34
  35 ## Configuration
  36
  37 The following table lists the configurable parameters of the Node Exporter chart and their default values.
  38
  39 |             Parameter             |                                                          Description                                                          |                 Default                 |     |
  40 | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | --- |
  41 | `image.repository`                | Image repository                                                                                                              | `quay.io/prometheus/node-exporter`      |     |
  42 | `image.tag`                       | Image tag                                                                                                                     | `v0.16.0`                               |     |
  43 | `image.pullPolicy`                | Image pull policy                                                                                                             | `IfNotPresent`                          |     |
  44 | `extraArgs`                       | Additional container arguments                                                                                                | `[]`                                    |     |
  45 | `extraHostVolumeMounts`           | Additional host volume mounts                                                                                                 | {}                                      |     |
  46 | `podLabels`                       | Additional labels to be added to pods                                                                                         | {}                                      |     |
  47 | `rbac.create`                     | If true, create & use RBAC resources                                                                                          | `true`                                  |     |
  48 | `rbac.pspEnabled`                 | Specifies whether a PodSecurityPolicy should be created.                                                                      | `true`                                  |     |
  49 | `resources`                       | CPU/Memory resource requests/limits                                                                                           | `{}`                                    |     |
  50 | `service.type`                    | Service type                                                                                                                  | `ClusterIP`                             |     |
  51 | `service.port`                    | The service port                                                                                                              | `9100`                                  |     |
  52 | `service.targetPort`              | The target port of the container                                                                                              | `9100`                                  |     |
  53 | `service.nodePort`                | The node port of the service                                                                                                  |                                         |     |
  54 | `service.annotations`             | Kubernetes service annotations                                                                                                | `{prometheus.io/scrape: "true"}`        |     |
  55 | `serviceAccount.create`           | Specifies whether a service account should be created.                                                                        | `true`                                  |     |
  56 | `serviceAccount.name`             | Service account to be used. If not set and `serviceAccount.create` is `true`, a name is generated using the fullname template |                                         |     |
  57 | `serviceAccount.imagePullSecrets` | Specify image pull secrets                                                                                                    | `[]`                                    |     |
  58 | `securityContext`                 | SecurityContext                                                                                                               | `{"runAsNonRoot": true, "runAsUser": 65534}` |     |
  59 | `affinity`                        | A group of affinity scheduling rules for pod assignment                                                                       | `{}`                                    |     |
  60 | `nodeSelector`                    | Node labels for pod assignment                                                                                                | `{}`                                    |     |
  61 | `tolerations`                     | List of node taints to tolerate                                                                                               | `- effect: NoSchedule operator: Exists` |     |
  62 | `priorityClassName`               | Name of Priority Class to assign pods                                                                                         | `nil`                                   |     |
  63 | `endpoints`            | list of addresses that have node exporter deployed outside of the cluster                                                                | `[]`                                    |     |
  64 | `prometheus.monitor.enabled` | Set this to `true` to create ServiceMonitor for Prometheus operator | `false` | |
  65 | `prometheus.monitor.additionalLabels` | Additional labels that can be used so ServiceMonitor will be discovered by Prometheus | `{}` | |
  66 | `prometheus.monitor.namespace` | namespace where servicemonitor resource should be created | `the same namespace as prometheus node exporter` | |
  67
  68 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
  69
  70 ```console
  71 $ helm install --name my-release \
  72   --set serviceAccount.name=node-exporter  \
  73     stable/prometheus-node-exporter
  74 ```
  75
  76 Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
  77
  78 ```console
  79 $ helm install --name my-release -f values.yaml stable/prometheus-node-exporter
  80 ```