Skip to content

Commit bcab98c

Browse files
committed
[OSDOCS-19997]: CQA: Sizing guidance for HCP
1 parent c2549fb commit bcab98c

6 files changed

Lines changed: 18 additions & 8 deletions

File tree

hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="hcp-sizing-guidance"]
3-
include::_attributes/common-attributes.adoc[]
43
= Sizing guidance for {hcp}
4+
include::_attributes/common-attributes.adoc[]
55
:context: hcp-sizing-guidance
66

77
toc::[]
88

9-
Many factors, including hosted cluster workload and worker node count, affect how many {hcp} can fit within a certain number of worker nodes. Use this sizing guide to help with hosted cluster capacity planning. This guidance assumes a highly available {hcp} topology. The load-based sizing examples were measured on a bare-metal cluster. Cloud-based instances might have different limiting factors, such as memory size.
9+
[role="_abstract"]
10+
Many factors, including hosted cluster workload and worker node count, affect how many hosted control planes can fit within a certain number of worker nodes. Use this sizing guide to help with hosted cluster capacity planning.
11+
12+
This guidance assumes a highly available {hcp} topology. The load-based sizing examples were measured on a bare-metal cluster. Cloud-based instances might have different limiting factors, such as memory size.
1013

1114
You can override the following resource utilization sizing measurements and disable the metric service monitoring.
1215

@@ -41,4 +44,4 @@ include::modules/hcp-shared-infra.adoc[leveloffset=+1]
4144
[role="_additional-resources"]
4245
.Additional resources
4346

44-
* xref:../../hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc[Sizing guidance for {hcp}]
47+
* xref:../../hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc#hcp-sizing-guidance[Sizing guidance for {hcp}]

modules/hcp-load-based-limit.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
// Module included in the following assemblies:
22
// * hosted-control-planes/hcp-prepare/hcp-sizing-guidance.adoc
33

4-
:_mod-docs-content-type: CONCEPT
4+
:_mod-docs-content-type: REFERENCE
55
[id="hcp-load-based-limit_{context}"]
66
= Load-based limit
77

8-
The maximum number of {hcp} that the cluster can host is calculated based on the hosted control plane pods CPU and memory utilizations when some workload is put on the hosted control plane Kubernetes API server.
8+
[role="_abstract"]
9+
As you plan your deployment, consider the maximum number of hosted control planes that the cluster can host. That number is calculated based on the hosted control plane pods CPU and memory utilizations when some workload is put on the hosted control plane Kubernetes API server.
910

1011
The following method is used to measure the hosted control plane resource utilizations as the workload increases:
1112

modules/hcp-pod-limits.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[id="hcp-pod-limits_{context}"]
66
= Pod limits
77

8+
[role="_abstract"]
89
The `maxPods` setting for each node affects how many hosted clusters can fit in a control-plane node. It is important to note the `maxPods` value on all control-plane nodes. Plan for about 75 pods for each highly available hosted control plane.
910

1011
For bare-metal nodes, the default `maxPods` setting of 250 is likely to be a limiting factor because roughly three {hcp} fit for each node given the pod requirements, even if the machine has plenty of resources to spare. Setting the `maxPods` value to 500 by configuring the `KubeletConfig` value allows for greater hosted control plane density, which can help you take advantage of additional compute resources.

modules/hcp-resource-limit.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[id="hcp-resource-limit_{context}"]
66
= Request-based resource limit
77

8-
The maximum number of {hcp} that the cluster can host is calculated based on the hosted control plane CPU and memory requests from the pods.
8+
[role="_abstract"]
9+
The maximum number of hosted control planes that the cluster can host is calculated based on the hosted control plane CPU and memory requests from the pods.
910

10-
A highly available hosted control plane consists of 78 pods that request 5 vCPUs and 18 GiB memory. These baseline numbers are compared to the cluster worker node resource capacities to estimate the maximum number of {hcp}.
11+
A highly available hosted control plane consists of 78 pods that request 5 vCPUs and 18 GiB memory. These baseline numbers are compared to the cluster worker node resource capacities to estimate the maximum number of hosted control planes.

modules/hcp-shared-infra.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[id="hcp-shared-infra_{context}"]
66
= Shared infrastructure between hosted and standalone control planes
77

8+
[role="_abstract"]
89
As a service provider, you can more effectively use your resources by sharing infrastructure between a standalone {product-title} control plane and {hcp}. A 3-node {product-title} cluster can be a management cluster for a hosted cluster.
910

1011
Sharing infrastructure can be beneficial in constrained environments, such as in small-scale deployments where you need resource efficiency.

modules/hcp-sizing-calculation.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
// Module included in the following assemblies:
22
// * hosted-control-planes/hcp-prepare/hcp-sizing-guidance.adoc
33

4-
:_mod-docs-content-type: CONCEPT
4+
:_mod-docs-content-type: REFERENCE
55
[id="hcp-sizing-calculation_{context}"]
66
= Sizing calculation example
77

8+
[role="_abstract"]
9+
Review an example of how to size a deployment of {hcp}.
10+
811
This example provides sizing guidance for the following scenario:
912

1013
* Three bare-metal workers that are labeled as `hypershift.openshift.io/control-plane` nodes

0 commit comments

Comments
 (0)