Skip to content

Commit

Permalink
clarifying etcd doc (#3361)
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Chinchilla <[email protected]>
  • Loading branch information
gibbscullen and Chris Chinchilla authored Mar 17, 2021
1 parent 5d23e1b commit 31d3bf8
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions site/content/operational_guide/etcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@ title: "etcd"
weight: 12
---

The M3 stack leverages `etcd` as a distributed key-value storage to:
## Overview

All components within the M3 stack (e.g. M3 Query, M3DB, M3 Aggregator) leverage `etcd` as its distributed key-value storage. See below for examples of how this `etcd` metadata is used:

1. Update cluster configuration in realtime
2. Manage placements for our distributed / sharded tiers like M3DB and M3Aggregator
2. Manage placements for distributed / sharded tiers like M3DB and M3Aggregator
3. Perform leader-election in M3Aggregator
4. Define placements for nodes within a M3DB cluster
5. Define which shards are tied to a given node within a M3DB cluster

and much more!

## Overview
## Best practices for operating etcd with M3

`M3DB` ships with support for running embedded `etcd` (called `seed nodes`), and while this is convenient for testing and development, we don't recommend running with this setup in production.

Expand Down

0 comments on commit 31d3bf8

Please sign in to comment.