From 551cb1d63814ea34965a13c0342af94b40337145 Mon Sep 17 00:00:00 2001 From: mahendrapaipuri Date: Thu, 16 Nov 2023 12:41:42 +0100 Subject: [PATCH] docs: Update README with TLS instructions Signed-off-by: Mahendra Paipuri --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5cc29a4d..f04a268e 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,16 @@ DCGM_FI_DEV_MEMORY_TEMP{gpu="0", UUID="GPU-604ac76c-d9cf-fef3-62e9-d92044ab6e52" To integrate DCGM-Exporter with Prometheus and Grafana, see the full instructions in the [user guide](https://docs.nvidia.com/datacenter/cloud-native/gpu-telemetry/latest/). `dcgm-exporter` is deployed as part of the GPU Operator. To get started with integrating with Prometheus, check the Operator [user guide](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/getting-started.html#gpu-telemetry). +### TLS and Basic Auth + +Exporter supports TLS and basic auth using [exporter-toolkit](https://github.com/prometheus/exporter-toolkit). To use TLS and/or basic auth, users need to use `--web-config-file` CLI flag as follows + +``` +dcgm-exporter --web-config-file=web-config.yaml +``` + +A sample `web-config.yaml` file can be fetched from [exporter-toolkit repository](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-config.yml). The reference of the `web-config.yaml` file can be consulted in the [docs](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md). + ### Building from Source In order to build dcgm-exporter ensure you have the following: