Skip to content

Commit 5b9ae73

Browse files
y82weli02
y82
authored and
weli02
committed
Actualized Dynamic modules info for NGINX Plus (#430)
* Updated Dynamic Modules sections in Installing NGINX Plus. * Actualized dynamic modules landing page. * Added intro, updated procedure for uninstall dynamic modules. * Actualized info about removed dynamic modules. * Minor updates to OpenTelemetry module.
1 parent fe7362c commit 5b9ae73

File tree

7 files changed

+383
-393
lines changed

7 files changed

+383
-393
lines changed

‎content/nginx/admin-guide/dynamic-modules/cookie-flag.md

+4-59
Original file line numberDiff line numberDiff line change
@@ -10,69 +10,14 @@ type:
1010
- how-to
1111
---
1212

13-
> **Note**: The module was deprecated in [Release 23]({{< ref "nginx/releases.md#r23" >}}) and removed in [Release 26]({{< ref "nginx/releases.md#r26" >}}). The [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive implements native support for setting cookie flags and replaces the module. See [Native Method for Setting Cookie Flags](https://www.nginx.com/blog/nginx-plus-r23-released#cookie-flags) for details.
13+
{{< note >}} The `nginx-plus-module-cookie-flag` package is no longer available.{{< /note >}}
1414

15-
## Installation
15+
The module was deprecated in [NGINX Plus Release 23]({{< ref "nginx/releases.md#r23" >}}) and removed in [NGINX Plus Release 26]({{< ref "nginx/releases.md#r26" >}}). Its functionality has been replaced with natively supported [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive.
1616

17-
1. Install the Cookie-Flag module.
17+
To remove the module, follow the [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) instructions.
1818

19-
For Amazon Linux, CentOS, Oracle Linux, and RHEL:
19+
To learn how to replace the module with the native solution, see [Native Method for Setting Cookie Flags](https://www.nginx.com/blog/nginx-plus-r23-released#cookie-flags) and the [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive.
2020

21-
```shell
22-
sudo yum update && \
23-
sudo yum install nginx-plus-module-cookie-flag
24-
```
25-
26-
For Debian and Ubuntu:
27-
28-
```shell
29-
sudo apt update && \
30-
sudo apt install nginx-plus-module-cookie-flag
31-
```
32-
33-
For SLES:
34-
35-
```shell
36-
sudo zypper refresh && \
37-
sudo zypper install nginx-plus-module-cookie-flag
38-
```
39-
40-
For Alpine:
41-
42-
```shell
43-
apk add nginx-plus-module-cookie-flag
44-
```
45-
46-
2. Put the [`load_module`](https://nginx.org/en/docs/ngx_core_module.html#load_module) directive in the top‑level (“`main`”) context of F5 NGINX Plus configuration file, **nginx.conf**:
47-
48-
```nginx
49-
load_module modules/ngx_http_cookie_flag_filter_module.so;
50-
51-
http {
52-
# ...
53-
}
54-
```
55-
56-
3. Perform additional configuration as required by the [module](https://github.com/AirisX/nginx_cookie_flag_module).
57-
58-
4. Test the NGINX Plus configuration. In a terminal, type-in the command:
59-
60-
```shell
61-
nginx -t
62-
```
63-
64-
Expected output of the command:
65-
66-
```shell
67-
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
68-
nginx: configuration file /etc/nginx/nginx.conf is successful
69-
```
70-
71-
5. Reload the NGINX Plus configuration to enable the module:
72-
73-
```shell
74-
nginx -s reload
75-
```
7621

7722
## More Info
7823

‎content/nginx/admin-guide/dynamic-modules/dynamic-modules.md

+136-65
Large diffs are not rendered by default.

‎content/nginx/admin-guide/dynamic-modules/nginx-waf.md

+3-82
Original file line numberDiff line numberDiff line change
@@ -9,90 +9,11 @@ type:
99
- how-to
1010
---
1111

12-
The F5 NGINX ModSecurity web application firewall (WAF) is built on ModSecurity 3.0.
12+
{{< note >}} The `nginx-plus-module-modsecurity` package is no longer available.{{< /note >}}
1313

14-
{{< note >}} The ModSecurity WAF module was deprecated since NGINX Plus [Release 29]({{< ref "nginx/releases.md#r29" >}}), and is no longer available since NGINX Plus [Release 32]({{< ref "nginx/releases.md#r32" >}}) {{< /note >}}
14+
The ModSecurity WAF module was deprecated since [NGINX Plus Release 29]({{< ref "nginx/releases.md#r29" >}}), and is no longer available since [NGINX Plus Release 32]({{< ref "nginx/releases.md#r32" >}}).
1515

16-
## Installation
17-
18-
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
19-
20-
2. Install the NGINX ModSecurity WAF module package `nginx-plus-module-modsecurity`.
21-
22-
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
23-
24-
```shell
25-
sudo yum update && \
26-
sudo yum install nginx-plus-module-modsecurity
27-
```
28-
29-
{{< note >}} ppc64le is currently not supported for Amazon Linux, CentOS, Oracle Linux, and RHEL. {{< /note >}}
30-
31-
For Amazon Linux 2023:
32-
33-
```shell
34-
sudo dnf update && \
35-
sudo dnf install nginx-plus-module-modsecurity
36-
```
37-
38-
For Debian and Ubuntu:
39-
40-
```shell
41-
sudo apt update && \
42-
sudo apt install nginx-plus-module-modsecurity
43-
```
44-
45-
{{< note >}} aarch64 and ppc64le is currently not supported for Ubuntu.{{< /note >}}
46-
47-
For SLES:
48-
49-
```shell
50-
sudo zypper refresh && \
51-
sudo zypper install nginx-plus-module-modsecurity
52-
```
53-
54-
For Alpine:
55-
56-
```shell
57-
apk add nginx-plus-module-modsecurity
58-
```
59-
60-
## Configuration
61-
62-
After installation you will need to enable and configure the module in NGINX Plus configuration file `nginx.conf`.
63-
64-
1. Enable dynamic loading of the module with the [`load_module`](https://nginx.org/en/docs/ngx_core_module.html#load_module) directive specified in the top-level (“`main`”) context:
65-
66-
```nginx
67-
load_module modules/ngx_http_modsecurity_module.so;
68-
69-
http {
70-
# ...
71-
}
72-
```
73-
74-
2. Perform additional configuration as required by the [module](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual).
75-
76-
3. Test the NGINX Plus configuration. In a terminal, type-in the command:
77-
78-
```shell
79-
nginx -t
80-
```
81-
82-
Expected output of the command:
83-
84-
```shell
85-
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
86-
nginx: configuration file /etc/nginx/nginx.conf is successful
87-
```
88-
89-
4. Reload the NGINX Plus configuration to enable the module:
90-
91-
```shell
92-
nginx -s reload
93-
```
94-
95-
5. [Configure](https://docs.nginx.com/nginx-waf/admin-guide/nginx-plus-modsecurity-waf-installation-logging/) the module.
16+
To remove the module, follow the [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) instructions.
9617

9718
## More Info
9819

‎content/nginx/admin-guide/dynamic-modules/opentelemetry.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ type:
1313

1414
[OpenTelemetry](https://opentelemetry.io/) (OTel) is an observability framework for monitoring, tracing, troubleshooting, and optimizing applications. OTel enables the collection of telemetry data from a deployed application stack.
1515

16-
The `nginx-plus-module-otel` module is an NGINX-authored dynamic module that enables NGINX Plus to send telemetry data to an OTel collector. The module supports [W3C](https://w3c.github.io/trace-context/) trace context propagation, OpenTelemetry Protocol (OTLP)/gRPC trace exports, and offers several advantages over existing OTel modules including:
16+
The `nginx-plus-module-otel` module is an [NGINX-authored]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md#nginx-authored-dynamic-modules" >}}) dynamic module that enables NGINX Plus to send telemetry data to an OTel collector. The module supports [W3C](https://w3c.github.io/trace-context/) trace context propagation, OpenTelemetry Protocol (OTLP)/gRPC trace exports, and offers several advantages over existing OTel modules including:
1717

1818
- Enhanced performance: with the module enabled, request processing overhead is limited to 10-15%, compared to other OpenTelemetry implementations, which can introduce performance degradation of up to 50%.
1919

@@ -30,7 +30,7 @@ The OpenTelemetry module supersedes the deprecated [OpenTracing]({{< ref "opentr
3030

3131
## Installation
3232

33-
The installation process closely follows the [NGINX Plus installation procedure]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}). Prebuilt packages of the module for various Linux distributions can can be installed directly from the official repository. Prior to installation, you need to add the NGINX Plus package repository for your distribution and update the repository metadata.
33+
The installation process closely follows the [NGINX Plus installation procedure]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}). The module is available as the prebuilt `nginx-plus-module-otel` package for various Linux distributions and can be installed directly from the official NGINX Plus repository. Prior to installation, you need to add the NGINX Plus package repository for your distribution and update the repository metadata.
3434

3535
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
3636

@@ -131,7 +131,7 @@ The installation process closely follows the [NGINX Plus installation procedure]
131131
132132
6. Ensure that your package management system is configured to pull packages from the NGINX Plus repository. See [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) for details.
133133
134-
7. Update the repository information and install the package. In a terminal, run the appropriate command for your operating system.
134+
7. Update the repository information and install the `nginx-plus-module-otel` package. In a terminal, run the appropriate command for your operating system.
135135
136136
For CentOS, Oracle Linux, and RHEL:
137137
@@ -170,9 +170,9 @@ The installation process closely follows the [NGINX Plus installation procedure]
170170
171171
The resulting `ngx_otel_module.so` dynamic module will be written to the following directory, depending on your operating system:
172172
173-
- `/usr/local/nginx/modules` for most Linux Distributions
174-
- `/usr/lib/nginx/modules` for Ubuntu
175-
- `/usr/local/etc/nginx/modules` for FreeBSD
173+
- `/usr/lib64/nginx/modules/` for most Linux distributions
174+
- `/usr/lib/nginx/modules` for Debian, Ubuntu, Alpine
175+
- `/usr/local/etc/nginx/modules` for FreeBSD
176176
177177
8. Enable dynamic loading of the module.
178178
@@ -211,7 +211,9 @@ The installation process closely follows the [NGINX Plus installation procedure]
211211
212212
## Configuration
213213
214-
In a text editor, open the NGINX Plus configuration file (`/etc/nginx/nginx.conf` for Linux or `/usr/local/etc/nginx/nginx.conf` for FreeBSD).
214+
In a text editor, open the NGINX Plus configuration file:
215+
- `/etc/nginx/nginx.conf` for Linux
216+
- `/usr/local/etc/nginx/nginx.conf` for FreeBSD
215217
216218
For a complete list of directives, embedded variables, default span attributes, refer to the `ngx_otel_module` official documentation.
217219

‎content/nginx/admin-guide/dynamic-modules/opentracing.md

+3-91
Original file line numberDiff line numberDiff line change
@@ -12,101 +12,13 @@ type:
1212
- how-to
1313
---
1414

15-
{{< note >}} The module no longer available since F5 NGINX Plus [Release 34]({{< ref "nginx/releases.md#r34" >}}). The [OpenTelemetry]({{< ref "nginx/admin-guide/dynamic-modules/opentelemetry.md" >}}) module is available since NGINX Plus [Release 29]({{< ref "nginx/releases.md#r29" >}}) that incorporates the features of the OpenTracing module.{{< /note >}}
15+
{{< note >}} The `nginx-plus-module-opentracing` package is no longer available.{{< /note >}}
1616

17+
The module was deprecated in [NGINX Plus Release 31]({{< ref "nginx/releases.md#r31" >}}) and removed in [NGINX Plus Release 34]({{< ref "nginx/releases.md#r34" >}}). Its functionality has been replaced with the [OpenTelemetry]({{< ref "nginx/admin-guide/dynamic-modules/opentelemetry.md" >}}) module.
1718

18-
<span id="install"></span>
19-
## Installation
19+
To remove the module, follow the [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) instructions.
2020

21-
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
2221

23-
2. Install the OpenTracing module package `nginx-plus-module-opentracing`.
24-
25-
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
26-
27-
```shell
28-
sudo yum update && \
29-
sudo yum install nginx-plus-module-opentracing
30-
```
31-
32-
{{< note >}}the OpenTracing module cannot be installed on CentOS 6, Oracle Linux 6, and RHEL 6. {{< /note >}}
33-
34-
For Amazon Linux 2023, AlmaLinux, Rocky Linux:
35-
36-
```shell
37-
sudo dnf update && \
38-
sudo dnf install nginx-plus-module-opentracing
39-
```
40-
41-
For Debian and Ubuntu:
42-
43-
```shell
44-
sudo apt update && \
45-
sudo apt install nginx-plus-module-opentracing
46-
```
47-
48-
For SLES:
49-
50-
```shell
51-
sudo zypper refresh && \
52-
sudo zypper install nginx-plus-module-opentracing
53-
```
54-
55-
{{< note >}} the OpenTracing module cannot be installed on SLES 12. {{< /note >}}
56-
57-
For Alpine:
58-
59-
```shell
60-
apk add nginx-plus-module-opentracing
61-
```
62-
63-
For FreeBSD:
64-
65-
```shell
66-
sudo pkg update && \
67-
sudo pkg install nginx-plus-module-opentracing
68-
```
69-
70-
71-
<span id="configure"></span>
72-
73-
## Configuration
74-
75-
After installation you will need to enable and configure the module in NGINX Plus configuration file `nginx.conf`.
76-
77-
1. Enable dynamic loading of the module with the [`load_module`](https://nginx.org/en/docs/ngx_core_module.html#load_module) directive specified in the top-level (“`main`”) context:
78-
79-
```nginx
80-
load_module modules/ngx_http_opentracing_module.so;
81-
82-
http {
83-
# ...
84-
}
85-
```
86-
87-
2. Perform additional configuration as required by the [module](https://github.com/opentracing-contrib/nginx-opentracing). You will also need to [install a tracer](https://github.com/opentracing-contrib/nginx-opentracing#building-from-source) (“portable binary plugin”) for your selected service.
88-
89-
3. Test the NGINX Plus configuration. In a terminal, type-in the command:
90-
91-
```shell
92-
nginx -t
93-
```
94-
95-
Expected output of the command:
96-
97-
```shell
98-
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
99-
nginx: configuration file /etc/nginx/nginx.conf is successful
100-
```
101-
102-
4. Reload the NGINX Plus configuration to enable the module:
103-
104-
```shell
105-
nginx -s reload
106-
```
107-
108-
109-
<span id="info"></span>
11022
## More Info
11123

11224
- [NGINX plugin for OpenTracing Reference](https://github.com/opentracing-contrib/nginx-opentracing)

0 commit comments

Comments
 (0)