Apply suggestions from code review

mjang · web-flow · commit a3bf8c547486 · 2025-05-02T07:58:37.000-07:00
diff --git a/content/controller/admin-guides/backup-restore/backup-restore-cluster-config.md b/content/controller/admin-guides/backup-restore/backup-restore-cluster-config.md
@@ -19,7 +19,7 @@ After installing F5 NGINX Controller, you should back up the cluster config and
   /opt/nginx-controller/helper.sh cluster-config save
   ```
 
-  The file is saved to `/opt/nginx-controller/cluster-config.tar.gz`.
+  The file is saved to `/opt/nginx-controller/cluster-config.tgz`.
 
 - To restore the cluster's config and encryption keys, take the following steps:
 
diff --git a/content/controller/admin-guides/install/install-nginx-controller.md b/content/controller/admin-guides/install/install-nginx-controller.md
@@ -325,7 +325,7 @@ After installing NGINX Controller, you should back up the cluster config and enc
   /opt/nginx-controller/helper.sh cluster-config save
   ```
 
-  The file is saved to `/opt/nginx-controller/cluster-config.tar.gz`.
+  The file is saved to `/opt/nginx-controller/cluster-config.tgz`.
 
 - To restore the cluster's config and encryption keys, take the following steps:
 
diff --git a/content/controller/admin-guides/install/using-helper-script.md b/content/controller/admin-guides/install/using-helper-script.md
@@ -84,7 +84,7 @@ After installing NGINX Controller, you should back up the cluster config and enc
   /opt/nginx-controller/helper.sh cluster-config save
   ```
 
-  The file is saved to `/opt/nginx-controller/cluster-config.tar.gz`.
+  The file is saved to `/opt/nginx-controller/cluster-config.tgz`.
 
 - To restore the cluster's config and encryption keys, take the following steps:
 
diff --git a/content/includes/nap-waf/bundles-volume-mount.md b/content/includes/nap-waf/bundles-volume-mount.md
@@ -22,6 +22,6 @@ By setting up this volume mount, the bundle files can be referenced within your
 For instance:
 
    ```nginx
-   app_protect_policy_file /bundles/custom_policy.tar.gz;
-   app_protect_security_log /bundles/custom_logging_profile.tar.gz syslog:server=localhost:514;
+   app_protect_policy_file /bundles/custom_policy.tgz;
+   app_protect_security_log /bundles/custom_logging_profile.tgz syslog:server=localhost:514;
    ```
diff --git a/content/includes/nap-waf/concept/grpc-logging.md b/content/includes/nap-waf/concept/grpc-logging.md
@@ -14,9 +14,9 @@ server {
     server_name my_grpc_service.com;
     location / {
         app_protect_enable on;
-        app_protect_policy_file "/etc/app_protect/conf/policy_with_grpc_profile.tar.gz";
+        app_protect_policy_file "/etc/app_protect/conf/policy_with_grpc_profile.tgz";
         app_protect_security_log_enable on;
-        app_protect_security_log "/etc/app_protect/conf/log_grpc_all.tar.gz" stderr;
+        app_protect_security_log "/etc/app_protect/conf/log_grpc_all.tgz" stderr;
         grpc_pass grpcs://grpc_backend;
     }
 }
diff --git a/content/includes/nap-waf/config/common/grpc-content-profiles.md b/content/includes/nap-waf/config/common/grpc-content-profiles.md
@@ -94,12 +94,12 @@ The profile in this example enables checking of attack signatures and disallowed
 
 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.
 
-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:
+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:
 
 ```json
 "idlFiles": [{
     "idlFile": {
-        "$ref": "file:///grpc_files/album_service_files.tar.gz"
+        "$ref": "file:///grpc_files/album_service_files.tgz"
     },
     "primaryIdlFileName": "album_service.proto"
 }]
diff --git a/content/includes/nap-waf/nap-k8s-use-compiled-bundles.md b/content/includes/nap-waf/nap-k8s-use-compiled-bundles.md
@@ -1,7 +1,7 @@
 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`.
 
-For example, to apply `custom_policy.tar.gz` that you've placed in `/mnt/nap5_bundles_pv_data/`, use:
+For example, to apply `custom_policy.tgz` that you've placed in `/mnt/nap5_bundles_pv_data/`, use:
 
 ```nginx
-app_protect_policy_file "/etc/app_protect/bundles/custom_policy.tar.gz";
+app_protect_policy_file "/etc/app_protect/bundles/custom_policy.tgz";
 ```
diff --git a/content/nap-dos/troubleshooting-guide/how-to-troubleshoot.md b/content/nap-dos/troubleshooting-guide/how-to-troubleshoot.md
@@ -150,7 +150,7 @@ If there are any problems, collect the troubleshooting information in a tarball
 3. Create the tarball:
 
    ```shell
-   tar cvfz logs.tar.gz `cat logs.txt`
+   tar cvfz logs.tgz `cat logs.txt`
    ```
 
-4. Send `logs.tar.gz` to your customer support.
+4. Send `logs.tgz` to your customer support.
diff --git a/content/nap-waf/v4/admin-guide/upgrade-nap-waf.md b/content/nap-waf/v4/admin-guide/upgrade-nap-waf.md
@@ -22,7 +22,7 @@ For details on matching NGINX App Protect WAF releases with their WAF compiler v
 
 ## Upgrade NGINX App Protect on the Data Plane
 
-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.
+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.
 
 To update NGINX App Protect on an NGINX data plane instance, follow these steps:
 
diff --git a/content/nap-waf/v4/troubleshooting-guide/troubleshooting.md b/content/nap-waf/v4/troubleshooting-guide/troubleshooting.md
@@ -105,9 +105,9 @@ In order to open a support ticket, collect the troubleshooting information in a
  5. Create the tarball:
 
      ```none
-     tar cvfz logs.tar.gz `cat logs.txt`
+     tar cvfz logs.tgz `cat logs.txt`
      ```
 
- 7. Attach `logs.tar.gz` to support ticket.
+ 7. Attach `logs.tgz` to support ticket.
 
  8. On the support ticket, in the NGINX App Protect WAF, set the release version according to the `opt/app_protect/RELEASE` file.
diff --git a/content/nap-waf/v5/admin-guide/compiler.md b/content/nap-waf/v5/admin-guide/compiler.md
@@ -128,7 +128,7 @@ Ensure that the output directory is writable, otherwise you may encounter a perm
 docker run --rm \
  -v $(pwd):$(pwd) \
  waf-compiler-<version-tag>:custom \
- -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tar.gz
+ -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tgz
 ```
 
 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:
 docker run --rm \
  -v $(pwd):$(pwd) \
  waf-compiler-1.0.0:custom \
- -g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tar.gz
+ -g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tgz
 ```
 
 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
 docker run --rm \
  -v $(pwd):$(pwd) \
  waf-compiler-1.0.0:custom \
- -include-source -full-export -g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tar.gz
+ -include-source -full-export -g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tgz
 ```
 
 ### Logging Profile Compilation
@@ -173,7 +173,7 @@ To compile a logging profile, execute the command below:
 docker run \
  -v $(pwd):$(pwd) \
  waf-compiler-<version-tag>:custom \
- -l $(pwd)/log_01.json -o $(pwd)/log01.tar.gz
+ -l $(pwd)/log_01.json -o $(pwd)/log01.tgz
 ```
 
 ### Bundle Information
@@ -184,7 +184,7 @@ To view information about a bundle file, such as attack signatures versions, use
 docker run \
  -v $(pwd):$(pwd) \
  waf-compiler-<version-tag>:custom \
- -dump -bundle $(pwd)/compiled_policy.tar.gz
+ -dump -bundle $(pwd)/compiled_policy.tgz
 ```
 
 ---
@@ -246,7 +246,7 @@ When executing commands inside the compiler container, especially if it's part o
 For example:
 
 ```shell
-/opt/app_protect/bin/apcompile -g /path/to/global_settings.json -p /path/to/policy.json -o /path/to/compiled_policy.tar.gz
+/opt/app_protect/bin/apcompile -g /path/to/global_settings.json -p /path/to/policy.json -o /path/to/compiled_policy.tgz
 ```
 
 <!-- ## Converter Tools
diff --git a/content/nap-waf/v5/admin-guide/overview.md b/content/nap-waf/v5/admin-guide/overview.md
@@ -83,7 +83,7 @@ We recommend that you deploy the NGINX App Protect WAF v5 in a staging environme
    - [Deploying NGINX App Protect WAF on Docker]({{<ref "/nap-waf/v5/admin-guide/deploy-on-docker.md">}})
    - [Deploying NGINX App Protect WAF on Kubernetes]({{<ref "/nap-waf/v5/admin-guide/deploy-with-helm.md">}})
 
-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.
+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.
 
    {{< note >}}
    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
 
    {{< /note >}}
 
-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">}}).
+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">}}).
 
-1. Make sure that `.tar.gz` bundles references are accessible to the `waf-config-mgr` container.
+1. Make sure that `.tgz` bundles references are accessible to the `waf-config-mgr` container.
 
 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.
 
diff --git a/content/nap-waf/v5/admin-guide/upgrade-nap-waf.md b/content/nap-waf/v5/admin-guide/upgrade-nap-waf.md
@@ -25,7 +25,7 @@ For details on matching NGINX App Protect WAF releases with their WAF compiler v
 
 ## Upgrade NGINX App Protect on the Data Plane
 
-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.
+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.
 
 To update NGINX App Protect on an NGINX data plane instance, follow these steps:
 
diff --git a/content/nap-waf/v5/configuration-guide/configuration.md b/content/nap-waf/v5/configuration-guide/configuration.md
@@ -71,7 +71,7 @@ See [signature sets](#signature-sets) for configuring the signature sets include
 
 ### Policy Configuration Overview
 
-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.
+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.
 
 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.
 
@@ -89,7 +89,7 @@ Replace the `1.0.0` with the version you use.
 
 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.
 
-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:
+In the following example, the NGINX configuration file with App Protect enabled in the HTTP context and the policy `/policies/policy1.tgz` is used:
 
 ```nginx
 user nginx;
@@ -110,9 +110,9 @@ http {
     keepalive_timeout  65;
 
     app_protect_enable on; # This is how you enable NGINX App Protect WAF in the relevant context/block
-    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
+    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
     app_protect_security_log_enable on; # This section enables the logging capability
-    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
+    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
 
     server {
         listen       80;
@@ -177,7 +177,7 @@ For instance, to create an updated version of the `app_protect_default_policy`,
 docker run \
  -v $(pwd):$(pwd) \
  waf-compiler-1.0.0:custom \
- -factory-policy default -o $(pwd)/new_default_policy.tar.gz
+ -factory-policy default -o $(pwd)/new_default_policy.tgz
 ```
 
 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:
 docker run \
  -v $(pwd):$(pwd) \
  waf-compiler-1.0.0:custom \
- -factory-policy strict -o $(pwd)/new_strict_policy.tar.gz
+ -factory-policy strict -o $(pwd)/new_strict_policy.tgz
 ```
 
 After creating the updated version of a policy, reference it in the `nginx.conf` file:
 
 ```nginx
-app_protect_policy_file /policies_mount/new_default_policy.tar.gz;
+app_protect_policy_file /policies_mount/new_default_policy.tgz;
 ```
 
 ### Policy Authoring and Tuning
@@ -976,9 +976,9 @@ This table summarizes the nginx.conf directives for NGINX App Protect WAF functi
 |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 |
 |app_protect_enforcer_address | <hostname/ip>:<port> | The Enforcer service address. | HTTP | app_protect_enforcer_address 127.0.0.1:50000; |
 |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 |
-|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 |
+|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 |
 |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 |
-|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 |
+|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 |
 |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' |
 
 #### Failure Mode
diff --git a/content/nap-waf/v5/logging-overview/logs-overview.md b/content/nap-waf/v5/logging-overview/logs-overview.md
@@ -32,7 +32,7 @@ There are several pre-compiled logging profile bundles available:
 - log_grpc_blocked
 - log_grpc_illegal
 
-These logging profiles can be referenced by their names, excluding the file path and the `tar.gz` extension.
+These logging profiles can be referenced by their names, excluding the file path and the `tgz` extension.
 
 For instance:
 
diff --git a/content/nap-waf/v5/logging-overview/security-log.md b/content/nap-waf/v5/logging-overview/security-log.md
@@ -18,7 +18,7 @@ NGINX App Protect WAF uses its own logging mechanism for request logging rather
 
 The Security log has the following properties:
 
- * **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`.
+ * **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`.
 
  * **Configuration contexts**: nginx.conf: `http`, `server`, `location`
 
@@ -59,11 +59,11 @@ The security log attributes are determined by the `app_protect_security_log` dir
 •	Examples:
 ```nginx
 app_protect_security_log log_default stderr;
-app_protect_security_log /mounted_host_dir/logging_profile_01.tar.gz /mounted_host_dir/security.log;
+app_protect_security_log /mounted_host_dir/logging_profile_01.tgz /mounted_host_dir/security.log;
 app_protect_security_log log_all syslog:server=localhost:514;
 app_protect_security_log log_grpc_all syslog:server=my-specific-machine-name:514;
 app_protect_security_log log_illegal syslog:server=192.168.12.34:51400;
-app_protect_security_log /shared_volume/logging_profile_02.tar.gz syslog:server=my.domain.com:514;
+app_protect_security_log /shared_volume/logging_profile_02.tgz syslog:server=my.domain.com:514;
 ```
 
 ##### Arguments
@@ -77,7 +77,7 @@ app_protect_security_log /shared_volume/logging_profile_02.tar.gz syslog:server=
 
 ### Security Log Configuration File
 
-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).
+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).
 
 The file is in JSON format and consists of two parts:
 1.	**filter:** which requests are to be logged.
diff --git a/content/nap-waf/v5/troubleshooting-guide/troubleshooting.md b/content/nap-waf/v5/troubleshooting-guide/troubleshooting.md
@@ -124,7 +124,7 @@ In order to open a support ticket, collect the troubleshooting information in on
 6. At the same direcotory, run the following command to create the tarball file:
 
      ```shell
-     tar cvfz logs.tar.gz .
+     tar cvfz logs.tgz .
      ```
 
-7. Attach `logs.tar.gz` to support ticket.
+7. Attach `logs.tgz` to support ticket.
diff --git a/content/nginxaas-azure/app-protect/enable-logging.md b/content/nginxaas-azure/app-protect/enable-logging.md

Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,9 @@ server {`
`14`	`14`	`server_name my_grpc_service.com;`
`15`	`15`	`location / {`
`16`	`16`	`app_protect_enable on;`
`17`		`- app_protect_policy_file "/etc/app_protect/conf/policy_with_grpc_profile.tar.gz";`
	`17`	`+ app_protect_policy_file "/etc/app_protect/conf/policy_with_grpc_profile.tgz";`
`18`	`18`	`app_protect_security_log_enable on;`
`19`		`- app_protect_security_log "/etc/app_protect/conf/log_grpc_all.tar.gz" stderr;`
	`19`	`+ app_protect_security_log "/etc/app_protect/conf/log_grpc_all.tgz" stderr;`
`20`	`20`	`grpc_pass grpcs://grpc_backend;`
`21`	`21`	`}`
`22`	`22`	`}`