Review readme (#6399)

Add config example
This commit is contained in:
Giancarlo Rubio
2018-07-15 09:22:55 -07:00
committed by k8s-ci-robot
parent dc6ef90328
commit beed8271e3
4 changed files with 19 additions and 14 deletions
@@ -1,7 +1,7 @@
apiVersion: v1
description: Prometheus Blackbox Exporter
name: prometheus-blackbox-exporter
version: 0.1.0
version: 0.1.1
appVersion: 0.12.0
home: https://github.com/prometheus/blackbox_exporter
sources:
@@ -0,0 +1,4 @@
approvers:
- gianrubio
reviewers:
- gianrubio
@@ -2,12 +2,12 @@
Prometheus exporter for blackbox testing
Learn more: [https://github.com/prometheus/blackbox_exporter](https://github.com/prometheus/blackbox_exporter])
Learn more: [https://github.com/prometheus/blackbox_exporter](https://github.com/prometheus/blackbox_exporter)
## TL;DR;
```bash
$ helm install stable/blackbox-exporter
$ helm install stable/prometheus-blackbox-exporter
```
## Introduction
@@ -23,7 +23,7 @@ This chart creates a Blackbox-Exporter deployment on a [Kubernetes](http://kuber
To install the chart with the release name `my-release`:
```bash
$ helm install --name my-release stable/blackbox-exporter
$ helm install --name my-release stable/prometheus-blackbox-exporter
```
The command deploys Blackbox Exporter on the Kubernetes cluster using the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
@@ -72,14 +72,14 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm
```bash
$ helm install --name my-release \
--set key_1=value_1,key_2=value_2 \
stable/blackbox-exporter
stable/prometheus-blackbox-exporter
```
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
```bash
# example for staging
$ helm install --name my-release -f values.yaml stable/blackbox-exporter
$ helm install --name my-release -f values.yaml stable/prometheus-blackbox-exporter
```
> **Tip**: You can use the default [values.yaml](values.yaml)
@@ -7,14 +7,15 @@ image:
nodeSelector: {}
config: {}
# http_2xx:
# prober: http
# timeout: 5s
# http:
# valid_http_versions: ["HTTP/1.1", "HTTP/2"]
# no_follow_redirects: false
# preferred_ip_protocol: "ip4" # defaults to "ip6"
config:
modules:
http_2xx:
prober: http
timeout: 5s
http:
valid_http_versions: ["HTTP/1.1", "HTTP/2"]
no_follow_redirects: false
preferred_ip_protocol: "ip4"
resources:
# limits: