-
Notifications
You must be signed in to change notification settings - Fork 164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: machine autoscaler documentation #2754
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
modules/administration-guide/pages/configuring-autoscaling.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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[] |
65 changes: 65 additions & 0 deletions
65
modules/administration-guide/pages/configuring-machine-autoscaling.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
@@ -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 | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
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 | ||||||||
---- |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.