Skip to content

Commit 1e20384

Browse files
authored
Merge pull request #40901 from bmcelvee/OSDOCS-3155
OSDOCS-3155 OSD/Rosa: Scaling/Autoscaling additions
2 parents 67ef514 + 8c45ffa commit 1e20384

7 files changed

+83
-7
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,8 @@ Distros: openshift-dedicated
148148
Topics:
149149
- Name: About machine pools
150150
File: nodes-machinepools-about
151+
- Name: Managing worker nodes
152+
File: rosa-managing-worker-nodes
151153
- Name: About autoscaling nodes on a cluster
152154
File: nodes-about-autoscaling-nodes
153155
---

modules/cluster-autoscaler-about.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * machine_management/applying-autoscaling.adoc
44
// * post_installation_configuration/cluster-tasks.adoc
5+
// * nodes/nodes-about-autoscaling-nodes.adoc
56

67
:_content-type: CONCEPT
78
[id="cluster-autoscaler-about_{context}"]
@@ -11,7 +12,14 @@ The cluster autoscaler adjusts the size of an {product-title} cluster to meet it
1112

1213
The cluster autoscaler increases the size of the cluster when there are pods that fail to schedule on any of the current worker nodes due to insufficient resources or when another node is necessary to meet deployment needs. The cluster autoscaler does not increase the cluster resources beyond the limits that you specify.
1314

14-
The cluster autoscaler computes the total memory, CPU, and GPU on all nodes the cluster, even though it does not manage the control plane nodes. These values are not single-machine oriented. They are an aggregation of all the resources in the entire cluster. For example, if you set the maximum memory resource limit, the cluster autoscaler includes all the nodes in the cluster when calculating the current memory usage. That calculation is then used to determine if the cluster autoscaler has the capacity to add more worker resources.
15+
The cluster autoscaler computes the total
16+
ifndef::openshift-dedicated,openshift-rosa[]
17+
memory, CPU, and GPU
18+
endif::[]
19+
ifdef::openshift-dedicated,openshift-rosa[]
20+
memory and CPU
21+
endif::[]
22+
on all nodes the cluster, even though it does not manage the control plane nodes. These values are not single-machine oriented. They are an aggregation of all the resources in the entire cluster. For example, if you set the maximum memory resource limit, the cluster autoscaler includes all the nodes in the cluster when calculating the current memory usage. That calculation is then used to determine if the cluster autoscaler has the capacity to add more worker resources.
1523

1624
[IMPORTANT]
1725
====

modules/rosa-adding-instance-types.adoc

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
2-
3-
41
// Module included in the following assemblies:
52
//
63
// * nodes/nodes/rosa-managing-worker-nodes.adoc
@@ -14,6 +11,7 @@ After a machine pool is created, the instance type cannot be changed. To add a d
1411

1512
.Procedure
1613

14+
ifdef::openshift-rosa[]
1715
. To add an instance type with a new machine pool, enter the following command:
1816
+
1917
[source,terminal]
@@ -48,3 +46,16 @@ default No 2 m5.xlarge
4846
db-nodes-mp No 2 m5.xlarge app=db, tier=backend us-east-1a
4947
db-nodes-large-mp No 2 m5.2xlarge app=db, tier=backend us-east-1a
5048
----
49+
endif::[]
50+
51+
52+
ifdef::openshift-dedicated[]
53+
54+
. From the {cluster-manager-url}, navigate to the *Clusters* page and select the cluster that you want to configure.
55+
. On the selected cluster, select the *Machine pools* tab.
56+
. Click *Add a machine pool*.
57+
. Select a *Worker node instance type*.
58+
. Select the number nodes you want to add to the machine pool using the *Worker node count* field.
59+
. Optional. Under *Node labels*, add labels to the *Key* and *Value* fields.
60+
. Select *Add machine pool* to create a machine pool and save these changes.
61+
endif::[]

modules/rosa-adding-node-labels.adoc

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Currently, adding node labels on an existing machine pool adds the labels to onl
1818

1919
.Procedure
2020

21-
. To create a new machine pool, add the node labels, and create replica worker nodes, enter the following command:
21+
ifdef::openshift-rosa[]
22+
* To create a new machine pool, add the node labels, and create replica worker nodes, enter the following command:
2223
+
2324
[source,terminal]
2425
----
@@ -40,7 +41,7 @@ I: Machine pool 'db-nodes-mp' created successfully on cluster 'mycluster'
4041

4142
.Verification
4243

43-
. To verify that the machine pool, labels, and replicas were created, enter the following command:
44+
* To verify that the machine pool, labels, and replicas were created, enter the following command:
4445
+
4546
[source,terminal]
4647
----
@@ -54,3 +55,18 @@ ID AUTOSCALING REPLICAS INSTANCE TYPE LABELS TA
5455
default No 2 m5.xlarge us-east-1a
5556
db-nodes-mp No 2 m5.xlarge app=db, tier=backend us-east-1a
5657
----
58+
59+
endif::[]
60+
61+
62+
ifdef::openshift-dedicated[]
63+
64+
. From the {cluster-manager-url}, navigate to the *Clusters* page and select the cluster that you want to configure.
65+
. On the selected cluster, select the *Machine pools* tab.
66+
. Click *Add a machine pool*.
67+
. Select a *Worker node instance type*.
68+
. Select the number nodes you want to add to the machine pool using the *Worker node count* field.
69+
. Expand the *Edit node labels and taints* menu.
70+
. Under *Node labels*, add labels to the *Key* and *Value* fields.
71+
. Select *Add machine pool* to create a machine pool and save these changes.
72+
endif::[]

modules/rosa-scaling-worker-nodes.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Worker nodes can be scaled manually if you do not want to configure node autosca
1111

1212
.Procedure
1313

14+
ifdef::openshift-rosa[]
15+
1416
. To get a list of the machine pools in a cluster, enter the following command. Each cluster has a default machine pool that is created when you create a cluster.
1517
+
1618
[source,terminal]
@@ -48,3 +50,22 @@ The response output shows the number of worker nodes, or replicas, as `Compute`
4850
. Optional: To view this change in {cluster-manager-url}:
4951
.. Select the cluster.
5052
.. From the *Overview* tab, in the `Details` pane, review the `Compute` node number.
53+
54+
endif::[]
55+
56+
57+
ifdef::openshift-dedicated[]
58+
59+
. From the {cluster-manager-url}, navigate to the *Clusters* page and select the cluster that you want to scale worker nodes manually for.
60+
. On the selected cluster, select the *Machine pools* tab.
61+
. Click the Options menu {kebab} at the end of the machine pool that you want to manually scale, and select *Scale*.
62+
. On the *Edit node count* dialog, edit the node count.
63+
+
64+
[NOTE]
65+
====
66+
Your subscription determines the number of nodes you can select.
67+
====
68+
+
69+
. Select *Apply* to save these changes.
70+
71+
endif::[]

nodes/nodes-about-autoscaling-nodes.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,15 @@ ifdef::openshift-rosa[]
7070
include::modules/rosa-disabling-autoscaling-nodes.adoc[leveloffset=+2]
7171
endif::[]
7272

73+
Applying autoscaling to an {product-title} cluster involves deploying a cluster autoscaler and then deploying machine autoscalers for each machine type in your cluster.
74+
75+
[IMPORTANT]
76+
====
77+
You can configure the cluster autoscaler only in clusters where the Machine API is operational.
78+
====
79+
80+
include::modules/cluster-autoscaler-about.adoc[leveloffset=+1]
81+
7382
[role="_additional-resources"]
7483
[id="nodes-about-autoscaling-nodes-additional-resources"]
7584
== Additional resources

nodes/rosa-managing-worker-nodes.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: rosa-managing-worker-nodes
66
toc::[]
77

8-
This section describes how to manage worker nodes with {product-title} (ROSA).
8+
This section describes how to manage worker nodes with
9+
ifndef::openshift-rosa[]
10+
{product-title}.
11+
endif::[]
12+
ifdef::openshift-rosa[]
13+
{product-title} (ROSA).
14+
endif::[]
15+
916

1017
The majority of changes for worker nodes are configured on machine pools. A _machine pool_ is a group of worker nodes in a cluster that have the same configuration, providing ease of management. You can edit the configuration of worker nodes for options such as scaling, instance type, labels, and taints.
1118

@@ -19,4 +26,6 @@ include::modules/rosa-adding-instance-types.adoc[leveloffset=+1]
1926
* xref:../nodes/nodes-about-autoscaling-nodes.adoc#nodes-about-autoscaling-nodes[About autoscaling]
2027
* xref:../nodes/nodes-about-autoscaling-nodes.adoc#nodes-enabling-autoscaling-nodes[Enabling autoscaling]
2128
* xref:../nodes/nodes-about-autoscaling-nodes.adoc#nodes-disabling-autoscaling-nodes[Disabling autoscaling]
29+
ifdef::openshift-rosa[]
2230
* xref:../rosa_policy/rosa-service-definition.adoc#rosa-service-definition[ROSA Service Definition]
31+
endif::[]

0 commit comments

Comments
 (0)