End of Sale Notice:

F5 NGINX is announcing the End of Sale (EoS) for NGINX Controller API Management Module, effective January 1, 2024.

F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing NGINX Controller API- Management customers can continue to use the product past the EoS date. License renewals are not available after September 30, 2024.

See our End of Sale announcement for more details.
End of Sale Notice:

F5 NGINX is announcing the End of Sale (EoS) for NGINX Controller Application Delivery Module, effective January 1, 2024.

F5 maintains generous lifecycle policies that allow customers to continue support and receive product updates. Existing NGINX Controller Application Delivery customers can continue to use the product past the EoS date. License renewals are not available after September 30, 2024.

See our End of Sale announcement for more details.

Release Notes 3.19.0

These release notes contain information about new features, improvements, known issues, and bug fixes in the NGINX Controller API Management Module.

We encourage you to install the latest version of the NGINX Controller APIM module to take advantage of the newest features and updates.

Technical support is provided for earlier versions that were released within two years of the current release.

See Also:

For related installation documentation, refer to the following publications:

Important:

Upgrading from NGINX Controller 3.x to NGINX Controller API Management Module 3.18 or later

NGINX Controller 3.x includes the NGINX Controller Application Delivery Module (ADC) and NGINX Controller API Management Module (APIM).

Starting with APIM 3.18, the ADC and APIM Modules are released independently on different schedules.

If you’ve installed NGINX Controller 3.18 or earlier before July 2021, we recommend you use the ADC Module going forward.

However, if you want to upgrade to APIM 3.18 or later, we recommend you upgrade to NGINX Controller 3.17 first.

 

August 9, 2021

Upgrade Considerations

Take note of the following considerations when upgrading to this version of the NGINX Controller API Management Module:

  • After upgrading NGINX Controller, make sure to upgrade the NGINX Controller Agent too.

  • If you’re upgrading NGINX Controller on a multi-node cluster, run the update.sh script on each node individually – the order in which you update the nodes doesn’t matter.

    Warning:
    Never update the control nodes in parallel. Doing so may result in race conditions for certain jobs, such as database migrations, and may cause the cluster to become unavailable.

What’s New

  • NGINX Controller API Management Advanced Security

    You can use the App Security add-onfor NGINX Controller APIM to enable Web Application Firewall (WAF) capabilities to protect your APIs. WAF lets you flag or block suspicious requests or attacks.

  • Support added for multiple API key identity providers on a component

    Now you can add multiple identity providers of type API key on a component. This will allow you to assign keys with better granularity.

  • API Keys can be imported from a CSV file

    API Keys can be imported from a CSV file or pasted in as a comma-separated list.

Resolved Issues

This release includes the following fixes. To locate the details for an issue when it was first reported, search the NGINX Docs for the issue ID.

  • Authentication policies are not yet supported for SOAP-REST proxy (26211)

  • Instructions for restoring external config database may not restore published APIs (26280)

  • Improved messaging when WSDL import fails (26630)

  • WSDLs without “types” section can now be imported (26655)

Known Issues

The following issues are known to be present in this release. Look for updates to these issues in future release notes.

  • Cannot use multiple listenIPs and a wildcard IP on the same port (26466)

    If you set more than one listenIP and a wildcard IP (null listenIP) to use the same port on the same NGINX Plus instance, reuseport will apply to all of the IP:port pairs on the listen directive in the nginx.conf - except the first - as well as to the wildcard IP. An example config is below:

    server {
  listen ip1:port;
  listen ip2:port reuseport;
  listen ip3:port reuseport;
}
server {
  listen port reuseport;  <-- wildcard IP
}

    This will cause all the traffic passed to the IP:port pairs that are using reuseport to be forwarded to the server block with the wildcard IP on the same port, because of the NGINX server match rule. The first IP:port pair is not affected.

    Workaround:

    To avoid this issue, use a unique port for each HTTP uri when both listenIP and wildcard IP are being used on the same instance.

Supported NGINX Plus Versions

NGINX Controller works with the following NGINX Plus versions:

  • NGINX Plus R24
  • NGINX Plus R23
  • NGINX Plus R22
  • NGINX Plus R21
  • NGINX Plus R20
  • NGINX Plus R19