feat: machine autoscaler documentation #2754
Conversation
Signed-off-by: dkwon17 <dakwon@redhat.com>
|
🎊 Navigate the preview: https://668d6baa3693aba70a089f74--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
@deerskindoll we need it for 3.15 as well |
modules/administration-guide/pages/configuring-autoscaling.adoc
Outdated
Show resolved
Hide resolved
| [id="configuring-autoscaling"] | ||
| = Configuring autoscaling | ||
|
|
||
| This section describes different aspects of autoscaling for {prod}. |
There was a problem hiding this comment.
which docs do you want to link here? configuring machine autoscaling and configuring number of replicas?
There was a problem hiding this comment.
Yes, I've added them in my latest commit
| [id="configuring-machine-autoscaling"] | ||
| = Configuring machine autoscaling | ||
|
|
||
| If a cluster has been configured to adjust the number of cluster nodes depending on resource needs, additional configuration is required to maintain the seamless operation of workspaces. |
There was a problem hiding this comment.
I've got some bad news. One of us will have to edit this procedure to get rid of the passive voice and replace it with a more action-oriented phrasing (e.g. "additional configuration is required" x "you must add configuration") . It will make the text flow better.
Do you want to do it or should I?
There was a problem hiding this comment.
@deerskindoll , I see, I can make a new commit
There was a problem hiding this comment.
Updated to:
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.
There was a problem hiding this comment.
That looks great! But now you have to tackle the other instances of passive voice, too. That's why I wrote that one of us has to update the whole procedure.
There was a problem hiding this comment.
Sounds good, I've made another commit to remove the passive voice, but please feel free to make more changes where appropriate
Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
|
|
||
| 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 |
There was a problem hiding this comment.
| == When the autoscaler adds a new node | |
| .When the autoscaler adds a new node | |
| - FailedScheduling | ||
| ---- | ||
|
|
||
| == When the autoscaler removes a node |
There was a problem hiding this comment.
| == When the autoscaler removes a node | |
| .When the autoscaler removes a node | |
* feat: machine autoscaler documentation Signed-off-by: dkwon17 <dakwon@redhat.com> * Update modules/administration-guide/pages/configuring-autoscaling.adoc Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com> * Fix PR feedback Signed-off-by: dkwon17 <dakwon@redhat.com> * Remove passive voice Signed-off-by: dkwon17 <dakwon@redhat.com> --------- Signed-off-by: dkwon17 <dakwon@redhat.com> Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
What does this pull request change?
Adds machine autoscaler documentation.
A new section called
Configuring autoscalinghas been added:I've also moved the
Configuring number of replicas for a Eclipse Che containerpage to the newConfiguring autoscalingsectionWhat issues does this pull request fix or reference?
https://issues.redhat.com/browse/CRW-6590
Specify the version of the product this pull request applies to
Che 7.88 / Dev Spaces 3.15
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.