Skip to content

Commit 1123dfb

Browse files
authored
Merge branch 'main' into custom-landing
2 parents a7f2528 + 14d6e21 commit 1123dfb

File tree

74 files changed

+4600
-2624
lines changed

Some content is hidden

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

74 files changed

+4600
-2624
lines changed

.github/workflows/ossf_scorecard.yml

Lines changed: 1 addition & 1 deletion
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

_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 >}}

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/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.

content/includes/ngf/installation/install-gateway-api-experimental-features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ kubectl kustomize "https://github.com/nginx/nginx-gateway-fabric/config/crd/gate
1717
To enable experimental features on NGINX Gateway Fabric:
1818

1919
Using Helm: Set `nginxGateway.gwAPIExperimentalFeatures.enable` to true. An example can be found
20-
in the [Installation with Helm]({{< ref "/ngf/installation/installing-ngf/helm.md#custom-installation-options" >}}) guide.
20+
in the [Installation with Helm]({{< ref "/ngf/install/helm.md#custom-installation-options" >}}) guide.
2121

2222
Using Kubernetes manifests: Add the `--gateway-api-experimental-features` command-line flag to the deployment manifest args.
23-
An example can be found in the [Installation with Kubernetes manifests]({{< ref "/ngf/installation/installing-ngf/manifests.md#3-deploy-nginx-gateway-fabric" >}}) guide.
23+
An example can be found in the [Installation with Kubernetes manifests]({{< ref "/ngf/install/manifests.md#3-deploy-nginx-gateway-fabric" >}}) guide.

content/includes/ngf/installation/nginx-plus/docker-registry-secret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs: "DOCS-000"
33
---
44

5-
{{< note >}} If you would rather pull the NGINX Plus image and push to a private registry, you can skip this specific step and instead follow [this step]({{< ref "/ngf/installation/nginx-plus-jwt.md#pulling-an-image-for-local-use" >}}). {{< /note >}}
5+
{{< note >}} If you would rather pull the NGINX Plus image and push to a private registry, you can skip this specific step and instead follow [this step]({{< ref "/ngf/install/nginx-plus.md#pulling-an-image-for-local-use" >}}). {{< /note >}}
66

77
If the `nginx-gateway` namespace does not yet exist, create it:
88

content/includes/nim/tech-specs/nim-app-protect-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ NGINX Instance Manager supports the following versions of [NGINX App Protect WAF
88

99
| NGINX Instance Manager | NGINX App Protect WAF |
1010
|------------------------|------------------------------------|
11-
| 2.17.0–2.19.1 | Release 4.8.0–4.14.0, 5.1.0–5.6.0 |
11+
| 2.17.0–2.19.2 | Release 4.8.0–4.14.0, 5.1.0–5.6.0 |
1212
| 2.15.1–2.16.0 | Release 4.8.0–4.10.0 |
1313
| 2.14.1–2.15.0 | Release 4.4.0–4.7.0 |
1414
| 2.13.0–2.14.0 | Release 4.3.0–4.5.0 |

content/ngf/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
---
22
title: "NGINX Gateway Fabric"
33
url: /nginx-gateway-fabric/
4+
cascade:
5+
banner:
6+
enabled: true
7+
type: deprecation
8+
start-date: 2025-05-30
9+
md: /_banners/ngf-2.0-release.md
410
---

0 commit comments

Comments
 (0)