diff --git a/docs/sources/operations/storage/_index.md b/docs/sources/operations/storage/_index.md index 1b6b3b4443..039d21ccbd 100644 --- a/docs/sources/operations/storage/_index.md +++ b/docs/sources/operations/storage/_index.md @@ -30,23 +30,38 @@ For more information: The following are supported for the index: -- [Single Store (boltdb-shipper) - Recommended for 2.0 and newer]({{< relref "./boltdb-shipper" >}}) index store which stores boltdb index files in the object store +- [TSDB]({{< relref "./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-shipper)]({{< relref "./boltdb-shipper" >}}) index store which stores boltdb index files in the object store. - [Amazon DynamoDB](https://aws.amazon.com/dynamodb) - [Google Bigtable](https://cloud.google.com/bigtable) - [Apache Cassandra](https://cassandra.apache.org) - [BoltDB](https://github.com/boltdb/bolt) (doesn't work when clustering Loki) -The following are supported for the chunks: +The following are deprecated for the index and will be removed in a future release: + +- [Amazon DynamoDB](https://aws.amazon.com/dynamodb). Support for this is deprecated and will be removed in a future release. +- [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. + +The following are supported and recommended for the chunks: -- [Amazon DynamoDB](https://aws.amazon.com/dynamodb) -- [Google Bigtable](https://cloud.google.com/bigtable) -- [Apache Cassandra](https://cassandra.apache.org) - [Amazon S3](https://aws.amazon.com/s3) - [Google Cloud Storage](https://cloud.google.com/storage/) - [Filesystem]({{< relref "./filesystem" >}}) (please read more about the filesystem to understand the pros/cons before using with production data) - [Baidu Object Storage](https://cloud.baidu.com/product/bos.html) - [IBM Cloud Object Storage](https://www.ibm.com/cloud/object-storage) +The following are supported for the chunks, but not typically recommended for production use: + +- [Filesystem]({{< relref "./filesystem" >}}) (please read more about the filesystem to understand the pros/cons before using with production data) + +The following are deprecated for the chunks and will be removed in a future release: + +- [Amazon DynamoDB](https://aws.amazon.com/dynamodb). Support for this is deprecated and will be removed in a future release. +- [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 @@ -64,6 +79,10 @@ See the [AWS deployment section]({{< relref "../../storage#aws-deployment-s3-sin ### DynamoDB +{{% admonition type="note" %}} +DynamoDB support is deprecated and will be removed in a future release. +{{% /admonition %}} + When using DynamoDB for the index, the following permissions are needed: - `dynamodb:BatchGetItem` diff --git a/docs/sources/operations/storage/boltdb-shipper.md b/docs/sources/operations/storage/boltdb-shipper.md index db772e9d7e..cd2c545be9 100644 --- a/docs/sources/operations/storage/boltdb-shipper.md +++ b/docs/sources/operations/storage/boltdb-shipper.md @@ -4,6 +4,8 @@ description: Single Store (boltdb-shipper) --- # Single Store (boltdb-shipper) +Note that single store (boltdb-shipper) is a legacy storage option and is not recommended for new deployments. It is recommended to use the [TSDB]({{< relref "./tsdb" >}}) index instead. + BoltDB Shipper lets you run Grafana Loki without any dependency on NoSQL stores for storing index. It locally stores the index in BoltDB files instead and keeps shipping those files to a shared object store i.e the same object store which is being used for storing chunks. It also keeps syncing BoltDB files from shared object store to a configured local directory for getting index entries created by other services of same Loki cluster. diff --git a/docs/sources/operations/storage/table-manager/_index.md b/docs/sources/operations/storage/table-manager/_index.md index ada4313711..f13f25e918 100644 --- a/docs/sources/operations/storage/table-manager/_index.md +++ b/docs/sources/operations/storage/table-manager/_index.md @@ -29,11 +29,15 @@ The Table Manager supports the following backends: - [Apache Cassandra](https://cassandra.apache.org) - [BoltDB](https://github.com/boltdb/bolt) (primarily used for local environments) - **Chunk store** - - [Amazon DynamoDB](https://aws.amazon.com/dynamodb) - - [Google Bigtable](https://cloud.google.com/bigtable) - - [Apache Cassandra](https://cassandra.apache.org) - Filesystem (primarily used for local environments) + +Loki does support the following backends for both index and chunk storage, but they are deprecated and will be removed in a future release: + +- [Amazon DynamoDB](https://aws.amazon.com/dynamodb) +- [Google Bigtable](https://cloud.google.com/bigtable) +- [Apache Cassandra](https://cassandra.apache.org) + The object storages - like Amazon S3 and Google Cloud Storage - supported by Loki to store chunks, are not managed by the Table Manager, and a custom bucket policy should be set to delete old data. diff --git a/docs/sources/operations/storage/tsdb.md b/docs/sources/operations/storage/tsdb.md index c7c11052b1..e3639b0036 100644 --- a/docs/sources/operations/storage/tsdb.md +++ b/docs/sources/operations/storage/tsdb.md @@ -6,7 +6,7 @@ weight: 1000 # TSDB -Starting with Loki v2.8, TSDB is the Loki index. It is heavily inspired by the Prometheus's TSDB [sub-project](https://github.com/prometheus/prometheus/tree/main/tsdb). For a deeper explanation you can read Owen's [blog post](https://lokidex.com/posts/tsdb/). The short version is that this new index is more efficient, faster, and more scalable. It also resides in object storage like the [boltdb-shipper]({{< relref "./boltdb-shipper" >}}) index which preceded it. +Starting with Loki v2.8, TSDB is the recommended Loki index. It is heavily inspired by the Prometheus's TSDB [sub-project](https://github.com/prometheus/prometheus/tree/main/tsdb). For a deeper explanation you can read Loki maintainer Owen's [blog post](https://lokidex.com/posts/tsdb/). The short version is that this new index is more efficient, faster, and more scalable. It also resides in object storage like the [boltdb-shipper]({{< relref "./boltdb-shipper" >}}) index which preceded it. ## Example Configuration