Skip to content

applied nb shortcode for non-breaking spaces and hyphens #627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ To quickly set up an NGINX Plus environment on AWS:

Click the **Continue to Subscribe** button to proceed to the **Launch on EC2** page.

3. Select the type of launch by clicking the appropriate tab (**1‑Click Launch***, **Manual Launch**, or **Service Catalog**). Choose the desired options for billing, instance size, and so on, and click the **Accept Software Terms…** button.
4. When configuring the firewall rules, add a rule to accept web traffic on TCP ports 80 and 443 (this happens automatically if you launch from the **1‑Click Launch** tab).
3. Select the type of launch by clicking the appropriate tab ({{<nb>}}**1-Click Launch**{{</nb>}}, {{<nb>}}**Manual Launch**{{</nb>}}, or {{<nb>}}**Service Catalog**{{</nb>}}). Choose the desired options for billing, instance size, and so on, and click the {{<nb>}}**Accept Software Terms…**{{</nb>}} button.
4. When configuring the firewall rules, add a rule to accept web traffic on TCP ports 80 and 443 (this happens automatically if you launch from the {{<nb>}}**1-Click Launch**{{</nb>}} tab).
5. As soon as the new EC2 instance launches, NGINX Plus starts automatically and serves a default **index.html** page. To view the page, use a web browser to access the public DNS name of the new instance. You can also check the status of the NGINX Plus server by logging into the EC2 instance and running this command:

```nginx
Expand Down
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/monitoring/new-relic-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Download the [plug‑in and installation instructions](https://docs.newrelic.com

## Configuring the Plug‑In

The configuration file for the NGINX plug‑in is **/etc/nginx&#8209;nr&#8209;agent/nginx&#8209;nr&#8209;agent.ini**. The minimal configuration includes:
The configuration file for the NGINX plug‑in is {{<nb>}}**/etc/nginx-nr-agent/nginx-nr-agent.ini**{{</nb>}}. The minimal configuration includes:

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

Expand All @@ -44,7 +44,7 @@ The configuration file for the NGINX plug‑in is **/etc/nginx&#8209;nr&#8209;ag

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.

The default log file is **/var/log/nginx&#8209;nr&#8209;agent.log**.
The default log file is {{<nb>}}**/var/log/nginx-nr-agent.log**{{</nb>}}.

## Running the Plug‑In

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ Allocate an Elastic IP address and remember its ID. For detailed instructions, s

The NGINX Plus HA solution uses two scripts, which are invoked by `keepalived`:

- **nginx&#8209;ha&#8209;check** – Determines the health of NGINX Plus.
- **nginx&#8209;ha&#8209;notify** – Moves the Elastic IP address when a state transition happens, for example when the backup instance becomes the primary.
- {{<nb>}}**nginx-ha-check**{{</nb>}} – Determines the health of NGINX Plus.
- {{<nb>}}**nginx-ha-notify**{{</nb>}} – Moves the Elastic IP address when a state transition happens, for example when the backup instance becomes the primary.

1. Create a directory for the scripts, if it doesn’t already exist.

Expand All @@ -121,7 +121,7 @@ The NGINX Plus HA solution uses two scripts, which are invoked by `keepalived`:
There are two configuration files for the HA solution:

- **keepalived.conf** – The main configuration file for `keepalived`, slightly different for each NGINX Plus instance.
- **nginx&#8209;ha&#8209;notify** – The script you downloaded in [Step 4](#ha-aws_ha-scripts), with several user‑defined variables.
- {{<nb>}}**nginx-ha-notify**{{</nb>}} – The script you downloaded in [Step 4](#ha-aws_ha-scripts), with several user‑defined variables.

<span id="ha-aws_keepalived-conf-file"></span>
### Creating keepalived.conf
Expand Down Expand Up @@ -158,8 +158,8 @@ You must change values for the following configuration keywords. As you do so, a

- `script` in the `chk_nginx_service` block – The script that sends health checks to NGINX Plus.

- On Ubuntu systems, **/usr/lib/keepalived/nginx&#8209;ha&#8209;check**
- On CentOS systems, **/usr/libexec/keepalived/nginx&#8209;ha&#8209;check**
- On Ubuntu systems, {{<nb>}}**/usr/lib/keepalived/nginx-ha-check**{{</nb>}}
- On CentOS systems, {{<nb>}}**/usr/libexec/keepalived/nginx-ha-check**{{</nb>}}

- `priority` – The value that controls which instance becomes primary, with a higher value meaning a higher priority. Use `101` for the primary instance and `100` for the backup.

Expand All @@ -171,13 +171,13 @@ You must change values for the following configuration keywords. As you do so, a

- `notify` – The script that is invoked during a state transition.

- On Ubuntu systems, **/usr/lib/keepalived/nginx&#8209;ha&#8209;notify**
- On CentOS systems, **/usr/libexec/keepalived/nginx&#8209;ha&#8209;notify**
- On Ubuntu systems, {{<nb>}}**/usr/lib/keepalived/nginx-ha-notify**{{</nb>}}
- On CentOS systems, {{<nb>}}**/usr/libexec/keepalived/nginx-ha-notify**{{</nb>}}

<span id="ha-aws_nginx-ha-notify-script"></span>
### Creating nginx-ha-notify

Modify the user‑defined variables section of the **nginx&#8209;ha&#8209;notify** script, replacing each `<value>` placeholder with the value specified in the list below:
Modify the user‑defined variables section of the {{<nb>}}**nginx-ha-notify**{{</nb>}} script, replacing each `<value>` placeholder with the value specified in the list below:

```none
export AWS_ACCESS_KEY_ID=<value>
Expand Down Expand Up @@ -223,7 +223,7 @@ Check the state on the backup instance, confirming that it has transitioned to `
<span id="ha-aws_troubleshooting"></span>
## Troubleshooting

If the solution doesn’t work as expected, check the `keepalived` logs, which are written to **/var/log/syslog**. Also, you can manually run the commands that invoke the `awscli` utility in the **nginx&#8209;ha&#8209;notify** script to check that the utility is working properly.
If the solution doesn’t work as expected, check the `keepalived` logs, which are written to **/var/log/syslog**. Also, you can manually run the commands that invoke the `awscli` utility in the {{<nb>}}**nginx-ha-notify**{{</nb>}} script to check that the utility is working properly.

<span id="ha-aws_caveats"></span>
## Caveats
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ Configure NGINX Plus instances as load balancers. These distribute requests to

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" >}}).

Repeat the instructions on both **ngx&#8209;plus&#8209;1** and **ngx&#8209;plus&#8209;2**.
Repeat the instructions on both {{<nb>}}**ngx-plus-1**{{</nb>}} and {{<nb>}}**ngx-plus-2**{{</nb>}}.

<span id="create-instances-automated"></span>
### Automate instance setup with Packer and Terraform
Expand All @@ -317,7 +317,7 @@ To run the scripts, follow these instructions:

3. Set your AWS credentials in the Packer and Terraform scripts:

- For Packer, set your credentials in the `variables` block in <span style="text-decoration: underline;">both</span> **packer/ngx&#8209;oss/packer.json** and **packer/ngx&#8209;plus/packer.json**:
- For Packer, set your credentials in the `variables` block in <span style="text-decoration: underline;">both</span> {{<nb>}}**packer/ngx-oss/packer.json**{{</nb>}} and {{<nb>}}**packer/ngx-plus/packer.json**{{</nb>}}:

```none
"variables": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ This guide covers the `eksctl` command as it is the simplest option.

1. Follow the instructions in the [eksctl.io documentation](https://eksctl.io/installation/) to install or update the `eksctl` command.

2. Create an Amazon EKS cluster by following the instructions in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html). Select the **Managed&nbsp;nodes&nbsp;–&nbsp;Linux** option for each step. Note that the <span style="white-space: nowrap;">`eksctl create cluster`</span> command in the first step can take ten minutes or more.
2. Create an Amazon EKS cluster by following the instructions in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html). Select the {{<nb>}}**Managed nodesLinux**{{</nb>}} option for each step. Note that the <span style="white-space: nowrap;">`eksctl create cluster`</span> command in the first step can take ten minutes or more.

<span id="amazon-ecr"></span>
## Push the NGINX Plus Ingress Controller Image to AWS ECR

This step is only required if you do not plan to use the prebuilt NGINX Open Source image.

1. Use the [AWS documentation](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html) to create a repository in the Amazon Elastic Container Registry (ECR). In Step 4 of the AWS instructions, name the repository **nginx&#8209;plus&#8209;ic** as that is what we use in this guide.
1. Use the [AWS documentation](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html) to create a repository in the Amazon Elastic Container Registry (ECR). In Step 4 of the AWS instructions, name the repository {{<nb>}}**nginx-plus-ic**{{</nb>}} as that is what we use in this guide.

2. Run the following AWS CLI command. It generates an auth token for your AWS ECR registry, then pipes it into the `docker login` command. This lets AWS ECR authenticate and authorize the upcoming Docker requests. For details about the command, see the [AWS documentation](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html).

Expand Down
Loading
Loading