Skip to content

Commit

Permalink
Document replicate
Browse files Browse the repository at this point in the history
Signed-off-by: Xiang Dai <764524258@qq.com>
  • Loading branch information
daixiang0 committed Feb 10, 2020
1 parent cfc427b commit 70c46b0
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 1 deletion.
70 changes: 70 additions & 0 deletions docs/components/bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ Subcommands:
bucket web [<flags>]
Web interface for remote storage bucket
bucket replicate [<flags>]
Replicate data from one object storage to another
```

Expand Down Expand Up @@ -315,3 +318,70 @@ Flags:
--timeout=5m Timeout to download metadata from remote storage
```

### replicate

`bucket replicate` is used to replicate buckets from one object storage to another.

Example:
```
$ thanos bucket replicate --objstore.config-file="..." --objstore-to.config="..."
```

[embedmd]:# (flags/bucket_replicate.txt)
```txt
usage: thanos bucket replicate [<flags>]
Replicate data from one object storage to another
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. Possible options: logfmt or
json.
--tracing.config-file=<file-path>
Path to YAML file with tracing configuration.
See format details:
https://thanos.io/tracing.md/#configuration
--tracing.config=<content>
Alternative to 'tracing.config-file' flag
(lower priority). Content of YAML file with
tracing configuration. See format details:
https://thanos.io/tracing.md/#configuration
--objstore.config-file=<file-path>
Path to YAML file that contains object store
configuration. See format details:
https://thanos.io/storage.md/#configuration
--objstore.config=<content>
Alternative to 'objstore.config-file' flag
(lower priority). Content of YAML file that
contains object store configuration. See format
details:
https://thanos.io/storage.md/#configuration
--http-address="0.0.0.0:10902"
Listen host:port for HTTP endpoints.
--http-grace-period=2m Time to wait after an interrupt received for
HTTP Server.
--objstore-to.config-file=<file-path>
Path to YAML file that contains object store-to
configuration. See format details:
https://thanos.io/storage.md/#configuration The
object storage which replicate data to.
--objstore-to.config=<content>
Alternative to 'objstore-to.config-file' flag
(lower priority). Content of YAML file that
contains object store-to configuration. See
format details:
https://thanos.io/storage.md/#configuration The
object storage which replicate data to.
--resolution=0 Only blocks with this resolution will be
replicated.
--compaction=1 Only blocks with this compaction level will be
replicated.
--matcher=key="value" ... Only blocks whose labels match this matcher
will be replicated.
--single-run Run replication only one time, then exit.
```
2 changes: 1 addition & 1 deletion scripts/genflagdocs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ for x in "${commands[@]}"; do
./thanos "${x}" --help &> "docs/components/flags/${x}.txt"
done

bucketCommands=("verify" "ls" "inspect" "web")
bucketCommands=("verify" "ls" "inspect" "web" "replicate")
for x in "${bucketCommands[@]}"; do
./thanos bucket "${x}" --help &> "docs/components/flags/bucket_${x}.txt"
done
Expand Down

0 comments on commit 70c46b0

Please sign in to comment.