Skip to content

Commit

Permalink
add auto generated docs
Browse files Browse the repository at this point in the history
Signed-off-by: Maria Eduarda Duarte <dudammduarte@yahoo.com.br>
  • Loading branch information
dudaduarte committed Jun 6, 2022
1 parent 173321d commit 086da5b
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/components/receive.md
Expand Up @@ -44,6 +44,7 @@ type: GCS
config:
bucket: ""
service_account: ""
prefix: ""
```

The example content of `hashring.json`:
Expand Down
1 change: 1 addition & 0 deletions docs/components/sidecar.md
Expand Up @@ -56,6 +56,7 @@ type: GCS
config:
bucket: ""
service_account: ""
prefix: ""
```

## Upload compacted blocks
Expand Down
1 change: 1 addition & 0 deletions docs/components/store.md
Expand Up @@ -15,6 +15,7 @@ type: GCS
config:
bucket: ""
service_account: ""
prefix: ""
```

In general, an average of 6 MB of local disk space is required per TSDB block stored in the object storage bucket, but for high cardinality blocks with large label set it can even go up to 30MB and more. It is for the pre-computed index, which includes symbols and postings offsets as well as metadata JSON.
Expand Down
3 changes: 3 additions & 0 deletions docs/components/tools.md
Expand Up @@ -101,6 +101,7 @@ type: GCS
config:
bucket: ""
service_account: ""
prefix: ""
```

Bucket can be extended to add more subcommands that will be helpful when working with object storage buckets by adding a new command within [`/cmd/thanos/tools_bucket.go`](../../cmd/thanos/tools_bucket.go) .
Expand Down Expand Up @@ -601,6 +602,7 @@ type: GCS
config:
bucket: ""
service_account: ""
prefix: ""
```

```$ mdox-exec="thanos tools bucket downsample --help"
Expand Down Expand Up @@ -675,6 +677,7 @@ type: GCS
config:
bucket: ""
service_account: ""
prefix: ""
```

```$ mdox-exec="thanos tools bucket mark --help"
Expand Down
8 changes: 8 additions & 0 deletions docs/storage.md
Expand Up @@ -96,6 +96,7 @@ config:
kms_encryption_context: {}
encryption_key: ""
sts_endpoint: ""
prefix: ""
```

At a minimum, you will need to provide a value for the `bucket`, `endpoint`, `access_key`, and `secret_key` keys. The rest of the keys are optional.
Expand Down Expand Up @@ -257,6 +258,7 @@ type: GCS
config:
bucket: ""
service_account: ""
prefix: ""
```

##### Using GOOGLE_APPLICATION_CREDENTIALS
Expand Down Expand Up @@ -358,6 +360,7 @@ config:
key_file: ""
server_name: ""
insecure_skip_verify: false
prefix: ""
```

If `msi_resource` is used, authentication is done via system-assigned managed identity. The value for Azure should be `https://<storage-account-name>.blob.core.windows.net`.
Expand Down Expand Up @@ -398,6 +401,7 @@ config:
connect_timeout: 10s
timeout: 5m
use_dynamic_large_objects: false
prefix: ""
```

#### Tencent COS
Expand All @@ -423,6 +427,7 @@ config:
max_idle_conns: 100
max_idle_conns_per_host: 100
max_conns_per_host: 0
prefix: ""
```

The `secret_key` and `secret_id` field is required. The `http_config` field is optional for optimize HTTP transport settings. There are two ways to configure the required bucket information:
Expand All @@ -444,6 +449,7 @@ config:
bucket: ""
access_key_id: ""
access_key_secret: ""
prefix: ""
```

Use --objstore.config-file to reference to this configuration file.
Expand All @@ -459,6 +465,7 @@ config:
endpoint: ""
access_key: ""
secret_key: ""
prefix: ""
```

#### Filesystem
Expand All @@ -471,6 +478,7 @@ NOTE: This storage type is experimental and might be inefficient. It is NOT advi
type: FILESYSTEM
config:
directory: ""
prefix: ""
```

### How to add a new client to Thanos?
Expand Down
1 change: 1 addition & 0 deletions pkg/objstore/prefixed_bucket.go
Expand Up @@ -31,6 +31,7 @@ func conditionalPrefix(prefix, name string) string {
if len(name) > 0 {
return withPrefix(prefix, name)
}

return name
}

Expand Down

0 comments on commit 086da5b

Please sign in to comment.