Update CC goal documentation #9678
Merged
Conversation
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
Signed-off-by: Kyle Liberti <kliberti@redhat.com>
kyguy
requested review from
PaulRMellor,
ShubhamRwt,
ppatierno,
scholzj and
fvaleri
scholzj
reviewed
Feb 12, 2024
| @@ -61,7 +61,7 @@ Resource distribution goals are subject to link:{BookURLConfiguring}#property-cr | |||
| == Hard and soft optimization goals | |||
|
|
|||
| Hard goals are goals that _must_ be satisfied in optimization proposals. | |||
| Goals that are not configured as hard goals are known as _soft goals_. | |||
| Goals that are not hard coded as _hard goals_ in Cruise Control are known as _soft goals_. | |||
There was a problem hiding this comment.
Suggested change
| Goals that are not hard coded as _hard goals_ in Cruise Control are known as _soft goals_. | |
| Goals that are not defined as _hard goals_ in Cruise Control code are known as _soft goals_. |
| @@ -71,16 +71,21 @@ An optimization proposal that does _not_ satisfy all the hard goals is rejected | |||
| NOTE: For example, you might have a soft goal to distribute a topic's replicas evenly across the cluster (the topic replica distribution goal). | |||
| Cruise Control will ignore this goal if doing so enables all the configured hard goals to be met. | |||
|
|
|||
| In Cruise Control, the following xref:main-goals[main optimization goals] are preset as hard goals: | |||
| In Cruise Control, the following xref:main-goals[main optimization goals] are hard coded as hard goals: | |||
There was a problem hiding this comment.
Suggested change
| In Cruise Control, the following xref:main-goals[main optimization goals] are hard coded as hard goals: | |
| In Cruise Control, the following xref:main-goals[main optimization goals] are hard goals: |
Signed-off-by: Kyle Liberti <kliberti@redhat.com>
PaulRMellor
approved these changes
Feb 13, 2024
documentation/modules/cruise-control/con-optimization-goals.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/cruise-control/con-optimization-goals.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/cruise-control/con-optimization-goals.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/cruise-control/con-optimization-goals.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/cruise-control/con-optimization-goals.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Kyle Liberti <kliberti@redhat.com>
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Kyle Liberti <kliberti@redhat.com>
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Kyle Liberti <kliberti@redhat.com>
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Kyle Liberti <kliberti@redhat.com>
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Kyle Liberti <kliberti@redhat.com>
scholzj
approved these changes
Feb 13, 2024
ShubhamRwt
approved these changes
Feb 14, 2024
PaulRMellor
approved these changes
Feb 14, 2024
documentation/modules/cruise-control/con-optimization-goals.adoc
Outdated
Show resolved
Hide resolved
documentation/modules/cruise-control/con-optimization-goals.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Kyle Liberti <kliberti@redhat.com>
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Kyle Liberti <kliberti@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Type of change
Description
Following up the discussion from here [1] and here [2] we have a misunderstanding of how the
hard.goalsconfiguration works in Cruise Control. We cannot configure whether a goal is a "soft goal" or a "hard goal". Thehard.goalsconfiguration only allows us to specify which goals will be enforced to run by Cruise Control.For example, if
NetworkInboundCapacityGoalis not specified indefault.goalslist but specified in thehard.goalslist, Cruise Control will throw an error. In order to ensureNetworkInboundCapacityGoalis not run, it must be removed fromdefault.goalsandhard.goalslists. Cruise Control hard codes which goals are "hard" and which are "soft" (e.g.NetworkInboundCapacityGoalis hard coded as a "hard goal", we cannot configure it as a "soft goal"). Therefore, if a hard goal is listed in thedefault.goalslist, it will prevent a optimization proposal from being generated if it is not satisfied.This PR updates the documentation to reflect this information.
[1] https://github.com/orgs/strimzi/discussions/9546
[2] linkedin/cruise-control#2111
Checklist
Please go through this checklist and make sure all applicable tasks have been done