Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
:_mod-docs-content-type: ASSEMBLY
[id="hcp-sizing-guidance"]
include::_attributes/common-attributes.adoc[]
= Sizing guidance for {hcp}
include::_attributes/common-attributes.adoc[]
:context: hcp-sizing-guidance

toc::[]

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.
[role="_abstract"]
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.

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.

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

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

* xref:../../hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc[Sizing guidance for {hcp}]
* xref:../../hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc#hcp-sizing-guidance[Sizing guidance for {hcp}]
5 changes: 3 additions & 2 deletions modules/hcp-load-based-limit.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
// Module included in the following assemblies:
// * hosted-control-planes/hcp-prepare/hcp-sizing-guidance.adoc

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

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.
[role="_abstract"]
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.

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

Expand Down
1 change: 1 addition & 0 deletions modules/hcp-pod-limits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="hcp-pod-limits_{context}"]
= Pod limits

[role="_abstract"]
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.

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.
5 changes: 3 additions & 2 deletions modules/hcp-resource-limit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="hcp-resource-limit_{context}"]
= Request-based resource limit

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.
[role="_abstract"]
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.

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}.
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.
1 change: 1 addition & 0 deletions modules/hcp-shared-infra.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[id="hcp-shared-infra_{context}"]
= Shared infrastructure between hosted and standalone control planes

[role="_abstract"]
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.

Sharing infrastructure can be beneficial in constrained environments, such as in small-scale deployments where you need resource efficiency.
Expand Down
5 changes: 4 additions & 1 deletion modules/hcp-sizing-calculation.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
// Module included in the following assemblies:
// * hosted-control-planes/hcp-prepare/hcp-sizing-guidance.adoc

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

[role="_abstract"]
Review an example of how to size a deployment of {hcp}.

This example provides sizing guidance for the following scenario:

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