Skip to content

Commit 2564694

Browse files
authored
clarify kv store dependency (grafana#207)
Signed-off-by: Tom Hayward <[email protected]>
1 parent 4896221 commit 2564694

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@ Horizontally scalable, highly available, multi-tenant, long term Prometheus.
1818

1919
### Key-Value store
2020

21-
Cortex requires an externally provided key-value store, such as [etcd](https://etcd.io/) or [Consul](https://www.consul.io/).
21+
Cortex requires a Key-Value (KV) store to store the ring. It can use traditional KV stores like [Consul](https://www.consul.io/) or [etcd](https://etcd.io/), but it can also build its own KV store on top of memberlist library using a gossip algorithm.
2222

23-
Both services can be installed alongside Cortex, for example using helm charts available [here](https://github.com/bitnami/charts/tree/master/bitnami/etcd) and [here](https://github.com/helm/charts/tree/master/stable/consul).
23+
The recommended approach is to use the built-in memberlist as a KV store, where supported.
24+
25+
External KV stores can be installed alongside Cortex using their respective helm charts https://github.com/bitnami/charts/tree/master/bitnami/etcd and https://github.com/helm/charts/tree/master/stable/consul.
2426

2527
### Storage
2628

README.md.gotmpl

+4-2
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@
1515

1616
### Key-Value store
1717

18-
Cortex requires an externally provided key-value store, such as [etcd](https://etcd.io/) or [Consul](https://www.consul.io/).
18+
Cortex requires a Key-Value (KV) store to store the ring. It can use traditional KV stores like [Consul](https://www.consul.io/) or [etcd](https://etcd.io/), but it can also build its own KV store on top of memberlist library using a gossip algorithm.
1919

20-
Both services can be installed alongside Cortex, for example using helm charts available [here](https://github.com/bitnami/charts/tree/master/bitnami/etcd) and [here](https://github.com/helm/charts/tree/master/stable/consul).
20+
The recommended approach is to use the built-in memberlist as a KV store, where supported.
21+
22+
External KV stores can be installed alongside Cortex using their respective helm charts https://github.com/bitnami/charts/tree/master/bitnami/etcd and https://github.com/helm/charts/tree/master/stable/consul.
2123

2224
### Storage
2325

0 commit comments

Comments
 (0)