diff --git a/docs/sources/configure/storage.md b/docs/sources/configure/storage.md index a4786d1cdebe5..a815b98f98897 100644 --- a/docs/sources/configure/storage.md +++ b/docs/sources/configure/storage.md @@ -31,11 +31,11 @@ Single Store refers to using object storage as the storage medium for both Loki' ### TSDB (recommended) -Starting in Loki 2.8, the [TSDB index store](https://grafana.com/docs/loki//operations/storage/tsdb/) improves query performance, reduces TCO and has the same feature parity as "boltdb-shipper". +Starting in Loki 2.8, the [TSDB index store](https://grafana.com/docs/loki//operations/storage/tsdb/) improves query performance, reduces TCO and has the same feature parity as "boltdb-shipper". TSDB is the recommended index store for Loki 2.8 and newer. ### BoltDB (deprecated) -Also known as "boltdb-shipper" during development (and is still the schema `store` name). The single store configurations for Loki utilize the chunk store for both chunks and the index, requiring just one store to run Loki. +Also known as "boltdb-shipper" during development (and is still the schema `store` name). The single store configurations for Loki utilize the chunk store for both chunks and the index, requiring just one store to run Loki. BoldDB is the recommended index store for Loki v2.0.0 through v2.7x. Performance is comparable to a dedicated index type while providing a much less expensive and less complicated deployment. When using Single Store, no extra [Chunk storage](#chunk-storage) and [Index storage](#index-storage) are necessary. @@ -172,7 +172,7 @@ For more information, see the [table manager](https://grafana.com/docs/loki//configure/#period_config) entry in your [schema_config](https://grafana.com/docs/loki//configure/#schema_config). The important thing to remember here is to set this at some point in the _future_ and then roll out the config file changes to Loki. This allows the table manager to create the required table in advance of writes and ensures that existing data isn't queried as if it adheres to the new schema. As an example, let's say it's 2023-07-14 and we want to start using the `v13` schema on the 20th: + ```yaml schema_config: configs: @@ -223,7 +224,6 @@ We're interested in adding targeted deletion in future Loki releases (think tena For more information, see the [retention configuration](https://grafana.com/docs/loki//operations/storage/retention/) documentation. - ## Examples ### Single machine/local development (boltdb+filesystem) @@ -314,7 +314,7 @@ The role should have a policy with the following permissions attached. } ``` -**To setup an S3 bucket and an IAM role and policy:** +**To setup an S3 bucket and an IAM role and policy:** This guide assumes a provisioned EKS cluster. @@ -324,14 +324,14 @@ This guide assumes a provisioned EKS cluster. 3. Export the AWS profile and region if not done so: - ``` + ```bash export AWS_PROFILE= export AWS_REGION= ``` 4. Save the OIDC provider in an environment variable: - ``` + ```bash oidc_provider=$(aws eks describe-cluster --name --query "cluster.identity.oidc.issuer" --output text | sed -e "s/^https:\/\///") ``` @@ -342,7 +342,6 @@ This guide assumes a provisioned EKS cluster. Note, the bucket name defaults to `loki-data` but can be changed via the `bucket_name` variable. - ### Azure deployment (Azure Blob Storage Single Store) #### Using account name and key diff --git a/docs/sources/operations/storage/_index.md b/docs/sources/operations/storage/_index.md index 26862d3a88fbd..b0cea23bd43d7 100644 --- a/docs/sources/operations/storage/_index.md +++ b/docs/sources/operations/storage/_index.md @@ -30,9 +30,8 @@ For more information: ### ✅ Supported index stores -- [Single Store TSDB](https://grafana.com/docs/loki//operations/storage/tsdb/) index store which stores TSDB index files in the object store. - **This is the recommended index store for Loki 2.8 and newer.** -- [Single Store BoltDB (boltdb-shipper)](https://grafana.com/docs/loki//operations/storage/boltdb-shipper/) index store which stores boltdb index files in the object store. +- [Single Store TSDB](https://grafana.com/docs/loki//operations/storage/tsdb/) index store which stores TSDB index files in the object store. This is the recommended index store for Loki 2.8 and newer. +- [Single Store BoltDB (boltdb-shipper)](https://grafana.com/docs/loki//operations/storage/boltdb-shipper/) index store which stores boltdb index files in the object store. Recommended store for Loki 2.0 through 2.7.x. ### ❌ Deprecated index stores @@ -61,7 +60,6 @@ For more information: - [Google Bigtable](https://cloud.google.com/bigtable). Support for this is deprecated and will be removed in a future release. - [Apache Cassandra](https://cassandra.apache.org). Support for this is deprecated and will be removed in a future release. - ## Cloud Storage Permissions ### S3 @@ -128,7 +126,6 @@ Resources: `*` Resources: `arn:aws:iam:::role/` - ### IBM Cloud Object Storage When using IBM Cloud Object Storage (COS) as object storage, IAM `Writer` role is needed. @@ -164,4 +161,3 @@ See the [IBM Cloud Object Storage section](https://grafana.com/docs/loki/}}) index is the recommended index. +Single store BoltDB Shipper is a legacy storage option recommended for Loki 2.0 through 2.7.x and is not recommended for new deployments. The [TSDB](https://grafana.com/docs/loki//operations/storage/tsdb/) is the recommended index for Loki 2.8 and newer. {{% /admonition %}} BoltDB Shipper lets you run Grafana Loki without any dependency on NoSQL stores for storing index. @@ -155,5 +155,3 @@ storage_config: gcs: bucket_name: GCS_BUCKET_NAME ``` - -