Skip to content

Commit 1f7e5fa

Browse files
committed
edits
1 parent 484a439 commit 1f7e5fa

File tree

15 files changed

+82
-82
lines changed

15 files changed

+82
-82
lines changed

content/nginx/admin-guide/monitoring/new-relic-plugin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Download the [plug‑in and installation instructions](https://docs.newrelic.com
3333

3434
## Configuring the Plug‑In
3535

36-
The configuration file for the NGINX plug‑in is {{<nb>}}**/etc/nginx-nr-agent/nginx-nr-agent.ini**.{{</nb>}} The minimal configuration includes:
36+
The configuration file for the NGINX plug‑in is {{<nb>}}**/etc/nginx-nr-agent/nginx-nr-agent.ini**{{</nb>}}. The minimal configuration includes:
3737

3838
- Your New Relic license key in the `newrelic_license_key` statement in the `global` section.
3939

@@ -44,7 +44,7 @@ The configuration file for the NGINX plug‑in is {{<nb>}}**/etc/nginx-nr-agent/
4444

4545
You can include the optional `http_user` and `http_pass` statements to set HTTP basic authentication credentials in cases where the corresponding location is protected by the NGINX [auth_basic](https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html#auth_basic) directive.
4646

47-
The default log file is {{<nb>}}**/var/log/nginx-nr-agent.log**.{{</nb>}}
47+
The default log file is {{<nb>}}**/var/log/nginx-nr-agent.log**{{</nb>}}.
4848

4949
## Running the Plug‑In
5050

content/nginx/deployment-guides/amazon-web-services/high-availability-network-load-balancer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ Configure NGINX Plus instances as load balancers. These distribute requests to
291291

292292
Use the *Step‑by‑step* instructions in our deployment guide, [Setting Up an NGINX Demo Environment]({{< ref "/nginx/deployment-guides/setting-up-nginx-demo-environment.md" >}}).
293293

294-
Repeat the instructions on both {{<nb>}}**ngx-plus-1**{{</nb>}} and {{<nb>}}**ngx-plus-2**.{{</nb>}}
294+
Repeat the instructions on both {{<nb>}}**ngx-plus-1**{{</nb>}} and {{<nb>}}**ngx-plus-2**{{</nb>}}.
295295

296296
<span id="create-instances-automated"></span>
297297
### Automate instance setup with Packer and Terraform

content/nginx/deployment-guides/amazon-web-services/route-53-global-server-load-balancing.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The setup for global server load balancing (GSLB) in this guide combines Amazon
4040

4141
<img src="/nginx/images/aws-route-53-topology.png" alt="Diagram showing a topology for global server load balancing (GSLB). Eight backend servers, four in each of two regions, host the content for a domain. Two NGINX Plus load balancers in each region route traffic to the backend servers. For each client requesting DNS information for the domain, Amazon Route 53 provides the DNS record for the region closest to the client." style="border:2px solid #666666; padding:2px; margin:2px;" />
4242

43-
Route 53 is a Domain Name System (DNS) service that performs global server load balancing by routing each request to the AWS region closest to the requester's location. This guide uses two regions: {{<nb>}}**US West (Oregon)**{{</nb>}} and {{<nb>}}**US East (N. Virginia)**.{{</nb>}}
43+
Route 53 is a Domain Name System (DNS) service that performs global server load balancing by routing each request to the AWS region closest to the requester's location. This guide uses two regions: {{<nb>}}**US West (Oregon)**{{</nb>}} and {{<nb>}}**US East (N. Virginia)**{{</nb>}}.
4444

4545
In each region, two or more NGINX Plus load balancers are deployed in a high‑availability (HA) configuration. In this guide, there are two NGINX Plus load balancer instances per region. You can also use NGINX Open Source for this purpose, but it lacks the [application health checks](https://docs.nginx.com/nginx/admin-guide/load-balancer/http-health-check/) that make for more precise error detection. For simplicity, we'll refer to NGINX Plus load balancers throughout this guide, noting when features specific to NGINX Plus are used.
4646

@@ -87,7 +87,7 @@ Create a _hosted zone_, which basically involves designating a domain name to be
8787

8888
<img src="https://cdn-1.wp.nginx.com/wp-content/uploads/2016/10/aws-route53-registered-domains-tab.png" alt="Screenshot showing the Route 53 Registered domains tab during configuration of NGINX GSLB (global server load balancing)" style="border:2px solid #666666; padding:2px; margin:2px;" />
8989

90-
If you see the Route 53 home page instead, access the **Registered domains** tab by clicking the <span style="background-color:#3366cc; color:white; white-space: nowrap;"> Get started now </span> button under {{<nb>}}**Domain registration**.{{</nb>}}
90+
If you see the Route 53 home page instead, access the **Registered domains** tab by clicking the <span style="background-color:#3366cc; color:white; white-space: nowrap;"> Get started now </span> button under {{<nb>}}**Domain registration**{{</nb>}}.
9191

9292
<img src="https://cdn-1.wp.nginx.com/wp-content/uploads/2016/10/aws-route53-homepage.png" alt="Screenshot showing the Amazon Route 53 homepage for a first-time Route 53 user during configuration of AWS GSLB (global server load balancing) with NGINX Plus" style="border:2px solid #666666; padding:2px; margin:2px;" />
9393

@@ -124,19 +124,19 @@ Create records sets for your domain:
124124
4. Fill in the fields in the **Create Record Set** column:
125125

126126
- **Name** – You can leave this field blank, but for this guide we are setting the name to **www.nginxroute53.com**.
127-
- **Type** – **A {{<nb>}}– IPv4 address**.{{</nb>}}
127+
- **Type** – **A {{<nb>}}– IPv4 address**{{</nb>}}.
128128
- **Alias** – **No**.
129129
- **TTL (Seconds)** – **60**.
130130

131131
**Note**: Reducing TTL from the default of **300** in this way can decrease the time that it takes for Route 53 to fail over when both NGINX Plus load balancers in the region are down, but there is always a delay of about two minutes regardless of the TTL setting. This is a built‑in limitation of Route 53.
132132

133-
- **Value** – [Elastic IP addresses](#elastic-ip) of the NGINX Plus load balancers in the first region [in this guide, {{<nb>}}**US West (Oregon)**].{{</nb>}}
133+
- **Value** – [Elastic IP addresses](#elastic-ip) of the NGINX Plus load balancers in the first region [in this guide, {{<nb>}}**US West (Oregon)**]{{</nb>}}.
134134
- **Routing Policy** – **Latency**.
135135

136136
5. A new area opens when you select **Latency**. Fill in the fields as indicated (see the figure below):
137137

138-
- **Region** – Region to which the load balancers belong (in this guide, {{<nb>}}**us-west-2**).{{</nb>}}
139-
- **Set ID** – Identifier for this group of load balancers (in this guide, {{<nb>}}**US West LBs**).{{</nb>}}
138+
- **Region** – Region to which the load balancers belong (in this guide, {{<nb>}}**us-west-2**){{</nb>}}.
139+
- **Set ID** – Identifier for this group of load balancers (in this guide, {{<nb>}}**US West LBs**){{</nb>}}.
140140
- **Associate with Health Check** – **No**.
141141

142142
When you complete all fields, the tab looks like this:
@@ -145,7 +145,7 @@ Create records sets for your domain:
145145

146146
6. Click the <span style="background-color:#3366cc; color:white; white-space: nowrap;"> Create </span> button.
147147

148-
7. Repeat Steps 3 through 6 for the load balancers in the other region [in this guide, {{<nb>}}**US East (N. Virginia)**].{{</nb>}}
148+
7. Repeat Steps 3 through 6 for the load balancers in the other region [in this guide, {{<nb>}}**US East (N. Virginia)**]{{</nb>}}.
149149

150150
You can now test your website. Insert your domain name into a browser and see that your request is being load balanced between servers based on your location.
151151

@@ -174,9 +174,9 @@ We create health checks both for each NGINX Plus load balancer individually and
174174

175175
2. Click the <span style="background-color:#3366cc; color:white; white-space: nowrap;"> Create health check </span> button. In the {{<nb>}}**Configure health check**{{</nb>}} form that opens, specify the following values, then click the <span style="background-color:#3366cc; color:white; white-space: nowrap;"> Next </span> button.
176176

177-
- **Name** – Identifier for an NGINX Plus load balancer instance, for example {{<nb>}}**US West LB 1**.{{</nb>}}
177+
- **Name** – Identifier for an NGINX Plus load balancer instance, for example {{<nb>}}**US West LB 1**{{</nb>}}.
178178
- **What to monitor** – **Endpoint**.
179-
- **Specify endpoint by** – {{<nb>}}**IP address**.{{</nb>}}
179+
- **Specify endpoint by** – {{<nb>}}**IP address**{{</nb>}}.
180180
- **IP address** – The [elastic IP address](#elastic-ip) of the NGINX Plus load balancer.
181181
- **Port** – The port advertised to clients for your domain or web service (the default is **80**).
182182

@@ -186,7 +186,7 @@ We create health checks both for each NGINX Plus load balancer individually and
186186

187187
<img src="https://cdn-1.wp.nginx.com/wp-content/uploads/2016/10/aws-route53-get-notified-health-check.png" alt="Screenshot of Route 53 configuration screen for enabling notifications of failed health checks, during configuration of Route 53 global load balancing (GLB) with NGINX Plus" style="border:2px solid #666666; padding:2px; margin:2px;" />
188188

189-
4. Repeat Steps 2 and 3 for your other NGINX Plus load balancers (in this guide, {{<nb>}}**US West LB 2**,{{</nb>}} {{<nb>}}**US East LB 1**,{{</nb>}} and {{<nb>}}**US East LB 2**).{{</nb>}}
189+
4. Repeat Steps 2 and 3 for your other NGINX Plus load balancers (in this guide, {{<nb>}}**US West LB 2**,{{</nb>}} {{<nb>}}**US East LB 1**,{{</nb>}} and {{<nb>}}**US East LB 2**){{</nb>}}.
190190

191191
5. Proceed to the next section to configure health checks for the load balancer pairs.
192192

@@ -197,7 +197,7 @@ We create health checks both for each NGINX Plus load balancer individually and
197197

198198
2. In the {{<nb>}}**Configure health check**{{</nb>}} form that opens, specify the following values, then click the <span style="background-color:#3366cc; color:white; white-space: nowrap;"> Next </span> button.
199199

200-
- **Name** – Identifier for the pair of NGINX Plus load balancers in the first region, for example {{<nb>}}**US West LBs**.{{</nb>}}
200+
- **Name** – Identifier for the pair of NGINX Plus load balancers in the first region, for example {{<nb>}}**US West LBs**{{</nb>}}.
201201
- **What to monitor** – {{<nb>}}**Status of other health checks{{</nb>}} **.
202202
- **Health checks to monitor** – The health checks of the two US West load balancers (add them one after the other by clicking in the box and choosing them from the drop‑down menu as shown).
203203
- **Report healthy when** – **at least 1 of 2 selected health checks are healthy** (the choices in this field are obscured in the screenshot by the drop‑down menu).
@@ -206,7 +206,7 @@ We create health checks both for each NGINX Plus load balancer individually and
206206

207207
3. On the {{<nb>}}**Get notified when health check fails**{{</nb>}} screen that opens, set the **Create alarm** radio button as appropriate (see Step 5 in the <a href="#route-53-health-checks-individual">previous section</a>), then click the <span style="background-color:#3366cc; color:white; white-space: nowrap;"> Create health check </span> button.
208208

209-
4. Repeat Steps 1 through 3 for the paired load balancers in the other region [in this guide, {{<nb>}}**US East (N. Virginia)**].{{</nb>}}
209+
4. Repeat Steps 1 through 3 for the paired load balancers in the other region [in this guide, {{<nb>}}**US East (N. Virginia)**]{{</nb>}}.
210210

211211
When you have finished configuring all six health checks, the **Health checks** tab looks like this:
212212

@@ -223,13 +223,13 @@ When you have finished configuring all six health checks, the **Health checks**
223223

224224
The tab changes to display the record sets for the domain.
225225

226-
3. In the list of record sets that opens, click the row for the record set belonging to your first region [in this guide, {{<nb>}}**US West (Oregon)**].{{</nb>}} The <span style="font-weight: bolder; white-space: nowrap;">Edit Record Set</span> column opens on the right side of the tab.
226+
3. In the list of record sets that opens, click the row for the record set belonging to your first region [in this guide, {{<nb>}}**US West (Oregon)**]{{</nb>}}. The <span style="font-weight: bolder; white-space: nowrap;">Edit Record Set</span> column opens on the right side of the tab.
227227

228228
<img src="https://cdn-1.wp.nginx.com/wp-content/uploads/2016/10/aws-route53-edit-record-set.png" alt="Screenshot of interface for editing Route 53 record sets during configuration of global server load balancing (GSLB) with NGINX Plus" style="border:2px solid #666666; padding:2px; margin:2px;" />
229229

230230
4. Change the **Associate with Health Check** radio button to **Yes**.
231231

232-
5. In the **Health Check to Associate** field, select the paired health check for your first region (in this guide, {{<nb>}}**US West LBs**).{{</nb>}}
232+
5. In the **Health Check to Associate** field, select the paired health check for your first region (in this guide, {{<nb>}}**US West LBs**){{</nb>}}.
233233

234234
6. Click the <span style="background-color:#3366cc; color:white; white-space: nowrap;"> Save Record Set </span> button.
235235

@@ -282,9 +282,9 @@ These instructions assume that you have configured NGINX Plus on two EC2 instan
282282
nginx -s reload
283283
```
284284

285-
5. Repeat Steps 1 through 4 for the other three load balancers {{<nb>}}(**US West LB 2**,{{</nb>}} {{<nb>}}**US East LB 1**,{{</nb>}} and {{<nb>}}**US East LB2**).{{</nb>}}
285+
5. Repeat Steps 1 through 4 for the other three load balancers {{<nb>}}(**US West LB 2**,{{</nb>}} {{<nb>}}**US East LB 1**,{{</nb>}} and {{<nb>}}**US East LB2**){{</nb>}}.
286286

287-
In Step 3, change the filename as appropriate {{<nb>}}(**west-lb2.conf**,{{</nb>}} {{<nb>}}**east-lb1.conf**,{{</nb>}} and {{<nb>}}**east-lb2.conf**).{{</nb>}} In the {{<nb>}}**east-lb1.conf**{{</nb>}} and {{<nb>}}**east-lb2.conf**{{</nb>}} files, the `server` directives specify the public DNS names of Backup 3 and Backup 4.
287+
In Step 3, change the filename as appropriate {{<nb>}}(**west-lb2.conf**,{{</nb>}} {{<nb>}}**east-lb1.conf**,{{</nb>}} and {{<nb>}}**east-lb2.conf**){{</nb>}}. In the {{<nb>}}**east-lb1.conf**{{</nb>}} and {{<nb>}}**east-lb2.conf**{{</nb>}} files, the `server` directives specify the public DNS names of Backup 3 and Backup 4.
288288

289289
<span id="appendix"></span>
290290
## Appendix
@@ -366,7 +366,7 @@ After you complete the instructions on all instances, the list for a region (her
366366
<span id="configure-backend-servers"></span>
367367
### Configuring NGINX Open Source on the Backend Servers
368368

369-
Perform these steps on all four backend servers: {{<nb>}}**Backend 1**,{{</nb>}} {{<nb>}}**Backend 2**,{{</nb>}} {{<nb>}}**Backend 3**,{{</nb>}} and {{<nb>}}**Backend 4**.{{</nb>}} In Step 3, substitute the appropriate name for `Backend X` in the **index.html** file.
369+
Perform these steps on all four backend servers: {{<nb>}}**Backend 1**,{{</nb>}} {{<nb>}}**Backend 2**,{{</nb>}} {{<nb>}}**Backend 3**,{{</nb>}} and {{<nb>}}**Backend 4**{{</nb>}}. In Step 3, substitute the appropriate name for `Backend X` in the **index.html** file.
370370

371371
**Note:** Some commands require `root` privilege. If appropriate for your environment, prefix commands with the `sudo` command.
372372

@@ -421,7 +421,7 @@ Perform these steps on all four backend servers: {{<nb>}}**Backend 1**,{{</nb>}}
421421
<span id="configure-load-balancers"></span>
422422
### Configuring NGINX Plus on the Load Balancers
423423

424-
Perform these steps on all four backend servers: {{<nb>}}**US West LB 1**,{{</nb>}} {{<nb>}}**US West LB 2**,{{</nb>}} {{<nb>}}**US East LB 1**,{{</nb>}} and {{<nb>}}**US West LB 2**.{{</nb>}}
424+
Perform these steps on all four backend servers: {{<nb>}}**US West LB 1**,{{</nb>}} {{<nb>}}**US West LB 2**,{{</nb>}} {{<nb>}}**US East LB 1**,{{</nb>}} and {{<nb>}}**US West LB 2**{{</nb>}}.
425425

426426
**Note:** Some commands require `root` privilege. If appropriate for your environment, prefix commands with the `sudo` command.
427427

content/nginx/deployment-guides/global-server-load-balancing/ns1-global-server-load-balancing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ In this section we install and configure the NS1 agent on the same hosts as our
128128

129129
1. Follow the instructions in the [NS1 documentation](https://help.ns1.com/hc/en-us/articles/360020474154) to set up and connect a separate data feed for each of the three NGINX Plus instances, which NS1 calls _answers_.
130130

131-
On the first page (**Configure a new data source from NSONE Data Feed API v1**) specify a name for the _data source_, which is the administrative container for the data feeds you will be creating. Use the same name each of the three times you go through the instructions. We're naming the data source {{<nb>}}**NGINX-GSLB**.{{</nb>}}
131+
On the first page (**Configure a new data source from NSONE Data Feed API v1**) specify a name for the _data source_, which is the administrative container for the data feeds you will be creating. Use the same name each of the three times you go through the instructions. We're naming the data source {{<nb>}}**NGINX-GSLB**{{</nb>}}.
132132

133133
On the next page (**Create Feed from NSONE Data Feed API v1**), create a data feed for the instance. Because the **Name** field is just for internal use, any value is fine. The value in the **Label** field is used in the YAML configuration file for the instance (see Step 4 below). We're specifying labels that indicate the country (using the ISO 3166 codes) in which the instance is running:
134134

@@ -138,7 +138,7 @@ In this section we install and configure the NS1 agent on the same hosts as our
138138

139139
After creating the three feeds, note the value in the **Feeds URL** field on the <span style="background-color:#000000; color:white; font-family:helvetica; white-space: nowrap;"> INTEGRATIONS </span> tab. The final element of the URL is the ``<NS1-data-source-ID>`` you will specify in the YAML configuration file in Step 4. In the third screenshot in the [NS1 documentation](https://help.ns1.com/hc/en-us/articles/360020474154), for example, it is **e566332c5d22c6b66aeaa8837eae90ac**.
140140

141-
2. Follow the instructions in the [NS1 documentation](https://help.ns1.com/hc/en-us/articles/360017341694-Creating-managing-API-keys) to create an NS1 API key for the agent, if you have not already. (To access **Account Settings** in Step 1, click your username in the upper right corner of the NS1 title bar.) We're naming the app {{<nb>}}**NGINX-GSLB**.{{</nb>}} Make note of the key value – you'll specify it as ``<NS1-API-key>`` in the YAML configuration file in Step 4. To see the actual hexadecimal value, click on the circled letter **i** in the **API Key** field.
141+
2. Follow the instructions in the [NS1 documentation](https://help.ns1.com/hc/en-us/articles/360017341694-Creating-managing-API-keys) to create an NS1 API key for the agent, if you have not already. (To access **Account Settings** in Step 1, click your username in the upper right corner of the NS1 title bar.) We're naming the app {{<nb>}}**NGINX-GSLB**{{</nb>}}. Make note of the key value – you'll specify it as ``<NS1-API-key>`` in the YAML configuration file in Step 4. To see the actual hexadecimal value, click on the circled letter **i** in the **API Key** field.
142142

143143
3. On each NGINX Plus host, clone the [GitHub repo](https://github.com/nginxinc/nginx-ns1-gslb) for the NS1 agent.
144144

0 commit comments

Comments
 (0)