Skip to content

Commit fb24c82

Browse files
author
Martin Dickson
committed
generate docs
1 parent 5b40b2e commit fb24c82

File tree

6 files changed

+39
-39
lines changed

6 files changed

+39
-39
lines changed

‎docs/components/bucket.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,15 @@ Flags:
4848
Path to YAML file that contains object store
4949
configuration.
5050
--objstore.config=<bucket.config-yaml>
51-
Alternative to 'objstore.config-file' flag. Object
51+
Alternative to 'objstore.config-file' flag. Objec
5252
store configuration in YAML.
5353

5454
Subcommands:
5555
bucket verify [<flags>]
5656
Verify all blocks in the bucket against specified issues
5757

5858
bucket ls [<flags>]
59-
List all blocks in the bucket
59+
List all blocks in the bucke
6060

6161
bucket inspect [<flags>]
6262
Inspect all blocks in the bucket in detailed, table-like way
@@ -98,7 +98,7 @@ Flags:
9898
Path to YAML file that contains object store
9999
configuration.
100100
--objstore.config=<bucket.config-yaml>
101-
Alternative to 'objstore.config-file' flag. Object
101+
Alternative to 'objstore.config-file' flag. Objec
102102
store configuration in YAML.
103103
--objstore-backup.config-file=<bucket.config-yaml-path>
104104
Path to YAML file that contains object store-backup
@@ -135,7 +135,7 @@ $ thanos bucket ls -o json --gcs.bucket example-bucket
135135
```txt
136136
usage: thanos bucket ls [<flags>]
137137
138-
List all blocks in the bucket
138+
List all blocks in the bucke
139139
140140
Flags:
141141
-h, --help Show context-sensitive help (also try --help-long and
@@ -155,7 +155,7 @@ Flags:
155155
Path to YAML file that contains object store
156156
configuration.
157157
--objstore.config=<bucket.config-yaml>
158-
Alternative to 'objstore.config-file' flag. Object
158+
Alternative to 'objstore.config-file' flag. Objec
159159
store configuration in YAML.
160160
-o, --output="" Optional format in which to print each block's
161161
information. Options are 'json', 'wide' or a custom
@@ -196,7 +196,7 @@ Flags:
196196
Path to YAML file that contains object store
197197
configuration.
198198
--objstore.config=<bucket.config-yaml>
199-
Alternative to 'objstore.config-file' flag. Object
199+
Alternative to 'objstore.config-file' flag. Objec
200200
store configuration in YAML.
201201
-l, --selector=<name>="<value>" ...
202202
Selects blocks based on label, e.g. '-l

‎docs/components/compact.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,46 +28,46 @@ On-disk data is safe to delete between restarts and should be the first attempt
2828
```$
2929
usage: thanos compact [<flags>]
3030

31-
continuously compacts blocks in an object store bucket
31+
continuously compacts blocks in an object store bucke
3232

3333
Flags:
3434
-h, --help Show context-sensitive help (also try --help-long
3535
and --help-man).
3636
--version Show application version.
3737
--log.level=info Log filtering level.
3838
--log.format=logfmt Log format to use.
39-
--gcloudtrace.project=GCLOUDTRACE.PROJECT
39+
--gcloudtrace.project=GCLOUDTRACE.PROJECT
4040
GCP project to send Google Cloud Trace tracings
4141
to. If empty, tracing will be disabled.
42-
--gcloudtrace.sample-factor=1
42+
--gcloudtrace.sample-factor=1
4343
How often we send traces (1/<sample-factor>). If
4444
0 no trace will be sent periodically, unless
4545
forced by baggage item. See
4646
`pkg/tracing/tracing.go` for details.
47-
--http-address="0.0.0.0:10902"
47+
--http-address="0.0.0.0:10902"
4848
Listen host:port for HTTP endpoints.
4949
--data-dir="./data" Data directory in which to cache blocks and
5050
process compactions.
51-
--objstore.config-file=<bucket.config-yaml-path>
51+
--objstore.config-file=<bucket.config-yaml-path>
5252
Path to YAML file that contains object store
5353
configuration.
54-
--objstore.config=<bucket.config-yaml>
54+
--objstore.config=<bucket.config-yaml>
5555
Alternative to 'objstore.config-file' flag.
5656
Object store configuration in YAML.
5757
--sync-delay=30m Minimum age of fresh (non-compacted) blocks
5858
before they are being processed.
59-
--retention.resolution-raw=0d
59+
--retention.resolution-raw=0d
6060
How long to retain raw samples in bucket. 0d -
6161
disables this retention
62-
--retention.resolution-5m=0d
62+
--retention.resolution-5m=0d
6363
How long to retain samples of resolution 1 (5
6464
minutes) in bucket. 0d - disables this retention
65-
--retention.resolution-1h=0d
65+
--retention.resolution-1h=0d
6666
How long to retain samples of resolution 2 (1
6767
hour) in bucket. 0d - disables this retention
6868
-w, --wait Do not exit after all compactions have been
6969
processed and wait for new work.
70-
--block-sync-concurrency=20
70+
--block-sync-concurrency=20
7171
Number of goroutines to use when syncing block
7272
metadata from object storage.
7373
--compact.concurrency=1 Number of goroutines to use when compacting

‎docs/components/query.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,8 @@ Flags:
189189
--grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
190190
disable TLS
191191
--grpc-server-tls-client-ca=""
192-
TLS CA to verify clients against. If no client
193-
CA is specified, there is no client
192+
TLS CA to verify clients against. If no clien
193+
CA is specified, there is no clien
194194
verification on server side. (tls.NoClientCert)
195195
--grpc-advertise-address=GRPC-ADVERTISE-ADDRESS
196196
Explicit (external) host:port address to
@@ -215,7 +215,7 @@ Flags:
215215
--cluster.pushpull-interval=<push-pull interval>
216216
Interval for gossip state syncs. Setting this
217217
interval lower (more frequent) will increase
218-
convergence speeds across larger clusters at
218+
convergence speeds across larger clusters a
219219
the expense of increased bandwidth usage.
220220
Default is used from a specified network-type.
221221
--cluster.refresh-interval=1m
@@ -237,7 +237,7 @@ Flags:
237237
advertise for HTTP QueryAPI in gossip cluster.
238238
If empty, 'http-address' will be used.
239239
--grpc-client-tls-secure Use TLS when talking to the gRPC server
240-
--grpc-client-tls-cert="" TLS Certificates to use to identify this client
240+
--grpc-client-tls-cert="" TLS Certificates to use to identify this clien
241241
to the server
242242
--grpc-client-tls-key="" TLS Key for the client's certificate
243243
--grpc-client-tls-ca="" TLS CA Certificates to use to verify gRPC
@@ -250,7 +250,7 @@ Flags:
250250
thanos UI to be served on a sub-path. This
251251
option is analogous to --web.route-prefix of
252252
Promethus.
253-
--web.external-prefix="" Static prefix for all HTML links and redirect
253+
--web.external-prefix="" Static prefix for all HTML links and redirec
254254
URLs in the UI query web interface. Actual
255255
endpoints are still served on / or the
256256
web.route-prefix. This allows thanos UI to be
@@ -282,18 +282,18 @@ Flags:
282282
info endpoint (repeated).
283283
--store=<store> ... Addresses of statically configured store API
284284
servers (repeatable). The scheme may be
285-
prefixed with 'dns+' or 'dnssrv+' to detect
285+
prefixed with 'dns+' or 'dnssrv+' to detec
286286
store API servers through respective DNS
287287
lookups.
288288
--store.sd-files=<path> ...
289289
Path to files that contain addresses of store
290290
API servers. The path can be a glob pattern
291291
(repeatable).
292-
--store.sd-interval=5m Refresh interval to re-read file SD files. It
292+
--store.sd-interval=5m Refresh interval to re-read file SD files. I
293293
is used as a resync fallback.
294294
--store.sd-dns-interval=30s
295295
Interval between DNS resolutions.
296-
--query.auto-downsampling Enable automatic adjustment (step / 5) to what
296+
--query.auto-downsampling Enable automatic adjustment (step / 5) to wha
297297
source of data should be used in store gateways
298298
if no max_source_resolution param is specified.
299299
--query.partial-response Enable partial response for queries if no

‎docs/components/rule.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Full relabelling is planned to be done in future and is tracked here: https://gi
142142
usage: thanos rule [<flags>]
143143
144144
ruler evaluating Prometheus rules against given Query nodes, exposing Store API
145-
and storing old blocks in bucket
145+
and storing old blocks in bucke
146146
147147
Flags:
148148
-h, --help Show context-sensitive help (also try
@@ -171,8 +171,8 @@ Flags:
171171
--grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
172172
disable TLS
173173
--grpc-server-tls-client-ca=""
174-
TLS CA to verify clients against. If no client
175-
CA is specified, there is no client
174+
TLS CA to verify clients against. If no clien
175+
CA is specified, there is no clien
176176
verification on server side. (tls.NoClientCert)
177177
--grpc-advertise-address=GRPC-ADVERTISE-ADDRESS
178178
Explicit (external) host:port address to
@@ -197,7 +197,7 @@ Flags:
197197
--cluster.pushpull-interval=<push-pull interval>
198198
Interval for gossip state syncs. Setting this
199199
interval lower (more frequent) will increase
200-
convergence speeds across larger clusters at
200+
convergence speeds across larger clusters a
201201
the expense of increased bandwidth usage.
202202
Default is used from a specified network-type.
203203
--cluster.refresh-interval=1m
@@ -227,18 +227,18 @@ Flags:
227227
--tsdb.retention=48h Block retention time on local disk.
228228
--alertmanagers.url=ALERTMANAGERS.URL ...
229229
Alertmanager replica URLs to push firing
230-
alerts. Ruler claims success if push to at
230+
alerts. Ruler claims success if push to a
231231
least one alertmanager from discovered
232232
succeeds. The scheme may be prefixed with
233233
'dns+' or 'dnssrv+' to detect Alertmanager IPs
234-
through respective DNS lookups. The port
234+
through respective DNS lookups. The por
235235
defaults to 9093 or the SRV record's value. The
236236
URL path is used as a prefix for the regular
237237
Alertmanager API path.
238238
--alertmanagers.send-timeout=10s
239239
Timeout for sending alerts to alertmanager
240240
--alert.query-url=ALERT.QUERY-URL
241-
The external Thanos Query URL that would be set
241+
The external Thanos Query URL that would be se
242242
in all alerts 'Source' field
243243
--alert.label-drop=ALERT.LABEL-DROP ...
244244
Labels by name to drop before sending to
@@ -249,7 +249,7 @@ Flags:
249249
thanos UI to be served on a sub-path. This
250250
option is analogous to --web.route-prefix of
251251
Promethus.
252-
--web.external-prefix="" Static prefix for all HTML links and redirect
252+
--web.external-prefix="" Static prefix for all HTML links and redirec
253253
URLs in the UI query web interface. Actual
254254
endpoints are still served on / or the
255255
web.route-prefix. This allows thanos UI to be
@@ -276,7 +276,7 @@ Flags:
276276
Object store configuration in YAML.
277277
--query=<query> ... Addresses of statically configured query API
278278
servers (repeatable). The scheme may be
279-
prefixed with 'dns+' or 'dnssrv+' to detect
279+
prefixed with 'dns+' or 'dnssrv+' to detec
280280
query API servers through respective DNS
281281
lookups.
282282
--query.sd-files=<path> ...

‎docs/components/sidecar.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ Flags:
7272
--grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
7373
disable TLS
7474
--grpc-server-tls-client-ca=""
75-
TLS CA to verify clients against. If no client
76-
CA is specified, there is no client
75+
TLS CA to verify clients against. If no clien
76+
CA is specified, there is no clien
7777
verification on server side. (tls.NoClientCert)
7878
--grpc-advertise-address=GRPC-ADVERTISE-ADDRESS
7979
Explicit (external) host:port address to
@@ -98,7 +98,7 @@ Flags:
9898
--cluster.pushpull-interval=<push-pull interval>
9999
Interval for gossip state syncs. Setting this
100100
interval lower (more frequent) will increase
101-
convergence speeds across larger clusters at
101+
convergence speeds across larger clusters a
102102
the expense of increased bandwidth usage.
103103
Default is used from a specified network-type.
104104
--cluster.refresh-interval=1m

‎docs/components/store.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ Flags:
5757
--grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
5858
disable TLS
5959
--grpc-server-tls-client-ca=""
60-
TLS CA to verify clients against. If no client
61-
CA is specified, there is no client
60+
TLS CA to verify clients against. If no clien
61+
CA is specified, there is no clien
6262
verification on server side. (tls.NoClientCert)
6363
--grpc-advertise-address=GRPC-ADVERTISE-ADDRESS
6464
Explicit (external) host:port address to
@@ -83,7 +83,7 @@ Flags:
8383
--cluster.pushpull-interval=<push-pull interval>
8484
Interval for gossip state syncs. Setting this
8585
interval lower (more frequent) will increase
86-
convergence speeds across larger clusters at
86+
convergence speeds across larger clusters a
8787
the expense of increased bandwidth usage.
8888
Default is used from a specified network-type.
8989
--cluster.refresh-interval=1m

0 commit comments

Comments
 (0)