-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathprometheus-puppetdb-sd.1
88 lines (87 loc) · 3.11 KB
/
prometheus-puppetdb-sd.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.TH prometheus-puppetdb-sd 1 "15 January 2025"
.SH NAME
prometheus-puppetdb-sd \- PuppetDB based service discovery for Prometheus
.SH SYNOPSIS
\fBprometheus-puppetdb-sd\fP [OPTIONS]
.SH DESCRIPTION
.SH OPTIONS
.SS Application Options
.TP
\fB\fB\-V\fR, \fB\-\-version\fR\fP
Display version.
.TP
\fB\fB\-m\fR, \fB\-\-manpage\fR\fP
Output manpage.
.TP
\fB\fB\-s\fR, \fB\-\-sleep\fR <default: \fI"5s"\fR>\fP
Sleep time between queries.
.SS PuppetDB Client Options
.TP
\fB\fB\-u\fR, \fB\-\-puppetdb.url\fR <default: \fI"http://puppetdb:8080"\fR>\fP
PuppetDB base URL.
.TP
\fB\fB\-x\fR, \fB\-\-puppetdb.cert-file\fR <default: \fI$PUPPETDB_CERT_FILE\fR>\fP
A PEM encoded certificate file.
.TP
\fB\fB\-y\fR, \fB\-\-puppetdb.key-file\fR <default: \fI$PUPPETDB_KEY_FILE\fR>\fP
A PEM encoded private key file.
.TP
\fB\fB\-z\fR, \fB\-\-puppetdb.cacert-file\fR <default: \fI$PUPPETDB_CACERT_FILE\fR>\fP
A PEM encoded CA's certificate file.
.TP
\fB\fB\-k\fR, \fB\-\-puppetdb.ssl-skip-verify\fR <default: \fI$PUPPETDB_SSL_SKIP_VERIFY\fR>\fP
Skip SSL verification.
.TP
\fB\fB\-q\fR, \fB\-\-puppetdb.query\fR <default: \fI"resources[certname, parameters] { type = 'Prometheus::Scrape_job' and exported = true }"\fR>\fP
PuppetDB query.
.SS Prometheus Service Discovery Options
.TP
\fB\fB\-\-prometheus.proxy-url\fR <default: \fI$PROMETHEUS_PROXY_URL\fR>\fP
Prometheus target scraping proxy URL.
.SS Output Configuration
.TP
\fB\fB\-o\fR, \fB\-\-output.method\fR <default: \fI"stdout"\fR>\fP
Output method.
.TP
\fB\fB\-\-output.format\fR <default: \fI"scrape-configs"\fR>\fP
Output format (irrelevant for HTTP output).
.SS File Output Configuration
.TP
\fB\fB\-f\fR, \fB\-\-output.file.filename\fR <default: \fI"puppetdb-sd.yml"\fR>\fP
Output filename.
.TP
\fB\fB\-\-output.file.filename-pattern\fR <default: \fI"*.yml"\fR>\fP
Output filename pattern ('*' is the placeholder).
.TP
\fB\fB\-\-output.file.directory\fR <default: \fI"/etc/prometheus/puppetdb-sd"\fR>\fP
Output directory.
.SS HTTP Output Configuration
.TP
\fB\fB\-\-output.http.port\fR <default: \fI"8080"\fR>\fP
HTTP server port.
.SS Kubernetes Secret Output Configuration
.TP
\fB\fB\-\-output.k8s-secret.secret-name\fR <default: \fI$OUTPUT_K8S_SECRET_NAME\fR>\fP
Kubernetes secret name.
.TP
\fB\fB\-\-output.k8s-secret.namespace\fR <default: \fI$OUTPUT_K8S_NAMESPACE\fR>\fP
Kubernetes namespace.
.TP
\fB\fB\-\-output.k8s-secret.object-labels\fR <default: \fI"app.kubernetes.io/name:prometheus-puppetdb-sd"\fR>\fP
Labels to add to Kubernetes objects.
.TP
\fB\fB\-\-output.k8s-secret.secret-key\fR <default: \fI$OUTPUT_K8S_SECRET_KEY\fR>\fP
Kubernetes secret key.
.TP
\fB\fB\-\-output.k8s-secret.secret-key-pattern\fR <default: \fI$OUTPUT_K8S_SECRET_KEY_PATTERN\fR>\fP
Kubernetes secret key pattern ('*' is the placeholder).
.TP
\fB\fB\-\-output.k8s-secret.extra-config-secret-name\fR <default: \fI$OUTPUT_K8S_EXTRA_CONFIG_SECRET_NAME\fR>\fP
Kubernetes secret name containing additional config.
.TP
\fB\fB\-\-output.k8s-secret.extra-config-secret-key\fR <default: \fI$OUTPUT_K8S_EXTRA_CONFIG_SECRET_KEY\fR>\fP
Key of the Kubernetes secret containing additional config.
.SS Help Options
.TP
\fB\fB\-h\fR, \fB\-\-help\fR\fP
Show this help message