gyfora commented on code in PR #394:
URL:
https://github.com/apache/flink-kubernetes-operator/pull/394#discussion_r990795976
##########
docs/content/docs/custom-resource/reference.md:
##########
@@ -251,6 +261,7 @@ This page serves as a full reference for FlinkDeployment
custom resource definit
| startTime | java.lang.String | Start time of the job. |
| updateTime | java.lang.String | Update time of the job. |
| savepointInfo |
org.apache.flink.kubernetes.operator.crd.status.SavepointInfo | Information
about pending and last savepoint for the job. |
+| jobHealthInfo | java.lang.String | Information about job health. |
Review Comment:
I have been thinking a bit about this, we currently have a `clusterInfo`
field in the `FlinkDeploymentStatus` we could simply use that map to store this
information.
I think originally it was designed with some flexibility in mind so we can
store different metadata. cc @morhidi
##########
docs/content/docs/custom-resource/reference.md:
##########
@@ -225,6 +225,16 @@ This page serves as a full reference for FlinkDeployment
custom resource definit
| error | java.lang.String | Error information about the
FlinkDeployment/FlinkSessionJob. |
| reconciliationStatus |
org.apache.flink.kubernetes.operator.crd.status.FlinkSessionJobReconciliationStatus
| Status of the last reconcile operation. |
+### JobHealthInfo
+**Class**: org.apache.flink.kubernetes.operator.crd.status.JobHealthInfo
Review Comment:
We should move this class to another package, so that the reference
generator does not pick it up. This object is not directly part of the status
(only in a serialized form)
##########
docs/layouts/shortcodes/generated/kubernetes_operator_config_configuration.html:
##########
@@ -80,6 +80,24 @@
<td>Boolean</td>
<td>Whether to enable recovery of missing/deleted jobmanager
deployments.</td>
</tr>
+ <tr>
+ <td><h5>kubernetes.operator.job.health-check.enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Whether to enable health check for jobs.</td>
+ </tr>
+ <tr>
+
<td><h5>kubernetes.operator.job.restart-check.duration-window</h5></td>
+ <td style="word-wrap: break-word;">2 min</td>
+ <td>Duration</td>
+ <td>The duration of the time window where job restart count
measured.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.operator.job.restart-check.threshold</h5></td>
Review Comment:
There is some inconsistency in the naming here, `health-check` vs
`restart-check`.
Maybe it could be:
```
kubernetes.operator.job.health-check.enabled
kubernetes.operator.job.health-check.window
kubernetes.operator.job.health-check.restarts.threshold /
kubernetes.operator.job.health-check.num- restarts.threshold
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
