Skip to content

Commit aabbcb8

Browse files
authored
Update ingress-controller-annotations.md
1 parent de9025e commit aabbcb8

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.author: greglin
1111

1212
# Annotations for Application Gateway Ingress Controller
1313

14-
You can annotate the Kubernetes ingress resource with arbitrary key/value pairs. Application Gateway Ingress Controller (AGIC) relies on annotations to program Azure Application Gateway features that aren't configurable via the ingress YAML. Ingress annotations are applied to all HTTP settings, back-end pools, and listeners derived from an ingress resource.
14+
You can annotate the Kubernetes ingress resource with arbitrary key/value pairs. Application Gateway Ingress Controller (AGIC) relies on annotations to program Azure Application Gateway features that aren't configurable via the ingress YAML. Ingress annotations are applied to all HTTP settings, backend pools, and listeners derived from an ingress resource.
1515

1616
## List of supported annotations
1717

@@ -48,7 +48,7 @@ For AGIC to observe an ingress resource, the resource *must be annotated* with `
4848

4949
## Backend Path Prefix
5050

51-
The following annotation allows the back-end path specified in an ingress resource to be rewritten with the specified prefix. Use it to expose services whose endpoints are different from the endpoint names that you use to expose a service in an ingress resource.
51+
The following annotation allows the backend path specified in an ingress resource to be rewritten with the specified prefix. Use it to expose services whose endpoints are different from the endpoint names that you use to expose a service in an ingress resource.
5252

5353
### Usage
5454

@@ -82,11 +82,11 @@ spec:
8282
8383
The preceding example defines an ingress resource named `go-server-ingress-bkprefix` with an annotation named `appgw.ingress.kubernetes.io/backend-path-prefix: "/test/"`. The annotation tells Application Gateway to create an HTTP setting that has a path prefix override for the path `/hello` to `/test/`.
8484

85-
The example defines only one rule. However, the annotations apply to the entire ingress resource. So if you define multiple rules, you set up the back-end path prefix for each of the specified paths. If you want different rules with different path prefixes (even for the same service), you need to define different ingress resources.
85+
The example defines only one rule. However, the annotations apply to the entire ingress resource. So if you define multiple rules, you set up the backend path prefix for each of the specified paths. If you want different rules with different path prefixes (even for the same service), you need to define different ingress resources.
8686

8787
## Backend Hostname
8888

89-
Use the following annotation to specify the host name that Application Gateway should use while talking to the pods.
89+
Use the following annotation to specify the hostname that Application Gateway should use while talking to the pods.
9090

9191
### Usage
9292

@@ -120,15 +120,15 @@ spec:
120120

121121
## Custom Health Probe
122122

123-
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 back-end application. The controller then applies the changes to Application Gateway.
123+
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.
124124

125-
- `health-probe-hostname`: This annotation allows a custom host name on the health probe.
125+
- `health-probe-hostname`: This annotation allows a custom hostname on the health probe.
126126
- `health-probe-port`: This annotation configures a custom port for the health probe.
127127
- `health-probe-path`: This annotation defines a path for the health probe.
128128
- `health-probe-status-code`: This annotation allows the health probe to accept different HTTP status codes.
129129
- `health-probe-interval`: This annotation defines the interval at which the health probe runs.
130130
- `health-probe-timeout`: This annotation defines how long the health probe waits for a response before failing the probe.
131-
- `health-probe-unhealthy-threshold`: This annotation defines how many health probes must fail for the back end to be marked as unhealthy.
131+
- `health-probe-unhealthy-threshold`: This annotation defines how many health probes must fail for the backend to be marked as unhealthy.
132132

133133
### Usage
134134

@@ -214,7 +214,7 @@ spec:
214214
Use the following annotations if you want to use connection draining:
215215

216216
- `connection-draining`: This annotation specifies whether to enable connection draining.
217-
- `connection-draining-timeout`: This annotation specifies a timeout, after which Application Gateway terminates the requests to the draining back-end endpoint.
217+
- `connection-draining-timeout`: This annotation specifies a timeout, after which Application Gateway terminates the requests to the draining backend endpoint.
218218

219219
### Usage
220220

@@ -354,7 +354,7 @@ spec:
354354

355355
## Override Frontend Port
356356

357-
Use the following annotation to configure a front-end listener to use ports other than 80 for HTTP and 443 for HTTPS.
357+
Use the following annotation to configure a frontend listener to use ports other than 80 for HTTP and 443 for HTTPS.
358358

359359
If the port is within the Application Gateway authorized range (1 to 64999), the listener is created on this specific port. If you set an invalid port or no port in the annotation, the configuration uses the default of 80 or 443.
360360

@@ -432,7 +432,7 @@ spec:
432432

433433
## Hostname Extension
434434

435-
You can configure Application Gateway to accept multiple host names. Use the `hostname-extension` annotation to define multiple host names, including wildcard host names. This action appends the host names onto the FQDN that's defined in the ingress `spec.rules.host` information on the front-end listener, so it's [configured as a multisite listener](./multiple-site-overview.md).
435+
You can configure Application Gateway to accept multiple hostnames. Use the `hostname-extension` annotation to define multiple hostnames, including wildcard hostnames. This action appends the hostnames onto the FQDN that's defined in the ingress `spec.rules.host` information on the frontend listener, so it's [configured as a multisite listener](./multiple-site-overview.md).
436436

437437
### Usage
438438

@@ -465,7 +465,7 @@ spec:
465465
number: 443
466466
```
467467

468-
The preceding example configures the listener to accept traffic for the host names `hostname1.contoso.com` and `hostname2.contoso.com`.
468+
The preceding example configures the listener to accept traffic for the hostnames `hostname1.contoso.com` and `hostname2.contoso.com`.
469469

470470
## WAF Policy for Path
471471

@@ -663,7 +663,7 @@ HTTP headers allow a client and server to pass additional information with a req
663663

664664
With the URL rewrite capability, you can:
665665

666-
- Rewrite the host name, path, and query string of the request URL.
666+
- Rewrite the hostname, path, and query string of the request URL.
667667
- Choose to rewrite the URL of all requests or only requests that match one or more of the conditions that you set. These conditions are based on the request and response properties (request header, response header, and server variables).
668668
- Choose to route the request based on either the original URL or the rewritten URL.
669669

0 commit comments

Comments
 (0)