Skip to content

Commit 0e7520f

Browse files
authored
Update ingress-controller-annotations.md
I was going through the AGIC annotation docs and noticed a small typo that might be worth updating. On this page: Application Gateway Ingress Controller annotations | Microsoft Learn The annotation is listed as: appgw.ingress.kubernetes.io/health-probe-status-code But the correct one that works is: appgw.ingress.kubernetes.io/health-probe-status-codes Just missing an “s” at the end.
1 parent 9ee6801 commit 0e7520f

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

articles/application-gateway/ingress-controller-annotations.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ For AGIC to observe an ingress resource, the resource *must be annotated* with `
2727
| [appgw.ingress.kubernetes.io/health-probe-hostname](#custom-health-probe) | `string` | `127.0.0.1` ||
2828
| [appgw.ingress.kubernetes.io/health-probe-port](#custom-health-probe) | `int32` | `80` ||
2929
| [appgw.ingress.kubernetes.io/health-probe-path](#custom-health-probe) | `string` | `/` ||
30-
| [appgw.ingress.kubernetes.io/health-probe-status-code](#custom-health-probe) | `string` | `200-399` ||
30+
| [appgw.ingress.kubernetes.io/health-probe-status-codes](#custom-health-probe) | `string` | `200-399` ||
3131
| [appgw.ingress.kubernetes.io/health-probe-interval](#custom-health-probe) | `int32` | `30` (seconds) ||
3232
| [appgw.ingress.kubernetes.io/health-probe-timeout](#custom-health-probe) | `int32` | `30` (seconds) ||
3333
| [appgw.ingress.kubernetes.io/health-probe-unhealthy-threshold](#custom-health-probe) | `int32` | `3` ||
@@ -37,7 +37,8 @@ For AGIC to observe an ingress resource, the resource *must be annotated* with `
3737
| [appgw.ingress.kubernetes.io/use-private-ip](#use-private-ip) | `bool` | `false` ||
3838
| [appgw.ingress.kubernetes.io/override-frontend-port](#override-frontend-port) | `bool` | `false` ||
3939
| [appgw.ingress.kubernetes.io/cookie-based-affinity](#cookie-based-affinity) | `bool` | `false` ||
40-
| [appgw.ingress.kubernetes.io/request-timeout](#request-timeout) | `int32` (seconds) | `30` ||
40+
| [appgw.ingress.kubernetes.io/request-timeout]
41+
(#request-timeout) | `int32` (seconds) | `30` ||
4142
| [appgw.ingress.kubernetes.io/use-private-ip](#use-private-ip) | `bool` | `false` ||
4243
| [appgw.ingress.kubernetes.io/backend-protocol](#backend-protocol) | `string` | `http` | `http`, `https` |
4344
| [appgw.ingress.kubernetes.io/hostname-extension](#hostname-extension) | `string` | `nil` ||
@@ -121,12 +122,12 @@ spec:
121122

122123
## Custom Health Probe
123124

124-
You can [configure Application Gateway](./application-gateway-probe-overview.md) to send custom health probes to the backend address pool. When the following annotations are present, the Kubernetes ingress controller [creates a custom probe](./application-gateway-create-probe-portal.md) to monitor the backend application. The controller then applies the changes to Application Gateway.
125+
You can [configure Application Gateway](./application-gateway-probe-overview.md) to send custom health probe to the backend address pool. When the following annotations are present, the Kubernetes ingress controller [creates a custom probe](./application-gateway-create-probe-portal.md) to monitor the backend application. The controller then applies the changes to Application Gateway.
125126

126127
- `health-probe-hostname`: This annotation allows a custom hostname on the health probe.
127128
- `health-probe-port`: This annotation configures a custom port for the health probe.
128129
- `health-probe-path`: This annotation defines a path for the health probe.
129-
- `health-probe-status-code`: This annotation allows the health probe to accept different HTTP status codes.
130+
- `health-probe-status-codes`: This annotation allows the health probe to accept different HTTP status codes.
130131
- `health-probe-interval`: This annotation defines the interval at which the health probe runs.
131132
- `health-probe-timeout`: This annotation defines how long the health probe waits for a response before failing the probe.
132133
- `health-probe-unhealthy-threshold`: This annotation defines how many health probes must fail for the backend to be marked as unhealthy.
@@ -137,7 +138,7 @@ You can [configure Application Gateway](./application-gateway-probe-overview.md)
137138
appgw.ingress.kubernetes.io/health-probe-hostname: "contoso.com"
138139
appgw.ingress.kubernetes.io/health-probe-port: 80
139140
appgw.ingress.kubernetes.io/health-probe-path: "/"
140-
appgw.ingress.kubernetes.io/health-probe-status-code: "100-599"
141+
appgw.ingress.kubernetes.io/health-probe-status-codes: "100-599"
141142
appgw.ingress.kubernetes.io/health-probe-interval: 30
142143
appgw.ingress.kubernetes.io/health-probe-timeout: 30
143144
appgw.ingress.kubernetes.io/health-probe-unhealthy-threshold: 2
@@ -155,7 +156,7 @@ metadata:
155156
appgw.ingress.kubernetes.io/health-probe-hostname: "contoso.com"
156157
appgw.ingress.kubernetes.io/health-probe-port: 81
157158
appgw.ingress.kubernetes.io/health-probe-path: "/probepath"
158-
appgw.ingress.kubernetes.io/health-probe-status-code: "100-599"
159+
appgw.ingress.kubernetes.io/health-probe-status-codes: "100-599"
159160
appgw.ingress.kubernetes.io/health-probe-interval: 31
160161
appgw.ingress.kubernetes.io/health-probe-timeout: 31
161162
appgw.ingress.kubernetes.io/health-probe-unhealthy-threshold: 2

0 commit comments

Comments
 (0)