This is an automated email from the ASF dual-hosted git repository.
ronething pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new 1af0dc74 docs: correct health check unhealthy timeout description
(#2625)
1af0dc74 is described below
commit 1af0dc746ea8d1dcf9771f8a37c4a30a5f770dbb
Author: Traky Deng <[email protected]>
AuthorDate: Wed Oct 29 10:20:19 2025 +0800
docs: correct health check unhealthy timeout description (#2625)
---
api/v2/apisixupstream_types.go | 2 +-
config/crd/bases/apisix.apache.org_apisixupstreams.yaml | 14 ++++++++------
docs/en/latest/reference/api-reference.md | 4 ++--
3 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/api/v2/apisixupstream_types.go b/api/v2/apisixupstream_types.go
index 11c3bcde..a9009178 100644
--- a/api/v2/apisixupstream_types.go
+++ b/api/v2/apisixupstream_types.go
@@ -313,9 +313,9 @@ type PassiveHealthCheckUnhealthy struct {
// +kubebuilder:validation:Maximum=254
// TCPFailures define the number of TCP failures to define an unhealthy
target.
TCPFailures int `json:"tcpFailures,omitempty"
yaml:"tcpFailures,omitempty"`
- // Timeout sets health check timeout in seconds.
// +kubebuilder:validation:Minimum=1
// +kubebuilder:validation:Maximum=254
+ // Timeout sets the number of timeouts to define an unhealthy target.
Timeouts int `json:"timeout,omitempty" yaml:"timeout,omitempty"`
}
diff --git a/config/crd/bases/apisix.apache.org_apisixupstreams.yaml
b/config/crd/bases/apisix.apache.org_apisixupstreams.yaml
index 2c840b97..0a7ba978 100644
--- a/config/crd/bases/apisix.apache.org_apisixupstreams.yaml
+++ b/config/crd/bases/apisix.apache.org_apisixupstreams.yaml
@@ -190,7 +190,8 @@ spec:
minimum: 0
type: integer
timeout:
- description: Timeout sets health check timeout in
seconds.
+ description: Timeout sets the number of timeouts
to define
+ an unhealthy target.
maximum: 254
minimum: 1
type: integer
@@ -252,7 +253,8 @@ spec:
minimum: 0
type: integer
timeout:
- description: Timeout sets health check timeout in
seconds.
+ description: Timeout sets the number of timeouts
to define
+ an unhealthy target.
maximum: 254
minimum: 1
type: integer
@@ -447,8 +449,8 @@ spec:
minimum: 0
type: integer
timeout:
- description: Timeout sets health check
timeout in
- seconds.
+ description: Timeout sets the number of
timeouts
+ to define an unhealthy target.
maximum: 254
minimum: 1
type: integer
@@ -510,8 +512,8 @@ spec:
minimum: 0
type: integer
timeout:
- description: Timeout sets health check
timeout in
- seconds.
+ description: Timeout sets the number of
timeouts
+ to define an unhealthy target.
maximum: 254
minimum: 1
type: integer
diff --git a/docs/en/latest/reference/api-reference.md
b/docs/en/latest/reference/api-reference.md
index 933c566b..8655f8e9 100644
--- a/docs/en/latest/reference/api-reference.md
+++ b/docs/en/latest/reference/api-reference.md
@@ -661,7 +661,7 @@ UpstreamActiveHealthCheckHealthy defines the conditions
used to actively determi
| `httpCodes` _integer array_ | HTTPCodes define a list of HTTP status codes
that are considered unhealthy. |
| `httpFailures` _integer_ | HTTPFailures define the number of HTTP failures
to define an unhealthy target. |
| `tcpFailures` _integer_ | TCPFailures define the number of TCP failures to
define an unhealthy target. |
-| `timeout` _integer_ | Timeout sets health check timeout in seconds. |
+| `timeout` _integer_ | Timeout sets the number of timeouts to define an
unhealthy target. |
| `interval`
_[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#duration-v1-meta)_
| Interval defines the time interval for checking targets, in seconds. |
@@ -1528,7 +1528,7 @@ UpstreamPassiveHealthCheckUnhealthy defines the
conditions used to passively det
| `httpCodes` _integer array_ | HTTPCodes define a list of HTTP status codes
that are considered unhealthy. |
| `httpFailures` _integer_ | HTTPFailures define the number of HTTP failures
to define an unhealthy target. |
| `tcpFailures` _integer_ | TCPFailures define the number of TCP failures to
define an unhealthy target. |
-| `timeout` _integer_ | Timeout sets health check timeout in seconds. |
+| `timeout` _integer_ | Timeout sets the number of timeouts to define an
unhealthy target. |
_Appears in:_
