summaryrefslogtreecommitdiffstats
path: root/vnfs/DAaaS/deploy/collection/charts/prometheus-node-exporter/README.md
diff options
context:
space:
mode:
authorDileep Ranganathan <dileep.ranganathan@intel.com>2019-05-30 12:38:37 -0700
committerDileep Ranganathan <dileep.ranganathan@intel.com>2019-05-30 21:11:52 +0000
commit3d5a3e06530c1250d48f7d838c619f3bfbcd019d (patch)
tree349e370c43ce7318b3f7eb7736345de6872cbef2 /vnfs/DAaaS/deploy/collection/charts/prometheus-node-exporter/README.md
parent31802660dfe74a8671ae29789f0018f0f887ea1a (diff)
Refactor Distributed Analytics project structure
Modified the project structure to improve maintainability and to add future CI and integration test support. Change-Id: Id30bfb1f83f23785a6b5f99e81f42f752d59c0f8 Issue-ID: ONAPARC-280 Signed-off-by: Dileep Ranganathan <dileep.ranganathan@intel.com>
Diffstat (limited to 'vnfs/DAaaS/deploy/collection/charts/prometheus-node-exporter/README.md')
-rwxr-xr-xvnfs/DAaaS/deploy/collection/charts/prometheus-node-exporter/README.md80
1 files changed, 80 insertions, 0 deletions
diff --git a/vnfs/DAaaS/deploy/collection/charts/prometheus-node-exporter/README.md b/vnfs/DAaaS/deploy/collection/charts/prometheus-node-exporter/README.md
new file mode 100755
index 00000000..b9b50101
--- /dev/null
+++ b/vnfs/DAaaS/deploy/collection/charts/prometheus-node-exporter/README.md
@@ -0,0 +1,80 @@
+# 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 | `v0.16.0` | |
+| `image.pullPolicy` | Image pull policy | `IfNotPresent` | |
+| `extraArgs` | Additional container arguments | `[]` | |
+| `extraHostVolumeMounts` | Additional host volume mounts | {} | |
+| `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.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 | `{"runAsNonRoot": true, "runAsUser": 65534}` | |
+| `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 | `[]` | |
+| `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` | |
+
+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
+```