Skip to content

Commit 12e934b

Browse files
authored
Merge branch 'main' into NLB-6773
2 parents 2ae2cbb + 2e9dc3f commit 12e934b

File tree

49 files changed

+1660
-291
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1660
-291
lines changed

.github/workflows/dot-org-content.yml

Lines changed: 0 additions & 56 deletions
This file was deleted.

.github/workflows/playwright.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
runs-on: ubuntu-latest
1010
steps:
1111
- uses: actions/checkout@v4
12-
- uses: actions/setup-node@v4
12+
- uses: actions/setup-node@v5
1313
with:
1414
node-version: lts/*
1515
- name: Install dependencies
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: Features configuration
3+
weight: 150
4+
toc: true
5+
nd-docs: DOCS-000
6+
nd-content-type: how-to
7+
---
8+
9+
## Overview
10+
11+
This guide describes the F5 NGINX Agent features, and how to enable and disable features using the NGINX Agent configuration file.
12+
13+
## Before you begin
14+
15+
Before you start, make sure that you have:
16+
17+
- [NGINX Agent installed]({{< ref "/agent/installation-upgrade/" >}}) in your system.
18+
- Access to the NGINX Agent configuration file.
19+
20+
## Features
21+
22+
The following table lists the NGINX Agent features:
23+
24+
{{< table "features" >}}
25+
| Feature Name | Description | Default/Non-default |
26+
| ---------------- | ----------------------------------------------------------------------- | ------------------- |
27+
| registration | Registering the NGINX Agent with the management plane. | Default |
28+
| nginx-config-async | Enable the publishing and uploading of NGINX configurations from the management plane. | Default |
29+
| metrics | Enable collecting of NGINX metrics. | Default |
30+
| metrics-throttle | Batch metrics before sending. | Non-default |
31+
| metrics-sender | Reports metrics over the gRPC connection. | Non-default |
32+
| dataplane-status | Report the health of the NGINX Instance. | Default |
33+
| process-watcher | Observe changes to the NGINX process. | Default |
34+
| file-watcher | Observe changes to the NGINX configuration or any changes to files on disk. | Default |
35+
| activity-events | Send NGINX or NGINX Agent related events to the management plane. | Default |
36+
| agent-api | Enable the NGINX Agent REST API. | Default |
37+
{{< /table >}}
38+
39+
## Use cases
40+
41+
### Enable metrics only
42+
43+
1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running.
44+
45+
`ssh user@your-nginx-instance`
46+
47+
1. Open the NGINX Agent configuration file in a text editor.
48+
49+
`sudo vim /etc/nginx-agent/nginx-agent.conf`
50+
51+
1. Add the features section: Add the following to the end of the configuration file if it doesn't already exist.
52+
53+
```nginx
54+
features:
55+
- metrics
56+
- metrics-throttle
57+
- dataplane-status
58+
```
59+
60+
1. Restart the NGINX Agent service to apply the changes.
61+
62+
`sudo systemctl restart nginx-agent`
63+
64+
Once the steps have been completed, users will be able to view metrics data being sent but will not have the capability to push NGINX configuration changes.
65+
66+
### Enable the publishing of NGINX configurations and disable the collection of metrics
67+
68+
1. Access the NGINX instance: Connect using SSH to the VM or server where NGINX Agent is running.
69+
70+
`ssh user@your-nginx-instance`
71+
72+
1. Open the NGINX Agent configuration file in a text editor.
73+
74+
`sudo vim /etc/nginx-agent/nginx-agent.conf`
75+
76+
1. Add the fetures section: Add the following to the end of the configuration file if it doesn't already exist.
77+
78+
```nginx
79+
features:
80+
- nginx-config-async
81+
- dataplane-status
82+
- file-watcher
83+
84+
1. Restart the NGINX Agent service to apply the changes.
85+
86+
`sudo systemctl restart nginx-agent`
87+
88+
Once the steps have been completed, users will be able to publish NGINX configurations but metrics data will not be collected by the NGINX Agent.

content/includes/nginx-one/how-to/install-nginx-agent.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ files:
88
After entering your data plane key, you'll see a `curl` command to install NGINX Agent, similar to the one below. Copy and run this command on each NGINX instance. Once installed, NGINX Agent typically registers with NGINX One within a few seconds.
99

1010
{{<call-out "important" "Connecting to NGINX One" >}}
11-
Ensure that any firewall rules you have in place for your NGINX hosts allows network traffic to port `443` for all of the following IPs:
11+
Make sure your firewall rules for NGINX hosts allow traffic to port `443` from these IP address ranges:
1212

13-
- `3.135.72.139`
14-
- `3.133.232.50`
15-
- `52.14.85.249`
13+
- `3.135.72.139/32`
14+
- `3.133.232.50/32`
15+
- `52.14.85.249/32`
16+
- `2600:1f16:19c8:d400::/62`
1617

17-
NGINX Agent must be able to establish a connection to NGINX One Console's Agent endpoint (`agent.connect.nginx.com`).
18+
NGINX Agent must be able to establish a connection to NGINX One Console's Agent endpoint (`agent.connect.nginx.com`).
1819
{{</call-out>}}
1920

2021
To install NGINX Agent on an NGINX instance:

content/nap-dos/deployment-guide/learn-about-deployment.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -413,22 +413,28 @@ When deploying App Protect DoS on NGINX Plus take the following precautions to s
413413
414414
6. Enable Yum repositories to pull NGINX App Protect DoS dependencies:
415415
416-
If you have a RHEL subscription:
416+
For RHEL subscription:
417417
418418
```shell
419419
sudo subscription-manager repos --enable=rhel-8-for-x86_64-baseos-rpms
420420
sudo subscription-manager repos --enable=rhel-8-for-x86_64-appstream-rpms
421421
sudo dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
422422
```
423423
424-
7. Add NGINX Plus and NGINX App Protect DoS repository:
424+
For RockyLinux:
425+
426+
```shell
427+
sudo dnf -y install epel-release
428+
```
429+
430+
8. Add NGINX Plus and NGINX App Protect DoS repository:
425431
426432
```shell
427433
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/nginx-plus-8.repo
428434
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/app-protect-dos-8.repo
429435
```
430436
431-
8. In case of fresh installation, update the repository and install the most recent version of the NGINX Plus App Protect DoS package (which includes NGINX Plus):
437+
9. In case of fresh installation, update the repository and install the most recent version of the NGINX Plus App Protect DoS package (which includes NGINX Plus):
432438
433439
```shell
434440
sudo dnf install app-protect-dos
@@ -457,7 +463,7 @@ When deploying App Protect DoS on NGINX Plus take the following precautions to s
457463
sudo dnf install app-protect-dos-27+2.4.0
458464
```
459465
460-
9. In case of upgrading from previously installed NGINX Plus App Protect DoS package (which includes NGINX Plus):
466+
10. In case of upgrading from previously installed NGINX Plus App Protect DoS package (which includes NGINX Plus):
461467
462468
```shell
463469
sudo dnf remove nginx-plus
@@ -621,14 +627,20 @@ When deploying App Protect DoS on NGINX Plus take the following precautions to s
621627
622628
6. Enable the yum repositories to pull NGINX App Protect DoS dependencies:
623629
624-
If you have a RHEL subscription:
630+
For RHEL subscription:
625631
626632
```shell
627633
sudo subscription-manager repos --enable=rhel-9-for-x86_64-baseos-rpms
628634
sudo subscription-manager repos --enable=rhel-9-for-x86_64-appstream-rpms
629635
sudo dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
630636
```
631637
638+
For RockyLinux:
639+
640+
```shell
641+
sudo dnf -y install epel-release
642+
```
643+
632644
7. Add the NGINX Plus and NGINX App Protect DoS repositories:
633645
634646
```shell

0 commit comments

Comments
 (0)