Skip to content

Commit f719d79

Browse files
committed
docs:change tarball extension from tgz to tar.gz
1 parent 8276017 commit f719d79

31 files changed

+95
-95
lines changed

content/controller/admin-guides/backup-restore/backup-restore-cluster-config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ After installing F5 NGINX Controller, you should back up the cluster config and
1919
/opt/nginx-controller/helper.sh cluster-config save
2020
```
2121

22-
The file is saved to `/opt/nginx-controller/cluster-config.tgz`.
22+
The file is saved to `/opt/nginx-controller/cluster-config.tar.gz`.
2323

2424
- To restore the cluster's config and encryption keys, take the following steps:
2525

content/controller/admin-guides/install/install-nginx-controller.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ After installing NGINX Controller, you should back up the cluster config and enc
325325
/opt/nginx-controller/helper.sh cluster-config save
326326
```
327327
328-
The file is saved to `/opt/nginx-controller/cluster-config.tgz`.
328+
The file is saved to `/opt/nginx-controller/cluster-config.tar.gz`.
329329
330330
- To restore the cluster's config and encryption keys, take the following steps:
331331

content/controller/admin-guides/install/using-helper-script.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ After installing NGINX Controller, you should back up the cluster config and enc
8484
/opt/nginx-controller/helper.sh cluster-config save
8585
```
8686

87-
The file is saved to `/opt/nginx-controller/cluster-config.tgz`.
87+
The file is saved to `/opt/nginx-controller/cluster-config.tar.gz`.
8888

8989
- To restore the cluster's config and encryption keys, take the following steps:
9090

content/includes/nap-waf/bundles-volume-mount.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ By setting up this volume mount, the bundle files can be referenced within your
2222
For instance:
2323

2424
```nginx
25-
app_protect_policy_file /bundles/custom_policy.tgz;
26-
app_protect_security_log /bundles/custom_logging_profile.tgz syslog:server=localhost:514;
25+
app_protect_policy_file /bundles/custom_policy.tar.gz;
26+
app_protect_security_log /bundles/custom_logging_profile.tar.gz syslog:server=localhost:514;
2727
```

content/includes/nap-waf/concept/grpc-logging.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ server {
1414
server_name my_grpc_service.com;
1515
location / {
1616
app_protect_enable on;
17-
app_protect_policy_file "/etc/app_protect/conf/policy_with_grpc_profile.tgz";
17+
app_protect_policy_file "/etc/app_protect/conf/policy_with_grpc_profile.tar.gz";
1818
app_protect_security_log_enable on;
19-
app_protect_security_log "/etc/app_protect/conf/log_grpc_all.tgz" stderr;
19+
app_protect_security_log "/etc/app_protect/conf/log_grpc_all.tar.gz" stderr;
2020
grpc_pass grpcs://grpc_backend;
2121
}
2222
}

content/includes/nap-waf/config/common/grpc-content-profiles.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,12 @@ The profile in this example enables checking of attack signatures and disallowed
9494

9595
The main IDL file, `album.proto` is marked as `primary`. The file it imports, `messages.proto`, is marked as secondary, i.e., `isPrimary` is `false` and so should be any imported file. In order for App Protect to be able to match it to the import statement, the file location should be specified as done in the example above using the `importUrl` property.
9696

97-
An alternative and probably more convenient way to specify all the IDL files, the primary and all its imports, direct and indirect, is to bundle them into a single tar file in the same directory structure as they are expected by the import statements. In this case, you will have to specify which of the files in the tarball is the primary one. The supported formats are `tar` and `tgz`. App Protect will identify the file type automatically (tar, gzipped tar, or JSON) and handle it accordingly. Following the above example:
97+
An alternative and probably more convenient way to specify all the IDL files, the primary and all its imports, direct and indirect, is to bundle them into a single tar file in the same directory structure as they are expected by the import statements. In this case, you will have to specify which of the files in the tarball is the primary one. The supported formats are `tar` and `tar.gz`. App Protect will identify the file type automatically (tar, gzipped tar, or JSON) and handle it accordingly. Following the above example:
9898

9999
```json
100100
"idlFiles": [{
101101
"idlFile": {
102-
"$ref": "file:///grpc_files/album_service_files.tgz"
102+
"$ref": "file:///grpc_files/album_service_files.tar.gz"
103103
},
104104
"primaryIdlFileName": "album_service.proto"
105105
}]
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
In this setup, copy your compiled policy and logging profile bundles to `/mnt/nap5_bundles_pv_data` on a cluster node. Make sure that input files are accessible to UID 101. Then, in your NGINX configuration, refer to these files from `/etc/app_protect/bundles`.
22

3-
For example, to apply `custom_policy.tgz` that you've placed in `/mnt/nap5_bundles_pv_data/`, use:
3+
For example, to apply `custom_policy.tar.gz` that you've placed in `/mnt/nap5_bundles_pv_data/`, use:
44

55
```nginx
6-
app_protect_policy_file "/etc/app_protect/bundles/custom_policy.tgz";
6+
app_protect_policy_file "/etc/app_protect/bundles/custom_policy.tar.gz";
77
```

content/nap-dos/troubleshooting-guide/how-to-troubleshoot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ If there are any problems, collect the troubleshooting information in a tarball
150150
3. Create the tarball:
151151

152152
```shell
153-
tar cvfz logs.tgz `cat logs.txt`
153+
tar cvfz logs.tar.gz `cat logs.txt`
154154
```
155155

156-
4. Send `logs.tgz` to your customer support.
156+
4. Send `logs.tar.gz` to your customer support.

content/nap-waf/v4/admin-guide/upgrade-nap-waf.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For details on matching NGINX App Protect WAF releases with their WAF compiler v
2222

2323
## Upgrade NGINX App Protect on the Data Plane
2424

25-
Before you start, make sure you're using NGINX Management Suite for your policy management. Your NGINX configuration should be set up to use WAF policies with a _.tgz_ extension.
25+
Before you start, make sure you're using NGINX Management Suite for your policy management. Your NGINX configuration should be set up to use WAF policies with a _.tar.gz_ extension.
2626

2727
To update NGINX App Protect on an NGINX data plane instance, follow these steps:
2828

content/nap-waf/v4/troubleshooting-guide/troubleshooting.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ In order to open a support ticket, collect the troubleshooting information in a
105105
5. Create the tarball:
106106
107107
```none
108-
tar cvfz logs.tgz `cat logs.txt`
108+
tar cvfz logs.tar.gz `cat logs.txt`
109109
```
110110
111-
7. Attach `logs.tgz` to support ticket.
111+
7. Attach `logs.tar.gz` to support ticket.
112112
113113
8. On the support ticket, in the NGINX App Protect WAF, set the release version according to the `opt/app_protect/RELEASE` file.

content/nap-waf/v5/admin-guide/compiler.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Ensure that the output directory is writable, otherwise you may encounter a perm
128128
docker run --rm \
129129
-v $(pwd):$(pwd) \
130130
waf-compiler-<version-tag>:custom \
131-
-p $(pwd)/policy.json -o $(pwd)/compiled_policy.tgz
131+
-p $(pwd)/policy.json -o $(pwd)/compiled_policy.tar.gz
132132
```
133133

134134
However, to utilize multiple policy bundles within a single NGINX configuration, it's necessary to supply a [global settings](#global-settings) JSON file. This ensures that all bundles have a common foundation, including cookie seed, user-defined signatures, and more.
@@ -153,7 +153,7 @@ Compilation with global settings:
153153
docker run --rm \
154154
-v $(pwd):$(pwd) \
155155
waf-compiler-1.0.0:custom \
156-
-g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tgz
156+
-g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tar.gz
157157
```
158158
159159
Using `-include-source`, you can incorporate the source of the policy (as `policy.json`) or logging profile (as `logging_profile.json`) into the final bundle. This process transforms any configuration that relies on external references into an inline configuration within the bundled source. Furthermore, when `-include-source` is combined with `-full-export`, the policy.json within the bundle will contain the entire source policy, including any default settings from the base template.
@@ -162,7 +162,7 @@ Using `-include-source`, you can incorporate the source of the policy (as `polic
162162
docker run --rm \
163163
-v $(pwd):$(pwd) \
164164
waf-compiler-1.0.0:custom \
165-
-include-source -full-export -g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tgz
165+
-include-source -full-export -g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tar.gz
166166
```
167167
168168
### Logging Profile Compilation
@@ -173,7 +173,7 @@ To compile a logging profile, execute the command below:
173173
docker run \
174174
-v $(pwd):$(pwd) \
175175
waf-compiler-<version-tag>:custom \
176-
-l $(pwd)/log_01.json -o $(pwd)/log01.tgz
176+
-l $(pwd)/log_01.json -o $(pwd)/log01.tar.gz
177177
```
178178
179179
### Bundle Information
@@ -184,7 +184,7 @@ To view information about a bundle file, such as attack signatures versions, use
184184
docker run \
185185
-v $(pwd):$(pwd) \
186186
waf-compiler-<version-tag>:custom \
187-
-dump -bundle $(pwd)/compiled_policy.tgz
187+
-dump -bundle $(pwd)/compiled_policy.tar.gz
188188
```
189189
190190
---
@@ -246,7 +246,7 @@ When executing commands inside the compiler container, especially if it's part o
246246
For example:
247247
248248
```shell
249-
/opt/app_protect/bin/apcompile -g /path/to/global_settings.json -p /path/to/policy.json -o /path/to/compiled_policy.tgz
249+
/opt/app_protect/bin/apcompile -g /path/to/global_settings.json -p /path/to/policy.json -o /path/to/compiled_policy.tar.gz
250250
```
251251
252252
<!-- ## Converter Tools

content/nap-waf/v5/admin-guide/overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ We recommend that you deploy the NGINX App Protect WAF v5 in a staging environme
8383
- [Deploying NGINX App Protect WAF on Docker]({{<ref "/nap-waf/v5/admin-guide/deploy-on-docker.md">}})
8484
- [Deploying NGINX App Protect WAF on Kubernetes]({{<ref "/nap-waf/v5/admin-guide/deploy-with-helm.md">}})
8585

86-
1. Compile your `.json` policies and logging profiles to `.tgz` bundles using [compiler-image]({{<ref "/nap-waf/v5/admin-guide/compiler.md">}}) because NGINX App Protect WAF v5 supports policies and logging profiles in a compiled bundle format only.
86+
1. Compile your `.json` policies and logging profiles to `.tar.gz` bundles using [compiler-image]({{<ref "/nap-waf/v5/admin-guide/compiler.md">}}) because NGINX App Protect WAF v5 supports policies and logging profiles in a compiled bundle format only.
8787

8888
{{< note >}}
8989
If you were previously using a default [logging profile]({{<ref "/nap-waf/v5/admin-guide/deploy-on-docker.md#using-policy-and-logging-profile-bundles">}}) JSON like `/opt/app_protect/share/defaults/log_all.json`, you can replace it with the default constant such as `log_all`, and then you will not need to explicitly compile the logging profile into a bundle.
@@ -94,9 +94,9 @@ We recommend that you deploy the NGINX App Protect WAF v5 in a staging environme
9494

9595
{{< /note >}}
9696

97-
1. Replace the `.json` references in nginx.conf with the above created `.tgz` [bundles]({{<ref "/nap-waf/v5/admin-guide/install.md#using-policy-and-logging-profile-bundles">}}).
97+
1. Replace the `.json` references in nginx.conf with the above created `.tar.gz` [bundles]({{<ref "/nap-waf/v5/admin-guide/install.md#using-policy-and-logging-profile-bundles">}}).
9898

99-
1. Make sure that `.tgz` bundles references are accessible to the `waf-config-mgr` container.
99+
1. Make sure that `.tar.gz` bundles references are accessible to the `waf-config-mgr` container.
100100

101101
1. Restart the deployment if it has already been initiated. Additionally, restart NGINX if utilizing the VM + containers deployment type. After the migrations, check that the NGINX process is running in the NGINX error log and there are no issues.
102102

content/nap-waf/v5/admin-guide/upgrade-nap-waf.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For details on matching NGINX App Protect WAF releases with their WAF compiler v
2525

2626
## Upgrade NGINX App Protect on the Data Plane
2727

28-
Before you start, make sure you're using NGINX Management Suite for your policy management. Your NGINX configuration should be set up to use WAF policies with a _.tgz_ extension.
28+
Before you start, make sure you're using NGINX Management Suite for your policy management. Your NGINX configuration should be set up to use WAF policies with a _.tar.gz_ extension.
2929

3030
To update NGINX App Protect on an NGINX data plane instance, follow these steps:
3131

content/nap-waf/v5/configuration-guide/configuration.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ See [signature sets](#signature-sets) for configuring the signature sets include
7171

7272
### Policy Configuration Overview
7373

74-
The NGINX App Protect WAF security policy configuration uses the declarative format based on a pre-defined base template. The policy is represented in a JSON file which you can edit to add, modify and remove security capabilities with respect to the base template. The JSON file then should be compiled to a bundle file (`.tgz`) using the [NGINX App Protect WAF Compiler]({{< ref "/nap-waf/v5/admin-guide/compiler.md" >}}). The way the policy is integrated into the NGINX configuration is via referencing the bundle file (using the full path) in the `nginx.conf` file.
74+
The NGINX App Protect WAF security policy configuration uses the declarative format based on a pre-defined base template. The policy is represented in a JSON file which you can edit to add, modify and remove security capabilities with respect to the base template. The JSON file then should be compiled to a bundle file (`.tar.gz`) using the [NGINX App Protect WAF Compiler]({{< ref "/nap-waf/v5/admin-guide/compiler.md" >}}). The way the policy is integrated into the NGINX configuration is via referencing the bundle file (using the full path) in the `nginx.conf` file.
7575

7676
Refer to the [admin guide]({{< ref "/nap-waf/v5/admin-guide/install.md#using-policy-and-logging-profile-bundles" >}}) for instructions on how to mount bundle files to your deployment.
7777

@@ -89,7 +89,7 @@ Replace the `1.0.0` with the version you use.
8989

9090
This script will output the schema to a file named `policy.json` into the current working directory. Once the schema file is generated, you can use validation tools such as [AJV](https://ajv.js.org/standalone.html) to validate a JSON policy file.
9191

92-
In the following example, the NGINX configuration file with App Protect enabled in the HTTP context and the policy `/policies/policy1.tgz` is used:
92+
In the following example, the NGINX configuration file with App Protect enabled in the HTTP context and the policy `/policies/policy1.tar.gz` is used:
9393

9494
```nginx
9595
user nginx;
@@ -110,9 +110,9 @@ http {
110110
keepalive_timeout 65;
111111
112112
app_protect_enable on; # This is how you enable NGINX App Protect WAF in the relevant context/block
113-
app_protect_policy_file "/etc/app_protect/conf/policy1.tgz"; # This is a reference to the policy bundle file to use. If not defined, the default policy is used
113+
app_protect_policy_file "/etc/app_protect/conf/policy1.tar.gz"; # This is a reference to the policy bundle file to use. If not defined, the default policy is used
114114
app_protect_security_log_enable on; # This section enables the logging capability
115-
app_protect_security_log "/etc/app_protect/conf/log_all.tgz" syslog:server=127.0.0.1:514; # This is where the remote logger is defined in terms of: logging options (defined in the referenced file), log server IP, log server port
115+
app_protect_security_log "/etc/app_protect/conf/log_all.tar.gz" syslog:server=127.0.0.1:514; # This is where the remote logger is defined in terms of: logging options (defined in the referenced file), log server IP, log server port
116116
117117
server {
118118
listen 80;
@@ -177,7 +177,7 @@ For instance, to create an updated version of the `app_protect_default_policy`,
177177
docker run \
178178
-v $(pwd):$(pwd) \
179179
waf-compiler-1.0.0:custom \
180-
-factory-policy default -o $(pwd)/new_default_policy.tgz
180+
-factory-policy default -o $(pwd)/new_default_policy.tar.gz
181181
```
182182

183183
To create an updated version of the `app_protect_strict_policy`, use:
@@ -186,13 +186,13 @@ To create an updated version of the `app_protect_strict_policy`, use:
186186
docker run \
187187
-v $(pwd):$(pwd) \
188188
waf-compiler-1.0.0:custom \
189-
-factory-policy strict -o $(pwd)/new_strict_policy.tgz
189+
-factory-policy strict -o $(pwd)/new_strict_policy.tar.gz
190190
```
191191

192192
After creating the updated version of a policy, reference it in the `nginx.conf` file:
193193

194194
```nginx
195-
app_protect_policy_file /policies_mount/new_default_policy.tgz;
195+
app_protect_policy_file /policies_mount/new_default_policy.tar.gz;
196196
```
197197

198198
### Policy Authoring and Tuning
@@ -976,9 +976,9 @@ This table summarizes the nginx.conf directives for NGINX App Protect WAF functi
976976
|load_module | load_module <library_file_path> | NGINX directive to load the App Protect module. It must be invoked with the App Protect library path | Global | load_module modules/ngx_http_app_protect_module.so |
977977
|app_protect_enforcer_address | <hostname/ip>:<port> | The Enforcer service address. | HTTP | app_protect_enforcer_address 127.0.0.1:50000; |
978978
|app_protect_enable | app_protect_enable on &#124; off | Whether to enable App Protect at the respective context. If not present, inherits from the parent context | HTTP, Server, Location | app_protect_enable on |
979-
|app_protect_policy_file | app_protect_policy_file <file_path> | Set a App Protect policy configuring behavior for the respective context. | HTTP, Server, Location | app_protect_policy_file /config/waf/strict_policy.tgz |
979+
|app_protect_policy_file | app_protect_policy_file <file_path> | Set a App Protect policy configuring behavior for the respective context. | HTTP, Server, Location | app_protect_policy_file /config/waf/strict_policy.tar.gz |
980980
|app_protect_security_log_enable | app_protect_security_log_enable on &#124; off | Whether to enable the App Protect per-request log at the respective context. | HTTP, Server, Location | app_protect_security_log_enable on |
981-
|app_protect_security_log | app_protect_security_log <file_path> <destination> | Specifies the per-request logging: what to log and where | HTTP, Server, Location | app_protect_security_log /config/waf/log_illegal.tgz syslog:localhost:522 |
981+
|app_protect_security_log | app_protect_security_log <file_path> <destination> | Specifies the per-request logging: what to log and where | HTTP, Server, Location | app_protect_security_log /config/waf/log_illegal.tar.gz syslog:localhost:522 |
982982
|app_protect_custom_log_attribute | app_protect_custom_log_attribute <key_value> | Specifies the assigned location/server/http dimension of each request. | HTTP, Server, Location | app_protect_custom_log_attribute ‘environment' 'env1' |
983983

984984
#### Failure Mode

content/nap-waf/v5/logging-overview/logs-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ There are several pre-compiled logging profile bundles available:
3232
- log_grpc_blocked
3333
- log_grpc_illegal
3434

35-
These logging profiles can be referenced by their names, excluding the file path and the `tgz` extension.
35+
These logging profiles can be referenced by their names, excluding the file path and the `tar.gz` extension.
3636

3737
For instance:
3838

content/nap-waf/v5/logging-overview/security-log.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ NGINX App Protect WAF uses its own logging mechanism for request logging rather
1818

1919
The Security log has the following properties:
2020

21-
* **Log Configuration**: `app_protect_security_log` directive referencing a custom logging profile bundle file (tgz) or a built-in logging profile name, for example - `log_all`.
21+
* **Log Configuration**: `app_protect_security_log` directive referencing a custom logging profile bundle file (tar.gz) or a built-in logging profile name, for example - `log_all`.
2222

2323
* **Configuration contexts**: nginx.conf: `http`, `server`, `location`
2424

@@ -59,11 +59,11 @@ The security log attributes are determined by the `app_protect_security_log` dir
5959
• Examples:
6060
```nginx
6161
app_protect_security_log log_default stderr;
62-
app_protect_security_log /mounted_host_dir/logging_profile_01.tgz /mounted_host_dir/security.log;
62+
app_protect_security_log /mounted_host_dir/logging_profile_01.tar.gz /mounted_host_dir/security.log;
6363
app_protect_security_log log_all syslog:server=localhost:514;
6464
app_protect_security_log log_grpc_all syslog:server=my-specific-machine-name:514;
6565
app_protect_security_log log_illegal syslog:server=192.168.12.34:51400;
66-
app_protect_security_log /shared_volume/logging_profile_02.tgz syslog:server=my.domain.com:514;
66+
app_protect_security_log /shared_volume/logging_profile_02.tar.gz syslog:server=my.domain.com:514;
6767
```
6868

6969
##### Arguments
@@ -77,7 +77,7 @@ app_protect_security_log /shared_volume/logging_profile_02.tgz syslog:server=my.
7777

7878
### Security Log Configuration File
7979

80-
Before applying, the log configuration file (JSON) should be [compiled]({{< ref "/nap-waf/v5/admin-guide/compiler.md#logging-profile-compilation" >}}) into a logging profile bundle (tgz).
80+
Before applying, the log configuration file (JSON) should be [compiled]({{< ref "/nap-waf/v5/admin-guide/compiler.md#logging-profile-compilation" >}}) into a logging profile bundle (tar.gz).
8181

8282
The file is in JSON format and consists of two parts:
8383
1. **filter:** which requests are to be logged.

content/nap-waf/v5/troubleshooting-guide/troubleshooting.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ In order to open a support ticket, collect the troubleshooting information in on
124124
6. At the same direcotory, run the following command to create the tarball file:
125125

126126
```shell
127-
tar cvfz logs.tgz .
127+
tar cvfz logs.tar.gz .
128128
```
129129

130-
7. Attach `logs.tgz` to support ticket.
130+
7. Attach `logs.tar.gz` to support ticket.

0 commit comments

Comments
 (0)