Merge pull request #94521 from kowen-rh/osdocs-12350

lahinson · web-flow · commit 3a673f73f873 · 2025-06-11T12:22:33.000-04:00
OSDOCS#12350: Migrate etcd performance content to new etcd book
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -3275,8 +3275,6 @@ Topics:
     File: recommended-control-plane-practices
   - Name: Recommended infrastructure practices
     File: recommended-infrastructure-practices
-  - Name: Recommended etcd practices
-    File: recommended-etcd-practices
 - Name: Telco core reference design specifications
   File: telco-core-rds
 - Name: Telco RAN DU reference design specifications
diff --git a/architecture/architecture-installation.adoc b/architecture/architecture-installation.adoc
@@ -15,7 +15,7 @@ include::modules/installation-process.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 
 * xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-control-plane-practices.adoc#master-node-sizing_recommended-control-plane-practices[Control plane node sizing]
 
diff --git a/architecture/control-plane.adoc b/architecture/control-plane.adoc
@@ -69,6 +69,6 @@ endif::openshift-dedicated,openshift-rosa[]
 ifndef::openshift-dedicated,openshift-rosa[]
 [role="_additional-resources"]
 .Additional resources
-* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 * xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd[Backing up etcd]
 endif::openshift-dedicated,openshift-rosa[]
diff --git a/etcd/etcd-performance.adoc b/etcd/etcd-performance.adoc
@@ -4,4 +4,31 @@ include::_attributes/common-attributes.adoc[]
 = Performance considerations for etcd
 :context: etcd-performance
 
-// This assembly will contain modules to provide information about etcd performance.
+toc::[]
+
+To ensure optimal performance and scalability for etcd in {product-title}, you can complete the following practices.
+
+include::modules/etcd-node-scaling.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* link:https://docs.redhat.com/en/documentation/assisted_installer_for_openshift_container_platform/2024/html/installing_openshift_container_platform_with_the_assisted_installer/expanding-the-cluster#adding-hosts-with-the-api_expanding-the-cluster[Adding hosts with the API]
+* link:https://docs.redhat.com/en/documentation/assisted_installer_for_openshift_container_platform/2023/html/assisted_installer_for_openshift_container_platform/expanding-the-cluster#installing-primary-control-plane-node-healthy-cluster_expanding-the-cluster[Installing a primary control plane node on a healthy cluster]
+* link:https://docs.redhat.com/en/documentation/assisted_installer_for_openshift_container_platform/2024/html/installing_openshift_container_platform_with_the_assisted_installer/expanding-the-cluster#installing-control-plane-node-healthy-cluster_expanding-the-cluster[Expanding the cluster]
+* xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[Restoring to a previous cluster state]
+
+include::modules/move-etcd-different-disk.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../architecture/architecture-rhcos.adoc#architecture-rhcos[Red Hat Enterprise Linux CoreOS (RHCOS)]
+
+include::modules/etcd-defrag.adoc[leveloffset=+1]
+
+include::modules/etcd-tuning-parameters.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features-about_nodes-cluster-enabling[Understanding feature gates]
+
+include::modules/etcd-increase-db.adoc[leveloffset=+1]
diff --git a/etcd/etcd-practices.adoc b/etcd/etcd-practices.adoc
@@ -4,4 +4,14 @@ include::_attributes/common-attributes.adoc[]
 = Recommended etcd practices
 :context: etcd-practices
 
-// This assembly will contain modules to provide recommended etcd practices.
+toc::[]
+
+The following documentation provides information on recommended performance and scalability practices for etcd.
+
+include::modules/recommended-etcd-practices.adoc[leveloffset=+1]
+include::modules/etcd-verify-hardware.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* link:https://access.redhat.com/solutions/4885641[How to use `fio` to check etcd disk performance in {product-title}]
+* link:https://access.redhat.com/articles/6271341[etcd performance troubleshooting guide for {product-title}]
diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc
@@ -39,7 +39,7 @@ include::modules/hcp-bm-infra-reqs.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 * xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc[Persistent storage using {lvms}]
 * xref:../../hosted_control_planes/hcp-import.adoc#hcp-import-disable_hcp-import[Disabling the automatic import of hosted clusters into {mce-short}]
 * xref:../../hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc[Enabling or disabling the {hcp} feature]
@@ -65,4 +65,4 @@ include::modules/hcp-bm-hc-mirror.adoc[leveloffset=+2]
 * To add hosts to the host inventory by using the Discovery Image, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#add-host-host-inventory[Adding hosts to the host inventory by using the Discovery Image].
 * To extract the {product-title} release image digest, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#configure-hosted-disconnected-digest-image[Extracting the {product-title} release image digest].
 
-include::modules/hcp-bm-verify.adoc[leveloffset=+1]
+include::modules/hcp-bm-verify.adoc[leveloffset=+1]
diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.adoc
@@ -40,7 +40,7 @@ include::modules/hcp-non-bm-infra-reqs.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 
 * xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#persistent-storage-using-lvms_logical-volume-manager-storage[Persistent storage using logical volume manager storage]
 
diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc
@@ -28,7 +28,7 @@ include::modules/hcp-virt-reqs.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 * xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#persistent-storage-using-lvms[Persistent storage using Logical Volume Manager Storage]
 
 include::modules/hcp-virt-prereqs.adoc[leveloffset=+2]
diff --git a/installing/installing_openstack/deploying-openstack-with-rootVolume-etcd-on-local-disk.adoc b/installing/installing_openstack/deploying-openstack-with-rootVolume-etcd-on-local-disk.adoc
@@ -13,5 +13,5 @@ include::modules/installation-osp-local-disk-deployment.adoc[leveloffset=+1]
 [role="_additional-resources"]
 [id="additional-resources_deploying-openstack-on-local-disk"]
 == Additional resources
-* xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
-* xref:../../backup_and_restore/index.adoc#backup-restore-operations-overview[Overview of backup and restore options]
+* xref:../../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../../backup_and_restore/index.adoc#backup-restore-operations-overview[Overview of backup and restore options]
diff --git a/installing/overview/index.adoc b/installing/overview/index.adoc
@@ -15,7 +15,7 @@ include::modules/installation-process.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 
 * xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-control-plane-practices.adoc#master-node-sizing_recommended-control-plane-practices[Control plane node sizing]
 
diff --git a/modules/etcd-defrag.adoc b/modules/etcd-defrag.adoc
@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * post_installation_configuration/cluster-tasks.adoc
-// * scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
+// * etcd/etcd-performance.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="etcd-defrag_{context}"]
diff --git a/modules/etcd-increase-db.adoc b/modules/etcd-increase-db.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
+// * etcd/etcd-performance.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="etcd-increase-db_{context}"]
diff --git a/modules/etcd-node-scaling.adoc b/modules/etcd-node-scaling.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
+// * etcd/etcd-performance.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="etcd-node-scaling_{context}"]
@@ -38,4 +38,4 @@ The following table shows failure tolerance for clusters of different sizes:
 |2
 |===
 
-For more information about recovering from quorum loss, see "Restoring to a previous cluster state".
+For more information about recovering from quorum loss, see "Restoring to a previous cluster state".
diff --git a/modules/etcd-tuning-parameters.adoc b/modules/etcd-tuning-parameters.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
+// * etcd/etcd-performance.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="etcd-tuning-parameters_{context}"]
diff --git a/modules/etcd-verify-hardware.adoc b/modules/etcd-verify-hardware.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
+// * etcd/etcd-practices.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="etcd-verify-hardware_{context}"]
@@ -40,4 +40,4 @@ The output reports whether the disk is fast enough to host etcd by comparing the
 
 Because etcd replicates the requests among all the members, its performance strongly depends on network input/output (I/O) latency. High network latencies result in etcd heartbeats taking longer than the election timeout, which results in leader elections that are disruptive to the cluster. A key metric to monitor on a deployed {product-title} cluster is the 99th percentile of etcd network peer latency on each etcd cluster member. Use Prometheus to track the metric.
 
-The `histogram_quantile(0.99, rate(etcd_network_peer_round_trip_time_seconds_bucket[2m]))` metric reports the round trip time for etcd to finish replicating the client requests between the members. Ensure that it is less than 50 ms.
+The `histogram_quantile(0.99, rate(etcd_network_peer_round_trip_time_seconds_bucket[2m]))` metric reports the round trip time for etcd to finish replicating the client requests between the members. Ensure that it is less than 50 ms.
diff --git a/modules/move-etcd-different-disk.adoc b/modules/move-etcd-different-disk.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
+// * etcd/etcd-performance.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="move-etcd-different-disk_{context}"]
diff --git a/modules/recommended-etcd-practices.adoc b/modules/recommended-etcd-practices.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
+// * etcd/etcd-practices.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="recommended-etcd-practices_{context}"]
@@ -36,4 +36,4 @@ Some key metrics to monitor on a deployed {product-title} cluster are p99 of etc
 [NOTE]
 ====
 The etcd member database sizes can vary in a cluster during normal operations. This difference does not affect cluster upgrades, even if the leader size is different from the other members.
-====
+====
diff --git a/post_installation_configuration/cluster-tasks.adoc b/post_installation_configuration/cluster-tasks.adoc
@@ -322,7 +322,7 @@ Back up etcd, enable or disable etcd encryption, or defragment etcd data.
 
 [NOTE]
 ====
-If you deployed a bare-metal cluster, you can scale the cluster up to 5 nodes as part of your post-installation tasks. For more information, see xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#etcd-node-scaling_recommended-etcd-practices[Node scaling for etcd].
+If you deployed a bare-metal cluster, you can scale the cluster up to 5 nodes as part of your post-installation tasks. For more information, see xref:../etcd/etcd-performance.adoc#etcd-node-scaling_etcd-performance[Node scaling for etcd].
 ====
 
 include::modules/about-etcd-encryption.adoc[leveloffset=+2]
@@ -335,7 +335,7 @@ include::modules/dr-restoring-cluster-state.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 * xref:../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal]
 * xref:../installing/overview/index.adoc#replacing-a-bare-metal-control-plane-node_bare-metal-expanding[Replacing a bare-metal control plane node]
 
diff --git a/scalability_and_performance/index.adoc b/scalability_and_performance/index.adoc
@@ -23,8 +23,6 @@ xref:../scalability_and_performance/recommended-performance-scale-practices/reco
 
 xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-infrastructure-practices.adoc#recommended-infrastructure-practices[Recommended infrastructure practices]
 
-xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
-
 [discrete]
 == Telco reference design specifications
 
diff --git a/scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc b/scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
diff --git a/scalability_and_performance/telco-hub-rds.adoc b/scalability_and_performance/telco-hub-rds.adoc
@@ -93,7 +93,7 @@ include::modules/telco-hub-storage-considerations.adoc[leveloffset=+2]
 * xref:../storage/understanding-persistent-storage.adoc#persistent-storage-overview_understanding-persistent-storage[Persistent storage overview]
 * link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/latest/html/red_hat_openshift_data_foundation_architecture/index[{rh-storage} architecture]
 * xref:../storage/persistent_storage/persistent_storage_local/persistent-storage-local.adoc#persistent-storage-using-local-volume[Persistent storage using local volumes]
-* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
+* xref:../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
 
 include::modules/telco-hub-git-repository.adoc[leveloffset=+2]
 
@@ -518,4 +518,4 @@ include::https://raw.githubusercontent.com/openshift-kni/telco-reference/release
 
 include::modules/telco-hub-software-stack.adoc[leveloffset=+1]
 
-:!telco-hub:
+:!telco-hub:
