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.

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

*: improve compaction documentation #9601

Merged
merged 2 commits into from
Apr 23, 2018
Merged

*: improve compaction documentation #9601

merged 2 commits into from
Apr 23, 2018

Conversation

gyuho
Copy link
Contributor

@gyuho gyuho commented Apr 20, 2018

Fix #8018.
Address #7607.

#7607 needs more monitoring doc.

@mitake @yudai

@@ -6,7 +6,17 @@ An etcd cluster needs periodic maintenance to remain reliable. Depending on an e

All etcd maintenance manages storage resources consumed by the etcd keyspace. Failure to adequately control the keyspace size is guarded by storage space quotas; if an etcd member runs low on space, a quota will trigger cluster-wide alarms which will put the system into a limited-operation maintenance mode. To avoid running out of space for writes to the keyspace, the etcd keyspace history must be compacted. Storage space itself may be reclaimed by defragmenting etcd members. Finally, periodic snapshot backups of etcd member state makes it possible to recover any unintended logical data loss or corruption caused by operational error.

## History compaction
## History compaction: Raft
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

raft log retention. do not confuse our users here. compaction should always mean compaction on db.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point.

@gyuho gyuho force-pushed the doc-compact branch 2 times, most recently from d23e995 to d348551 Compare April 20, 2018 22:03
Signed-off-by: Gyuho Lee <gyuhox@gmail.com>
Signed-off-by: Gyuho Lee <gyuhox@gmail.com>
@codecov-io
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (master@353f938). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #9601   +/-   ##
=========================================
  Coverage          ?   69.23%           
=========================================
  Files             ?      369           
  Lines             ?    33725           
  Branches          ?        0           
=========================================
  Hits              ?    23349           
  Misses            ?     8670           
  Partials          ?     1706

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 353f938...e23ee1a. Read the comment docs.

@mitake
Copy link
Contributor

mitake commented Apr 23, 2018

@gyuho thanks for working on this! LGTM

@xiang90
Copy link
Contributor

xiang90 commented Apr 23, 2018

lgtm

@gyuho gyuho merged commit e81f9d8 into etcd-io:master Apr 23, 2018
@gyuho gyuho deleted the doc-compact branch April 23, 2018 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants