feat: machine autoscaler documentation (#2754)

* feat: machine autoscaler documentation

Signed-off-by: dkwon17 <[email protected]>

* Update modules/administration-guide/pages/configuring-autoscaling.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Fix PR feedback

Signed-off-by: dkwon17 <[email protected]>

* Remove passive voice

Signed-off-by: dkwon17 <[email protected]>

---------

Signed-off-by: dkwon17 <[email protected]>
Co-authored-by: Jana Vrbkova <[email protected]>

modules/administration-guide/nav.adoc

@@ -37,7 +37,9 @@
 ** xref:configuring-server-components.adoc[]
 *** xref:mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container.adoc[]
 *** xref:advanced-configuration-options-for-the-che-server-component.adoc[]
+** xref:configuring-autoscaling.adoc[]
 *** xref:configuring-number-of-replicas.adoc[]
+*** xref:configuring-machine-autoscaling.adoc[]
 ** xref:configuring-workspaces-globally.adoc[]
 *** xref:limiting-the-number-of-workspaces-that-a-user-can-keep.adoc[]
 *** xref:enabling-users-to-run-multiple-workspaces-simultaneously.adoc[]

modules/administration-guide/pages/configuring-autoscaling.adoc

@@ -0,0 +1,13 @@
+:_content-type: ASSEMBLY
+:description: Configuring autoscaling
+:keywords: administration-guide, configuring, autoscaling, autoscale, horizontal, scaling, machine
+:navtitle: Configuring autoscaling
+:page-aliases:
+
+[id="configuring-autoscaling"]
+= Configuring autoscaling
+
+Learn about different aspects of autoscaling for {prod}.
+
+* xref:configuring-number-of-replicas.adoc[]
+* xref:configuring-machine-autoscaling.adoc[]

modules/administration-guide/pages/configuring-machine-autoscaling.adoc

@@ -0,0 +1,65 @@
+:_content-type: PROCEDURE
+:description: Configuring machine autoscaling
+:keywords: administration guide, machine, autoscaling, scaling
+:navtitle: Configuring machine autoscaling
+:page-aliases:
+
+[id="configuring-machine-autoscaling"]
+= Configuring machine autoscaling
+
+If you configured the cluster to adjust the number of nodes depending on resource needs, you need additional configuration to maintain the seamless operation of {prod-short} workspaces.
+
+Workspaces need special consideration when the autoscaler adds and removes nodes.
+
+When a new node is being added by the autoscaler, workspace startup can take longer than usual until the node provisioning is complete.
+
+Conversely when a node is being removed, ideally nodes that are running workspace pods should not be evicted by the autoscaler to avoid any interruptions while using the workspace and potentially losing any unsaved data.
+
+== When the autoscaler adds a new node
+You need to make additional configurations to the {prod-short} installation to ensure proper workspace startup while a new node is being added.
+
+.Procedure
+
+. In the CheCluster Custom Resource, set the `spec.devEnvironments.startTimeoutSeconds` field to at least 600 seconds to allow time for a new node to be provisioned when needed during workspace startup.
++
+[source,yaml,subs="+quotes,+attributes"]
+----
+spec:
+  devEnvironments:
+    startTimeoutSeconds: 600
+----
+
+. In the DevWorkspaceOperatorConfig Custom Resource in the {prod-namespace} namespace, add the `FailedScheduling` event to the `config.workpsace.ignoredUnrecoverableEvents` field. This allows the workspace startup to not fail if not enough nodes are available. When the new node is provisioned, this allows the workspace startup to continue. 
++
+[source,yaml,subs="+quotes,+attributes"]
+----
+config:
+  workspace:
+    ignoredUnrecoverableEvents:
+    - FailedScheduling
+----
+
+== When the autoscaler removes a node
+To prevent workspace pods from being evicted when the autoscaler needs to remove a node, add the `"cluster-autoscaler.kubernetes.io/safe-to-evict": "true"` annotation to every workspace pod.
+
+.Procedure
+
+. In the CheCluster Custom Resource, add the `cluster-autoscaler.kubernetes.io/safe-to-evict: "true"` annotation in the `spec.devEnvironments.workspacesPodAnnotations` field.
++
+[source,yaml,subs="+quotes,+attributes"]
+----
+spec:
+  devEnvironments:
+    workspacesPodAnnotations:
+      cluster-autoscaler.kubernetes.io/safe-to-evict: "true"
+----
+
+.Verification steps
+
+. Start a workspace and verify that the workspace pod contains the `cluster-autoscaler.kubernetes.io/safe-to-evict: "true"` annotation.
++
+[subs="+attributes,+quotes"]
+----
+$ {orch-cli} get pod __<workspace_pod_name>__ -o jsonpath='{.metadata.annotations.cluster-autoscaler\.kubernetes\.io/safe-to-evict}'
+true
+----