Correct comment for AtomicIncreaseSize method #7106
Conversation
k8s-ci-robot
added
the
kind/documentation
k8s-ci-robot
added
area/cluster-autoscaler
cncf-cla: yes
k8s-ci-robot
added
the
size/S
| // - If the method returns nil, it guarantees that delta instances will be added to the node group | ||
| // within its MaxNodeProvisionTime. The function should wait until node group size is updated. | ||
| // The cloud provider is responsible for tracking and ensuring successful scale up asynchronously. | ||
| // - If the method returns nil, it guarantees that either delta instances will be added to the node group |
There was a problem hiding this comment.
I'd remove the phrasing with 'guarantee'.
We can't really have a guarantee that all nodes will register successfully until they do, and caller of this method should be able to handle this case later on (and cluster autoscaler does so, cleaning up the instances as usual).
Maybe sth like:
"AtomicIncreaseSize tries to increase the size of the node group atomically. It returns error if requesting the entire delta fails. The method doesn't wait until the new instances appear.
Implementation is optional. Implementation of this method generally requires external cloud provider support for atomically requesting multiple instances. If implemented, CA will < insert the rest of the description > "
?
There was a problem hiding this comment.
SGTM, done
yaroslava-serdiuk
force-pushed
the
atomic-comment
branch
from
abf65a1
to
f531544
Compare
yaroslava-serdiuk
force-pushed
the
atomic-comment
branch
from
f531544
to
0b26c35
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: aleksandra-malinowska, yaroslava-serdiuk The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
What type of PR is this?
/kind documentation
Fixes #6856