Skip to content

Commit

Permalink
generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Dickson committed Apr 4, 2019
1 parent 5b40b2e commit fb24c82
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 39 deletions.
12 changes: 6 additions & 6 deletions docs/components/bucket.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@ Flags:
Path to YAML file that contains object store
configuration.
--objstore.config=<bucket.config-yaml>
Alternative to 'objstore.config-file' flag. Object
Alternative to 'objstore.config-file' flag. Objec
store configuration in YAML.

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

bucket ls [<flags>]
List all blocks in the bucket
List all blocks in the bucke

bucket inspect [<flags>]
Inspect all blocks in the bucket in detailed, table-like way
Expand Down Expand Up @@ -98,7 +98,7 @@ Flags:
Path to YAML file that contains object store
configuration.
--objstore.config=<bucket.config-yaml>
Alternative to 'objstore.config-file' flag. Object
Alternative to 'objstore.config-file' flag. Objec
store configuration in YAML.
--objstore-backup.config-file=<bucket.config-yaml-path>
Path to YAML file that contains object store-backup
Expand Down Expand Up @@ -135,7 +135,7 @@ $ thanos bucket ls -o json --gcs.bucket example-bucket
```txt
usage: thanos bucket ls [<flags>]
List all blocks in the bucket
List all blocks in the bucke
Flags:
-h, --help Show context-sensitive help (also try --help-long and
Expand All @@ -155,7 +155,7 @@ Flags:
Path to YAML file that contains object store
configuration.
--objstore.config=<bucket.config-yaml>
Alternative to 'objstore.config-file' flag. Object
Alternative to 'objstore.config-file' flag. Objec
store configuration in YAML.
-o, --output="" Optional format in which to print each block's
information. Options are 'json', 'wide' or a custom
Expand Down Expand Up @@ -196,7 +196,7 @@ Flags:
Path to YAML file that contains object store
configuration.
--objstore.config=<bucket.config-yaml>
Alternative to 'objstore.config-file' flag. Object
Alternative to 'objstore.config-file' flag. Objec
store configuration in YAML.
-l, --selector=<name>="<value>" ...
Selects blocks based on label, e.g. '-l
Expand Down
20 changes: 10 additions & 10 deletions docs/components/compact.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,46 +28,46 @@ On-disk data is safe to delete between restarts and should be the first attempt
```$
usage: thanos compact [<flags>]

continuously compacts blocks in an object store bucket
continuously compacts blocks in an object store bucke

Flags:
-h, --help Show context-sensitive help (also try --help-long
and --help-man).
--version Show application version.
--log.level=info Log filtering level.
--log.format=logfmt Log format to use.
--gcloudtrace.project=GCLOUDTRACE.PROJECT
--gcloudtrace.project=GCLOUDTRACE.PROJECT
GCP project to send Google Cloud Trace tracings
to. If empty, tracing will be disabled.
--gcloudtrace.sample-factor=1
--gcloudtrace.sample-factor=1
How often we send traces (1/<sample-factor>). If
0 no trace will be sent periodically, unless
forced by baggage item. See
`pkg/tracing/tracing.go` for details.
--http-address="0.0.0.0:10902"
--http-address="0.0.0.0:10902"
Listen host:port for HTTP endpoints.
--data-dir="./data" Data directory in which to cache blocks and
process compactions.
--objstore.config-file=<bucket.config-yaml-path>
--objstore.config-file=<bucket.config-yaml-path>
Path to YAML file that contains object store
configuration.
--objstore.config=<bucket.config-yaml>
--objstore.config=<bucket.config-yaml>
Alternative to 'objstore.config-file' flag.
Object store configuration in YAML.
--sync-delay=30m Minimum age of fresh (non-compacted) blocks
before they are being processed.
--retention.resolution-raw=0d
--retention.resolution-raw=0d
How long to retain raw samples in bucket. 0d -
disables this retention
--retention.resolution-5m=0d
--retention.resolution-5m=0d
How long to retain samples of resolution 1 (5
minutes) in bucket. 0d - disables this retention
--retention.resolution-1h=0d
--retention.resolution-1h=0d
How long to retain samples of resolution 2 (1
hour) in bucket. 0d - disables this retention
-w, --wait Do not exit after all compactions have been
processed and wait for new work.
--block-sync-concurrency=20
--block-sync-concurrency=20
Number of goroutines to use when syncing block
metadata from object storage.
--compact.concurrency=1 Number of goroutines to use when compacting
Expand Down
16 changes: 8 additions & 8 deletions docs/components/query.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,8 @@ Flags:
--grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
disable TLS
--grpc-server-tls-client-ca=""
TLS CA to verify clients against. If no client
CA is specified, there is no client
TLS CA to verify clients against. If no clien
CA is specified, there is no clien
verification on server side. (tls.NoClientCert)
--grpc-advertise-address=GRPC-ADVERTISE-ADDRESS
Explicit (external) host:port address to
Expand All @@ -215,7 +215,7 @@ Flags:
--cluster.pushpull-interval=<push-pull interval>
Interval for gossip state syncs. Setting this
interval lower (more frequent) will increase
convergence speeds across larger clusters at
convergence speeds across larger clusters a
the expense of increased bandwidth usage.
Default is used from a specified network-type.
--cluster.refresh-interval=1m
Expand All @@ -237,7 +237,7 @@ Flags:
advertise for HTTP QueryAPI in gossip cluster.
If empty, 'http-address' will be used.
--grpc-client-tls-secure Use TLS when talking to the gRPC server
--grpc-client-tls-cert="" TLS Certificates to use to identify this client
--grpc-client-tls-cert="" TLS Certificates to use to identify this clien
to the server
--grpc-client-tls-key="" TLS Key for the client's certificate
--grpc-client-tls-ca="" TLS CA Certificates to use to verify gRPC
Expand All @@ -250,7 +250,7 @@ Flags:
thanos UI to be served on a sub-path. This
option is analogous to --web.route-prefix of
Promethus.
--web.external-prefix="" Static prefix for all HTML links and redirect
--web.external-prefix="" Static prefix for all HTML links and redirec
URLs in the UI query web interface. Actual
endpoints are still served on / or the
web.route-prefix. This allows thanos UI to be
Expand Down Expand Up @@ -282,18 +282,18 @@ Flags:
info endpoint (repeated).
--store=<store> ... Addresses of statically configured store API
servers (repeatable). The scheme may be
prefixed with 'dns+' or 'dnssrv+' to detect
prefixed with 'dns+' or 'dnssrv+' to detec
store API servers through respective DNS
lookups.
--store.sd-files=<path> ...
Path to files that contain addresses of store
API servers. The path can be a glob pattern
(repeatable).
--store.sd-interval=5m Refresh interval to re-read file SD files. It
--store.sd-interval=5m Refresh interval to re-read file SD files. I
is used as a resync fallback.
--store.sd-dns-interval=30s
Interval between DNS resolutions.
--query.auto-downsampling Enable automatic adjustment (step / 5) to what
--query.auto-downsampling Enable automatic adjustment (step / 5) to wha
source of data should be used in store gateways
if no max_source_resolution param is specified.
--query.partial-response Enable partial response for queries if no
Expand Down
18 changes: 9 additions & 9 deletions docs/components/rule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Full relabelling is planned to be done in future and is tracked here: https://gi
usage: thanos rule [<flags>]
ruler evaluating Prometheus rules against given Query nodes, exposing Store API
and storing old blocks in bucket
and storing old blocks in bucke
Flags:
-h, --help Show context-sensitive help (also try
Expand Down Expand Up @@ -171,8 +171,8 @@ Flags:
--grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
disable TLS
--grpc-server-tls-client-ca=""
TLS CA to verify clients against. If no client
CA is specified, there is no client
TLS CA to verify clients against. If no clien
CA is specified, there is no clien
verification on server side. (tls.NoClientCert)
--grpc-advertise-address=GRPC-ADVERTISE-ADDRESS
Explicit (external) host:port address to
Expand All @@ -197,7 +197,7 @@ Flags:
--cluster.pushpull-interval=<push-pull interval>
Interval for gossip state syncs. Setting this
interval lower (more frequent) will increase
convergence speeds across larger clusters at
convergence speeds across larger clusters a
the expense of increased bandwidth usage.
Default is used from a specified network-type.
--cluster.refresh-interval=1m
Expand Down Expand Up @@ -227,18 +227,18 @@ Flags:
--tsdb.retention=48h Block retention time on local disk.
--alertmanagers.url=ALERTMANAGERS.URL ...
Alertmanager replica URLs to push firing
alerts. Ruler claims success if push to at
alerts. Ruler claims success if push to a
least one alertmanager from discovered
succeeds. The scheme may be prefixed with
'dns+' or 'dnssrv+' to detect Alertmanager IPs
through respective DNS lookups. The port
through respective DNS lookups. The por
defaults to 9093 or the SRV record's value. The
URL path is used as a prefix for the regular
Alertmanager API path.
--alertmanagers.send-timeout=10s
Timeout for sending alerts to alertmanager
--alert.query-url=ALERT.QUERY-URL
The external Thanos Query URL that would be set
The external Thanos Query URL that would be se
in all alerts 'Source' field
--alert.label-drop=ALERT.LABEL-DROP ...
Labels by name to drop before sending to
Expand All @@ -249,7 +249,7 @@ Flags:
thanos UI to be served on a sub-path. This
option is analogous to --web.route-prefix of
Promethus.
--web.external-prefix="" Static prefix for all HTML links and redirect
--web.external-prefix="" Static prefix for all HTML links and redirec
URLs in the UI query web interface. Actual
endpoints are still served on / or the
web.route-prefix. This allows thanos UI to be
Expand All @@ -276,7 +276,7 @@ Flags:
Object store configuration in YAML.
--query=<query> ... Addresses of statically configured query API
servers (repeatable). The scheme may be
prefixed with 'dns+' or 'dnssrv+' to detect
prefixed with 'dns+' or 'dnssrv+' to detec
query API servers through respective DNS
lookups.
--query.sd-files=<path> ...
Expand Down
6 changes: 3 additions & 3 deletions docs/components/sidecar.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ Flags:
--grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
disable TLS
--grpc-server-tls-client-ca=""
TLS CA to verify clients against. If no client
CA is specified, there is no client
TLS CA to verify clients against. If no clien
CA is specified, there is no clien
verification on server side. (tls.NoClientCert)
--grpc-advertise-address=GRPC-ADVERTISE-ADDRESS
Explicit (external) host:port address to
Expand All @@ -98,7 +98,7 @@ Flags:
--cluster.pushpull-interval=<push-pull interval>
Interval for gossip state syncs. Setting this
interval lower (more frequent) will increase
convergence speeds across larger clusters at
convergence speeds across larger clusters a
the expense of increased bandwidth usage.
Default is used from a specified network-type.
--cluster.refresh-interval=1m
Expand Down
6 changes: 3 additions & 3 deletions docs/components/store.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Flags:
--grpc-server-tls-key="" TLS Key for the gRPC server, leave blank to
disable TLS
--grpc-server-tls-client-ca=""
TLS CA to verify clients against. If no client
CA is specified, there is no client
TLS CA to verify clients against. If no clien
CA is specified, there is no clien
verification on server side. (tls.NoClientCert)
--grpc-advertise-address=GRPC-ADVERTISE-ADDRESS
Explicit (external) host:port address to
Expand All @@ -83,7 +83,7 @@ Flags:
--cluster.pushpull-interval=<push-pull interval>
Interval for gossip state syncs. Setting this
interval lower (more frequent) will increase
convergence speeds across larger clusters at
convergence speeds across larger clusters a
the expense of increased bandwidth usage.
Default is used from a specified network-type.
--cluster.refresh-interval=1m
Expand Down

0 comments on commit fb24c82

Please sign in to comment.