diff --git a/api/swagger-spec/v1.json b/api/swagger-spec/v1.json index 8c8c4b66438..dbdaef1027a 100644 --- a/api/swagger-spec/v1.json +++ b/api/swagger-spec/v1.json @@ -13524,7 +13524,7 @@ }, "v1.Probe": { "id": "v1.Probe", - "description": "Probe describes a liveness probe to be examined to the container.", + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to recieve traffic.", "properties": { "exec": { "$ref": "v1.ExecAction", @@ -13546,7 +13546,22 @@ "timeoutSeconds": { "type": "integer", "format": "int64", - "description": "Number of seconds after which liveness probes timeout. Defaults to 1 second. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes" + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes" + }, + "periodSeconds": { + "type": "integer", + "format": "int64", + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1." + }, + "successThreshold": { + "type": "integer", + "format": "int32", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1." + }, + "failureThreshold": { + "type": "integer", + "format": "int32", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1." } } }, diff --git a/api/swagger-spec/v1beta1.json b/api/swagger-spec/v1beta1.json index 06c71eb9f31..b270e5d8046 100644 --- a/api/swagger-spec/v1beta1.json +++ b/api/swagger-spec/v1beta1.json @@ -3768,7 +3768,7 @@ }, "v1.Probe": { "id": "v1.Probe", - "description": "Probe describes a liveness probe to be examined to the container.", + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to recieve traffic.", "properties": { "exec": { "$ref": "v1.ExecAction", @@ -3790,7 +3790,22 @@ "timeoutSeconds": { "type": "integer", "format": "int64", - "description": "Number of seconds after which liveness probes timeout. Defaults to 1 second. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes" + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes" + }, + "periodSeconds": { + "type": "integer", + "format": "int64", + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1." + }, + "successThreshold": { + "type": "integer", + "format": "int32", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1." + }, + "failureThreshold": { + "type": "integer", + "format": "int32", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1." } } }, diff --git a/docs/api-reference/extensions/v1beta1/definitions.html b/docs/api-reference/extensions/v1beta1/definitions.html index 827fe3a2f32..ca7f0f9ceaf 100644 --- a/docs/api-reference/extensions/v1beta1/definitions.html +++ b/docs/api-reference/extensions/v1beta1/definitions.html @@ -3257,7 +3257,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
Probe describes a liveness probe to be examined to the container.
+Probe describes a health check to be performed against a container to determine whether it is alive or ready to recieve traffic.
timeoutSeconds |
-Number of seconds after which liveness probes timeout. Defaults to 1 second. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
+Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes |
false |
integer (int64) |
|
periodSeconds |
+How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
+false |
+integer (int64) |
++ | |
successThreshold |
+Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
+false |
+integer (int32) |
++ | |
failureThreshold |
+Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
+false |
+integer (int32) |
++ |