Fix types in k8s+dns docs (#7474)

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
This commit is contained in:
Julien Pivotto 2020-06-28 09:13:23 +02:00 committed by GitHub
parent f0a439bfc5
commit 800c0aefcf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -592,10 +592,10 @@ record name that produced the discovered target.
```yaml ```yaml
# A list of DNS domain names to be queried. # A list of DNS domain names to be queried.
names: names:
[ - <domain_name> ] [ - <string> ]
# The type of DNS query to perform. # The type of DNS query to perform. One of SRV, A, or AAAA.
[ type: <query_type> | default = 'SRV' ] [ type: <string> | default = 'SRV' ]
# The port number used if the query type is not SRV. # The port number used if the query type is not SRV.
[ port: <number>] [ port: <number>]
@ -604,9 +604,6 @@ names:
[ refresh_interval: <duration> | default = 30s ] [ refresh_interval: <duration> | default = 30s ]
``` ```
Where `<domain_name>` is a valid DNS domain name.
Where `<query_type>` is `SRV`, `A`, or `AAAA`.
### `<ec2_sd_config>` ### `<ec2_sd_config>`
EC2 SD configurations allow retrieving scrape targets from AWS EC2 EC2 SD configurations allow retrieving scrape targets from AWS EC2
@ -1018,7 +1015,8 @@ See below for the configuration options for Kubernetes discovery:
[ api_server: <host> ] [ api_server: <host> ]
# The Kubernetes role of entities that should be discovered. # The Kubernetes role of entities that should be discovered.
role: <role> # One of endpoints, service, pod, node, or ingress.
role: <string>
# Optional authentication information used to authenticate to the API server. # Optional authentication information used to authenticate to the API server.
# Note that `basic_auth`, `bearer_token` and `bearer_token_file` options are # Note that `basic_auth`, `bearer_token` and `bearer_token_file` options are
@ -1062,14 +1060,11 @@ namespaces:
# if you just want to monitor small subset of pods in large cluster it's recommended to use selectors. # if you just want to monitor small subset of pods in large cluster it's recommended to use selectors.
# Decision, if selectors should be used or not depends on the particular situation. # Decision, if selectors should be used or not depends on the particular situation.
[ selectors: [ selectors:
[ - role: <role> [ - role: <string>
[ label: <string> ] [ label: <string> ]
[ field: <string> ] ]] [ field: <string> ] ]]
``` ```
Where `<role>` must be `endpoints`, `service`, `pod`, `node`, or
`ingress`.
See [this example Prometheus configuration file](/documentation/examples/prometheus-kubernetes.yml) See [this example Prometheus configuration file](/documentation/examples/prometheus-kubernetes.yml)
for a detailed example of configuring Prometheus for Kubernetes. for a detailed example of configuring Prometheus for Kubernetes.