Skip to content

Commit 56fa0e5

Browse files
committed
Merge remote-tracking branch 'origin' into epic-472-port-nginx-one-labs
2 parents 411d3b8 + de52c05 commit 56fa0e5

File tree

127 files changed

+4997
-3087
lines changed

Some content is hidden

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

127 files changed

+4997
-3087
lines changed

.github/workflows/ossf_scorecard.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
persist-credentials: false
3535

3636
- name: Run analysis
37-
uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
37+
uses: ossf/scorecard-action@05b42c624433fc40578a4040d5cf5e36ddca8cde # v2.4.2
3838
with:
3939
results_file: results.sarif
4040
results_format: sarif
@@ -56,6 +56,6 @@ jobs:
5656

5757
# Upload the results to GitHub's code scanning dashboard.
5858
- name: Upload SARIF results to code scanning
59-
uses: github/codeql-action/upload-sarif@28deaeda66b76a05916b6923827895f2b14ab387 # v3.28.16
59+
uses: github/codeql-action/upload-sarif@fca7ace96b7d713c7035871441bd52efbe39e27e # v3.28.19
6060
with:
6161
sarif_file: results.sarif

_banners/agent-v3-release.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{{< banner "notice" "NGINX Agent 3.0 is now available" >}}
2+
3+
4+
F5 NGINX One Console does not currently support Agent 3.x. If you are using NGINX One Console in your environment, upgrade to the latest Agent 2.x version by following the [Upgrade NGINX Agent](/nginx-agent/installation-upgrade/upgrade/) guide.
5+
6+
Please see the [Technical specifications](/nginx-agent/technical-specifications/) for product compatibility.
7+
8+
9+
{{< /banner >}}

_banners/ngf-2.0-release.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{{< banner "notice" "NGINX Gateway Fabric 2.0 is now available" >}}
2+
3+
NGINX Gateway Fabric 2.0 has released! Follow [these instructions]({{< ref "/ngf/install/upgrade-version.md#upgrade-from-v1x-to-v2x" >}}) to upgrade from 1.x to 2.0.
4+
5+
For 1.x, checkout [an older version]({{< ref "/ngf/install/upgrade-version.md#access-nginx-gateway-fabric-1x-documentation" >}}) of documentation.
6+
7+
{{< /banner >}}

_banners/upgrade-r33.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{{< banner "caution" "NGINX Plus R33 requires NGINX Instance Manager 2.18 or later" >}}
22
If your NGINX data plane instances are running NGINX Plus R33 or later, you must upgrade to NGINX Instance Manager 2.18 or later to support usage reporting. NGINX Plus R33 instances must report usage data to the F5 licensing endpoint or NGINX Instance Manager. Otherwise, they will stop processing traffic.
33
<br><br>
4-
For more details about usage reporting and enforcement, see [About solution licenses](../../../../solutions/about-subscription-licenses)
4+
For more details about usage reporting and enforcement, see [About solution licenses]({{< ref "/solutions/about-subscription-licenses.md" >}})
55
{{</ banner >}}

content/agent/_index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
---
22
title: NGINX Agent
3-
description: NGINX Agent is a companion daemon for your NGINX Open Source or NGINX
4-
Plus instance.
53
url: /nginx-agent/
64
cascade:
75
logo: NGINX-product-icon.png
6+
banner:
7+
enabled: true
8+
type: deprecation
9+
start-date: 2025-05-29
10+
end-date: 2025-09-09
11+
md: /_banners/agent-v3-release.md
812
---

content/agent/configuration/configure-nginx-agent-features.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ weight: 150
55
toc: true
66
type:
77
- how-to
8+
docs: DOCS-1678
89
---
910

1011
## Overview
@@ -47,7 +48,7 @@ The following table lists the NGINX Agent features.
4748
ssh user@your-nginx-instance
4849
```
4950

50-
2. **Edit NGINX Agent configuration:**
51+
2. **Edit NGINX Agent configuration:**
5152

5253
```
5354
sudo vim /etc/nginx-agent/nginx-agent.conf
@@ -60,7 +61,7 @@ The following table lists the NGINX Agent features.
6061
- metrics
6162
- metrics-throttle
6263
- dataplane-status
63-
```
64+
```
6465

6566
4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes.
6667

@@ -73,7 +74,7 @@ Once the steps have been completed, users will be able to view metrics data bein
7374
ssh user@your-nginx-instance
7475
```
7576

76-
2. **Edit NGINX Agent configuration:**
77+
2. **Edit NGINX Agent configuration:**
7778

7879
```
7980
sudo vim /etc/nginx-agent/nginx-agent.conf
@@ -86,9 +87,9 @@ Once the steps have been completed, users will be able to view metrics data bein
8687
- nginx-config-async
8788
- dataplane-status
8889
- file-watcher
89-
```
90+
```
9091

9192
4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes.
9293

93-
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.
94+
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.
9495

content/agent/configuration/health-checks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ weight: 400
55
toc: true
66
type:
77
- how-to
8+
docs: DOCS-1677
89
---
910

1011
## Overview

content/agent/installation-upgrade/upgrade.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ type:
1212

1313
Learn how to upgrade NGINX Agent.
1414

15-
## Upgrade NGINX Agent from version v2.31.0 or greater
16-
17-
{{< note >}} Starting from version v2.31.0, NGINX Agent will automatically restart itself during an upgrade. {{< /note >}}
15+
## Upgrade NGINX Agent
1816

1917
To upgrade NGINX Agent, follow these steps:
2018

@@ -41,43 +39,48 @@ To upgrade NGINX Agent, follow these steps:
4139
sudo apt-get install -y --only-upgrade nginx-agent -o Dpkg::Options::="--force-confold"
4240
```
4341

42+
## Upgrade NGINX Agent to a Specific Version
4443

44+
To upgrade NGINX Agent to a specific **v2.x version**, follow these steps:
4545

46-
## Upgrade NGINX Agent from a version less than v2.31.0
47-
48-
To upgrade NGINX Agent, take the following steps:
46+
#### Steps to Upgrade:
4947

50-
1. Open an SSH connection to the server where you’ve installed NGINX Agent and log in.
48+
1. Open an SSH connection to the server running NGINX Agent and log in.
5149

52-
1. Make a backup copy of the following locations to ensure that you can successfully recover if the upgrade has issues:
50+
1. Back up the following files and directories to ensure you can restore the environment in case of issues during the upgrade:
5351

5452
- `/etc/nginx-agent`
55-
- `config_dirs` values for any configuration specified in `/etc/nginx-agent/nginx-agent.conf`
56-
57-
1. Stop NGINX Agent:
53+
- Any `config_dirs` directory specified in `/etc/nginx-agent/nginx-agent.conf`.
5854

59-
```shell
60-
sudo systemctl stop nginx-agent
61-
```
62-
63-
1. Install the updated version of NGINX Agent:
64-
65-
- CentOS, RHEL, RPM-Based
55+
1. Perform the version-controlled upgrade.
6656

57+
- Debian, Ubuntu, Deb-Based
58+
6759
```shell
68-
sudo yum -y makecache
69-
sudo yum update -y nginx-agent
60+
sudo apt-get update
61+
sudo apt-get install -y nginx-agent=<specific-version> -o Dpkg::Options::="--force-confold"
7062
```
71-
72-
- Debian, Ubuntu, Deb-Based
73-
63+
64+
Example (to upgrade to version 2.41.1~noble):
65+
7466
```shell
75-
sudo apt-get update
76-
sudo apt-get install -y --only-upgrade nginx-agent -o Dpkg::Options::="--force-confold"
67+
sudo apt-get install -y nginx-agent=2.41.1~noble -o Dpkg::Options::="--force-confold"
7768
```
7869

79-
1. Start NGINX Agent:
70+
- CentOS, RHEL, RPM-Based
71+
72+
```shell
73+
sudo yum install -y nginx-agent-<specific-version>
74+
```
75+
76+
Example (to upgrade to version `2.41.1`):
77+
78+
```shell
79+
sudo yum install -y nginx-agent-2.41.1
80+
```
8081

82+
1. Verify the installed version:
83+
8184
```shell
82-
sudo systemctl start nginx-agent
85+
sudo nginx-agent --version
8386
```

content/agent/technical-specifications.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ type:
1212

1313
This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
1414

15+
## NGINX Agent v3.0 Compatibility
16+
{{< bootstrap-table "table table-striped table-bordered" >}}
17+
| NGINX Product | Agent Version |
18+
|------------------------------|----------------|
19+
| **NGINX One Console** | 2.x |
20+
| **NGINX Gateway Fabric** | 3.x |
21+
| **NGINX Plus** | 2.x, 3.x |
22+
| **NGINX Ingress Controller** | 2.x |
23+
| **NGINX Instance Manager** | 2.x |
24+
{{< /bootstrap-table >}}
25+
1526
## Supported Distributions
1627

1728
NGINX Agent can run in most environments. We support the following distributions:

content/includes/ngf/installation/helm/pulling-the-chart.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22
docs: "DOCS-1439"
33
---
44

5-
Pull the latest stable release of the NGINX Gateway Fabric chart:
5+
```shell
6+
helm pull oci://ghcr.io/nginx/charts/nginx-gateway-fabric --untar
7+
cd nginx-gateway-fabric
8+
```
69

7-
```shell
8-
helm pull oci://ghcr.io/nginx/charts/nginx-gateway-fabric --untar
9-
cd nginx-gateway-fabric
10-
```
11-
12-
If you want the latest version from the **main** branch, add `--version 0.0.0-edge` to your pull command.
10+
For the latest version from the **main** branch, add _--version 0.0.0-edge_ to your pull command.

0 commit comments

Comments
 (0)