Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] -- Adding clarification around etcd and M3 to etcd operational guide #3361

Merged
merged 2 commits into from
Mar 17, 2021
Merged

[Docs] -- Adding clarification around etcd and M3 to etcd operational guide #3361

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
796ac5e
clarifying etcd doc
gibbscullen Mar 16, 2021
334f11a
Merge branch 'master' into gibbs/etcd_doc
Mar 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions site/content/operational_guide/etcd.md
View file
Open in desktop
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