[FLINK-33634] Add Conditions to Flink CRD's Status field

flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/status/FlinkDeploymentStatus.java

@@ -19,16 +19,20 @@
 
 import org.apache.flink.annotation.Experimental;
 import org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentSpec;
+import org.apache.flink.kubernetes.operator.api.utils.ConditionUtils;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import io.fabric8.kubernetes.api.model.Condition;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import lombok.ToString;
 import lombok.experimental.SuperBuilder;
 
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 /** Last observed status of the Flink deployment. */
@@ -55,4 +59,13 @@ public class FlinkDeploymentStatus extends CommonStatus<FlinkDeploymentSpec> {
 
     /** Information about the TaskManagers for the scale subresource. */
     private TaskManagerInfo taskManager;
+
+    /** Condition of the CR . */
+    private List<Condition> conditions = new ArrayList<>();
+
+    public List<Condition> getConditions() {
+        Condition condition = ConditionUtils.getCondition(this);
+        ConditionUtils.updateLastTransitionTime(conditions, condition);
+        return condition == null ? List.of() : List.of(condition);
+    }
 }

flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/status/JobManagerDeploymentConditionStatus.java

@@ -0,0 +1,35 @@
+package org.apache.flink.kubernetes.operator.api.status;
+
+/** Condition Status of the Flink JobManager Kubernetes deployment. */
+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"),
+    DEPLOYED_NOT_READY(
+            "False",
+            "DeployedNotReady",
+            "JobManager is running but not ready yet to receive REST API calls"),
+    ERROR("False", "Error", "JobManager deployment failed");
+
+    private String status;
+    private String reason;
+    private String message;
+
+    JobManagerDeploymentConditionStatus(String status, String reason, String message) {
+        this.status = status;
+        this.reason = reason;
+        this.message = message;
+    }
+
+    public String getReason() {
+        return reason;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public String getStatus() {
+        return status;
+    }
+}

flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/utils/ConditionUtils.java

@@ -0,0 +1,131 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.kubernetes.operator.api.utils;
+
+import org.apache.flink.api.common.JobStatus;
+import org.apache.flink.kubernetes.operator.api.status.FlinkDeploymentStatus;
+import org.apache.flink.kubernetes.operator.api.status.JobManagerDeploymentConditionStatus;
+import org.apache.flink.kubernetes.operator.api.status.JobManagerDeploymentStatus;
+
+import io.fabric8.kubernetes.api.model.Condition;
+import io.fabric8.kubernetes.api.model.ConditionBuilder;
+
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+
+import static org.apache.flink.api.common.JobStatus.RUNNING;
+
+/** 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 =
+            Map.of(
+                    JobManagerDeploymentStatus.READY.name(),
+                    new ConditionBuilder()
+                            .withType(CONDITION_TYPE_RUNNING)
+                            .withStatus(JobManagerDeploymentConditionStatus.READY.getStatus())
+                            .withReason(JobManagerDeploymentConditionStatus.READY.getReason())
+                            .withMessage(JobManagerDeploymentConditionStatus.READY.getMessage())
+                            .build(),
+                    JobManagerDeploymentStatus.MISSING.name(),
+                    new ConditionBuilder()
+                            .withType(CONDITION_TYPE_RUNNING)
+                            .withStatus(JobManagerDeploymentConditionStatus.MISSING.getStatus())
+                            .withReason(JobManagerDeploymentConditionStatus.MISSING.getReason())
+                            .withMessage(JobManagerDeploymentConditionStatus.MISSING.getMessage())
+                            .build(),
+                    JobManagerDeploymentStatus.DEPLOYING.name(),
+                    new ConditionBuilder()
+                            .withType(CONDITION_TYPE_RUNNING)
+                            .withStatus(JobManagerDeploymentConditionStatus.DEPLOYING.getStatus())
+                            .withReason(JobManagerDeploymentConditionStatus.DEPLOYING.getReason())
+                            .withMessage(JobManagerDeploymentConditionStatus.DEPLOYING.getMessage())
+                            .build(),
+                    JobManagerDeploymentStatus.DEPLOYED_NOT_READY.name(),
+                    new ConditionBuilder()
+                            .withType(CONDITION_TYPE_RUNNING)
+                            .withStatus(
+                                    JobManagerDeploymentConditionStatus.DEPLOYED_NOT_READY
+                                            .getStatus())
+                            .withReason(
+                                    JobManagerDeploymentConditionStatus.DEPLOYED_NOT_READY
+                                            .getReason())
+                            .withMessage(
+                                    JobManagerDeploymentConditionStatus.DEPLOYED_NOT_READY
+                                            .getMessage())
+                            .build(),
+                    JobManagerDeploymentStatus.ERROR.name(),
+                    new ConditionBuilder()
+                            .withType(CONDITION_TYPE_RUNNING)
+                            .withStatus(JobManagerDeploymentConditionStatus.ERROR.getStatus())
+                            .withReason(JobManagerDeploymentConditionStatus.ERROR.getReason())
+                            .withMessage(JobManagerDeploymentConditionStatus.ERROR.getMessage())
+                            .build());
+
+    public static Condition getCondition(FlinkDeploymentStatus flinkDeploymentStatus) {
+        org.apache.flink.kubernetes.operator.api.status.JobStatus status =
+                flinkDeploymentStatus.getJobStatus();
+        Condition conditionToAdd = null;
+        if (status != null) {
+
+            JobStatus jobStatus = status.getState();
+
+            conditionToAdd =
+                    jobStatus == null
+                            ? SESSION_MODE_CONDITION.get(
+                                    flinkDeploymentStatus.getJobManagerDeploymentStatus().name())
+                            : getApplicationModeCondition(jobStatus);
+        }
+
+        return conditionToAdd;
+    }
+
+    public static void updateLastTransitionTime(List<Condition> conditions, Condition condition) {
+        if (condition == null) {
+            return;
+        }
+        if (isLastTransactionTimeStampUpdateRequired(conditions, condition)) {
+            condition.setLastTransitionTime(
+                    new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(new Date()));
+        } else {
+            condition.setLastTransitionTime(conditions.get(0).getLastTransitionTime());
+        }
+    }
+
+    private static Condition getApplicationModeCondition(JobStatus jobStatus) {
+        return new ConditionBuilder()
+                .withType(CONDITION_TYPE_RUNNING)
+                .withStatus(jobStatus == RUNNING ? "True" : "False")
+                .withReason(toCameCase(jobStatus.name()))
+                .withMessage("Job state " + jobStatus.name())
+                .build();
+    }
+
+    private static String toCameCase(String reason) {
+        reason = reason.toLowerCase();
+        return reason.substring(0, 1).toUpperCase() + reason.substring(1);
+    }
+
+    private static boolean isLastTransactionTimeStampUpdateRequired(
+            List<Condition> conditions, Condition newCondition) {
+        return conditions.isEmpty()
+                || !conditions.get(0).getStatus().equals(newCondition.getStatus());
+    }
+}