diff --git a/content/nim/releases/known-issues.md b/content/nim/releases/known-issues.md index 563ce6c11..793d90364 100644 --- a/content/nim/releases/known-issues.md +++ b/content/nim/releases/known-issues.md @@ -1,8 +1,7 @@ --- docs: DOCS-937 -tags: -- docs -title: Known Issues +type: reference +title: Known issues toc: true weight: 200 --- @@ -344,7 +343,7 @@ Under certain conditions, instances that are not reporting request totals may no #### Workaround -Configure NGINX Plus or NGINX Stub Status APIs to send correctly the NGINX metrics using NGINX Agent. See the [Metrics]({{< relref "nim/monitoring/overview-metrics.md" >}}) documentation to learn more. +Configure NGINX Plus or NGINX Stub Status APIs to send correctly the NGINX metrics using NGINX Agent. See the [Metrics]({{< ref "nim/monitoring/overview-metrics.md" >}}) documentation to learn more. --- @@ -807,7 +806,7 @@ When installing on CentOS 7, RHEL 7, and Amazon Linux 2, the package manager doe #### Workaround -Install a supported version of NGINX (v1.18 or later) or NGINX Plus (R22 or later). See the [Technical Specifications]({{< relref "nim/fundamentals/tech-specs.md" >}}) guide for details. +Install a supported version of NGINX (v1.18 or later) or NGINX Plus (R22 or later). See the [Technical Specifications]({{< ref "nim/fundamentals/tech-specs.md" >}}) guide for details. --- diff --git a/content/nim/releases/release-notes.md b/content/nim/releases/release-notes.md index 5852995b7..599f7d9a5 100644 --- a/content/nim/releases/release-notes.md +++ b/content/nim/releases/release-notes.md @@ -1,5 +1,5 @@ --- -title: Release Notes +title: Release notes weight: 100 toc: true type: reference @@ -24,9 +24,9 @@ March 27, 2025 ### Upgrade Paths {#2-19-1-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.19.1 supports upgrades from these previous versions: -- 2.16.x - 2.19.0 +- 2.16.0 - 2.19.0 If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. @@ -35,32 +35,36 @@ This release includes the following updates: - {{% icon-feature %}} **Stability and performance improvements** - This release includes stability and performance improvements for a more reliable experience. + This release includes stability and performance improvements for a more reliable experience. + ### Resolved Issues{#2-19-1-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. + +- {{% icon-resolved %}} Publishing the NAP policy fails with the error “The attack signatures with the given version was not found” (45845) +- {{% icon-resolved %}} Automatic downloading of NAP compiler versions 5.210.0 and 5.264.0 fails on Ubuntu 24.04 (45846) -- {{% icon-resolved %}} Automatic downloading of NAP compiler versions 5.210.0 and 5.264.0 fails on Ubuntu 24 (45846) +### Known Issues{#2-19-1-known-issues} -- {{% icon-resolved %}} Publishing the NAP policy fails with the error "The attack signatures with the given version was not found" (45845) +You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. --- ## 2.19.0 -February 6, 2025 +February 06, 2025 ### Upgrade Paths {#2-19-0-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.19.0 supports upgrades from these previous versions: -- 2.16.x - 2.18.x +- 2.16.0 - 2.18.0 If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. -### Important Note about upgrades to NGINX Instance Manager 2.19 for API Connectivity Manager (ACM) users +### Important Note about upgrades to NGINX Instance Manager 2.19 for API Connectivity Manager (ACM) users NGINX Instance Manager 2.19 is the first iteration of NGINX Instance Manager as a standalone product without modules such as API Connectivity Manager (which is [EoS](https://my.f5.com/manage/s/article/K000137989)). NGINX Instance Manager now includes Security Monitoring (previously a module) as a feature under App Protect in the web interface. The Instance Manager helm charts and docker compose options include Security Monitoring also. @@ -73,9 +77,9 @@ This release includes the following updates: Starting with this release, NGINX Instance Manager is a standalone product without any dependencies from other NGINX products (NGINX Management Suite, API Connectivity Manager). - The Security Monitoring module is now a feature of NGINX Instance Manager found in the "App Protect" section. + The Security Monitoring module is now a feature of NGINX Instance Manager found in the "App Protect" section. - If NGINX API Connectivity Manager is currently running as a module in NGINX Instance Manager or NGINX Management Suite in your environment, you will need to remove the module before upgrading to 2.19.0. + If NGINX API Connectivity Manager is currently running as a module in NGINX Instance Manager or NGINX Management Suite in your environment, you will need to remove the module before upgrading to 2.19.0. - {{% icon-feature %}} **Forward proxy support using the HTTP CONNECT method** @@ -95,41 +99,38 @@ This release includes the following updates: - Documentation: [Configure high availability (HA) for NGINX Instance Manager]({{< ref "nim/system-configuration/configure-high-availability.md" >}}) -- {{% icon-feature %}} **Added "Export" feature for templates** +- {{% icon-feature %}} **Added "Export" feature for templates** We have added a new option to export templates using the NGINX Instance Manager web interface. -### Changes in Default Behavior{#2-19-0-changes-in-behavior} +### Changes in Default Behavior{#2-19-0-changes-in-behavior} This release has the following changes in default behavior: - {{% icon-feature %}} **Prompt to specify an FQDN for NIM when generating SSL certificates during installation** - When installing, users will be prompted to enter a fully qualified domain name (FQDN) to include in the Subject Alternative Name (SAN) of the NGINX Instance Manager's self-signed certificate generated during installation. This FQDN can serve as the server name for NGINX Instance Manager. Users can also specify this FQDN in the Installation Script + When installing, users will be prompted to enter a fully qualified domain name (FQDN) to include in the Subject Alternative Name (SAN) of the NGINX Instance Manager's self-signed certificate generated during installation. This FQDN can serve as the server name for NGINX Instance Manager. Users can also specify this FQDN in the Installation Script - {{< note >}}Starting with NGINX Plus R33, usage data reporting requires validating the SSL certificate of NGINX Instance Manager via the `ssl_verify` directive in the `mgmt` block. Proper SAN configuration ensures seamless SSL verification.{{< /note >}} + {{< note >}}Starting with NGINX Plus R33, usage data reporting requires validating the SSL certificate of NGINX Instance Manager via the `ssl_verify` directive in the `mgmt` block. Proper SAN configuration ensures seamless SSL verification.{{< /note >}} - {{% icon-feature %}} **Watchdog enhancements to improve stability** - We have introduced new configurable element in `nms.conf` called `enable_watchdog_notifications`. When enabled, if any process takes longer than expected to respond the customer will get a notification in the web interface warning about the unresponsive process. Previously, a Watchdog process was stopping the process and led to configurations not applying. + We have introduced new configurable element in `nms.conf` called `enable_watchdog_notifications`. When enabled, if any process takes longer than expected to respond the customer will get a notification in the web interface warning about the unresponsive process. Previously, a Watchdog process was stopping the process and led to configurations not applying. - {{% icon-feature %}} **Expired unmanaged certificates are eventually removed from the web interface** - Starting in 2.19.0, remote certificates that are expired are removed from the web interface after 30 days. + Starting in 2.19.0, remote certificates that are expired are removed from the web interface after 30 days. + ### Resolved Issues{#2-19-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +- {{% icon-resolved %}} Error messages persist after fix (45024) - {{% icon-resolved %}} .tgz files are not accepted in templates (45301) - - {{% icon-resolved %}} The web interface can't display more than 100 certificates (45565) - -- {{% icon-resolved %}} Syntax errors while saving template configuration (45573) - -- {{% icon-resolved %}} Error messages persist after fix (45024) - - {{% icon-resolved %}} NGINX configuration error messages overlap outside the error window (45570) +- {{% icon-resolved %}} Syntax errors while saving template configuration (45573) ### Known Issues{#2-19-0-known-issues} @@ -140,36 +141,28 @@ You can find information about known issues in the [Known Issues]({{< ref "/nim/ ## 2.18.0 -November 8, 2024 +November 08, 2024 ### Upgrade Paths {#2-18-0-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.18.0 supports upgrades from these previous versions: -- 2.15.x - 2.17.x +- 2.15.0 - 2.17.4 If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-18-0-whats-new} This release includes the following updates: -- {{% icon-feature %}} **Adds support for NGINX App Protect WAF v5** - - NGINX Instance Manager 2.18.0 adds support for [NGINX App Protect WAF v5.3 and v4.11]({{< ref "nap-waf/v5/admin-guide/overview.md" >}}). - - NGINX App Protect WAF v5, designed for both NGINX Open Source and NGINX Plus environments, includes a dynamic NGINX module and containerized WAF services. It provides robust security and scalability. +- {{% icon-feature %}} **Resilient Docker Compose NGINX Instance Manager deployment** -- {{% icon-feature %}} **Ridiculously easy NGINX Instance Manager installation script (Bash)** - - Reduce the number of steps to deploy all NGINX Instance Manager components, including prerequisites, using a single [installation script]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}). The script supports every OS that NGINX Instance Manager supports in the [technical specifications]({{< ref "nim/fundamentals/tech-specs.md" >}}). - - The script installs NGINX (Plus or Open Source), ClickHouse, and NGINX Instance Manager. Customers only need their NGINX Plus certificate, key, and, for NGINX Plus R33 or later, a JWT downloaded from MyF5. Support for offline installations will be added in a future update. + In 2.17, we released a [bundled container image]({{< ref "nim/deploy/docker/deploy-nginx-instance-manager-docker-compose.md" >}}) with all NGINX Instance Manager components. While this is a great option for demos and lab environments, it is not the most fault-tolerant for production. - Support for [offline installations]({{< ref "nim/disconnected/offline-install-guide.md" >}}) is also available for air-gapped environments. + This [Docker Compose option]({{< ref "nim/deploy/docker/deploy-nginx-instance-manager-docker-compose.md" >}}) unlocks another easy, production-ready installation method for customers using Docker. It will also make upgrades easier when new Docker images are released by F5 NGINX. This option includes health checking, NGINX App Protect compilation support, and security monitoring. -- {{% icon-feature %}} **Entitlement and visibility for NGINX Plus R33 – Telemetry reporting for network-restricted environments** +- {{% icon-feature %}} **Entitlement and visibility for NGINX Plus R33 – Telemetry reporting for network-restricted environments** - If NGINX Instance Manager has internet access, customers can [automatically or manually send the usage data to F5]({{< ref "nim/admin-guide/license/report-usage-connected-deployment.md" >}}) as part of the new NGINX Plus R33 changes. + If NGINX Instance Manager has internet access, customers can [automatically or manually send the usage data to F5]({{< ref "nim/admin-guide/license/report-usage-connected-deployment.md" >}}) as part of the new NGINX Plus R33 changes. For customers who have NGINX Instance Manager deployed in [network-restricted environments]({{< ref "nim/disconnected" >}}), this release also includes support for manual usage reporting. Customers can now manually license NGINX Instance Manager and export usage telemetry for fully disconnected environments. For usage reporting, customers can: @@ -177,24 +170,36 @@ This release includes the following updates: - **Send the report to F5**: Submit the report to F5 for verification from a location with internet access. - **Upload the acknowledgment**: After verification, upload the acknowledgment from F5 to NGINX Instance Manager. -- {{% icon-feature %}} **Resilient Docker Compose NGINX Instance Manager deployment** +- {{% icon-feature %}} **Ridiculously easy NGINX Instance Manager installation script (Bash)** - This [Docker Compose option]({{< ref "nim/deploy/docker/deploy-nginx-instance-manager-docker-compose.md" >}}) unlocks another easy, production-ready installation method for customers using Docker. It will also make upgrades easier when new Docker images are released by F5 NGINX. This option includes health checking, NGINX App Protect compilation support, and security monitoring. + Reduce the number of steps to deploy all NGINX Instance Manager components, including prerequisites, using a single [installation script]({{< ref "nim/deploy/vm-bare-metal/install.md" >}}). The script supports every OS that NGINX Instance Manager supports in the [technical specifications]({{< ref "nim/fundamentals/tech-specs.md" >}}). -### Changes in Default Behavior{#2-18-0-changes-in-behavior} + The script installs NGINX (Plus or Open Source), ClickHouse, and NGINX Instance Manager. Customers only need their NGINX Plus certificate, key, and, for NGINX Plus R33 or later, a JWT downloaded from MyF5. Support for offline installations will be added in a future update. + + Support for [offline installations]({{< ref "nim/disconnected/offline-install-guide.md" >}}) is also available for air-gapped environments. + +- {{% icon-feature %}} **Adds support for NGINX App Protect WAF v5.3 and v4.11** + + NGINX Instance Manager 2.18.0 adds support for [NGINX App Protect WAF v5.3 and v4.11]({{< relref "nap-waf/v5/admin-guide/overview.md" >}}). + + NGINX App Protect WAF v5, designed for both NGINX Open Source and NGINX Plus environments, includes a dynamic NGINX module and containerized WAF services. It provides robust security and scalability. + +### Changes in Default Behavior{#2-18-0-changes-in-behavior} This release has the following changes in default behavior: -- {{% icon-feature %}} **The NGINX Usage page now only shows instances configured with the NGINX Plus R33 mgmt block.** +- {{% icon-feature %}} **The NGINX Usage page now only shows instances configured with the NGINX Plus R33 mgmt block.** The “NGINX Usage” page previously displayed instances connected to NGINX Instance Manager through multiple methods, including the NGINX Agent, health checks, and the `mgmt` block in NGINX Plus R31-R32. With the introduction of native reporting in NGINX Plus R33, only instances using this feature appear on the page, preventing duplicates. For more information on R33 usage reporting, see [About subscription licenses]({{< ref "solutions/about-subscription-licenses.md" >}}). + ### Resolved Issues{#2-18-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. -- {{% icon-resolved %}} Mismatch in date formats in custom date selection on NGINX usage graph (45512) +- {{% icon-resolved %}} Licensing issues when adding JWT licenses in firewalled environments (43719) - {{% icon-resolved %}} Failure to notify user when template configuration publish fails (44975) +- {{% icon-resolved %}} Mismatch in date formats in custom date selection on NGINX usage graph (45512) ### Known Issues{#2-18-0-known-issues} @@ -209,7 +214,7 @@ November 06, 2024 ### Upgrade Paths {#2-17-4-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.17.4 supports upgrades from these previous versions: - 2.14.0 - 2.17.3 @@ -220,7 +225,8 @@ This release includes the following updates: - {{% icon-feature %}} **Stability and performance improvements** - This release includes stability and performance improvements. + This release includes stability and performance improvements. + ### Known Issues{#2-17-4-known-issues} @@ -235,7 +241,7 @@ September 13, 2024 ### Upgrade Paths {#2-17-3-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.17.3 supports upgrades from these previous versions: - 2.14.0 - 2.17.2 @@ -246,7 +252,8 @@ This release includes the following updates: - {{% icon-feature %}} **GPG key update for NGINX Agent packages** - Previous releases of NGINX Instance Manager included NGINX Agent packages signed with an expired GPG key. This release of NGINX Instance Manager includes updated keys, allowing users to successfully download the NGINX Agent from NGINX Instance Manager. + Previous releases of NGINX Instance Manager included NGINX Agent packages signed with an expired GPG key. This release of NGINX Instance Manager includes updated keys, allowing users to successfully download the NGINX Agent from NGINX Instance Manager. + ### Known Issues{#2-17-3-known-issues} @@ -261,7 +268,7 @@ August 21, 2024 ### Upgrade Paths {#2-17-2-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.17.2 supports upgrades from these previous versions: - 2.14.0 - 2.17.1 @@ -272,7 +279,8 @@ This release includes the following updates: - {{% icon-feature %}} **Stability and performance improvements** - This release includes stability and performance improvements for a more reliable experience. + This release includes stability and performance improvements for a more reliable experience. + ### Known Issues{#2-17-2-known-issues} @@ -287,7 +295,7 @@ July 24, 2024 ### Upgrade Paths {#2-17-1-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.17.1 supports upgrades from these previous versions: - 2.14.0 - 2.17.0 @@ -298,7 +306,8 @@ This release includes the following updates: - {{% icon-feature %}} **Stability and performance improvements** - This release includes stability and performance improvements for a more reliable experience. + This release includes stability and performance improvements for a more reliable experience. + ### Known Issues{#2-17-1-known-issues} @@ -313,7 +322,7 @@ July 10, 2024 ### Upgrade Paths {#2-17-0-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.17.0 supports upgrades from these previous versions: - 2.14.0 - 2.16.0 @@ -324,28 +333,31 @@ This release includes the following updates: - {{% icon-feature %}} **Adds support for NGINX App Protect WAF v5** - NGINX Instance Manager 2.17.0 adds support for [NGINX App Protect WAF v5.](https://docs.nginx.com/nginx-app-protect-waf/v5/admin-guide/overview/). + NGINX Instance Manager 2.17.0 adds support for [NGINX App Protect WAF v5.](https://docs.nginx.com/nginx-app-protect-waf/v5/admin-guide/overview/). NGINX App Protect WAF v5 (designed for both NGINX Open Source and NGINX Plus environments) consists of a dynamic NGINX module and containerized WAF services, providing robust security and scalability. - {{% icon-feature %}} **Hosted Docker images for Kubernetes Helm charts** - Prior to this release, users had to download NGINX Instance Manager docker images and push them to their local container registry for use in the Kubernetes Helm charts. This was not very turnkey and required multiple steps before being able to use the Helm charts. Now all Instance Manager container images are available from F5's public docker repository, simplifying the installation in Kubernetes. + Prior to this release, users had to download NGINX Instance Manager docker images and push them to their local container registry for use in the Kubernetes Helm charts. This was not very turnkey and required multiple steps before being able to use the Helm charts. Now all Instance Manager container images are available from F5's public docker repository, simplifying the installation in Kubernetes. See the [Deploy Instance Manager on Kubernetes]({{< ref "/nim/deploy/kubernetes/deploy-using-helm.md" >}}) documentation for more information. - {{% icon-feature %}} **Ansible role to deploy NGINX Instance Manager** - This release comes with an Ansible role to help you Install NGINX Instance Manager quickly, while also encouraging the best practices for your chosen environment. + This release comes with an Ansible role to help you Install NGINX Instance Manager quickly, while also encouraging the best practices for your chosen environment. - {{% icon-feature %}} **NGINX Instance Manager IaC using Packer and Terraform** - This release improves the [Infrastructure as Code (IaC) project]({{< ref "/nim/deploy/infrastructure-as-code/overview.md#nginx-management-suite-infrastructure-as-code" >}}) to help you quickly get started with NGINX Instance Manager using Packer and Terraform. + This release improves the [Infrastructure as Code (IaC) project]({{< ref "/nim/deploy/infrastructure-as-code/overview.md#nginx-management-suite-infrastructure-as-code" >}}) to help you quickly get started with NGINX Instance Manager using Packer and Terraform. The project uses Packer to create images and Terraform to deploy these images to your preferred cloud provider, including GCP, Azure, or vSphere. - {{% icon-feature %}} **Single docker image with all the NGINX Instance Manager services and dependencies** + This release includes access to a single Docker image for running NGINX Instance Manager as a container. This allows customers to deploy Instance Manager locally with a single "docker run" command. For more details, see [Deploy NGINX Instance Manager in a Single Docker Container]({{< ref "/nim/deploy/docker/deploy-nginx-instance-manager-docker-compose.md" >}}). + + ### Changes in Default Behavior{#2-17-0-changes-in-behavior} This release has the following changes in default behavior: @@ -367,15 +379,17 @@ This release has the following changes in default behavior: Please upgrade your environment to one of the [supported distributions]({{< ref "/nim/fundamentals/tech-specs.md#supported-distributions" >}}) to continue using NGINX Instance Manager. + ### Resolved Issues{#2-17-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Users receive login error when NGINX Management Suite is deployed in Kubernetes (44686) - {{% icon-resolved %}} REST API does not work until you log into the web interface first (44877) - {{% icon-resolved %}} Editing template submissions uses the latest versions, may cause "malformed" errors (44961) - {{% icon-resolved %}} Editing template submissions now allows for using most recent template version (44971) + ### Known Issues{#2-17-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -388,7 +402,7 @@ April 18, 2024 ### Upgrade Paths {#2-16-0-upgrade-paths} -NGINX Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.16.0 supports upgrades from these previous versions: - 2.13.0 - 2.15.1 @@ -399,13 +413,13 @@ This release includes the following updates: - {{% icon-feature %}} **Introducing configuration templates for simplifying NGINX configurations and self-service workflows** - This release of NGINX Instance Manager introduces [Config Templates]({{< ref "nim/nginx-configs/config-templates/concepts/config-templates.md" >}}). These templates use Go templating to make it easier to set up and standardize NGINX configurations. Now, you don't need to know all the details of NGINX syntax to create a working configuration. Just provide the required inputs for a template, and the system will do the rest. This makes setting up NGINX simpler and helps you follow best practices. + This release of NGINX Instance Manager introduces [Config Templates]({{< ref "nim/nginx-configs/config-templates/concepts/config-templates.md" >}}). These templates use Go templating to make it easier to set up and standardize NGINX configurations. Now, you don't need to know all the details of NGINX syntax to create a working configuration. Just provide the required inputs for a template, and the system will do the rest. This makes setting up NGINX simpler and helps you follow best practices. To provide more control over your configurations, [augment templates]({{< ref "nim/nginx-configs/config-templates/concepts/default-base-template.md#augmenting-global-default-base-template" >}}) let you modify only specific segments of your NGINX configuration. This, when combined with [RBAC for template submissions]({{< ref "/nim/nginx-configs/config-templates/how-to/rbac-config-templates-and-submissions.md" >}}), enables self-service workflows. Look for pre-built templates for common scenarios in our GitHub repositories soon. - {{% icon-feature %}} **Stability and performance improvements** - This release enhances system stability and performance. + This release enhances system stability and performance. ### Changes in Default Behavior{#2-16-0-changes-in-behavior} @@ -416,6 +430,13 @@ This release has the following changes in default behavior: Starting from version v2.31.0, the NGINX Agent will automatically restart itself during an upgrade. +### Resolved Issues{#2-16-0-resolved-issues} + +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. + +- {{% icon-resolved %}} Upgrading to 2.12 disables telemetry (43606) + + ### Known Issues{#2-16-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -428,27 +449,28 @@ February 14, 2024 ### Upgrade Paths {#2-15-1-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.15.1 supports upgrades from these previous versions: - 2.12.0 - 2.15.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-15-1-whats-new} This release includes the following updates: - {{% icon-feature %}} **Stability and performance improvements** - This release includes stability and performance improvements. + This release includes stability and performance improvements. ### Resolved Issues{#2-15-1-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Helm chart backup and restore is broken in NIM 2.15.0 (44758) - {{% icon-resolved %}} Unable to use NMS Predefined Log Profiles for NAP 4.7 (44759) + ### Known Issues{#2-15-1-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -461,29 +483,31 @@ December 12, 2023 ### Upgrade Paths {#2-15-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.15.0 supports upgrades from these previous versions: - 2.12.0 - 2.14.1 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-15-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Support for CA Certificates added** - Instance Manager now allows for managing CA Certificates to fully support NGINX directives such as _proxy_ssl_trusted_ and _proxy_ssl_verify_. The main difference after this change is that you no longer need a corresponding key to upload a certificate to Instance Manager. + Instance Manager now allows for managing CA Certificates to fully support NGINX directives such as _proxy_ssl_trusted_ and _proxy_ssl_verify_. The main difference after this change is that you no longer need a corresponding key to upload a certificate to Instance Manager. ### Resolved Issues{#2-15-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +- {{% icon-resolved %}} Querying API endpoints for Security deployments associations may return empty UIDs for Attack-Signatures and Threat-Campaigns (43034) - {{% icon-resolved %}} Instances reporting incorrect memory utilization (44351) - {{% icon-resolved %}} Data on the dashboard is updating unexpectedly (44504) - {{% icon-resolved %}} Missing Data when ClickHouse services are not running (44586) - {{% icon-resolved %}} NGINX App Protect Attack Signature, Threat Campaign and Compiler fail to download (44603) + ### Known Issues{#2-15-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -496,18 +520,19 @@ October 19, 2023 ### Upgrade Paths {#2-14-1-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.14.1 supports upgrades from these previous versions: - 2.11.0 - 2.14.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-14-1-whats-new} This release includes the following updates: - {{% icon-feature %}} **Stability and performance improvements** - This release includes stability and performance improvements. + This release includes stability and performance improvements. + ### Known Issues{#2-14-1-known-issues} @@ -522,27 +547,27 @@ October 16, 2023 ### Upgrade Paths {#2-14-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.14.0 supports upgrades from these previous versions: - 2.11.0 - 2.13.1 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-14-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Instance Manager Dashboard** - Monitor the health and performance of your NGINX instance fleet from a single page. Get insights and trends on CPU, memory, disk, and network traffic utilization. Quickly spot and mitigate common HTTP errors and TLS certificate issues. See the [Instance Manager Dashboard]({{< ref "nim/fundamentals/dashboard-overview.md" >}}) documentation to learn more. + Monitor the health and performance of your NGINX instance fleet from a single page. Get insights and trends on CPU, memory, disk, and network traffic utilization. Quickly spot and mitigate common HTTP errors and TLS certificate issues. See the [Instance Manager Dashboard]({{< ref "nim/fundamentals/dashboard-overview.md" >}}) documentation to learn more. - {{% icon-feature %}} **Work with NGINX App Protect Bundles from Instance Manager** - Starting with Instance Manager 2.14, you can now use the "/security/policies/bundles" endpoint to create, read, update, and delete NGINX App Protect bundles, which allow faster deployment through pre-compilation of security policies, attack signatures, and threat-campaign. For additional information on how to use the API endpoint, refer to your product API documentation. - To learn more about this feature, see the [Manage WAF Security Policies]({{< ref "/nim/nginx-app-protect/manage-waf-security-policies.md" >}}) documentation. + Starting with Instance Manager 2.14, you can now use the "/security/policies/bundles" endpoint to create, read, update, and delete NGINX App Protect bundles, which allow faster deployment through pre-compilation of security policies, attack signatures, and threat-campaign. For additional information on how to use the API endpoint, refer to your product API documentation. + To learn more about this feature, see the [Manage WAF Security Policies]({{< ref "/nim/nginx-app-protect/manage-waf-security-policies.md" >}}) documentation. - {{% icon-feature %}} **Clickhouse LTS 23.8 support** - This release of Instance Manager has been tested and is compatible with Clickhouse LTS versions 22.3.15.33 to 23.8. + This release of Instance Manager has been tested and is compatible with Clickhouse LTS versions 22.3.15.33 to 23.8. ### Changes in Default Behavior{#2-14-0-changes-in-behavior} @@ -553,6 +578,17 @@ This release has the following changes in default behavior: If an NGINX instance has been inactive (NGINX Agent not reporting to NGINX Management Suite) for a fixed amount of time, it is now automatically removed from the instances list. Instances deployed in a virtual machine or hardware are removed after 72 hours of inactivity, and those deployed in a container are removed after 12 hours. +### Resolved Issues{#2-14-0-resolved-issues} + +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. + +- {{% icon-resolved %}} OIDC-authenticated users can't view the Users list using the API or web interface (43031) +- {{% icon-resolved %}} getAttackCountBySeverity endpoint broken with NGINX App Protect 4.4 and above (44051) +- {{% icon-resolved %}} Certificates may not appear in resource group (44323) +- {{% icon-resolved %}} NGINX Agent does not report NGINX App Protect status (44531) +- {{% icon-resolved %}} Issues sorting HTTP errors in the dashboard (44536) + + ### Known Issues{#2-14-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -565,19 +601,20 @@ September 05, 2023 ### Upgrade Paths {#2-13-1-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.13.1 supports upgrades from these previous versions: - 2.10.0 - 2.13.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### Resolved Issues{#2-13-1-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Validation errors in Resource Groups for certificates uploaded before 2.13 upgrade (44254) - {{% icon-resolved %}} Access levels cannot be assigned to certain RBAC features (44277) + ### Known Issues{#2-13-1-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -590,22 +627,22 @@ August 28, 2023 ### Upgrade Paths {#2-13-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.13.0 supports upgrades from these previous versions: - 2.10.0 - 2.12.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-13-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Easily manage access to specific objects with Resource Groups** - With NGINX Instance Manager, you can now combine Instances, Instance Groups, and Certificates into a Resource Group. This grouping can be used when defining roles to grant access to those specific objects. When objects are added to or removed from the Resource Group, the changes are automatically reflected in any roles that use the Resource Group. For more details, refer to [Working with Resource Groups]({{< ref "/nim/admin-guide/rbac/manage-resource-groups.md" >}}). + With NGINX Instance Manager, you can now combine Instances, Instance Groups, and Certificates into a Resource Group. This grouping can be used when defining roles to grant access to those specific objects. When objects are added to or removed from the Resource Group, the changes are automatically reflected in any roles that use the Resource Group. For more details, refer to [Working with Resource Groups]({{< ref "/nim/admin-guide/rbac/manage-resource-groups.md" >}}). - {{% icon-feature %}} **Get version controlled NGINX configurations with an external commit hash** - The Instance Manager REST API supports setting and retrieving instances, instance groups, and staged NGINX configurations using a version control commit hash. + The Instance Manager REST API supports setting and retrieving instances, instance groups, and staged NGINX configurations using a version control commit hash. To learn how to use a commit hash with NGINX configurations, refer to these topics: @@ -615,31 +652,34 @@ This release includes the following updates: - {{% icon-feature %}} **Configure analytics data retention with the nms.conf file** - You can set the data retention policy for analytics data, which includes metrics, events, and security events, in the `nms.conf` file. By default, metrics and security events are stored for 32 days, while events are stored for 120 days. To keep data for a longer period, update the retention durations in the `nms.conf` file. + You can set the data retention policy for analytics data, which includes metrics, events, and security events, in the `nms.conf` file. By default, metrics and security events are stored for 32 days, while events are stored for 120 days. To keep data for a longer period, update the retention durations in the `nms.conf` file. - {{% icon-feature %}} **RBAC for security policies** - You can now use [Role-Based Access Control (RBAC)]({{< ref "/nim/admin-guide/rbac/overview-rbac.md" >}}) to allow or restrict the level of access to security policies according to your security governance model. + You can now use [Role-Based Access Control (RBAC)]({{< ref "/nim/admin-guide/rbac/overview-rbac.md" >}}) to allow or restrict the level of access to security policies according to your security governance model. - {{% icon-feature %}} **RBAC for log profiles** - You can now use [Role-Based Access Control (RBAC)]({{< ref "/nim/admin-guide/rbac/overview-rbac.md" >}}) to allow or restrict access to log profiles according to your security governance model. + You can now use [Role-Based Access Control (RBAC)]({{< ref "/nim/admin-guide/rbac/overview-rbac.md" >}}) to allow or restrict access to log profiles according to your security governance model. - {{% icon-feature %}} **Use NGINX Plus Health Checks to easily track NGINX Plus Usage with NGINX Instance Manager** - The NGINX Plus Health Check feature now allows you to monitor the count of both NGINX Plus and NGINX App Protect instances that you've deployed. You can view this information in the "NGINX Plus" area of the "Instance Manager" web interface, or through the `/inventory` API. For guidance on how to set this up, refer to the following documentation: [View Count of NGINX Plus Instances]({{< ref "/nim/admin-guide/license/report-usage-connected-deployment.md" >}}). + The NGINX Plus Health Check feature now allows you to monitor the count of both NGINX Plus and NGINX App Protect instances that you've deployed. You can view this information in the "NGINX Plus" area of the "Instance Manager" web interface, or through the `/inventory` API. For guidance on how to set this up, refer to the following documentation: [View Count of NGINX Plus Instances]({{< ref "/nim/admin-guide/license/report-usage-connected-deployment.md" >}}). - {{% icon-feature %}} **Improved log output for better JSON parsing** - In the log output, extra whitespace has been removed, and brackets have been removed from the log `level` field. This results in clean, parsable log output, particularly when using JSON log encoding. + In the log output, extra whitespace has been removed, and brackets have been removed from the log `level` field. This results in clean, parsable log output, particularly when using JSON log encoding. ### Resolved Issues{#2-13-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +- {{% icon-resolved %}} Staged configs fail to publish after upgrading NGINX Management Suite (37479) +- {{% icon-resolved %}} Error: "Failed to create secret" when reinstalling or upgrading NGINX Management Suite in Kubernetes (42967) - {{% icon-resolved %}} An "unregistered clickhouse-adapter" failure is logged every few seconds if logging is set to debug. (43438) + ### Known Issues{#2-13-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -652,27 +692,32 @@ July 20, 2023 ### Upgrade Paths {#2-12-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.12.0 supports upgrades from these previous versions: - 2.9.0 - 2.11.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-12-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **New support for license tokens for automatic entitlement updates, renewals, and Flexible Consumption Reporting** - NGINX Management Suite now supports license tokens formatted as a JSON Web Token (JWT). With JWT licensing, you can automatically update entitlements during subscription renewals or amendments, and you can automate reporting for the Flexible Consumption Program (FCP). For more information, see the [Add a License]({{< ref "/nim/admin-guide/license/add-license.md" >}}) topic. + NGINX Management Suite now supports license tokens formatted as a JSON Web Token (JWT). With JWT licensing, you can automatically update entitlements during subscription renewals or amendments, and you can automate reporting for the Flexible Consumption Program (FCP). For more information, see the [Add a License]({{< ref "/nim/admin-guide/license/add-license.md" >}}) topic. ### Resolved Issues{#2-12-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Filtering Analytics data with values that have double backslashes (`\\`) causes failures (42105) - {{% icon-resolved %}} Unable to publish configurations referencing the log bundle for Security Monitor (42932) - {{% icon-resolved %}} Disk Usage in Metrics Summary shows incorrect data when multiple partitions exist on a system (42999) +- {{% icon-resolved %}} When adding a Certs RBAC permission, the "Applies to" field may display as "nginx-repo" (43012) +- {{% icon-resolved %}} Publication status of instance groups may be shown as 'not available' after restarting NGINX Management Suite (43016) +- {{% icon-resolved %}} A JWT license for an expired subscription cannot be terminated from the web interface (43580) +- {{% icon-resolved %}} On Kubernetes, uploading a JWT license for NGINX Management Suite results in the error "secret not found" (43655) + ### Known Issues{#2-12-0-known-issues} @@ -686,22 +731,22 @@ June 12, 2023 ### Upgrade Paths {#2-11-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.11.0 supports upgrades from these previous versions: - 2.8.0 - 2.10.1 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-11-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **The config editor now lets you see auxiliary files** - Auxiliary files, such as certificate files and other non-config files on managed instances or instance groups, are now visible in the file tree of the config editor view. This improvement makes it easier to reference these files within a configuration. + Auxiliary files, such as certificate files and other non-config files on managed instances or instance groups, are now visible in the file tree of the config editor view. This improvement makes it easier to reference these files within a configuration. - {{% icon-feature %}} **Introducing new predefined log profiles for NGINX App Protect WAF** - Now, managing your NGINX App Protect WAF configuration is even easier with new predefined log profiles. In addition to the existing log_all, log_blocked, log_illegal, and log_secops log profiles, the following new predefined log profiles are now available: + Now, managing your NGINX App Protect WAF configuration is even easier with new predefined log profiles. In addition to the existing log_all, log_blocked, log_illegal, and log_secops log profiles, the following new predefined log profiles are now available: - log_f5_arcsight - log_f5_splunk @@ -713,11 +758,11 @@ This release includes the following updates: - {{% icon-feature %}} **You can now install Advanced Metrics automatically when you install NGINX Agent** - When installing the NGINX Agent with NGINX Management Suite, you can include the `-a` or `--advanced-metrics` flag. Including this option installs the Advanced Metrics module along with the NGINX Agent. With this module, you gain access to extra metrics and insights that enrich the monitoring and analysis capabilities of the NGINX Management Suite, empowering you to make more informed decisions. + When installing the NGINX Agent with NGINX Management Suite, you can include the `-a` or `--advanced-metrics` flag. Including this option installs the Advanced Metrics module along with the NGINX Agent. With this module, you gain access to extra metrics and insights that enrich the monitoring and analysis capabilities of the NGINX Management Suite, empowering you to make more informed decisions. - {{% icon-feature %}} **NGINX Management Suite can send telemetry data to F5 NGINX** - In order to enhance product development and support the success of our users with NGINX Management Suite, we offer the option to send limited telemetry data to F5 NGINX. This data provides valuable insights into software usage and adoption. By default, telemetry is enabled, but you have the flexibility to disable it through the web interface or API. For detailed information about the transmitted data, please refer to our documentation. + In order to enhance product development and support the success of our users with NGINX Management Suite, we offer the option to send limited telemetry data to F5 NGINX. This data provides valuable insights into software usage and adoption. By default, telemetry is enabled, but you have the flexibility to disable it through the web interface or API. For detailed information about the transmitted data, please refer to our documentation. ### Changes in Default Behavior{#2-11-0-changes-in-behavior} @@ -727,7 +772,7 @@ This release has the following changes in default behavior: In this release, the `agent-dynamic.conf` file has been moved from `/etc/nginx-agent/` to `/var/lib/nginx-agent/`. To assign an instance group and tags to an instance, you will now need to edit the file located in `/var/lib/nginx-agent/`. -- {{% icon-feature %}} **Action required:Update OIDC configurations for management plane after upgrading to Instance Manager 2.11.0** +- {{% icon-feature %}} **⚠ Action required: Update OIDC configurations for management plane after upgrading to Instance Manager 2.11.0** In Instance Manager 2.11.0, we added support for telemetry to the OIDC configuration files. Existing OIDC configurations will continue to work, but certain telemetry events, such as login, may not be captured. @@ -749,15 +794,17 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-11-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Count of NGINX Plus graph has a delay in being populated (37705) +- {{% icon-resolved %}} When upgrading to Instance Manager 2.10, the publish status on App Security pages shows "Invalid Date" (42108) - {{% icon-resolved %}} Duplicate Certificate and Key published for managed certificates (42182) - {{% icon-resolved %}} The Metrics module is interrupted during installation on Red Hat 9 (42219) - {{% icon-resolved %}} Certificate file is not updated automatically under certain conditions (42425) - {{% icon-resolved %}} Certificate updates allow for multiples certs to share the same serial number (42429) + ### Known Issues{#2-11-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -770,18 +817,19 @@ May 22, 2023 ### Upgrade Paths {#2-10-1-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.10.1 supports upgrades from these previous versions: - 2.7.0 - 2.10.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### Resolved Issues{#2-10-1-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Valid licenses incorrectly identified as invalid (42598) + ### Known Issues{#2-10-1-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -794,47 +842,47 @@ April 26, 2023 ### Upgrade Paths {#2-10-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.10.0 supports upgrades from these previous versions: - 2.7.0 - 2.9.1 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-10-0-whats-new} This release includes the following updates: -- {{% icon-feature %}} **New "Category" Filter in the Events web interface** +- {{% icon-feature %}} **New "Category" Filter in the Events web interface** - You can now filter entries in the Events web interface using a new "Category" filter. Categories for event entries include "Certs", "Instance Groups", and "Templates". + You can now filter entries in the Events web interface using a new "Category" filter. Categories for event entries include "Certs", "Instance Groups", and "Templates". - {{% icon-feature %}} **New NGINX Agent install flag for NGINX App Protect WAF** - The NGINX Agent installation script now has a flag to enable the default configuration required for NGINX App Protect WAF. It is used to retrieve the deployment status and `precompiled_publication` mode, with an option for the NGINX App Protect WAF instance to use the mode for policies. + The NGINX Agent installation script now has a flag to enable the default configuration required for NGINX App Protect WAF. It is used to retrieve the deployment status and `precompiled_publication` mode, with an option for the NGINX App Protect WAF instance to use the mode for policies. - {{% icon-feature %}} **NGINX Management Suite version now visible in the web interface and API** - You can now look up the NGINX Management Suite and NGINX Instance Manager versions in the web interface and API. Other module versions are also visible, though older versions of API Connectivity Manager and Security Monitoring may appear as undefined. + You can now look up the NGINX Management Suite and NGINX Instance Manager versions in the web interface and API. Other module versions are also visible, though older versions of API Connectivity Manager and Security Monitoring may appear as undefined. - {{% icon-feature %}} **NGINX Management Suite can now use NGINX Ingress Controller to manage routing** - The NGINX Management Suite Helm Chart can now generate an NGINX Ingress Controller VirtualServer definition, which can be used to expose NGINX Management Suite when running in your Kubernetes cluster. + The NGINX Management Suite Helm Chart can now generate an NGINX Ingress Controller VirtualServer definition, which can be used to expose NGINX Management Suite when running in your Kubernetes cluster. More about the VirtualServer custom resource can be found in the [VirtualServer and VirtualServerRoute](https://docs.nginx.com/nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources/) documentation. - {{% icon-feature %}} **Configuration Publication Status now visible in App Security pages.** - The most recent publication date and status for an instance's configuration is now visible on App Security Pages. This reflects configuration for NGINX, NGINX App Protect policies, Attack Signatures and Threat Campaigns. + The most recent publication date and status for an instance's configuration is now visible on App Security Pages. This reflects configuration for NGINX, NGINX App Protect policies, Attack Signatures and Threat Campaigns. - {{% icon-feature %}} **Instance Manager can now automatically retrieve WAF compilers associated with NGINX App Protect instances** - Using a user-provided NGINX repository certificate & key after the first set-up of the WAF compiler, Instance Manager can automatically retrieve WAF compilers associated with NGINX App Protect instances. These can be used to publish App Protect WAF configurations in `precompiled_publication` mode. + Using a user-provided NGINX repository certificate & key after the first set-up of the WAF compiler, Instance Manager can automatically retrieve WAF compilers associated with NGINX App Protect instances. These can be used to publish App Protect WAF configurations in `precompiled_publication` mode. - {{% icon-feature %}} **Add option to toggle ICMP scanning in the web interface** - You can now explicitly enable or disable ICMP scanning at the top of the "Scan" interface. + You can now explicitly enable or disable ICMP scanning at the top of the "Scan" interface. - {{% icon-feature %}} **New NGINX Agent install flag for Security Monitoring** - The NGINX Agent installation script now has a flag to enable the default configuration required for the Security Monitoring module. + The NGINX Agent installation script now has a flag to enable the default configuration required for the Security Monitoring module. ### Changes in Default Behavior{#2-10-0-changes-in-behavior} @@ -850,12 +898,14 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-10-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Installing NGINX Agent on FreeBSD fails with "error 2051: not implemented" (41157) +- {{% icon-resolved %}} Configuration changes for NGINX Agent take longer than expected. (41257) - {{% icon-resolved %}} SELinux errors encountered when starting NGINX Management Suite on RHEL9 with the SELinux policy installed (41327) + ### Known Issues{#2-10-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -868,18 +918,19 @@ April 06, 2023 ### Upgrade Paths {#2-9-1-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.9.1 supports upgrades from these previous versions: - 2.6.0 - 2.9.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### Resolved Issues{#2-9-1-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} NGINX configurations with special characters may not be editable from the web interface after upgrading Instance Manager (41557) + ### Known Issues{#2-9-1-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -892,34 +943,34 @@ March 21, 2023 ### Upgrade Paths {#2-9-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.9.0 supports upgrades from these previous versions: - 2.6.0 - 2.8.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-9-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **New webpages for viewing Attack Signature and Threat Campaigns** - The Instance Manager web interface now allows you to view Attack Signatures and Threat Campaign packages published to instances and instance groups. You can also publish these packages using the precompiled publication mode. + The Instance Manager web interface now allows you to view Attack Signatures and Threat Campaign packages published to instances and instance groups. You can also publish these packages using the precompiled publication mode. - {{% icon-feature %}} **NGINX Agent supports Rocky Linux 8 and 9** - The NGINX Agent now supports Rocky Linux 8 (x86_64, aarch64) and 9 (x86_64, aarch64). The NGINX Agent supports the same distributions as NGINX Plus. For a list of the supported distributions, refer to the [NGINX Plus Technical Specs](https://docs.nginx.com/nginx/technical-specs/#supported-distributions) guide. + The NGINX Agent now supports Rocky Linux 8 (x86_64, aarch64) and 9 (x86_64, aarch64). The NGINX Agent supports the same distributions as NGINX Plus. For a list of the supported distributions, refer to the [NGINX Plus Technical Specs](https://docs.nginx.com/nginx/technical-specs/#supported-distributions) guide. - {{% icon-feature %}} **New Events for CUD actions** - Events will be triggered for `CREATE`, `UPDATE`, and `DELETE` actions on Templates, Instances, Certificates, Instance Groups, and Licenses. + Events will be triggered for `CREATE`, `UPDATE`, and `DELETE` actions on Templates, Instances, Certificates, Instance Groups, and Licenses. - {{% icon-feature %}} **The _Certificate and Keys_ webpage has a new look!** - Our new and improved _Certificates and Keys_ webpage makes it easier than ever to efficiently manage your TLS certificates. + Our new and improved _Certificates and Keys_ webpage makes it easier than ever to efficiently manage your TLS certificates. - {{% icon-feature %}} **Add commit hash details to NGINX configurations for version control** - Use the Instance Manager REST API to add a commit hash to NGINX configurations if you use version control, such as Git. + Use the Instance Manager REST API to add a commit hash to NGINX configurations if you use version control, such as Git. For more information, see the following topics: @@ -963,7 +1014,7 @@ This release has the following changes in default behavior: When assigning SSL certificates for the NGINX data plane, you have the option of associating them with a single instance or with an instance group. When associated with an instance group, the certificates will be shared across all instances in the group. -- {{% icon-feature %}} **Action required: OIDC configurations for the management plane must be updated after upgrading to Instance Manager 2.9.0** +- {{% icon-feature %}} **⚠ Action required: OIDC configurations for the management plane must be updated after upgrading to Instance Manager 2.9.0** OIDC configuration files were modified to improve support for automation and integration in CI/CD pipelines. To continue using OIDC after upgrading to Instance Manager 2.9.0, you'll need to update these configuration files. @@ -1026,16 +1077,20 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-9-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} After upgrading to NGINX Instance Manager 2.1.0, the web interface reports timeouts when NGINX Agent configs are published (32349) +- {{% icon-resolved %}} Scan misidentifies some NGINX OSS instances as NGINX Plus (35172) - {{% icon-resolved %}} Scan does not update an unmanaged instance to managed (37544) - {{% icon-resolved %}} "Public Key Not Available" error when upgrading Instance Manager on a Debian-based system (39431) - {{% icon-resolved %}} The Type text on the Instances overview page may be partially covered by the Hostname text (39760) +- {{% icon-resolved %}} System reports "Attack Signature does not exist" when publishing default Attack Signature (40020) - {{% icon-resolved %}} App Protect: "Assign Policy and Signature Versions" webpage may not initially display newly added policies (40085) +- {{% icon-resolved %}} Precompiled Publication setting is reverted to false after error publishing NGINX App Protect policy (40484) - {{% icon-resolved %}} Upgrading NGINX Management Suite may remove the OIDC configuration for the platform (41328) + ### Known Issues{#2-9-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1048,26 +1103,26 @@ January 30, 2023 ### Upgrade Paths {#2-8-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.8.0 supports upgrades from these previous versions: - 2.5.0 - 2.7.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-8-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Enhanced details page for SSL Certificates** - The Instance Manager web interface now features an improved details page for SSL Certificates. This page provides important information about the certificate and any associated instances. + The Instance Manager web interface now features an improved details page for SSL Certificates. This page provides important information about the certificate and any associated instances. - {{% icon-feature %}} **Automatic retrieval of Attack Signatures and Threat Campaign updates to Instance Manager** - Instance Manager now allows you to [set up automatic downloads of the most recent Attack Signature and Threat Campaign packages]({{< ref "/nim/nginx-app-protect/setup-waf-config-management.md##automatically-download-latest-packages" >}}). By publishing these updates to your App Protect instances from Instance Manager, you can ensure your applications are shielded from all recognized attack types. + Instance Manager now allows you to [set up automatic downloads of the most recent Attack Signature and Threat Campaign packages]({{< ref "/nim/nginx-app-protect/setup-waf-config-management.md##automatically-download-latest-packages" >}}). By publishing these updates to your App Protect instances from Instance Manager, you can ensure your applications are shielded from all recognized attack types. - {{% icon-feature %}} **Improved WAF Compiler error messages** - The messaging around [security policy compilation errors]({{< ref "/nim/nginx-app-protect/manage-waf-security-policies.md#check-for-compilation-errors" >}}) has been improved by providing more detailed information and alerting users if the required compiler version is missing. + The messaging around [security policy compilation errors]({{< ref "/nim/nginx-app-protect/manage-waf-security-policies.md#check-for-compilation-errors" >}}) has been improved by providing more detailed information and alerting users if the required compiler version is missing. ### Changes in Default Behavior{#2-8-0-changes-in-behavior} @@ -1096,8 +1151,8 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-8-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Web interface reports no license found when a license is present (30647) - {{% icon-resolved %}} Associating instances with expired certificates causes internal error (34182) @@ -1109,9 +1164,12 @@ This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/ - {{% icon-resolved %}} NGINX Management Suite services may lose connection to ClickHouse in a Kubernetes deployment (39285) - {{% icon-resolved %}} NGINX App Protect status may not be displayed after publishing a configuration with a security policy and certificate reference (39382) - {{% icon-resolved %}} Security Policy Snippet selector adds incorrect path reference for policy directive (39492) +- {{% icon-resolved %}} "Unpack: parse error" when compiling security update packages on CentOS 7, RHEL 7, and Amazon Linux 2 (39563) - {{% icon-resolved %}} The API Connectivity Manager module won't load if the Security Monitoring module is enabled (39943) +- {{% icon-resolved %}} Automatic downloads of attack signatures and threat campaigns are not supported on CentOS 7, RHEL 7, or Amazon Linux 2 (40396) - {{% icon-resolved %}} The API Connectivity Manager module won't load if the Security Monitoring module is enabled (44433) + ### Known Issues{#2-8-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1124,11 +1182,11 @@ December 20, 2022 ### Upgrade Paths {#2-7-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.7.0 supports upgrades from these previous versions: - 2.4.0 - 2.6.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### Changes in Default Behavior{#2-7-0-changes-in-behavior} This release has the following changes in default behavior: @@ -1147,17 +1205,19 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-7-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Instance Manager reports old NGINX version after upgrade (31225) - {{% icon-resolved %}} Instance Manager returns a "Download failed" error when editing an NGINX config for instances compiled and installed from source (35851) - {{% icon-resolved %}} Null data count is not correctly represented in the NGINX Plus usage graph. (38206) +- {{% icon-resolved %}} When upgrading a multi-node NMS deployment with helm charts the core, dpm, or integrations pods may fail to start (38589) - {{% icon-resolved %}} When upgrading Instance Manager from v2.4 to later versions of Instance Manager, certificate associations are no longer visible. (38641) - {{% icon-resolved %}} NGINX App Protect policy deployment status not reflecting removal of associated instance. (38700) - {{% icon-resolved %}} When upgrading a multi-node NMS deployment with helm charts the ingestion pod may report a "Mismatched migration version" error (38880) - {{% icon-resolved %}} After a version upgrade of NGINX Instance Manager, NMS Data Plane Manager crashes if you publish NGINX configuration with App Protect enablement directive (app_protect_enable) set to ON (38904) + ### Known Issues{#2-7-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1170,18 +1230,18 @@ November 17, 2022 ### Upgrade Paths {#2-6-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.6.0 supports upgrades from these previous versions: - 2.3.0 - 2.5.1 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-6-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Manage and deploy configurations to NGINX App Protect WAF Instances** - This release introduces the following features to [manage and deploy configurations to NGINX App Protect instances]({{< ref "/nim/nginx-app-protect/overview-nap-waf-config-management.md" >}}): + This release introduces the following features to [manage and deploy configurations to NGINX App Protect instances]({{< ref "/nim/nginx-app-protect/overview-nap-waf-config-management.md" >}}): - Create, upsert, and delete NGINX App Protect WAF security policies - Manage NGINX App Protect WAF security configurations by using the NGINX Management Suite user interface or REST API @@ -1190,19 +1250,19 @@ This release includes the following updates: - {{% icon-feature %}} **Adds support for RHEL 9** - Instance Manager 2.6 supports RHEL 9. See the [Technical Specifications Guide]({{< ref "/nim/fundamentals/tech-specs#distributions" >}}) for details. + Instance Manager 2.6 supports RHEL 9. See the [Technical Specifications Guide]({{< ref "/nim/fundamentals/tech-specs#distributions" >}}) for details. - {{% icon-feature %}} **Support for using HashiCorp Vault for storing secrets** - NGINX Management Suite now supports the use of Hashicorp Vault to store secrets such as SSL Certificates and Keys. Use of a new or existing Vault deployment is supported. + NGINX Management Suite now supports the use of Hashicorp Vault to store secrets such as SSL Certificates and Keys. Use of a new or existing Vault deployment is supported. - {{% icon-feature %}} **Graph and additional data are included in NGINX Plus usage tracking interface** - On the NGINX Plus usage tracking page, the number of NGINX Plus instances used over time is available in a graph. You can also view the minimum, maximum, and average count of concurrent unique instances in a given time period. + On the NGINX Plus usage tracking page, the number of NGINX Plus instances used over time is available in a graph. You can also view the minimum, maximum, and average count of concurrent unique instances in a given time period. - {{% icon-feature %}} **Adds support for Oracle 8** - Oracle 8 is now [a supported distribution]({{< ref "/nim/fundamentals/tech-specs#distributions" >}}) starting with Instance Manager 2.6. You can use the RedHat/CentOS distro to install the Oracle 8 package. + Oracle 8 is now [a supported distribution]({{< ref "/nim/fundamentals/tech-specs#distributions" >}}) starting with Instance Manager 2.6. You can use the RedHat/CentOS distro to install the Oracle 8 package. ### Changes in Default Behavior{#2-6-0-changes-in-behavior} @@ -1214,12 +1274,13 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-6-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Password error "option unknown" occurs when installing NGINX Instance Manager on Ubuntu with OpenSSL v1.1.0 (33055) - {{% icon-resolved %}} Instance Manager reports the NGINX App Protect WAF build number as the version (37510) + ### Known Issues{#2-6-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1232,18 +1293,19 @@ October 11, 2022 ### Upgrade Paths {#2-5-1-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.5.1 supports upgrades from these previous versions: - 2.2.0 - 2.5.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### Resolved Issues{#2-5-1-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Extended NGINX metrics aren't reported for NGINX Plus R26 and earlier (37738) + ### Known Issues{#2-5-1-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1256,32 +1318,33 @@ October 04, 2022 ### Upgrade Paths {#2-5-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.5.0 supports upgrades from these previous versions: - 2.2.0 - 2.4.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-5-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Track NGINX Plus usage over time** - When viewing your NGINX Plus instances in the Instnace Manager web interface, you can set a date and time filter to review the [NGINX Plus instance count]({{< ref "/nim/admin-guide/license/report-usage-connected-deployment.md" >}}) for a specific period. Also, you can use the Instance Manager REST API to view the lowest, highest, and average number of NGINX Plus instances over time. + When viewing your NGINX Plus instances in the Instnace Manager web interface, you can set a date and time filter to review the [NGINX Plus instance count]({{< ref "/nim/admin-guide/license/report-usage-connected-deployment.md" >}}) for a specific period. Also, you can use the Instance Manager REST API to view the lowest, highest, and average number of NGINX Plus instances over time. - {{% icon-feature %}} **New helm charts for each release of Instance Manager** - Each release of Instance Manager now includes a helm chart, which you can use to easily [install Instance Manager on Kubernetes]({{< ref "/nim/deploy/kubernetes/deploy-using-helm.md" >}}). You can download the helm charts from [MyF5](https://my.f5.com/manage/s/downloads). + Each release of Instance Manager now includes a helm chart, which you can use to easily [install Instance Manager on Kubernetes]({{< ref "/nim/deploy/kubernetes/deploy-using-helm.md" >}}). You can download the helm charts from [MyF5](https://my.f5.com/manage/s/downloads). ### Resolved Issues{#2-5-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} OIDC is not supported for helm chart deployments (33248) - {{% icon-resolved %}} Managed certificates may be overwritten if they have the same name on different datapath certificates (36240) - {{% icon-resolved %}} Scan overview page doesn't scroll to show the full list of instances (36514) + ### Known Issues{#2-5-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1294,22 +1357,22 @@ August 16, 2022 ### Upgrade Paths {#2-4-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.4.0 supports upgrades from these previous versions: - 2.1.0 - 2.3.1 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-4-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Get notified about critical events** - Instance Manager 2.4 adds a notifications panel to the web interface. After logging in to NGINX Management Suite, select the notification bell at the top of the page to view critical system events (`WARNING` or `ERROR` level events). Future releases will support additional notification options. + Instance Manager 2.4 adds a notifications panel to the web interface. After logging in to NGINX Management Suite, select the notification bell at the top of the page to view critical system events (`WARNING` or `ERROR` level events). Future releases will support additional notification options. - {{% icon-feature %}} **See which of your NGINX Plus instances have NGINX App Protect installed** - Now, when you [view your NGINX Plus inventory]({{< ref "/nim/admin-guide/license/report-usage-connected-deployment.md" >}}), you can see which instances have [NGINX App Protect](https://www.nginx.com/products/nginx-app-protect/) installed. NGINX App Protect is a modern app‑security solution that works seamlessly in DevOps environments as a robust WAF or app‑level DoS defense, helping you deliver secure apps from code to customer + Now, when you [view your NGINX Plus inventory]({{< ref "/nim/admin-guide/license/report-usage-connected-deployment.md" >}}), you can see which instances have [NGINX App Protect](https://www.nginx.com/products/nginx-app-protect/) installed. NGINX App Protect is a modern app‑security solution that works seamlessly in DevOps environments as a robust WAF or app‑level DoS defense, helping you deliver secure apps from code to customer. ### Changes in Default Behavior{#2-4-0-changes-in-behavior} @@ -1325,11 +1388,12 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-4-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Unable to publish config changes to a custom nginx.conf location (35276) + ### Known Issues{#2-4-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1342,11 +1406,11 @@ July 21, 2022 ### Upgrade Paths {#2-3-1-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.3.1 supports upgrades from these previous versions: - 2.0.0 - 2.3.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### Security Updates{#2-3-1-security-updates} @@ -1365,6 +1429,7 @@ This release includes the following security updates: For more information, refer to the AskF5 article [K37080719](https://support.f5.com/csp/article/K37080719). + ### Known Issues{#2-3-1-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1377,43 +1442,43 @@ June 30, 2022 ### Upgrade Paths {#2-3-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.3.0 supports upgrades from these previous versions: - 2.0.0 - 2.2.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-3-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Instance Manager provides information about your NGINX App Protect WAF installations** - You can configure NGINX Agent to report the following NGINX App Protect WAF installation information to NGINX Management Suite: + You can configure NGINX Agent to report the following NGINX App Protect WAF installation information to NGINX Management Suite: - The current version of NGINX App Protect WAF - The current status of NGINX App Protect WAF (active or inactive) - The Attack Signatures package version - The Threat Campaigns package version -- {{% icon-feature %}} **View a summary of your instances' most important metrics for the last 24 hours** +- {{% icon-feature %}} **View a summary of your instances' most important metrics for the last 24 hours** - This release adds a **Metrics Summary** page, from which you can view key system, network, HTTP request, and connection metrics at a glance for the last 24 hours. After logging in to Instance Manager, select an instance on the **Instances Overview** page, then select the **Metrics Summary** tab. + This release adds a **Metrics Summary** page, from which you can view key system, network, HTTP request, and connection metrics at a glance for the last 24 hours. After logging in to Instance Manager, select an instance on the **Instances Overview** page, then select the **Metrics Summary** tab. - {{% icon-feature %}} **Track the details for your NGINX Plus instances** - Easily track your NGINX Plus instances from the new NGINX Plus inventory list page. [View the current count for all your NGINX Plus instances]({{< ref "/nim/admin-guide/license/report-usage-connected-deployment.md" >}}), as well as each instance's hostname, UID, version, and the last time each instance was reported to Instance Manager. Select the `Export` button to export the list of NGINX Plus instances to a `.csv` file. + Easily track your NGINX Plus instances from the new NGINX Plus inventory list page. [View the current count for all your NGINX Plus instances]({{< ref "/nim/admin-guide/license/report-usage-connected-deployment.md" >}}), as well as each instance's hostname, UID, version, and the last time each instance was reported to Instance Manager. Select the `Export` button to export the list of NGINX Plus instances to a `.csv` file. - {{% icon-feature %}} **Explore events in NGINX Instance Manager with the Events Catalogs API** - This release introduces a Catalogs API endpoint specifically for viewing NGINX Instance Manager events and corresponding information. You can access the endpoint at `/analytics/catalogs/events`. + This release introduces a Catalogs API endpoint specifically for viewing NGINX Instance Manager events and corresponding information. You can access the endpoint at `/analytics/catalogs/events`. - {{% icon-feature %}} **Support for provisioning users and user groups with SCIM** - Now, you can [use SCIM to provision, update, or deprovision users and user groups]({{< ref "/nim/admin-guide/authentication/oidc/scim-provisioning.md" >}}) for your Identity Provider to NGINX Instance Manager. SCIM, short for "[System for Cross-domain Identity Management](http://www.simplecloud.info)," is an open API for managing identities. + Now, you can [use SCIM to provision, update, or deprovision users and user groups]({{< ref "/nim/admin-guide/authentication/oidc/scim-provisioning.md" >}}) for your Identity Provider to NGINX Instance Manager. SCIM, short for "[System for Cross-domain Identity Management](http://www.simplecloud.info)," is an open API for managing identities. - {{% icon-feature %}} **Adds support for Ubuntu 22.04** - The NGINX Management Suite, which includes NGINX Instance Manager, now supports Ubuntu 22.04 (Jammy). + The NGINX Management Suite, which includes NGINX Instance Manager, now supports Ubuntu 22.04 (Jammy). Refer to the [Technical Specifications Guide]({{< ref "/nim/fundamentals/tech-specs" >}}) for details. @@ -1427,11 +1492,12 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-3-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Post-install steps to load SELinux policy are in the wrong order (34276) + ### Known Issues{#2-3-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1444,34 +1510,34 @@ May 25, 2022 ### Upgrade Paths {#2-2-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.2.0 supports upgrades from these previous versions: - 2.0.0 - 2.1.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-2-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **New events for NGINX processes and configuration rollbacks** - Now, you can use the [NGINX Instance Manager Events API]({{< ref "/nim/monitoring/view-events-metrics.md" >}}) or [web interface]({{< ref "/nim/monitoring/view-events-metrics.md" >}}) to view events when NGINX instances start and reload or when a configuration is rolled back. + Now, you can use the [NGINX Instance Manager Events API]({{< ref "/nim/monitoring/view-events-metrics.md" >}}) or [web interface]({{< ref "/nim/monitoring/view-events-metrics.md" >}}) to view events when NGINX instances start and reload or when a configuration is rolled back. - {{% icon-feature %}} **Filter events and metrics with custom date and time ranges** - Now you can filter [events]({{< ref "/nim/monitoring/view-events-metrics" >}}) and [metrics]({{< ref "/nim/monitoring/view-events-metrics" >}}) using a custom date and time range. Select **Custom time range** in the filter list, then specify the date and time range you want to use. + Now you can filter [events]({{< ref "/nim/monitoring/view-events-metrics" >}}) and [metrics]({{< ref "/nim/monitoring/view-events-metrics" >}}) using a custom date and time range. Select **Custom time range** in the filter list, then specify the date and time range you want to use. - {{% icon-feature %}} **Role-based access control added to Events and Metrics pages** - A warning message is shown when users try to view the Events and Metrics pages in the web interface if they don't have permission to access the Analytics feature. For instructions on assigning access to features using role-based access control (RBAC), see [Set Up RBAC]({{< ref "/nim/admin-guide/rbac/overview-rbac.md" >}}). + A warning message is shown when users try to view the Events and Metrics pages in the web interface if they don't have permission to access the Analytics feature. For instructions on assigning access to features using role-based access control (RBAC), see [Set Up RBAC]({{< ref "/nim/admin-guide/rbac/overview-rbac.md" >}}). - {{% icon-feature %}} **Modules field added to Metrics and Dimensions catalogs** - A `modules` field was added to the [Metics]({{< ref "nms/reference/catalogs/metrics.md" >}}) and [Dimensions]({{< ref "nms/reference/catalogs/dimensions.md" >}}) catalogs. This field indicates which module or modules the metric or dimension belongs to. + A `modules` field was added to the [Metics]({{< ref "nms/reference/catalogs/metrics.md" >}}) and [Dimensions]({{< ref "nms/reference/catalogs/dimensions.md" >}}) catalogs. This field indicates which module or modules the metric or dimension belongs to. - {{% icon-feature %}} **Adds reporting for NGINX worker metrics (API only)** - The NGINX Agent now gathers metrics for NGINX workers. You can access these metrics using the NGINX Instance Manager Metrics API. + The NGINX Agent now gathers metrics for NGINX workers. You can access these metrics using the NGINX Instance Manager Metrics API. The following worker metrics are reported: @@ -1480,11 +1546,12 @@ This release includes the following updates: ### Resolved Issues{#2-2-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Running Agent install script with sh returns “not found” error (33385) + ### Known Issues{#2-2-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1497,18 +1564,18 @@ April 05, 2022 ### Upgrade Paths {#2-1-0-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.1.0 supports upgrades from these previous versions: - 2.0.0 - 2.0.1 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### What's New{#2-1-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **Adds Docker support for NGINX Agent** - Now you can collect metrics about the Docker containers that the NGINX Agent is running in. The NGINX Agent uses the available cgroup files to calculate metrics like CPU and memory usage. + Now you can collect metrics about the Docker containers that the NGINX Agent is running in. The NGINX Agent uses the available cgroup files to calculate metrics like CPU and memory usage. If you have multiple Docker containers on your data plane host, each container registers with Instance Manager as unique. @@ -1518,29 +1585,29 @@ This release includes the following updates: - {{% icon-feature %}} **Redesigned metrics views in the web interface** - The metrics pages in the web interface have been revised and improved. + The metrics pages in the web interface have been revised and improved. See the [View Metrics]({{< ref "/nim/monitoring/view-events-metrics" >}}) topic to get started. - {{% icon-feature %}} **New RBAC lets you limit access to NGINX Instance Manager features** - RBAC has been updated and improved. Add users to roles -- or add users to user groups if you're using an external identity provider -- to limit access to Instance Manager features. + RBAC has been updated and improved. Add users to roles -- or add users to user groups if you're using an external identity provider -- to limit access to Instance Manager features. For more information, see the tutorial [Set Up RBAC]({{< ref "/nim/admin-guide/rbac/overview-rbac.md" >}}). - {{% icon-feature %}} **Improved certificate handling** - Stability and performance improvements for managing certificates using the web interface. + Stability and performance improvements for managing certificates using the web interface. - {{% icon-feature %}} **View events for your NGINX instances** - Now you can use the Instance Manager API or web interface to view events for your NGINX instances. + Now you can use the Instance Manager API or web interface to view events for your NGINX instances. See the [View Events]({{< ref "/nim/monitoring/view-events-metrics" >}}) and [View Events (API)]({{< ref "/nim/monitoring/view-events-metrics" >}}) topics for instructions. - {{% icon-feature %}} **Deploy NGINX Instance Manager on Kubernetes using a helm chart** - We recommend using the Instance Manager helm chart to install Instance Manager on Kubernetes. + We recommend using the Instance Manager helm chart to install Instance Manager on Kubernetes. Among the benefits of deploying from a helm chart, the chart includes the required services, which you can scale independently as needed; upgrades can be done with a single helm command; and there's no requirement for root privileges. @@ -1581,8 +1648,8 @@ This release has the following changes in default behavior: ### Resolved Issues{#2-1-0-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Unable to register multiple NGINX Agents in containers on the same host (30780) - {{% icon-resolved %}} Include cycles in the configuration cause analyzer to spin. (31025) @@ -1590,6 +1657,7 @@ This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/ - {{% icon-resolved %}} When using Instance Groups, tag-based access controls are not enforced (31267) - {{% icon-resolved %}} Bad Gateway (502) errors with Red Hat 7 (31277) + ### Known Issues{#2-1-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1602,19 +1670,20 @@ January 27, 2022 ### Upgrade Paths {#2-0-1-upgrade-paths} -Instance Manager supports upgrades from these previous versions: +NGINX Instance Manager 2.0.1 supports upgrades from these previous versions: - 2.0.0 -If your Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. +If your NGINX Instance Manager version is older, you may need to upgrade to an intermediate version before upgrading to the target version. ### Resolved Issues{#2-0-1-resolved-issues} -This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. +This release fixes the following issues. Check the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic for more information on the latest resolved issues. Use your browser's search function to find the issue ID in the page. - {{% icon-resolved %}} Unable to access the NGINX Instance Manager web interface after loading SELinux policy (31583) - {{% icon-resolved %}} The `nms-dpm` service restarts when registering multiple NGINX Agents with the same identity (31612) + ### Known Issues{#2-0-1-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. @@ -1624,27 +1693,29 @@ You can find information about known issues in the [Known Issues]({{< ref "/nim/ ## 2.0.0 December 21, 2021 + + ### What's New{#2-0-0-whats-new} This release includes the following updates: - {{% icon-feature %}} **(Experimental) Share a configuration across multiple instances** - With a feature called **Instance Groups**, you can share the same configuration across multiple instances. So, if your website requires a number of instances to support the load, you can publish the same configuration to each instance with ease. + With a feature called **Instance Groups**, you can share the same configuration across multiple instances. So, if your website requires a number of instances to support the load, you can publish the same configuration to each instance with ease. - {{% icon-feature %}} **More metrics and instance dashboards** - Instance Manager now collects additional metrics from the NGINX instances. We also added pre-configured dashboards to the web interface for each NGINX instance managed by Instance Manager. See the [Catalog Reference]({{< ref "/nms/reference/catalogs/_index.md" >}}) documentation for a complete list of metrics. + Instance Manager now collects additional metrics from the NGINX instances. We also added pre-configured dashboards to the web interface for each NGINX instance managed by Instance Manager. See the [Catalog Reference]({{< ref "/nms/reference/catalogs/_index.md" >}}) documentation for a complete list of metrics. - {{% icon-feature %}} **New architecture!** - We redesigned and improved the architecture of Instance Manager! + We redesigned and improved the architecture of Instance Manager! - {{% icon-feature %}} **Improved user access control** - Instance Manager 2.x. allows you to create user access controls with tags. Administrators can grant users read or write access to perform instance management tasks. And admins can grant or restrict access to the Settings options, such as managing licenses and creating users and roles. See the [Set up Authentication]({{< ref "/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md#rbac" >}}) guide for more details. + Instance Manager 2.x. allows you to create user access controls with tags. Administrators can grant users read or write access to perform instance management tasks. And admins can grant or restrict access to the Settings options, such as managing licenses and creating users and roles. See the [Set up Authentication]({{< ref "/nim/admin-guide/authentication/basic-auth/set-up-basic-authentication.md#rbac" >}}) guide for more details. + ### Known Issues{#2-0-0-known-issues} You can find information about known issues in the [Known Issues]({{< ref "/nim/releases/known-issues.md" >}}) topic. -