Merge branch 'main' into secure-your-fleet-r3

Author: mjang

.github/pull_request_template.md

@@ -1,35 +1,31 @@
 ### Proposed changes
 
-Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
-following format:
+[//]: # "Write a clear and concise description of what the pull request changes."
+[//]: # "You can use our Commit messages guidance for this."
+[//]: # "https://github.com/nginx/documentation/blob/main/documentation/git-conventions.md#commit-messages"
 
-Problem: Give a brief overview of the problem or feature being addressed.
+[//]: # "First, explain what was changed, and why. This should be most of the detail."
+[//]: # "Then how the changes were made, such as referring to existing styles and conventions."
+[//]: # "Finish by noting anything beyond the scope of the PR changes that may be affected."
 
-Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
-considerations.
+[//]: # "Include information on testing if relevant and non-obvious from the deployment preview."
+[//]: # "For expediency, you can use screenshots to show small before and after examples."
 
-Testing: Describe any testing that you did.
+[//]: # "If the changes were defined by a GitHub issue, reference it using keywords."
+[//]: # "https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests"
 
-Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
-specific feedback, add them here.
-
-If this PR addresses an [issue](https://github.com/nginx/documentation/issues) on GitHub, ensure that you link to it here:
-
-Closes #ISSUE
+[//]: # "Do not like to any internal, non-public resources. This includes internal repository issues or anything in an intranet."
+[//]: # "You can make reference to internal discussions without linking to them: see 'Referencing internal information'."
+[//]: # "https://github.com/nginx/documentation/blob/main/documentation/closed-contributions.md#referencing-internal-information"
 
 ### Checklist
 
-Before merging a pull request, run through this checklist and mark each as complete.
+Before sharing this pull request, I completed the following checklist:
 
-- [ ] I have read the [contributing guidelines](https://github.com/nginx/documentation/blob/main/CONTRIBUTING.md)
-- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
-- [ ] I have rebased my branch onto main
-- [ ] I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
-- [ ] I have ensured that the commit messages adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
-- [ ] I have ensured that documentation content adheres to [the style guide](/documentation/style-guide.md)
-- [ ] If the change involves potentially sensitive changes[^1], I have assessed the possible impact
-- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
-- [ ] I have ensured that existing tests pass after adding my changes
-- [ ] If applicable, I have updated [`README.md`](/README.md)
+- [ ] I read the [Contributing guidelines](/CONTRIBUTING.md)
+- [ ] My branch adheres to the [Git conventions](/documentation/git-conventions.md)
+- [ ] My content changes adhere to the [F5 NGINX Documentation style guide](/documentation/style-guide.md)
+- [ ] If my changes involve potentially sensitive information[^1], I have assessed the possible impact
+- [ ] I have waited to ensure my changes pass tests, and addressed any discovered issues
 
-[^1]: Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to [our style guide](/documentation/style-guide.md) for guidance about placeholder content.
+[^1]: Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the [style guide](/documentation/style-guide.md) for guidance about placeholder content.

.github/workflows/ossf_scorecard.yml

@@ -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@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
+        uses: github/codeql-action/upload-sarif@4e828ff8d448a8a6e532957b1811f387a63867e8 # v3.29.4
         with:
           sarif_file: results.sarif

CONTRIBUTING.md

@@ -41,6 +41,7 @@ To understand how we use Git in this repository, read our [Git conventions](/doc
 The broad workflow is as follows:
 
 - Fork the NGINX repository
+  - If you're an F5/NGINX user, you can work from a clone
 - Create a branch
 - Implement your changes in your branch
 - Submit a pull request (PR) when your changes are ready for review

content/agent/installation-upgrade/installation-oss.md

@@ -50,10 +50,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     module_hotfixes=true
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo yum install nginx-agent
+    sudo yum install -y nginx-agent-2.42.0
     ```
 
     When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
@@ -105,11 +105,13 @@ Before you install NGINX Agent for the first time on your system, you need to se
       | sudo tee /etc/apt/sources.list.d/nginx-agent.list
     ```
 
-1. To install `nginx-agent`, run the following commands:
-
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
+   
+    Update your package index and install a specific version of the nginx-agent. Replace <VERSION_CODENAME> with your current Ubuntu codename (e.g., jammy, noble).
+   
     ```shell
     sudo apt update
-    sudo apt install nginx-agent
+    sudo apt install -y nginx-agent=2.42.0~<VERSION_CODENAME>
     ```
 
 1. Verify the installation:
@@ -166,12 +168,13 @@ Before you install NGINX Agent for the first time on your system, you need to se
       http://packages.nginx.org/nginx-agent/debian/ `lsb_release -cs` agent" \ | sudo tee /etc/apt/sources.list.d/nginx-agent.list
     ```
 
-1. To install `nginx-agent`, run the following commands:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
+    Update your package index and install a specific version of the nginx-agent. Replace <VERSION_CODENAME> with your current Debian codename (e.g., bullseye).
+    
     ```shell
     sudo apt update
-    sudo apt install nginx-agent
-    ```
+    sudo apt install -y nginx-agent=2.42.0~<VERSION_CODENAME>
 
 1. Verify the installation:
 
@@ -229,10 +232,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     sudo rpmkeys --import /tmp/nginx_signing.key
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo zypper install nginx-agent
+    sudo zypper install -y nginx-agent=2.42.0
     ```
 
 1. Verify the installation:
@@ -303,10 +306,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     sudo mv /tmp/nginx_signing.rsa.pub /etc/apk/keys/
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo apk add nginx-agent
+    sudo apk add nginx-agent=2.42.0
     ```
 
 1. Verify the installation:
@@ -334,10 +337,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     module_hotfixes=true
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo dnf install nginx-agent
+    sudo dnf install -y nginx-agent-2.42.0
     ```
 
 1. When prompted to accept the GPG key, verify that the fingerprint matches
@@ -370,10 +373,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     module_hotfixes=true
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo yum install nginx-agent
+    sudo yum install -y nginx-agent-2.42.0
     ```
 
 1. When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
@@ -396,10 +399,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     }
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo pkg install nginx-agent
+    sudo pkg install nginx-agent-2.42.0
     ```
 
 1. Verify the installation:

content/agent/installation-upgrade/installation-plus.md

@@ -73,10 +73,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     enabled=1
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo yum install nginx-agent
+    sudo yum install -y nginx-agent-2.42.0
     ```
 
     When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
@@ -131,11 +131,13 @@ Before you install NGINX Agent for the first time on your system, you need to se
       | sudo tee /etc/apt/sources.list.d/nginx-agent.list
     ```
 
-1. To install `nginx-agent`, run the following commands:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
+     Update your package index and install a specific version of the nginx-agent. Replace <VERSION_CODENAME> with your current Ubuntu codename (e.g., jammy, noble).
+   
     ```shell
     sudo apt update
-    sudo apt install nginx-agent
+    sudo apt install -y nginx-agent=2.42.0~<VERSION_CODENAME>
     ```
 
 1. Verify the installation:
@@ -183,12 +185,14 @@ Before you install NGINX Agent for the first time on your system, you need to se
     Acquire::https::pkgs.nginx.com::SslKey      "/etc/ssl/nginx/nginx-repo.key";
     ```
 
-1. To install `nginx-agent`, run the following commands:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
+    Update your package index and install a specific version of the nginx-agent. Replace <VERSION_CODENAME> with your current Debian codename (e.g., bullseye).
+    
     ```shell
     sudo apt update
-    sudo apt install nginx-agent
-    ```
+    sudo apt install -y nginx-agent=2.42.0~<VERSION_CODENAME>
+
 
 1. Verify the installation:
 
@@ -265,10 +269,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     sudo rpmkeys --import /tmp/nginx_signing.key
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo zypper install nginx-agent
+    sudo zypper install -y nginx-agent=2.42.0
     ```
 
 1. Verify the installation:
@@ -394,10 +398,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     enabled=1
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo dnf install nginx-agent
+    sudo dnf install -y nginx-agent-2.42.0
     ```
 
 1. When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
@@ -442,10 +446,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     enabled=1
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo yum install nginx-agent
+    sudo yum install -y nginx-agent-2.42.0
     ```
 
 1. When prompted to accept the GPG key, verify that the fingerprint matches `8540 A6F1 8833 A80E 9C16 53A4 2FD2 1310 B49F 6B46`, `573B FD6B 3D8F BC64 1079 A6AB ABF5 BD82 7BD9 BF62`, `9E9B E90E ACBC DE69 FE9B 204C BCDC D8A3 8D88 A2B3`, and if so, accept it.
@@ -496,10 +500,10 @@ Before you install NGINX Agent for the first time on your system, you need to se
     SSL_CLIENT_KEY_FILE: "/etc/ssl/nginx/nginx-repo.key" }
     ```
 
-1. To install `nginx-agent`, run the following command:
+1. To install `nginx-agent` with a specific version (example: 2.42.0):
 
     ```shell
-    sudo pkg install nginx-agent
+    sudo pkg install nginx-agent-2.42.0
     ```
 
 1. Verify the installation:

content/agent/installation-upgrade/upgrade.md

@@ -60,10 +60,10 @@ To upgrade NGINX Agent to a specific **v2.x version**, follow these steps:
         sudo apt-get install -y nginx-agent=<specific-version> -o Dpkg::Options::="--force-confold"
         ```
 
-        Example (to upgrade to version 2.41.1~noble):
+        Example (to upgrade to version 2.42.0~noble):
 
         ```shell
-        sudo apt-get install -y nginx-agent=2.41.1~noble -o Dpkg::Options::="--force-confold"
+        sudo apt-get install -y nginx-agent=2.42.0~noble -o Dpkg::Options::="--force-confold"
         ```
 
     - CentOS, RHEL, RPM-Based
@@ -72,10 +72,10 @@ To upgrade NGINX Agent to a specific **v2.x version**, follow these steps:
         sudo yum install -y nginx-agent-<specific-version>
         ```
 
-        Example (to upgrade to version `2.41.1`):
+        Example (to upgrade to version `2.42.0`):
 
         ```shell
-        sudo yum install -y nginx-agent-2.41.1
+        sudo yum install -y nginx-agent-2.42.0
         ```
 
 1. Verify the installed version:

content/agent/technical-specifications.md

@@ -14,10 +14,10 @@ This document provides technical specifications for NGINX Agent. It includes inf
 {{< bootstrap-table "table table-striped table-bordered" >}}
 | NGINX Product                | Agent Version  |
 |------------------------------|----------------|
-| **NGINX One Console**        | 2.x            |
+| **NGINX One Console**        | 3.x            |
 | **NGINX Gateway Fabric**     | 3.x            |
 | **NGINX Plus**               | 2.x, 3.x       |
-| **NGINX Ingress Controller** | 2.x            |
+| **NGINX Ingress Controller** | 2.x, 3.x       |
 | **NGINX Instance Manager**   | 2.x            |
 {{< /bootstrap-table >}}
 

content/includes/agent/installation/update-container.md

@@ -14,11 +14,11 @@ wget https://raw.githubusercontent.com/nginx/agent/refs/heads/v3/scripts/package
 ./upgrade-agent-config.sh --v2-config-file=./nginx-agent-v2.conf --v3-config-file=nginx-agent-v3.conf
 ```
 
-If your NGINX Agent container was previously a member of a config sync group, then your NGINX Agent config must be manually updated to add the config sync group label.
+If your NGINX Agent container was previously a member of a Config Sync Group, then your NGINX Agent config must be manually updated to add the Config Sync Group label.
 See [Add Config Sync Group]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}) for more information.
 
 ### Rolling back from NGINX Agent v3 to v2
 
 If you need to roll back your environment to NGINX Agent v2, the upgrade process creates a backup of the NGINX Agent v2 config in the file `/etc/nginx-agent/nginx-agent-v2-backup.conf`.
 
-Replace the contents of `/etc/nginx-agent/nginx-agent.conf` with the contents of `/etc/nginx-agent/nginx-agent-v2-backup.conf` and then reinstall an older version of NGINX Agent.
+Replace the contents of `/etc/nginx-agent/nginx-agent.conf` with the contents of `/etc/nginx-agent/nginx-agent-v2-backup.conf` and then reinstall an older version of NGINX Agent.

content/includes/agent/installation/update.md

@@ -10,12 +10,12 @@ files:
 
    - `sudo systemctl stop nginx-agent`
 
-And start it again after the update:
+And start it again after the update or upgrade:
 
    - `sudo systemctl start nginx-agent`
 {{< /note >}}
 
-Follow the steps below to update NGINX Agent to the latest version.
+Follow the steps below to update or upgrade NGINX Agent to the latest version.
 The same steps apply if you are **upgrading from NGINX Agent v2 to NGINX Agent v3**.
 
 1. Open an SSH connection to the server where you've installed NGINX Agent.

content/includes/licensing-and-reporting/apply-jwt.md

@@ -1,12 +1,15 @@
 ---
-docs:
 file:
   - content/solutions/about-subscription-licenses.md
   - content/nap-waf/v5/admin-guide/install.md
 ---
 
-1. Copy the license file to `/etc/nginx/license.jwt` on Linux or `/usr/local/etc/nginx/license.jwt` on FreeBSD for each NGINX Plus instance.
-2. Reload NGINX:
+1. Copy the license file to:
+
+   - `/etc/nginx/license.jwt` on Linux
+   - `/usr/local/etc/nginx/license.jwt` on FreeBSD
+
+1. Reload NGINX:
 
    ```shell
    systemctl reload nginx