Skip to content

Commit

Permalink
Update example for bucket
Browse files Browse the repository at this point in the history
Signed-off-by: jojohappy <[email protected]>
  • Loading branch information
jojohappy committed Sep 8, 2018
1 parent a0f3acb commit 7d5dffa
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 8 deletions.
4 changes: 3 additions & 1 deletion docs/components/bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ It is normally run as a stand alone command to aid with troubleshooting.
Example:

```
$ thanos bucket verify --gcs.bucket example-bucket
$ thanos bucket verify --objstore.config="type: GCS
config:
bucket: example-bucket"
```

Bucket can be extended to add more subcommands that will be helpful when working with object storage buckets
Expand Down
4 changes: 3 additions & 1 deletion docs/components/compact.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ It is generally not semantically concurrency safe and must be deployed as a sing
Example:

```
$ thanos compact --gcs.bucket example-bucket --data-dir /tmp/thanos-compact
$ thanos compact --data-dir /tmp/thanos-compact --objstore.config="type: GCS
config:
bucket: example-bucket"
```

The compactor needs local disk space to store intermediate data for its processing. Generally, about 100GB are recommended for it to keep working as the compacted time ranges grow over time.
Expand Down
8 changes: 5 additions & 3 deletions docs/components/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ $ thanos rule \
--eval-interval "30s" \
--rule-file "/path/to/rules/*.rules.yaml" \
--alert.query-url "http://0.0.0.0:9090" \
--alertmanagers.url "alert.thanos.io"
--gcs.bucket "example-bucket" \
--cluster.peers "thanos-cluster.example.org"
--alertmanagers.url "alert.thanos.io" \
--cluster.peers "thanos-cluster.example.org" \
--objstore.config="type: GCS
config:
bucket: example-bucket"
```

As rule nodes outsource query processing to query nodes, they should generally experience little load. If necessary, functional sharding can be applied by splitting up the sets of rules between HA pairs.
Expand Down
4 changes: 3 additions & 1 deletion docs/components/sidecar.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ The retention is recommended to not be lower than three times the block duration
$ thanos sidecar \
--tsdb.path "/path/to/prometheus/data/dir" \
--prometheus.url "http://localhost:9090" \
--gcs.bucket "example-bucket" \
--cluster.peers "thanos-cluster.example.org" \
--objstore.config="type: GCS
config:
bucket: example-bucket"
```

## Deployment
Expand Down
6 changes: 4 additions & 2 deletions docs/components/store.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ It keeps a small amount of information about all remote blocks on local disk and
```
$ thanos store \
--tsdb.path "/local/state/data/dir" \
--gcs.bucket "example-bucket" \
--cluster.peers "thanos-cluster.example.org"
--cluster.peers "thanos-cluster.example.org" \
--objstore.config="type: GCS
config:
bucket: example-bucket"
```

In general about 1MB of local disk space is required per TSDB block stored in the object storage bucket.
Expand Down

0 comments on commit 7d5dffa

Please sign in to comment.