Skip to content

Commit 70e198b

Browse files
authored
Merge pull request #81631 from lahinson/osdocs-11570-etcd-4-5-nodes
[OSDOCS-11570]: Adding docs about 4 and 5 node architecture
2 parents cba5a4a + 4f9e0a5 commit 70e198b

File tree

4 files changed

+53
-1
lines changed

4 files changed

+53
-1
lines changed

modules/architecture-machine-roles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Extra controls apply to control plane machines to prevent you from deleting all
8181
[NOTE]
8282
====
8383
ifndef::openshift-dedicated,openshift-rosa[]
84-
Exactly three control plane nodes must be used for all production deployments.
84+
Exactly three control plane nodes must be used for all production deployments. However, on bare metal platforms, clusters can be scaled up to five control plane nodes.
8585
endif::openshift-dedicated,openshift-rosa[]
8686
ifdef::openshift-dedicated,openshift-rosa[]
8787
Single availability zone clusters and multiple availability zone clusters require a minimum of three control plane nodes.

modules/etcd-node-scaling.adoc

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="etcd-node-scaling_{context}"]
7+
= Node scaling for etcd
8+
9+
In general, clusters must have 3 control plane nodes. However, if your cluster is installed on a bare metal platform, you can scale a cluster up to 5 nodes as a post-installation task. For example, to scale from 3 to 4 nodes after installation, you can add a host and install it as a control plane node. Then, the etcd Operator scales accordingly to account for the additional node.
10+
11+
Scaling to 4-node or 5-node clusters is available only on bare metal platforms.
12+
13+
For more information about how to scale from 3 to 4 nodes by using the Assisted Installer, see "Adding hosts with the API" and "Installing a primary control plane node on a healthy cluster".
14+
15+
The following table shows failure tolerance for clusters of different sizes:
16+
17+
.Failure tolerances by cluster size
18+
[%autowidth]
19+
|===
20+
|Cluster size |Majority |Failure tolerance
21+
22+
|1 node
23+
|1
24+
|0
25+
26+
|3 nodes
27+
|2
28+
|1
29+
30+
|4 nodes
31+
|3
32+
|1
33+
34+
|5 nodes
35+
|3
36+
|2
37+
|===
38+
39+
For more information about recovering from quorum loss, see "Restoring to a previous cluster state".

post_installation_configuration/cluster-tasks.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,11 @@ include::modules/nodes-cluster-enabling-features-cli.adoc[leveloffset=+2]
322322
== etcd tasks
323323
Back up etcd, enable or disable etcd encryption, or defragment etcd data.
324324

325+
[NOTE]
326+
====
327+
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].
328+
====
329+
325330
include::modules/about-etcd-encryption.adoc[leveloffset=+2]
326331
include::modules/etcd-encryption-types.adoc[leveloffset=+2]
327332
include::modules/enabling-etcd-encryption.adoc[leveloffset=+2]

scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ include::modules/etcd-verify-hardware.adoc[leveloffset=+1]
1616
* link:https://access.redhat.com/solutions/4885641[How to use `fio` to check etcd disk performance in {product-title}]
1717
* link:https://access.redhat.com/articles/6271341[etcd performance troubleshooting guide for {product-title}]
1818
19+
include::modules/etcd-node-scaling.adoc[leveloffset=+1]
20+
21+
[role="_additional-resources"]
22+
.Additional resources
23+
* 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]
24+
* 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-primary-control-plane-node-healthy-cluster_expanding-the-cluster[Installing a primary control plane node on a healthy cluster]
25+
* 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]
26+
1927
include::modules/move-etcd-different-disk.adoc[leveloffset=+1]
2028

2129
[role="_additional-resources"]

0 commit comments

Comments
 (0)