Skip to content

Commit f719d79

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

File tree

31 files changed

+95
-95
lines changed

31 files changed

+95
-95
lines changed

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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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
}]
Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 2 additions & 2 deletions
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.

0 commit comments

Comments
 (0)