-
Notifications
You must be signed in to change notification settings - Fork 468
[FLINK-33634] Add Conditions to Flink CRD's Status field #957
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
base: main
Are you sure you want to change the base?
Conversation
@lajith2006 please could you fill in a descriptive title next to the Jira number |
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.
removed comment
@lajith2006 this implementation does not match the Flip words and has not been discussed in the slack thread, please can you update the discussion thread to ensure that you get consensus, and confirm that the Flip vote still is valid after this change. |
} else if (getJobStatus() != null && getJobStatus().getState() != null) { | ||
switch (getJobStatus().getState()) { | ||
case RECONCILING: | ||
phase = "Pending"; |
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.
why is this one not RECONCILING like the pattern the others follow others? I suggest a comment, also a constant is better then a an inline literal.
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.
Right, as mentioned here , phase
which is intended to keep the current status of FlinkDeployment especially useful in Openshift environment, as Openshift UI can render the value from status.phase
and populate the current status of deployment.
As when FlinkDeployment applied in Application Mode, in the initial phase, as the JM brining up , job state would be in RECONCILING
state, so status.phase is kept as "Pending".
updateCondition( | ||
conditions, | ||
ConditionUtils.runningTrue( | ||
"JobManager is running and ready to receive REST API call", |
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.
nit: call -> calls
if (reconciliationStatus != null | ||
&& reconciliationStatus.deserializeLastReconciledSpec() != null | ||
&& reconciliationStatus.deserializeLastReconciledSpec().getJob() == null) { | ||
switch (jobManagerDeploymentStatus) { |
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.
can we have a datastructure, keyed off the jobManagerDeploymentStatus, that we interrogate to get the inserts for the updateConditions. Maybe a map with the key of the status and the value of an object RunningCondition, that has 2 fields the boolean and the description. Something like :
Map<JobManagerDeploymentStatus,String> jobmanagerDeploymentStatusMap = new HashMap<String,String>() {{
put(READY, new RunningCondition(true, "JobManager is running and ready to receive REST API calls")),
....
}};
then the code just loops through the map updating conditions using the map values. Similar for jobstatus
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.
Wondering will that add any value?. Any way to build the Map , we have to call ConditionUtils
to build the Condition, so rather than have a Prebuild Map , we can directly call ConditionUtils
to build them right. Your thoughts?.
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.
I think you have pre built the map now - with map.of - looks good - thanks.
conditions, | ||
ConditionUtils.runningFalse( | ||
JobStatus.RESTARTING.name(), | ||
"The job is currently undergoing a restarting")); |
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.
nit: "The job is currently undergoing a restarting" -> "The job is currently restarting"
private String phase; | ||
|
||
public List<Condition> getConditions() { | ||
if (reconciliationStatus != null |
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.
I am curious which parts of the code refer to application mode and which are session cluster. It would be good to have some comments to detail this and maybe use the mode name in method name or variable names to make this more intuitive to read.
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.
I will add comments in the respective code.
conditions, | ||
ConditionUtils.runningFalse( | ||
"JobManager process is starting up", | ||
"JobManager process is starting up")); |
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.
I am curious why the message and reaon is the same . I would expect them to be different. In this case I would expect the reason to be "A New JVM deployment exists and is being created" - i.e. the word on the arrow in the UML.
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.
As per description here which says Reason is intended to be a one-word, CamelCase representation of the category of cause of the current status, and Message is intended to be a human-readable phrase or sentence
, I would use the existing enum https://github.com/apache/flink-kubernetes-operator/blob/main/flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/status/JobManagerDeploymentStatus.java, to use as reason and respective explanation as message
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.
I see https://github.com/apache/flink-kubernetes-operator/pull/961/files, gives examples of camelcase single words reasons. We should follow that style for the cases that PR does not cover.
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.
Done a refactoring for the conditions.
@@ -448,6 +465,15 @@ public void verifyUpgradeFromSavepointLegacyMode(FlinkVersion flinkVersion) thro | |||
assertEquals( | |||
"savepoint_1", appCluster.getStatus().getJobStatus().getUpgradeSavepointPath()); | |||
|
|||
// Validate status conditions |
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.
can we use a java parameterized test (or more than one as appropriate) to cover all the permutations of the tests.
import java.util.Date; | ||
|
||
/** | ||
* Creates a condition object with the specified parameters. |
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.
nit: with the specified parameters -> whether this is running , the message and the reason.
then for return just say @return A condition
*/ | ||
public class ConditionUtils { | ||
public static Condition runningTrue(final String message, final String reason) { | ||
return crCondition("Running", "True", message, reason); |
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.
no need to pass "Running" as a parameter, we can hard code that in the method,
nit: rename crCondition -> crRunningCondition
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.
I would like to keep method name as crCondition
rather crRunningCondition
, just because , crCondition
will keep it as more generic , so that if in case, if we need to address any other condition with type
other than Running
, we just need to pass parameter to build respective condition.
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.
I suggest doing that refactor when we need to, in the spirit of keeping the code lean.
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.
@davidradl There were some refactoring done on this class.
} | ||
|
||
public static Condition runningFalse(final String message, final String reason) { | ||
return crCondition("Running", "False", message, reason); |
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.
are there constants / enums for "False" and "True" we can use?
Os there an existing constant for "Running" we can use from OCP or the like. If not we should define this as a constant. We use this literal a few times in this change.
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.
I haven't see any existing enum/constants for "False" / "True , instead looks like used as string itself in wherever required in existing code.
Would it be useful also to set also observedGeneration on the conditions, I believe it is in general a good practice. |
&& existingCondition.getMessage().equals(condition.getMessage())) { | ||
return; | ||
} | ||
conditions.add(condition); |
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.
It's maybe just me, just don't get how this list is truncated eventually, in other words, how is it prevented from growing indefinitely?
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.
Thanks for review @csviri . Right now it's not preventing from growing indefinitely. As conditions reflects the different transitions state of Job/Deployment , thinking what could be the use case where can grow indefinitely?.
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.
I think there should only ever be a single condition of type Running
in the list that we return. Since we only have a single condition type right now, then the list should only have a single element. The latestTransition timestamp needs to represent when running changed from true->false or false->true. We can however keep updating the message if we want.
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.
Thanks @gyfora for review , If I read correctly , you meant that we need to have only condition in the list at right now as we have only one type Running
instead of multiple conditions of same type Running
in the list as currently this PR having. And the lastTransitionTime
in the condition must represent when the Running
type changed its status from true>false or false > true. Is that correct?.
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.
@lajith2006 you say the lastTransitionTime in the condition must represent when the Running type changed its status from true>false or false > true. Is that correct?.
So I am curious what happens in the history if we change the reason Text? Can you check that if we change the reason text and not the running flag, we see all of the entries in the history if all the historical conditions have the same lastTransitionTime with changing reasons.
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.
Yes @lajith2006 , there should be a single condition of type Running and lastTransitionTime when that changed
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.
Thanks for clarification @gyfora
So just to be align with what you have mentioned , for an example , when we do an application cluster deployment, as Job cycles goes through CREATED>RUNNING
initially conditions will have as below
status
conditions:
- type: Running
status: "False"
reason: Job is created
message: "Job is newly created, no task has started to run"
lastTransitionTime: 2025-04-030T06:17:08Z
And then when the Job starts running at 2025-04-030T06:19:01Z
, condition will have as below
status
conditions:
- type: Running
status: "True"
reason: Job is running
message: "Job is running"
lastTransitionTime: 2025-04-030T06:19:01Z
and then later at 2025-04-030T07:00:01Z
. when job gets finished , condition will have as below.
status
conditions:
- type: Running
status: "False"
reason: Job's tasks have successfully finished
message: Job's tasks have successfully finished
lastTransitionTime: 2025-04-030T07:00:01Z
which means ideally we will not have an history in the condition when the Job goes through different job lifecycle , instead only single condition and lastTransitionTime will reflect when the status was changed.
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.
Yes, I think this makes sense for a Running
condition
&& reconciliationStatus.deserializeLastReconciledSpec().getJob() == null) { | ||
// Populate conditions for SessionMode deployment | ||
switch (jobManagerDeploymentStatus) { | ||
case READY: |
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.
instead of this switch can we just issue
updateCondition(
conditions,
ConditionUtils.crCondition(
ConditionUtils.SESSION_MODE_CONDITION.get(
jobManagerDeploymentStatus.name())));
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.
@davidradl this has been revisited and made it simple by removing switch.
} | ||
} else if (getJobStatus() != null && getJobStatus().getState() != null) { | ||
// Populate conditions for ApplicationMode deployment | ||
switch (getJobStatus().getState()) { |
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.
can this switch as-is be replaced with
updateCondition(
conditions,
ConditionUtils.crCondition(
ConditionUtils.APPLICATION_MODE_CONDITION.get(
getJobStatus().getState().name())));
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.
I was thinking exactly the same here @lajith2006
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.
Yes, @gyfora and @davidradl this has been revisited and addressed by removing switch and made it simple.
.withType("Running") | ||
.withStatus("True") | ||
.withMessage("Ready") | ||
.withReason("JobManager is running and ready to receive REST API calls") |
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.
isn't the reason - how it got to this state, not a description of the state itself?
https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-conditions
it says:
reason | Machine-readable, UpperCamelCase text indicating the reason for the condition's last transition.
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.
@davidradl this has been updated and reason as is made as one-word, CamelCase representation of current status.
&& reconciliationStatus.deserializeLastReconciledSpec() != null | ||
&& reconciliationStatus.deserializeLastReconciledSpec().getJob() == null) { |
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.
We should avoid deserializing twice here, could we simply check the job status instead?
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.
Sure will use JobStatus.
@lajith2006 , I think we should try to somehow try to wrap this PR up. We have been going back and forth on this for months, a lot of reviews, different people involved (many unaddressed comments from @davidradl). This is a significant time investment from all involved. Overall I feel that you need to iterate over the changes once more and try to eliminate the parts that were added with a much more complex design in mind, and just simplify the methods, eliminate the large switch statements etc. I would love to include this in the upcoming release but for that we need to merge it by the end of next week. |
ConditionUtils.crCondition( | ||
ConditionUtils.SESSION_MODE_CONDITION.get( | ||
jobManagerDeploymentStatus.name()))); | ||
} else if (jobStatus != null) { |
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.
nit: } else if (jobStatus != null) {
-> else {
if (existingCondition.isPresent()) { | ||
return; | ||
} | ||
// Remove existing Condition with type running and then add a new condition that |
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.
nit: the comment is not quite right I think.
I suggest this comment be
// Remove existing Condition with type running if not the same as the new condition
then add a new condition that reflects the current state.
should be after the if
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.
It's been refactored..
conditions.removeIf( | ||
c -> | ||
c.getType().equals(CONDITION_TYPE_RUNNING) | ||
&& !c.getMessage().equals(newCondition.getMessage()) |
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.
we have got here because the new condition is not the same as the existing condition. So we should just remove the existing condition without any conditions.
As-is the condition will not be removed if existing condition message or reason matches the new condition; which is not correct.
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.
So we should just remove the existing condition without any conditions.
Right its fine for now, But I think, if in later point of time, if we are adding new conditions other than Running, just removing the existing condition without of any check will cause an issue.
As-is the condition will not be removed if existing condition message or reason matches the new condition; which is not correct.
That's right, but for Running type , we don't have any such case were reason or message can be matched with existing condition.
if (getJobStatus() != null) { | ||
JobStatus jobStatus = getJobStatus().getState(); | ||
if (jobStatus == null) { | ||
// Populate conditions for SessionMode deployment | ||
updateCondition( | ||
conditions, | ||
ConditionUtils.crCondition( | ||
ConditionUtils.SESSION_MODE_CONDITION.get( | ||
jobManagerDeploymentStatus.name()))); | ||
} else if (jobStatus != null) { | ||
// Populate conditions for ApplicationMode deployment | ||
updateCondition( | ||
conditions, | ||
ConditionUtils.crCondition( | ||
ConditionUtils.APPLICATION_MODE_CONDITION.get(jobStatus.name()))); | ||
} | ||
} |
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.
I think this entire code block should be part of the ConditionUtils probably encapsulated into a single:
ConditionUtils. updateCondition(status)
method.
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.
Thanks @gyfora . I believe , If we have them in ConditionUtils block, we will not be able to utilise the jobManagerDeploymentStatus
ConditionUtils. Please Correct me if I am wrong.
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.
This could be implemented as a static method that operates on the status
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.
This could be implemented as a static method that operates on the status
@gyfora Yes - we were thinking changing to something like
if (getJobStatus() != null) {
JobStatus jobStatus = getJobStatus().getState();
Condition conditionToAdd = null;
if (jobStatus == null) {
// Populate conditions for SessionMode deployment
conditionToAdd =
ConditionUtils.SESSION_MODE_CONDITION.get(
jobManagerDeploymentStatus.name());
} else {
// Populate conditions for ApplicationMode deployment
conditionToAdd =
ConditionUtils.APPLICATION_MODE_CONDITION.get(jobStatus.name());
}
conditions = ConditionsUtils.createListOfConditions(conditionToAdd);
}
Can you see a slicker way of doing this given we need jobManagerDeploymentStatus.name()
for session and jobStatus.name()
for application mode - which we know at this level. We could add a ternary if, I am not too worried about this.
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.
I just wanted to factor out this condition logic from the FlinkDeploymentStatus class, it doesn't seem to belong there. I don't have an issue with he logic itself
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.
Moved logic to ConditionUtils
if (newCondition.getType().equals(CONDITION_TYPE_RUNNING)) { | ||
Optional<Condition> existingCondition = | ||
conditions.stream() | ||
.filter( | ||
c -> | ||
c.getType().equals(CONDITION_TYPE_RUNNING) | ||
&& c.getReason() | ||
.equals(newCondition.getReason()) | ||
&& c.getMessage() | ||
.equals(newCondition.getMessage())) | ||
.findFirst(); | ||
// Until there is a condition change which reflects the latest state, no need to add | ||
// condition to list. | ||
if (existingCondition.isPresent()) { | ||
return; | ||
} | ||
// Remove existing Condition with type running and then add a new condition that |
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.
Honestly I don't get this whole logic here.
We should have a single condition at the moment of type RUNNING. So a at any point in time we either have a SingletonList or empty list.
Can we simply always update the list to List.of(newCondition) + update the transition timestamp if the value changed from true->false or vice versa.
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.
@davidradl @lajith2006 am I missing something ?
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.
@gyfora I talked with @lajith2006. His code originally was wanting to handle more than one condition and manage the existing list to prevent 2 running conditions being in the list.
We agreed to keep it simple and amend this code as you suggest i.e. just add a new list with one running condition. We thought the transition time should also be updated if the message changes, as there are cases in the flow diagram in the Flip where the running condition remains false, but the message changes, in this case we think that we should update the transition time WDYT?
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.
lastTransitionTime time should refer to the time when the status changes (true -> false or false->true) at least this is how it is used everywhere I know and everywhere I find online. Changed message alone should not update the timestamp as it would break the semantics and makes it impossible to tell when the job actually stopped running for example.
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.
Thanks @gyfora , modified in such a way that lastTransitionTimeStamp
gets updated when status changes from true> false or vice versa.
.withMessage("JobManager deployment failed") | ||
.build()); | ||
|
||
public static final Map<String, Condition> APPLICATION_MODE_CONDITION = |
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.
To me this entire mapping feels like that it should be replaced with a method,
return new ConditionBuilder()
.withType(CONDITION_TYPE_RUNNING)
.withStatus(status == RUNNING ? "True" : "False")
.withReason(status.name())
.withMessage("Job state " + status.name)
.build()
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.
Thanks, I have a them in method. As reason is expected to be in camelcase, I have added a method to make it as camecase from status.name().
.withStatus("True") | ||
.withReason("JobManagerReady") | ||
.withMessage( | ||
"JobManager is running and ready to receive REST API calls") |
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.
May be a better design to add this fields into the enum directly then simply get it from it.
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.
Thanks, Sure, have addressed using enum .
.withMessage(JobManagerDeploymentConditionStatus.ERROR.getMessage()) | ||
.build()); | ||
|
||
public static Condition getCondition(FlinkDeploymentStatus flinkDeploymentStatus) { |
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.
Only the parameters that are required should be passed not the complete FlinkDeploymentStatus.
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.
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.
public enum JobManagerDeploymentConditionStatus { | ||
READY("True", "JobManagerReady", "JobManager is running and ready to receive REST API calls"), | ||
MISSING("False", "JobManagerDeploymentMissing", "JobManager deployment not found"), | ||
DEPLOYING("False", "JobManagerIsDeploying", "JobManager process is starting up"), |
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.
is deploying a starting up the same thing?
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.
I have referenced from here https://github.com/apache/flink-kubernetes-operator/blob/main/flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/status/JobManagerDeploymentStatus.java#L29. I would have as JobManager deployment is in progress
. Happy to make change , WDYT?.
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.
OK that makes sense. Maybe link to that class in a comment to say where you got the descriptions from.
DEPLOYED_NOT_READY( | ||
"False", | ||
"DeployedNotReady", | ||
"JobManager is running but not ready yet to receive REST API calls"), |
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.
nit ready yet -> yet ready
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.
Thanks, I will change that .
.build(); | ||
} | ||
|
||
private static String toCameCase(String reason) { |
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.
I think you mean toCamelCase
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.
Thank you, my bad.
|
||
private static String toCameCase(String reason) { | ||
reason = reason.toLowerCase(); | ||
return reason.substring(0, 1).toUpperCase() + reason.substring(1); |
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.
Camel case is not just upper casing the first letter. We may need to upper case in the string as well. I suggest mapping the lower case to the appropriate camel cased reason.
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.
Right, but not as of now as per here. If we go with mapping, we end up with new method, do we required them?.
if (condition == null) { | ||
return; | ||
} | ||
if (isLastTransactionTimeStampUpdateRequired(conditions, condition)) { |
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.
would it not be simpler to have an existing condition that is null or a value, then we do not need to get the first element of the list twice.
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.
updated,
return; | ||
} | ||
if (isLastTransactionTimeStampUpdateRequired(conditions, condition)) { | ||
condition.setLastTransitionTime( |
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.
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.
Above is from flink-autoscaler
, but flink-kubernetes-operator-api
, doesn't have dependency to flink-autoscaler
, so we can't utilise it.
.withType(CONDITION_TYPE_RUNNING) | ||
.withStatus(jobStatus == RUNNING ? "True" : "False") | ||
.withReason(toCameCase(jobStatus.name())) | ||
.withMessage("Job state " + jobStatus.name()) |
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.
should the message say Job status - as that is what we are reading?
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.
Yes,
/** Creates a condition object with the type, status, message and reason. */ | ||
public class ConditionUtils { | ||
public static final String CONDITION_TYPE_RUNNING = "Running"; | ||
private static final Map<String, Condition> SESSION_MODE_CONDITION = |
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.
@gyfora are you happy with this map in the utils class - it might be cleaner to be in its own appropriately named class, same for the application mode map
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.
To be completely honest, I am not very happy about it... :)
This is again a copy paste, logic that could be simply replaced with:
public Condition from(JobManagerDeploymentStatus jmStatus) {
return new ConditionBuilder()
.withType(jmStatus == DEPLOYED ? CONDITION_TYPE_RUNNING : NOT_RUNNING)
.withStatus(jmStatus.getStatus())
.withReason(jmStatus.getReason())
.withMessage(jmStatus.getMessage())
.build()
}
I have already given the same exact feedback to the JobStatus, not sure why it wasn't followed here too.
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.
It has been moved to method and moved reason and messages to enum and getting from there.
private static final Map<String, Condition> SESSION_MODE_CONDITION = | ||
Map.of( | ||
JobManagerDeploymentStatus.READY.name(), | ||
new ConditionBuilder() |
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.
nit: you could refactor to a method and pass JobManagerDeploymentConditionStatus.READY, as the rest of the condition builder is the same apart from the status .
So
JobManagerDeploymentStatus.READY.name(),
createRunningConditionBuilder(JobManagerDeploymentConditionStatus.READY),
JobManagerDeploymentStatus.MISSING.name(),
createRunningConditionBuilder(JobManagerDeploymentConditionStatus.MISSING),
...
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.
It has been moved to method and reason and messages are getting from enum.
flinkDeploymentStatus.getJobManagerDeploymentStatus()) | ||
: getApplicationModeCondition(jobStatus); | ||
} | ||
|
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.
can we not update the last transition time here?
It seems that this would be useful if the condition.observedGeneration does not matches the metadata.generation value. |
by looking into some docs, It seems like condition offers a meaningful status info if the cond.observedGeneration is same as metadata.generation, provided condition is calculated based on the last configuration of the object. So in our case here , as condition represents the different status of job, not sure if we have cond.observedGeneration, that will matches with metadata.generation. WDYT? |
What is the purpose of the change
This PR address the FLIP to add conditions to flink deployment status related to issue https://issues.apache.org/jira/browse/FLINK-33634
Brief change log
FlinkDeploymentStatus
ConditionUtils
introduced as utility class to build condition.Verifying this change
Does this pull request potentially affect one of the following parts:
CustomResourceDescriptors
: yesDocumentation