Skip to content

Commit dd33c92

Browse files
ADubhlaoichADubhlaoich
committed
Merge branch 'main' into docs/ia-heuristics
2 parents 1a0a510 + 90cf13c commit dd33c92

Some content is hidden

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

65 files changed

+4381
-2460
lines changed

‎.github/workflows/ossf_scorecard.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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/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/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/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
---

content/ngf/releases.md renamed to content/ngf/changelog.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: Releases
3-
description: "NGINX Gateway Fabric releases."
4-
weight: 700
2+
title: Changelog
53
toc: true
6-
type: reference
7-
product: NGF
8-
docs: "DOCS-1359"
4+
weight: 900
5+
nd-content-type: reference
6+
nd-product: NGF
7+
nd-docs: "DOCS-1359"
98
---
109

1110
See the NGINX Gateway Fabric changelog page:

0 commit comments

Comments
 (0)