github.com/verrazzano/verrazzano@v1.7.0/platform-operator/thirdparty/charts/prometheus-community/prometheus-node-exporter/README.md (about)

     1  # Prometheus `Node Exporter`
     2  
     3  Prometheus exporter for hardware and OS metrics exposed by *NIX kernels, written in Go with pluggable metric collectors.
     4  
     5  This chart bootstraps a prometheus [`Node Exporter`](http://github.com/prometheus/node_exporter) daemonset on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
     6  
     7  ## Get Repository Info
     8  
     9  ```console
    10  helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
    11  helm repo update
    12  ```
    13  
    14  _See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._
    15  
    16  ## Install Chart
    17  
    18  ```console
    19  helm install [RELEASE_NAME] prometheus-community/prometheus-node-exporter
    20  ```
    21  
    22  _See [configuration](#configuring) below._
    23  
    24  _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
    25  
    26  ## Uninstall Chart
    27  
    28  ```console
    29  helm uninstall [RELEASE_NAME]
    30  ```
    31  
    32  This removes all the Kubernetes components associated with the chart and deletes the release.
    33  
    34  _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
    35  
    36  ## Upgrading Chart
    37  
    38  ```console
    39  helm upgrade [RELEASE_NAME] [CHART] --install
    40  ```
    41  
    42  _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._
    43  
    44  ### 4.16 to 4.17+
    45  
    46  `containerSecurityContext.readOnlyRootFilesystem` is set to `true` by default.
    47  
    48  ### 3.x to 4.x
    49  
    50  Starting from version 4.0.0, the `node exporter` chart is using the [Kubernetes recommended labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/). Therefore you have to delete the daemonset before you upgrade.
    51  
    52  ```console
    53  kubectl delete daemonset -l app=prometheus-node-exporter
    54  helm upgrade -i prometheus-node-exporter prometheus-community/prometheus-node-exporter
    55  ```
    56  
    57  If you use your own custom [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitor) or [PodMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#podmonitor), please ensure to upgrade their `selector` fields accordingly to the new labels.
    58  
    59  ### From 2.x to 3.x
    60  
    61  Change the following:
    62  
    63  ```yaml
    64  hostRootFsMount: true
    65  ```
    66  
    67  to:
    68  
    69  ```yaml
    70  hostRootFsMount:
    71    enabled: true
    72    mountPropagation: HostToContainer
    73  ```
    74  
    75  ## Configuring
    76  
    77  See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands:
    78  
    79  ```console
    80  helm show values prometheus-community/prometheus-node-exporter
    81  ```
    82  
    83  ### kube-rbac-proxy
    84  
    85  You can enable `prometheus-node-exporter` endpoint protection using `kube-rbac-proxy`. By setting `kubeRBACProxy.enabled: true`, this chart will deploy a RBAC proxy container protecting the node-exporter endpoint.
    86  To authorize access, authenticate your requests (via a `ServiceAccount` for example) with a `ClusterRole` attached such as:
    87  
    88  ```yaml
    89  apiVersion: rbac.authorization.k8s.io/v1
    90  kind: ClusterRole
    91  metadata:
    92    name: prometheus-node-exporter-read
    93  rules:
    94    - apiGroups: [ "" ]
    95      resources: ["services/node-exporter-prometheus-node-exporter"]
    96      verbs:
    97        - get
    98  ```
    99  
   100  See [kube-rbac-proxy examples](https://github.com/brancz/kube-rbac-proxy/tree/master/examples/resource-attributes) for more details.