Skip to content

Commit bf929b9

Browse files
committed
updating documentation
1 parent e80b3b8 commit bf929b9

File tree

1 file changed

+44
-3
lines changed

1 file changed

+44
-3
lines changed

README.md

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,11 @@ module "frontdoor" {
6262
}
6363
]
6464
65-
# In order to enable the use of your own custom HTTPS certificate you must grant Azure Front Door Service
66-
# access to your key vault. For instuctions on how to configure your Key Vault correctly
67-
# Please refer to the product documentation (https://bit.ly/38FuAZv).
65+
# In order to enable the use of your own custom HTTPS certificate you must grant
66+
# Azure Front Door Service access to your key vault. For instuctions on how to
67+
# configure your Key Vault correctly. Please refer to the product documentation.
68+
# https://bit.ly/38FuAZv
69+
6870
frontend_endpoints = [
6971
{
7072
name = "exampleFrontendEndpoint1"
@@ -109,6 +111,45 @@ module "frontdoor" {
109111
* [Frontdoor with SSL Offloading](examples/frontdoor_with_custom_https_configuration/)
110112
* [Frontdoor with WAF Policies](examples/frontdoor_with_waf_policies/)
111113

114+
## **`backend_pools`** - Backends and backend pools
115+
116+
A backend pool in Front Door refers to the set of backends that receive similar traffic for their app. In other words, it's a logical grouping of your app instances across the world that receive the same traffic and respond with expected behavior. These backends are deployed across different regions or within the same region. All backends can be in Active/Active deployment mode or what is defined as Active/Passive configuration.
117+
118+
Front Door backends refers to the host name or public IP of your application that serves your client requests. Front Door supports both Azure and non-Azure resources in the backend pool. The application can either be in your on-premises datacenter or located in another cloud provider.
119+
120+
`backend_pools` object accepts following argumnets
121+
122+
| Name | Description
123+
|--|--
124+
`name`| Specifies the name of the Backend Pool
125+
`load_balancing_name`|Specifies the name of the `backend_pool_load_balancing` block within this resource to use for this `Backend Pool`.
126+
`health_probe_name`|Specifies the name of the `backend_pool_health_probe` block within this resource to use for this `Backend Pool`.
127+
||**`backend` - A backend block as defined below**||
128+
`address`|Location of the backend (IP address or FQDN)
129+
`host_header`|The value to use as the host header sent to the backend.
130+
`http_port`|The HTTP TCP port number. Possible values are between `1` - `65535`.
131+
`https_port`|The HTTPS TCP port number. Possible values are between `1` - `65535`.
132+
`priority`| Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. Defaults to `1`.
133+
`weight`| Weight of this endpoint for load balancing purposes. Defaults to `50`.
134+
135+
## **`backend_pool_health_probes`** - Health probes
136+
137+
To determine the health and proximity of each backend for a given Front Door environment, each Front Door environment periodically sends a synthetic HTTP/HTTPS request to each of your configured backends. Front Door then uses these responses from the probe to determine the "best" backend resources to route your client requests.
138+
139+
> For lower load and cost on your backends, Front Door recommends using `HEAD` requests for health probes.
140+
141+
`backend_pool_health_probes` object accepts following argumnets
142+
143+
| Name | Description
144+
|--|--
145+
`name`|Specifies the name of the Health Probe.
146+
`enabled`|Is this health probe enabled? Dafaults to `true`.
147+
`path`|The path to use for the Health Probe. Default is `/`.
148+
`protocol`|Protocol scheme to use for the Health Probe. Defaults to `Http`.
149+
`probe_method`|Specifies HTTP method the health probe uses when querying the backend pool instances. Possible values include: `Get` and `Head`. Defaults to `Get`.
150+
`interval_in_seconds`| The number of seconds between each Health Probe. Defaults to `120`.
151+
152+
112153
## Recommended naming and tagging conventions
113154

114155
Applying tags to your Azure resources, resource groups, and subscriptions to logically organize them into a taxonomy. Each tag consists of a name and a value pair. For example, you can apply the name `Environment` and the value `Production` to all the resources in production.

0 commit comments

Comments
 (0)