Skip to content

Commit 7a4a29d

Browse files
EricPonvelleEricPonvelle
authored
Merge pull request #62651 from aldiazRH/OSDOCS-6133
[OSDOCS-6133] ROSA OSD UI cluster autoscaling
2 parents ca10b2a + c51d198 commit 7a4a29d

File tree

7 files changed

+207
-0
lines changed

7 files changed

+207
-0
lines changed

‎_topic_maps/_topic_map_osd.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,8 @@ Topics:
202202
Topics:
203203
- Name: Accessing the service logs
204204
File: osd-accessing-the-service-logs
205+
# - Name: Cluster autoscaling
206+
# File: osd-cluster-autoscaling
205207
---
206208
Name: Security and compliance
207209
Dir: security

‎_topic_maps/_topic_map_rosa.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,8 @@ Topics:
296296
Distros: openshift-rosa
297297
- Name: About autoscaling nodes on a cluster
298298
File: rosa-nodes-about-autoscaling-nodes
299+
# - Name: Cluster autoscaling
300+
# File: rosa-cluster-autoscaling
299301
---
300302
Name: Security and compliance
301303
Dir: security

‎modules/rosa-cluster-autoscaler-settings.adoc‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_cluster_admin/rosa-cluster-autoscaling.adoc
4+
:_content-type: REFERENCE
5+
[id="rosa-cluster-autoscale-settings_{context}"]
6+
= Cluster autoscaling settings using OpenShift Cluster Manager
7+
8+
The tables explain all the configurable UI settings when using cluster autoscaling with OpenShift Cluster Manager.
9+
10+
== Balancing behavior
11+
12+
[cols="4",options="header"]
13+
|===
14+
|Setting
15+
|Description
16+
|Type or Range
17+
|Default
18+
19+
|`balanceSimilarNodeGroups`
20+
|If `true`, this setting automatically identifies node groups with the same instance type and the same set of labels and tries to keep the respective sizes of those node groups balanced.
21+
|`boolean`
22+
|false
23+
24+
|`logVerbosity`
25+
|Sets the autoscaler log level. Default value is 1, level 4 is recommended for debugging and level 6 enables almost everything.
26+
|`integer`
27+
|1
28+
29+
|`maxPodGracePeriod`
30+
|Gives pods graceful termination time before scaling down.
31+
|`integer`
32+
|600
33+
34+
|`skipNodesWithLocalStorage`
35+
|If `true`, the cluster autoscaler never deletes nodes with pods with local storage, e.g. EmptyDir or HostPath.
36+
|`boolean`
37+
|true
38+
|===
39+
40+
== Resource limits
41+
42+
[cols="4",options="header"]
43+
|===
44+
|Setting
45+
|Description
46+
|Type or Range
47+
|Default
48+
49+
|`maxNodesTotal`
50+
|Maximum number of nodes in all node groups. Includes all nodes, not just automatically scaled nodes. The cluster autoscaler does not grow the cluster beyond this number.
51+
|`integer`
52+
|0
53+
54+
|`cores.min`
55+
|Minimum number of cores in cluster. The cluster autoscaler does not scale the cluster beyond these numbers.
56+
|`object`
57+
|1
58+
59+
|`cores.max`
60+
|Maximum number of cores in cluster. The cluster autoscaler does not scale the cluster beyond these numbers.
61+
|`object`
62+
|320000
63+
64+
|`memory.min`
65+
|Minimum number of gigabytes of memory in cluster. The cluster autoscaler does not scale the cluster beyond these numbers.
66+
|`object`
67+
|1
68+
69+
|`memory.max`
70+
|Maximum number of gigabytes of memory in cluster. The cluster autoscaler does not scale the cluster beyond these numbers.
71+
|`object`
72+
|6400000
73+
|===
74+
75+
== Scale down configuration
76+
77+
[cols="4",options="header"]
78+
|===
79+
|Setting
80+
|Description
81+
|Type or Range
82+
|Default
83+
84+
|`enable`
85+
|Should the cluster autoscaler scale down the cluster.
86+
|`boolean`
87+
|`true`
88+
89+
|`scaleDown.unneededTime`
90+
|How long a node should be unneeded before it is eligible for scale down.
91+
|`string`
92+
|10m
93+
94+
|`scaleDown.utilizationThreshold`
95+
|Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down.
96+
|`string`
97+
|0.5
98+
99+
|`scaleDown.delayAfterAdd`
100+
|How long after scale up that scale down evaluation resumes.
101+
|`string`
102+
|10m
103+
104+
|`scaleDown.delayAfterDelete`
105+
|How long after node deletion that scale down evaluation resumes.
106+
|`string`
107+
|0s
108+
109+
|`scaleDown.delayAfterFailure`
110+
|How long after scale down failure that scale down evaluation resumes.
111+
|`string`
112+
|3m
113+
|===

‎modules/rosa-cluster-autoscaler-ui-after.adoc‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_cluster_admin/rosa-cluster-autoscaling.adoc
4+
:_content-type: REFERENCE
5+
[id="rosa-cluster-autoscale-ui-after_{context}"]
6+
= Enable autoscaling after cluster creation with OpenShift Cluster Manager
7+
8+
You can use OpenShift Cluster Manager to autoscale after cluster creation.
9+
10+
.Procedure
11+
12+
. In OpenShift Cluster Manager, click the name of the cluster you want to autoscale. The Overview page for the cluster has a *Autoscaling* item that indicates if it is enabled or disabled.
13+
14+
. Click the *Machine Pools* tab.
15+
16+
. Click the *Edit cluster autoscaling* button. The *Edit cluster autoscaling* settings window is shown.
17+
18+
. Check the *Enable cluster autoscaling* box at the top of the window. All the settings are now editable.
19+
20+
. Edit any settings you want and then click *Save*.
21+
22+
. Click the x at the top right of the screen to close the settings window.
23+
24+
To revert all autoscaling settings to the defaults if they have been changed, click the *Revert all to defaults* button.

‎modules/rosa-cluster-autoscaler-ui-during.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * rosa_cluster_admin/rosa-cluster-autoscaling.adoc
4+
:_content-type: REFERENCE
5+
[id="rosa-cluster-autoscale-ui-during_{context}"]
6+
= Enable autoscaling during cluster creation with OpenShift Cluster Manager
7+
8+
You can use OpenShift Cluster Manager to autoscale during cluster creation.
9+
10+
.Procedure
11+
12+
. During cluster creation, check the *Enable autoscaling* box. The *Edit cluster autoscaling settings* button becomes selectable.
13+
14+
.. You can also choose the minimum or maximum amount of nodes to autoscale.
15+
16+
. Click *Edit cluster autoscaling settings*.
17+
18+
. Edit any settings you want and then click *Close*.

‎osd_cluster_admin/osd-cluster-autoscaling.adoc‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:_content-type: ASSEMBLY
2+
[id="osd-cluster-autoscaling"]
3+
= Cluster autoscaling
4+
include::_attributes/attributes-openshift-dedicated.adoc[]
5+
:context: osd-cluster-autoscaling
6+
7+
toc::[]
8+
9+
Applying autoscaling to {product-title} clusters involves configuring a cluster autoscaler and then configuring a machine autoscaler for at least one machine pool in your cluster.
10+
11+
[IMPORTANT]
12+
====
13+
You can configure the cluster autoscaler only in clusters where the machine API is operational.
14+
+
15+
Only one cluster autoscaler can be created per cluster.
16+
====
17+
18+
include::modules/cluster-autoscaler-about.adoc[leveloffset=+1]
19+
20+
include::modules/rosa-cluster-autoscaler-ui-during.adoc[leveloffset=+1]
21+
22+
include::modules/rosa-cluster-autoscaler-ui-after.adoc[leveloffset=+1]
23+
24+
include::modules/rosa-cluster-autoscaler-settings.adoc[leveloffset=+1]

‎rosa_cluster_admin/rosa-cluster-autoscaling.adoc‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:_content-type: ASSEMBLY
2+
[id="rosa-cluster-autoscaling"]
3+
= Cluster autoscaling
4+
include::_attributes/attributes-openshift-dedicated.adoc[]
5+
:context: rosa-cluster-autoscaling
6+
7+
toc::[]
8+
9+
Applying autoscaling to {product-title} clusters involves configuring a cluster autoscaler and then configuring a machine autoscaler for at least one machine pool in your cluster.
10+
11+
[IMPORTANT]
12+
====
13+
You can configure the cluster autoscaler only in clusters where the machine API is operational.
14+
+
15+
Only one cluster autoscaler can be created per cluster.
16+
====
17+
18+
include::modules/cluster-autoscaler-about.adoc[leveloffset=+1]
19+
20+
include::modules/rosa-cluster-autoscaler-ui-during.adoc[leveloffset=+1]
21+
22+
include::modules/rosa-cluster-autoscaler-ui-after.adoc[leveloffset=+1]
23+
24+
include::modules/rosa-cluster-autoscaler-settings.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)