Skip to content

Commit a03d90d

Browse files
committed
chore: regenerate CRD manifests with BackendTrafficPolicy health check fields
1 parent 0c19a9d commit a03d90d

1 file changed

Lines changed: 175 additions & 0 deletions

File tree

config/crd/bases/apisix.apache.org_backendtrafficpolicies.yaml

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,181 @@ spec:
4242
BackendTrafficPolicySpec defines traffic handling policies applied to backend services,
4343
such as load balancing strategy, connection settings, and failover behavior.
4444
properties:
45+
healthCheck:
46+
description: |-
47+
HealthCheck defines active and passive health check configuration for
48+
the upstream backends. When configured, APISIX will probe backends
49+
(active) or monitor live traffic (passive) to detect and bypass
50+
unhealthy nodes.
51+
properties:
52+
active:
53+
description: Active health checks proactively send requests to
54+
upstream nodes to determine their availability.
55+
properties:
56+
concurrency:
57+
description: Concurrency sets the number of targets to be
58+
checked at the same time.
59+
minimum: 0
60+
type: integer
61+
healthy:
62+
description: Healthy configures the thresholds for marking
63+
a node healthy.
64+
properties:
65+
httpCodes:
66+
description: HTTPCodes is the list of HTTP status codes
67+
considered healthy.
68+
items:
69+
type: integer
70+
minItems: 1
71+
type: array
72+
interval:
73+
description: |-
74+
Interval defines the time between health check probes.
75+
Minimum is 1s.
76+
type: string
77+
successes:
78+
description: Successes is the number of consecutive successful
79+
responses required to mark a node healthy.
80+
maximum: 254
81+
minimum: 0
82+
type: integer
83+
type: object
84+
host:
85+
description: Host sets the upstream host used in the health
86+
check request.
87+
type: string
88+
httpPath:
89+
description: HTTPPath sets the HTTP path for the probe request.
90+
type: string
91+
port:
92+
description: Port sets the port on the upstream node to probe.
93+
format: int32
94+
maximum: 65535
95+
minimum: 1
96+
type: integer
97+
requestHeaders:
98+
description: RequestHeaders sets additional HTTP request headers
99+
for the probe.
100+
items:
101+
type: string
102+
type: array
103+
strictTLS:
104+
description: StrictTLS controls whether TLS certificate validation
105+
is enforced.
106+
type: boolean
107+
timeout:
108+
description: Timeout sets health check timeout.
109+
type: string
110+
type:
111+
default: http
112+
description: Type is the health check type. Can be `http`,
113+
`https`, or `tcp`.
114+
enum:
115+
- http
116+
- https
117+
- tcp
118+
type: string
119+
unhealthy:
120+
description: Unhealthy configures the thresholds for marking
121+
a node unhealthy.
122+
properties:
123+
httpCodes:
124+
description: HTTPCodes is the list of HTTP status codes
125+
considered unhealthy.
126+
items:
127+
type: integer
128+
minItems: 1
129+
type: array
130+
httpFailures:
131+
description: HTTPFailures is the number of HTTP failures
132+
to mark a node unhealthy.
133+
maximum: 254
134+
minimum: 0
135+
type: integer
136+
interval:
137+
description: |-
138+
Interval defines the time between health check probes.
139+
Minimum is 1s.
140+
type: string
141+
tcpFailures:
142+
description: TCPFailures is the number of TCP failures
143+
to mark a node unhealthy.
144+
maximum: 254
145+
minimum: 0
146+
type: integer
147+
timeout:
148+
description: Timeouts is the number of timeouts to mark
149+
a node unhealthy.
150+
maximum: 254
151+
minimum: 1
152+
type: integer
153+
type: object
154+
type: object
155+
passive:
156+
description: Passive health checks evaluate upstream health based
157+
on observed traffic (timeouts, errors).
158+
properties:
159+
healthy:
160+
description: Healthy defines conditions under which a node
161+
is considered healthy.
162+
properties:
163+
httpCodes:
164+
description: HTTPCodes is the list of HTTP status codes
165+
considered healthy.
166+
items:
167+
type: integer
168+
minItems: 1
169+
type: array
170+
successes:
171+
description: Successes is the number of consecutive successful
172+
responses required to mark a node healthy.
173+
maximum: 254
174+
minimum: 0
175+
type: integer
176+
type: object
177+
type:
178+
default: http
179+
description: Type is the passive health check type. Can be
180+
`http`, `https`, or `tcp`.
181+
enum:
182+
- http
183+
- https
184+
- tcp
185+
type: string
186+
unhealthy:
187+
description: Unhealthy defines conditions under which a node
188+
is considered unhealthy.
189+
properties:
190+
httpCodes:
191+
description: HTTPCodes is the list of HTTP status codes
192+
considered unhealthy.
193+
items:
194+
type: integer
195+
minItems: 1
196+
type: array
197+
httpFailures:
198+
description: HTTPFailures is the number of HTTP failures
199+
to mark a node unhealthy.
200+
maximum: 254
201+
minimum: 0
202+
type: integer
203+
tcpFailures:
204+
description: TCPFailures is the number of TCP failures
205+
to mark a node unhealthy.
206+
maximum: 254
207+
minimum: 0
208+
type: integer
209+
timeout:
210+
description: Timeouts is the number of timeouts to mark
211+
a node unhealthy.
212+
maximum: 254
213+
minimum: 1
214+
type: integer
215+
type: object
216+
type: object
217+
required:
218+
- active
219+
type: object
45220
loadbalancer:
46221
description: |-
47222
LoadBalancer represents the load balancer configuration for Kubernetes Service.

0 commit comments

Comments
 (0)