Skip to content

Commit f147e32

Browse files
committed
Include etcd degragmentation instructions
This commit adds instructions on degfragging the etcd to the scalability and performance guide as part of the recommended etcd practices. This is needed for etcd to avoid suffering from poor performance if the keyspace grows excessively large and exceeds the space quota.
1 parent f633de4 commit f147e32

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

modules/etcd-defrag.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * post_installation_configuration/cluster-tasks.adoc
4+
// * scalability_and_performance/recommended-host-practices.adoc
45

56
[id="etcd-defrag_{context}"]
67
= Defragmenting etcd data

modules/recommended-etcd-practices.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
// Module included in the following assemblies:
22
//
33
// * scalability_and_performance/recommended-host-practices.adoc
4-
// * post_installation_configuration/cluster-tasks.adoc
5-
// * post_installation_configuration/node-tasks.adoc
64

75
[id="recommended-etcd-practices_{context}"]
86
= Recommended etcd practices
@@ -18,7 +16,8 @@ only accepts key reads and deletes. Some of the key metrics to monitor are
1816
`etcd_mvcc_db_total_size_in_use_in_bytes` which indicates the actual
1917
database usage after a history compaction, and
2018
`etcd_debugging_mvcc_db_total_size_in_bytes` which shows the database size
21-
including free space waiting for defragmentation.
19+
including free space waiting for defragmentation. Instructions on defragging
20+
etcd can be found in the `Defragmenting etcd data` section.
2221

2322
Etcd writes data to disk, so its performance strongly depends on disk performance. Etcd
2423
persists proposals on disk. Slow disks and disk activity from other processes might cause long

post_installation_configuration/cluster-tasks.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,6 @@ include::modules/nodes-cluster-enabling-features-cluster.adoc[leveloffset=+1]
565565
== etcd tasks
566566
Back up etcd, enable or disable etcd encryption, or defragment etcd data.
567567

568-
include::modules/recommended-etcd-practices.adoc[leveloffset=+2]
569568
include::modules/about-etcd-encryption.adoc[leveloffset=+2]
570569
include::modules/enabling-etcd-encryption.adoc[leveloffset=+2]
571570
include::modules/disabling-etcd-encryption.adoc[leveloffset=+2]

post_installation_configuration/node-tasks.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ include::modules/recommended-node-host-practices.adoc[leveloffset=+1]
5656
include::modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc[leveloffset=+2]
5757
include::modules/modify-unavailable-workers.adoc[leveloffset=+2]
5858
include::modules/master-node-sizing.adoc[leveloffset=+2]
59-
include::modules/recommended-etcd-practices.adoc[leveloffset=+2]
6059
include::modules/setting-up-cpu-manager.adoc[leveloffset=+2]
6160

6261
[id="post-install-huge-pages"]

scalability_and_performance/recommended-host-practices.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ include::modules/master-node-sizing.adoc[leveloffset=+1]
1717

1818
include::modules/recommended-etcd-practices.adoc[leveloffset=+1]
1919

20+
include::modules/etcd-defrag.adoc[leveloffset=+1]
21+
2022
include::modules/infrastructure-components.adoc[leveloffset=+1]
2123

2224
include::modules/infrastructure-moving-monitoring.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)