Merge branch 'main' into jputrino-patch-1-1

Author: jputrino

.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@f6091c0113d1dcf9b98e269ee48e8a7e51b7bdd4 # v3.28.5
+        uses: github/codeql-action/upload-sarif@dd746615b3b9d728a6a37ca2045b68ca76d4841a # v3.28.8
         with:
           sarif_file: results.sarif

content/nginx-one/changelog.md

@@ -1,10 +1,10 @@
 ---
-description: ''
+description: ""
 docs: DOCS-1394
 doctypes:
-- reference
+  - reference
 tags:
-- docs
+  - docs
 title: Changelog
 toc: true
 weight: 99999
@@ -34,6 +34,14 @@ Stay up-to-date with what's new and improved in the F5 NGINX One Console.
 
 ## January 20, 2025
 
+### Revert a configuration
+
+Using the NGINX One Console you can now:
+
+- See a history of changes to the configuration on an instance or a Config Sync Group, as well as the content of the previous five configs published to that object
+- Review the differences between the current and other saved configurations
+- Revert to older configurations as needed
+
 ### AI Assistant
 
 In the F5 NGINX One Console, you can now select lines from your configuration files, and then select **Explain with AI**. The NGINX One AI Assistant explains those lines based on the official NGINX documentation.
@@ -62,7 +70,7 @@ For more information, see the full documentation on [Managing Config Sync Groups
 
 ### Instance object cleanup
 
-NGINX Instance objects that have been `unavailable` for a set period will be automatically cleaned up (deleted). By default, this period is 24 hours from the time the NGINX Instance object was last updated. An administrator can change or disable the cleanup process in the "Instance Settings" under Settings. Events will be generated for NGINX Instances that have been automatically cleaned up. See "Events" for a list of NGINX Instances that have been deleted automatically. 
+NGINX Instance objects that have been `unavailable` for a set period will be automatically cleaned up (deleted). By default, this period is 24 hours from the time the NGINX Instance object was last updated. An administrator can change or disable the cleanup process in the "Instance Settings" under Settings. Events will be generated for NGINX Instances that have been automatically cleaned up. See "Events" for a list of NGINX Instances that have been deleted automatically.
 
 ## June 11, 2024
 
@@ -92,9 +100,9 @@ We've updated the **Instance Details** and **Data Plane Keys** pages to make it
 ### Breaking change
 
 - API responses now use "object_id" instead of "uuid". For example, **key_1mp6W5pqRxSZJugJN-yA8g**. We've introduced specific prefixes for different types of objects:
-  - Use **key_** for data-plane keys.
-  - Use **inst_** for NGINX instances.
-  - Use **nc_** for NGINX configurations.
+  - Use **key\_** for data-plane keys.
+  - Use **inst\_** for NGINX instances.
+  - Use **nc\_** for NGINX configurations.
 - Likewise, we've updated the JSON key from **uuid** to **object_id** in response objects.
 
 ## February 6, 2024

content/nim/deploy/kubernetes/deploy-using-helm.md

@@ -49,85 +49,9 @@ To deploy NGINX Instance Manager using a Helm chart, you need:
 
 ### Using Docker
 
-#### Configure Docker to access the NGINX Instance Manager public registry
-
-{{< include "nim/docker/docker-registry-login.md" >}}
-
-#### Pull the NGINX Instance Manager images
-You can now pull the necessary images for NGINX Instance Manager from the private registry at `private-registry.nginx.com`.
-
-Replace `<version-tag>` with the specific version you want to use.
-
-{{< note >}} The `latest` tag is not supported. {{< /note >}}
-
-```shell
-docker pull private-registry.nginx.com/nms/apigw:<version-tag>
-docker pull private-registry.nginx.com/nms/core:<version-tag>
-docker pull private-registry.nginx.com/nms/dpm:<version-tag>
-docker pull private-registry.nginx.com/nms/ingestion:<version-tag>
-docker pull private-registry.nginx.com/nms/integrations:<version-tag>
-docker pull private-registry.nginx.com/nms/utility:<version-tag>
-```
-
-If needed, you can push these images to your own private registry.
-
-#### Push images to your private registry
-
-After pulling the images, tag them and upload them to your private registry.
-
-1. Log in to your private registry:
-
-   ```shell
-   docker login <my-docker-registry>
-   ```
-
-2. Tag and push each image. Replace `<my-docker-registry>` with your registry’s path and `<version-tag>` with the version you’re using (for example, `2.17.0`):
-
-   - For the `apigw` image:
-
-     ```shell
-     docker tag private-registry.nginx.com/nms/apigw:<version-tag> <my-docker-registry>/nms/apigw:<version-tag>
-     docker push <my-docker-registry>/nms/apigw:<version-tag>
-     ```
-
-   - For the `core` image:
-
-     ```shell
-     docker tag private-registry.nginx.com/nms/core:<version-tag> <my-docker-registry>/nms/core:<version-tag>
-     docker push <my-docker-registry>/nms/core:<version-tag>
-     ```
-
-   - For the `dpm` image:
-
-     ```shell
-     docker tag private-registry.nginx.com/nms/dpm:<version-tag> <my-docker-registry>/nms/dpm:<version-tag>
-     docker push <my-docker-registry>/nms/dpm:<version-tag>
-     ```
-
-   - For the `ingestion` image:
-
-     ```shell
-     docker tag private-registry.nginx.com/nms/ingestion:<version-tag> <my-docker-registry>/nms/ingestion:<version-tag>
-     docker push <my-docker-registry>/nms/ingestion:<version-tag>
-     ```
-
-   - For the `integrations` image:
-
-     ```shell
-     docker tag private-registry.nginx.com/nms/integrations:<version-tag> <my-docker-registry>/nms/integrations:<version-tag>
-     docker push <my-docker-registry>/nms/integrations:<version-tag>
-     ```
-
-   - For the `utility` image:
-
-     ```shell
-     docker tag private-registry.nginx.com/nms/utility:<version-tag> <my-docker-registry>/nms/utility:<version-tag>
-     docker push <my-docker-registry>/nms/utility:<version-tag>
-     ```
-
 ### Using Helm with a JWT token
 
-If you don't need a private registry, you can use a JWT token as a Docker configuration secret with Helm charts.
+You can use your NGINX JWT as a Docker configuration secret with Helm charts.
 
 Create a Docker registry secret on the cluster, using the JWT token as the username and `none` as the password. The Docker server is `private-registry.nginx.com`.
 
@@ -179,8 +103,8 @@ The `values.yaml` file customizes the Helm chart installation without editing th
 
 1. Create a `values.yaml` file similar to this example:
 
-    - Replace `<my-docker-registry:port>` with your private Docker registry and port (if needed).
     - In the `imagePullSecrets` section, add the credentials for your private Docker registry.
+    - Change the version tag to the version of NGINX Instance Manager you would like to install. See "Install the chart" below for versions.
 
     {{< see-also >}} For more on creating a secret, see Kubernetes [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). {{</ see-also >}}
 
@@ -190,27 +114,27 @@ The `values.yaml` file customizes the Helm chart installation without editing th
             - name: regcred
         apigw:
             image:
-                repository: <my-docker-registry:port>/nms-apigw
+                repository: private-registry.nginx.com/nms-apigw
                 tag: <version>
         core:
             image:
-                repository: <my-docker-registry:port>/nms-core
+                repository: private-registry.nginx.com/nms-core
                 tag: <version>
         dpm:
             image:
-                repository: <my-docker-registry:port>/nms-dpm
+                repository: private-registry.nginx.com/nms-dpm
                 tag: <version>
         ingestion:
             image:
-                repository: <my-docker-registry:port>/nms-ingestion
+                repository: private-registry.nginx.com/nms-ingestion
                 tag: <version>
         integrations:
             image:
-                repository: <my-docker-registry:port>/nms-integrations
+                repository: private-registry.nginx.com/nms-integrations
                 tag: <version>
         utility:
             image:
-                repository: <my-docker-registry:port>/nms-utility
+                repository: private-registry.nginx.com/nms-utility
                 tag: <version>
     ```
 
@@ -220,36 +144,7 @@ The `values.yaml` file customizes the Helm chart installation without editing th
 
 ---
 
-## Manage network policies
 
-To apply network policies for NGINX Instance Manager, ensure Kubernetes has a [network plugin](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) installed before the Helm chart installation.
-
-By default, the following network policies will be created in the release namespace:
-
-```shell
-kubectl get netpol -n nms
-```
-
-```text
-NAME           POD-SELECTOR                          AGE
-apigw          app.kubernetes.io/name=apigw          4m47s
-clickhouse     app.kubernetes.io/name=clickhouse     4m47s
-core           app.kubernetes.io/name=core           4m47s
-dpm            app.kubernetes.io/name=dpm            4m47s
-ingestion      app.kubernetes.io/name=ingestion      4m47s
-integrations   app.kubernetes.io/name=integrations   4m47s
-utility        app.kubernetes.io/name=integrations   4m47s
-```
-
-To disable network policies, update the `values.yaml` file:
-
-```yaml
-networkPolicies:
-    # Set this to true to enable network policies for NGINX Instance Manager.
-    enabled: false
-```
-
----
 
 ## Install the chart
 
@@ -342,6 +237,37 @@ This deletes the `nms` application and all associated Kubernetes resources.
 
 ---
 
+## Manage network policies
+
+To apply network policies for NGINX Instance Manager, ensure Kubernetes has a [network plugin](https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) installed before the Helm chart installation.
+
+By default, the following network policies will be created in the release namespace:
+
+```shell
+kubectl get netpol -n nms
+```
+
+```text
+NAME           POD-SELECTOR                          AGE
+apigw          app.kubernetes.io/name=apigw          4m47s
+clickhouse     app.kubernetes.io/name=clickhouse     4m47s
+core           app.kubernetes.io/name=core           4m47s
+dpm            app.kubernetes.io/name=dpm            4m47s
+ingestion      app.kubernetes.io/name=ingestion      4m47s
+integrations   app.kubernetes.io/name=integrations   4m47s
+utility        app.kubernetes.io/name=integrations   4m47s
+```
+
+To disable network policies, update the `values.yaml` file:
+
+```yaml
+networkPolicies:
+    # Set this to true to enable network policies for NGINX Instance Manager.
+    enabled: false
+```
+
+---
+
 ## Troubleshooting
 
 For instructions on creating a support package to share with NGINX Customer Support, see [Create a Support Package from a Helm Installation]({{< relref "/nms/support/k8s-support-package.md" >}}).