Merge branch 'main' into internal/nim-release-2.20.0

Author: travisamartin

.github/workflows/ossf_scorecard.yml

@@ -34,7 +34,7 @@ jobs:
           persist-credentials: false
 
       - name: Run analysis
-        uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
+        uses: ossf/scorecard-action@05b42c624433fc40578a4040d5cf5e36ddca8cde # v2.4.2
         with:
           results_file: results.sarif
           results_format: sarif
@@ -56,6 +56,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: Upload SARIF results to code scanning
-        uses: github/codeql-action/upload-sarif@28deaeda66b76a05916b6923827895f2b14ab387 # v3.28.16
+        uses: github/codeql-action/upload-sarif@fca7ace96b7d713c7035871441bd52efbe39e27e # v3.28.19
         with:
           sarif_file: results.sarif

_banners/eos-cltr.md

@@ -0,0 +1,8 @@
+{{< banner "warning" "End of Sale Notice:" >}}
+  <br>
+  F5 NGINX is announcing the <strong>End of Sale (EoS)</strong> for NGINX Controller Application Delivery Module, <strong>effective January 1, 2024</strong>.
+  <br><br>
+  F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing NGINX Controller Application Delivery customers can continue to use the product past the EoS date. <strong>License renewals are not available after September 30, 2024.</strong>
+  <br><br>
+  See our <a href="https://my.f5.com/manage/s/article/K000137993">End of Sale announcement</a> for more details
+{{</ banner >}}

_banners/eos-mesh.md

@@ -0,0 +1,8 @@
+{{< banner "warning" "End of Sale Notice:" >}}
+  <br>
+  F5 NGINX is announcing the <strong>End of Sale (EoS)</strong> for NGINX Management Suite API Connectivity Manager Module, <strong>effective January 1, 2024</strong>.
+  <br><br>
+  F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing API Connectivity Manager Module customers can continue to use the product past the EoS date. <strong>License renewals are not available after September 30, 2024.</strong>
+  <br><br>
+  See our <a href="https://my.f5.com/manage/s/article/K000137989">End of Sale announcement</a> for more details.
+{{</ banner >}}

_banners/ngf-2.0-release.md

@@ -0,0 +1,7 @@
+{{< banner "notice" "NGINX Gateway Fabric 2.0 is now available" >}}
+
+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.
+
+For 1.x, checkout [an older version]({{< ref "/ngf/install/upgrade-version.md#access-nginx-gateway-fabric-1x-documentation" >}}) of documentation.
+
+{{< /banner >}}

_banners/upgrade-r33.md

@@ -0,0 +1,5 @@
+{{< banner "caution" "NGINX Plus R33 requires NGINX Instance Manager 2.18 or later" >}}
+  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. 
+  <br><br>
+  For more details about usage reporting and enforcement, see [About solution licenses]({{< ref "/solutions/about-subscription-licenses.md" >}})
+{{</ banner >}}

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

@@ -5,6 +5,7 @@ weight: 150
 toc: true
 type:
 - how-to
+docs: DOCS-1678
 ---
 
 ## Overview
@@ -47,7 +48,7 @@ The following table lists the NGINX Agent features.
     ssh user@your-nginx-instance
 ```
 
-2. **Edit NGINX Agent configuration:** 
+2. **Edit NGINX Agent configuration:**
 
 ```
     sudo vim /etc/nginx-agent/nginx-agent.conf
@@ -60,7 +61,7 @@ The following table lists the NGINX Agent features.
       - metrics
       - metrics-throttle
       - dataplane-status
-``` 
+```
 
 4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes.
 
@@ -73,7 +74,7 @@ Once the steps have been completed, users will be able to view metrics data bein
     ssh user@your-nginx-instance
 ```
 
-2. **Edit NGINX Agent configuration:** 
+2. **Edit NGINX Agent configuration:**
 
 ```
     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
       - nginx-config-async
       - dataplane-status
       - file-watcher
-``` 
+```
 
 4. **Restart the NGINX Agent service:** Restart the NGINX Agent service to enable changes.
 
-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. 
+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/agent/configuration/health-checks.md

@@ -5,6 +5,7 @@ weight: 400
 toc: true
 type:
 - how-to
+docs: DOCS-1677
 ---
 
 ## Overview

content/agent/installation-upgrade/upgrade.md

@@ -12,9 +12,7 @@ type:
 
 Learn how to upgrade NGINX Agent.
 
-## Upgrade NGINX Agent from version v2.31.0 or greater
-
-{{< note >}} Starting from version v2.31.0, NGINX Agent will automatically restart itself during an upgrade. {{< /note >}}
+## Upgrade NGINX Agent
 
 To upgrade NGINX Agent, follow these steps:
 
@@ -41,43 +39,48 @@ To upgrade NGINX Agent, follow these steps:
         sudo apt-get install -y --only-upgrade nginx-agent -o Dpkg::Options::="--force-confold"
         ```
 
+## Upgrade NGINX Agent to a Specific Version 
 
+To upgrade NGINX Agent to a specific **v2.x version**, follow these steps: 
 
-## Upgrade NGINX Agent from a version less than v2.31.0
-
-To upgrade NGINX Agent, take the following steps:
+#### Steps to Upgrade: 
 
-1. Open an SSH connection to the server where you’ve installed NGINX Agent and log in.
+1. Open an SSH connection to the server running  NGINX Agent and log in.
 
-1. Make a backup copy of the following locations to ensure that you can successfully recover if the upgrade has issues:
+1. Back up the following files and directories to ensure you can restore the environment in case of issues during the upgrade: 
 
     - `/etc/nginx-agent`
-    - `config_dirs` values for any configuration specified in `/etc/nginx-agent/nginx-agent.conf`
-
-1. Stop NGINX Agent:
+    - Any `config_dirs` directory specified in `/etc/nginx-agent/nginx-agent.conf`.
 
-    ```shell
-    sudo systemctl stop nginx-agent
-    ```
-
-1. Install the updated version of NGINX Agent:
-
-    - CentOS, RHEL, RPM-Based
+1. Perform the version-controlled upgrade. 
 
+   - Debian, Ubuntu, Deb-Based
+        
         ```shell
-        sudo yum -y makecache
-        sudo yum update -y nginx-agent
+        sudo apt-get update
+        sudo apt-get install -y nginx-agent=<specific-version> -o Dpkg::Options::="--force-confold"
         ```
-
-    - Debian, Ubuntu, Deb-Based
-
+        
+        Example (to upgrade to version 2.41.1~noble): 
+        
         ```shell
-        sudo apt-get update
-        sudo apt-get install -y --only-upgrade nginx-agent -o Dpkg::Options::="--force-confold"
+        sudo apt-get install -y nginx-agent=2.41.1~noble -o Dpkg::Options::="--force-confold"
         ```
 
-1. Start NGINX Agent:
+    - CentOS, RHEL, RPM-Based        
+       
+        ```shell
+        sudo yum install -y nginx-agent-<specific-version>
+        ```
+        
+        Example (to upgrade to version `2.41.1`): 
+    
+        ```shell
+        sudo yum install -y nginx-agent-2.41.1
+        ```
 
+1. Verify the installed version:    
+    
     ```shell
-    sudo systemctl start nginx-agent
+    sudo nginx-agent --version
     ```

content/controller/_index.md

@@ -5,8 +5,11 @@ title: F5 NGINX Controller
 weight: 2100
 cascade:
   logo: "NGINX-Controller-product-icon-RGB.svg"
-  type: "ctlr-eos"
   noindex: true
+  banner:
+    enabled: true
+    type: deprecation
+    md: _banners/eos-cltr.md
 url: /nginx-controller/
 ---
 

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

@@ -2,11 +2,9 @@
 docs: "DOCS-1439"
 ---
 
-Pull the latest stable release of the NGINX Gateway Fabric chart:
+```shell
+helm pull oci://ghcr.io/nginx/charts/nginx-gateway-fabric --untar
+cd nginx-gateway-fabric
+```
 
-   ```shell
-   helm pull oci://ghcr.io/nginx/charts/nginx-gateway-fabric --untar
-   cd nginx-gateway-fabric
-   ```
-
-   If you want the latest version from the **main** branch, add `--version 0.0.0-edge` to your pull command.
+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

@@ -17,7 +17,7 @@ kubectl kustomize "https://github.com/nginx/nginx-gateway-fabric/config/crd/gate
 To enable experimental features on NGINX Gateway Fabric:
 
 Using Helm: Set `nginxGateway.gwAPIExperimentalFeatures.enable` to true. An example can be found
-in the [Installation with Helm]({{< ref "/ngf/installation/installing-ngf/helm.md#custom-installation-options" >}}) guide.
+in the [Installation with Helm]({{< ref "/ngf/install/helm.md#custom-installation-options" >}}) guide.
 
 Using Kubernetes manifests: Add the `--gateway-api-experimental-features` command-line flag to the deployment manifest args.
-An example can be found in the [Installation with Kubernetes manifests]({{< ref "/ngf/installation/installing-ngf/manifests.md#3-deploy-nginx-gateway-fabric" >}}) guide.
+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

@@ -2,7 +2,7 @@
 docs: "DOCS-000"
 ---
 
-{{< 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 >}}
+{{< 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 >}}
 
 If the `nginx-gateway` namespace does not yet exist, create it:
 

content/includes/nginx-one/add-file/existing-ssl-bundle.md

@@ -2,7 +2,7 @@
 docs:
 ---
 
-With this option, You can incorporate [Managed certificates]({{< ref "/nginx-one/how-to/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
+With this option, you can incorporate [Managed certificates]({{< ref "/nginx-one/nginx-configs/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}).
 In the **Choose Certificate** drop-down, select the managed certificate of your choice, and select **Add**. You can then:
 
 1. Review details of the certificate. The next steps depend on whether the certificate is a CA bundle or a certificate / key pair.

content/includes/nginx-one/how-to/add-instance.md

@@ -0,0 +1,26 @@
+---
+docs:
+files:
+  - content/nginx-one/connect-instances/add-instance.md
+  - content/nginx-one/getting-started.md
+---
+
+You can add an instance to NGINX One Console in the following ways:
+
+- Directly, under **Instances**
+- Indirectly, by selecting a Config Sync Group, and selecting **Add Instance to Config Sync Group**
+
+In either case, NGINX One Console gives you a choice for data plane keys:
+
+- Create a new key
+- Use an existing key
+
+NGINX One Console takes the option you use, and adds the data plane key to a command that you'd use to register your target instance. You should see the command in the **Add Instance** screen in the console.
+
+Connect to the host where your NGINX instance is running. Run the provided command to [install NGINX Agent]({{< ref "/nginx-one/getting-started#install-nginx-agent" >}}) dependencies and packages on that host.
+
+```bash
+curl https://agent.connect.nginx.com/nginx-agent/install | DATA_PLANE_KEY="<data_plane_key>" sh -s -- -y
+```
+
+Once the process is complete, you can configure that instance in your NGINX One Console.

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

@@ -8,7 +8,7 @@ NGINX Instance Manager supports the following versions of [NGINX App Protect WAF
 
 | NGINX Instance Manager | NGINX App Protect WAF              |
 |------------------------|------------------------------------|
-| 2.17.0–2.19.1          | Release 4.8.0–4.14.0, 5.1.0–5.6.0 |
+| 2.17.0–2.19.2          | Release 4.8.0–4.14.0, 5.1.0–5.6.0 |
 | 2.15.1–2.16.0          | Release 4.8.0–4.10.0              |
 | 2.14.1–2.15.0          | Release 4.4.0–4.7.0               |
 | 2.13.0–2.14.0          | Release 4.3.0–4.5.0               |

content/includes/use-cases/monitoring/n1c-dashboard-overview.md

@@ -0,0 +1,39 @@
+---
+docs:
+files:
+  - content/nginx-one/metrics/enable-metrics.md
+  - content/nginx-one/getting-started.md
+---
+
+Navigating the dashboard:
+
+- **Drill down into specifics**: For in-depth information on a specific metric, like expiring certificates, click on the relevant link in the metric's card to go to a detailed overview page.
+- **Refine metric timeframe**: Metrics show the last hour's data by default. To view data from a different period, select the time interval you want from the drop-down menu.
+
+<span style="display: inline-block; margin-top: 20px; margin-bottom: 50px;">
+{{< img src="nginx-one/images/nginx-one-dashboard.png">}}
+</span>
+
+{{<bootstrap-table "table table-striped table-bordered">}}
+**NGINX One dashboard metrics**
+| Metric | Description | Details |
+|---|---|---|
+| <i class="fas fa-heartbeat"></i> **Instance availability** | Understand the operational status of your NGINX instances. | - **Online**: The NGINX instance is actively connected and functioning properly. <br> - **Offline**: NGINX Agent is connected but the NGINX instance isn't running, isn't installed, or can't communicate with NGINX Agent. <br> - **Unavailable**: The connection between NGINX Agent and NGINX One has been lost or the instance has been decommissioned. <br> - **Unknown**: The current state can't be determined at the moment. |
+| <i class="fas fa-code-branch"></i> **NGINX versions by instance** | See which NGINX versions are in use across your instances. | |
+| <i class="fas fa-desktop"></i> **Operating systems** | Find out which operating systems your instances are running on. | |
+| <i class="fas fa-certificate"></i> **Certificates** | Monitor the status of your SSL certificates to know which are expiring soon and which are still valid. | |
+| <i class="fas fa-cogs"></i> **Config recommendations** | Get configuration recommendations to optimize your instances' settings. | |
+| <i class="fas fa-shield-alt"></i> **CVEs (Common Vulnerabilities and Exposures)** | Evaluate the severity and number of potential security threats in your instances. | - **Major**: Indicates a high-severity threat that needs immediate attention. <br> - **Medium**: Implies a moderate threat level. <br> - **Minor** and **Low**: Represent less critical issues that still require monitoring. <br> - **Other**: Encompasses any threats that don't fit the standard categories. |
+| <i class="fas fa-microchip"></i> **CPU utilization** | Track CPU usage trends and pinpoint instances with high CPU demand. | |
+| <i class="fas fa-memory"></i> **Memory utilization** | Watch memory usage patterns to identify instances using significant memory. | |
+| <i class="fas fa-hdd"></i> **Disk space utilization** | Monitor how much disk space your instances are using and identify those nearing capacity. | |
+| <i class="fas fa-exclamation-triangle"></i> **Unsuccessful response codes** | Look for instances with a high number of HTTP server errors and investigate their error codes. | |
+| <i class="fas fa-tachometer-alt"></i> **Top network usage** | Review the network usage and bandwidth consumption of your instances. | |
+
+{{</bootstrap-table>}}
+
+
+
+
+
+

content/mesh/_index.md

@@ -5,9 +5,12 @@ description: 'NGINX Service Mesh is a fully integrated lightweight service mesh
   environments.
 
   '
+url: /nginx-service-mesh/
 cascade:
-  type: mesh-eos
   noindex: true
-url: /nginx-service-mesh/
+  banner:
+    enabled: true
+    type: deprecation
+    md: _banners/eos-mesh.md
 ---
 

content/ngf/_index.md

@@ -1,4 +1,10 @@
 ---
 title: "NGINX Gateway Fabric"
 url: /nginx-gateway-fabric/
+cascade:
+    banner:
+        enabled: true
+        type: deprecation
+        start-date: 2025-05-30
+        md: /_banners/ngf-2.0-release.md
 ---

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

@@ -1,11 +1,10 @@
 ---
-title: Releases
-description: "NGINX Gateway Fabric releases."
-weight: 700
+title: Changelog
 toc: true
-type: reference
-product: NGF
-docs: "DOCS-1359"
+weight: 900
+nd-content-type: reference
+nd-product: NGF
+nd-docs: "DOCS-1359"
 ---
 
 See the NGINX Gateway Fabric changelog page: