Skip to content

Commit 1f17e1c

Browse files
authored
Merge branch 'nap-release-5.7' into nap-ip-intelligence
2 parents ce877e5 + dfc25ee commit 1f17e1c

File tree

228 files changed

+27220
-1731
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

228 files changed

+27220
-1731
lines changed

.github/workflows/build-push.yml

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,22 @@ on:
3333
type: string
3434
pull_request:
3535
branches:
36-
- "*"
36+
- "**"
3737
push:
3838
branches:
3939
- "main"
4040

4141
env:
4242
FRONT_DOOR_USERNAME: ${{ secrets.FRONT_DOOR_USERNAME }}
4343
FRONT_DOOR_PASSWORD: ${{ secrets.FRONT_DOOR_PASSWORD }}
44-
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
44+
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
4545
jobs:
4646
prod-check-branch:
4747
runs-on: ubuntu-24.04
4848
steps:
4949
- name: Output variables
5050
run: |
51-
echo "Environment: ${{ inputs.environment }}"
51+
echo "Environment: ${{ inputs.environment || github.event.client_payload.environment }}"
5252
echo "Branch: ${{ github.ref }}"
5353
- name: Checks to see that main branch is selected if deploying to prod
5454
if: ${{ inputs.environment == 'prod' && github.ref != 'refs/heads/main' }}
@@ -65,14 +65,33 @@ jobs:
6565
docs_source_path: "public"
6666
docs_build_path: "./"
6767
doc_type: "hugo"
68-
environment: ${{inputs.environment}}
68+
environment: ${{ inputs.environment || github.event.client_payload.environment }}
6969
force_hugo_theme_version: ${{inputs.hugo_theme_override}}
7070
auto_deploy_branch: "main"
7171
auto_deploy_env: "prod"
7272
secrets:
7373
AZURE_CREDENTIALS: ${{secrets.AZURE_CREDENTIALS_DOCS}}
7474
AZURE_KEY_VAULT: ${{secrets.AZURE_KEY_VAULT_DOCS}}
7575

76+
trigger-theme-slack-notification:
77+
if: github.event_name == 'repository_dispatch'
78+
needs: call-docs-build-push
79+
runs-on: ubuntu-latest
80+
permissions: read-all
81+
steps:
82+
- name: Trigger 'Slack notification for new theme release' workflow in 'nginx-hugo-theme' repo.
83+
run: |
84+
curl -L \
85+
-X POST \
86+
-H "Accept: application/vnd.github+json" \
87+
-H "Authorization: Bearer ${{ secrets.THEME_SLACK_FLOW_PAT }}" \
88+
-H "X-GitHub-Api-Version: 2022-11-28" \
89+
"https://api.github.com/repos/${{ secrets.OWNER }}/${{ secrets.REPO }}/dispatches" \
90+
-d "{\"event_type\": \"trigger-slack-notification\", \"client_payload\": {\"previewURL\": \"${{ env.PREVIEW_URL }}\", \"author\": \"${{ github.event.client_payload.author}}\", \"tag_name\": \"${{ github.event.client_payload.tag_name }}\", \"release_name\": \"${{ github.event.client_payload.release_name }}\"}}"
91+
env:
92+
PREVIEW_URL: ${{ needs.call-docs-build-push.outputs.PREVIEW_URL }}
93+
94+
7695
lighthouseci:
7796
if: github.event.pull_request
7897
needs: call-docs-build-push

CLOSED_CONTRIBUTIONS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To create closed content, add the closed repository as a remote to the main repo
3333
```shell
3434
cd documentation
3535
git remote add internal [email protected]:<closed-url>.git
36-
git fetch
36+
git fetch --all
3737
```
3838

3939
Check out the remote `main` branch, and use it to create a feature branch. **Ensure that you prefix all branch names with `internal/`**
@@ -64,4 +64,4 @@ git merge internal/internal/feature
6464
git push origin
6565
```
6666

67-
Once the content changes have been merged in the open repository, they will synchronize back to the closed repository.
67+
Once the content changes have been merged in the open repository, they will synchronize back to the closed repository.

config/_default/config.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ enableGitInfo = true
4747
"taxonomyTerm"
4848
]
4949
taxonomiesExcludedFromSitemap = ["tags", "categories", "doctypes"]
50-
50+
unitversion= "1.34.1"
51+
unitversionv= "v1.34.1"
5152
#logo = ""
5253

5354
# Version lists; used by the versions shortcode

content/agent/configuration/configuration-overview.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ server:
5151
host: <FQDN>
5252
grpcPort: 443
5353
backoff: # note: default values are prepopulated
54-
initial_interval: 100ms # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
55-
randomization_factor: 0.10 # Add the appropriate float value here, e.g., 0.10
56-
multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5
57-
max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
58-
max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
54+
initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
55+
randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
56+
multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
57+
max_interval: 1m # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
58+
max_elapsed_time: 0 # Add the appropriate duration value here, for example, "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
5959
# tls options
6060
tls:
6161
# enable tls in the nginx-agent setup for grpcs
@@ -89,11 +89,11 @@ metrics:
8989
collection_interval: 15s
9090
mode: aggregated
9191
backoff: # note: default values are prepopulated
92-
initial_interval: 100ms # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
93-
randomization_factor: 0.10 # Add the appropriate float value here, e.g., 0.10
94-
multiplier: 1.5 # Add the appropriate float value here, e.g., 1.5
95-
max_interval: 1m # Add the appropriate duration value here, e.g., "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
96-
max_elapsed_time: 0 # Add the appropriate duration value here, e.g., "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
92+
initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
93+
randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
94+
multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
95+
max_interval: 1m # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
96+
max_elapsed_time: 0 # Add the appropriate duration value here, for example, "0" for indefinite "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
9797
9898
# OSS NGINX default config path
9999
# path to aux file dirs can also be added
@@ -193,7 +193,7 @@ If you are upgrading from an older version, update your configuration accordingl
193193
| `--features` | `NGINX_AGENT_FEATURES` | Specifies a comma-separated list of features enabled for the agent. Default: *[registration, nginx-config-async, nginx-ssl-config, nginx-counting, metrics, dataplane-status, process-watcher, file-watcher, activity-events, agent-api]* |
194194
| `--ignore-directives` | | Specifies a comma-separated list of directives to ignore for sensitive info.|
195195
| `--instance-group` | `NGINX_AGENT_INSTANCE_GROUP` | Sets the instance's group value. |
196-
| `--log-level` | `NGINX_AGENT_LOG_LEVEL` | Sets the logging level (e.g., panic, fatal, error, info, debug, trace). Default: *info* |
196+
| `--log-level` | `NGINX_AGENT_LOG_LEVEL` | Sets the logging level (for example, panic, fatal, error, info, debug, trace). Default: *info* |
197197
| `--log-path` | `NGINX_AGENT_LOG_PATH` | Specifies the path to output log messages. |
198198
| `--metrics-bulk-size` | `NGINX_AGENT_METRICS_BULK_SIZE` | Specifies the number of metrics reports collected before sending data. Default: *20* |
199199
| `--metrics-collection-interval` | `NGINX_AGENT_METRICS_COLLECTION_INTERVAL` | Sets the interval for metrics collection. Default: *15s* |

content/amplify/faq/nginx-amplify-agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ If you don't see the new system or NGINX in the web interface, or (some) metrics
8282

8383
3. NGINX Amplify Agent is running under the same user as your NGINX worker processes.
8484

85-
4. The NGINX instance is started with an absolute path. Currently, NGINX Amplify Agent **can't** detect NGINX instances launched with a relative path (e.g., "./nginx").
85+
4. The NGINX instance is started with an absolute path. Currently, NGINX Amplify Agent **can't** detect NGINX instances launched with a relative path (for example, "./nginx").
8686

8787
5. The [user ID that is used by NGINX Amplify Agent and NGINX ]({{< ref "/amplify/nginx-amplify-agent/install/configuring-amplify-agent#overriding-the-effective-user-id" >}}), can run *ps(1)* to see all system processes. If *ps(1)* is restricted for non-privileged users, NGINX Amplify Agent won't be able to find and properly detect the NGINX master process.
8888

content/amplify/nginx-amplify-agent/configuration-analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ docs: DOCS-961
88

99
F5 NGINX Amplify Agent can automatically find all relevant NGINX configuration files, parse them, extract their logical structure, and send the associated JSON data to the Amplify backend for further analysis and reporting. For more information on configuration analysis, please see the [Analyzer]({{< ref "/amplify/user-interface/analyzer.md" >}})) documentation.
1010

11-
After NGINX Amplify Agent finds a particular NGINX configuration, it then automatically starts to keep track of its changes. When a change is detected with NGINX — e.g., a master process restarts, or the NGINX config is edited, an update is sent to the Amplify backend.
11+
After NGINX Amplify Agent finds a particular NGINX configuration, it then automatically starts to keep track of its changes. When a change is detected with NGINX — for example, a master process restarts, or the NGINX config is edited, an update is sent to the Amplify backend.
1212

1313
{{< note >}} NGINX Amplify Agent never sends the raw unprocessed config files to the backend system. In addition, the following directives in the NGINX configuration are never analyzed — and their parameters aren't exported to the SaaS backend:
1414
[ssl_certificate_key](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_certificate_key), [ssl_client_certificate](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_client_certificate), [ssl_password_file](http://nginx.org/en/docs/mail/ngx_mail_ssl_module.html#ssl_password_file), [ssl_stapling_file](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_stapling_file), [ssl_trusted_certificate](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_trusted_certificate), [auth_basic_user_file](http://nginx.org/en/docs/http/ngx_http_auth_basic_module.html#auth_basic_user_file), [secure_link_secret](http://nginx.org/en/docs/http/ngx_http_secure_link_module.html#secure_link_secret).{{< /note >}}

content/amplify/nginx-amplify-agent/configuring-metric-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ NGINX Amplify Agent will also collect more NGINX metrics from the [access.log](h
9393

9494
You don't have to specifically point NGINX Amplify Agent to either the NGINX configuration or the NGINX log files — it should detect their location automatically.
9595

96-
NGINX Amplify Agent will also try to detect the [log format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format) for a particular log to parse it properly and try to extract even more useful metrics, e.g., [$upstream_response_time](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_response_time).
96+
NGINX Amplify Agent will also try to detect the [log format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format) for a particular log to parse it properly and try to extract even more useful metrics, for example, [$upstream_response_time](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#var_upstream_response_time).
9797

9898
{{< note >}}Several metrics outlined in [Metrics and Metadata]({{< ref "metrics-metadata" >}}) will only be available if the corresponding variables are included in a custom [access.log](http://nginx.org/en/docs/http/ngx_http_log_module.html) format used for logging requests. You can find a complete list of NGINX log variables [here](http://nginx.org/en/docs/varindex.html).{{< /note >}}
9999

content/amplify/nginx-amplify-agent/metadata-metrics-collection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ docs: DOCS-964
99
F5 NGINX Amplify Agent collects the following types of data:
1010

1111
* **NGINX metrics.** NGINX Amplify Agent collects a lot of NGINX related metrics from [stub_status](http://nginx.org/en/docs/http/ngx_http_stub_status_module.html), the NGINX Plus status API, the NGINX log files, and from the NGINX process state.
12-
* **System metrics.** These are various key metrics describing the system, e.g., CPU usage, memory usage, network traffic, etc.
12+
* **System metrics.** These are various key metrics describing the system, for example, CPU usage, memory usage, network traffic, etc.
1313
* **PHP-FPM metrics.** NGINX Amplify Agent can obtain metrics from the PHP-FPM pool status if it detects a running PHP-FPM main process.
1414
* **MySQL metrics.** NGINX Amplify Agent can obtain metrics from the MySQL global status set of variables.
1515
* **NGINX metadata.** This is what describes your NGINX instances, and it includes package data, build information, the path to the binary, build configuration options, etc. NGINX metadata also includes the NGINX configuration elements.

content/amplify/user-interface/account-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Users can be assigned one of the three roles — Admin, User, or Read-Only. Admi
2626

2727
In the **Notifications** section, you will find information about the emails currently registered with your account and whether they are verified or not. The alert notifications are only sent to verified emails.
2828

29-
In addition to the email alert notifications, you can optionally configure the integration with your Slack team and workspace. Under the registered emails section, select the "Add to Slack" button to allow Amplify to send you certain notifications on Slack. You will have to log in and provide the necessary details about your team and what channels you'd like to add to Amplify notifications. Both direct messages and channels can be used for notifications. If configured successfully, Amplify can send alert information to Slack. A few more additional notifications are available — e.g., F5 NGINX Amplify Agent not finding a running NGINX instance, but also proactive messages about the issues with the SSL certs.
29+
In addition to the email alert notifications, you can optionally configure the integration with your Slack team and workspace. Under the registered emails section, select the "Add to Slack" button to allow Amplify to send you certain notifications on Slack. You will have to log in and provide the necessary details about your team and what channels you'd like to add to Amplify notifications. Both direct messages and channels can be used for notifications. If configured successfully, Amplify can send alert information to Slack. A few more additional notifications are available — for example, F5 NGINX Amplify Agent not finding a running NGINX instance, but also proactive messages about the issues with the SSL certs.
3030

3131

3232
{{< img src="amplify/amplify-notifications.png" alt="Notifications" >}}

content/amplify/user-interface/analyzer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ The following information is provided when a report is generated from an NGINX c
3737
* Typical configuration issues highlighted
3838
* Common advice about proxy configurations
3939
* Suggestions about simplifying rewrites for certain use cases
40-
* Key security measures (e.g., *stub_status* is unprotected)
40+
* Key security measures (for example, *stub_status* is unprotected)
4141
* Typical errors in configuring locations, especially with *regex*
4242

4343
To parse SSL certificate metadata, NGINX Amplify Agent uses standard OpenSSL(1) functions. SSL certificates are parsed and analyzed only when the corresponding [settings]({{< ref "/amplify/user-interface/account-settings" >}}) are turned on. SSL certificate analysis is *off* by default.
4444

4545
Static analysis will only include information about specific issues with the NGINX configuration if those are found in your NGINX setup.
4646

47-
In the future, the **Analyzer** page will also include *dynamic analysis*, effectively linking the observed NGINX behavior to its configuration — e.g., when it makes sense to increase or decrease certain parameters like [proxy_buffers](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers), etc.
47+
In the future, the **Analyzer** page will also include *dynamic analysis*, effectively linking the observed NGINX behavior to its configuration — for example, when it makes sense to increase or decrease certain parameters like [proxy_buffers](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffers), etc.
4848

4949
{{< note >}} Config analysis is *on* by default. If you don't want your NGINX configuration to be checked, unset the corresponding setting in either Global, or Local (per-system) settings. See [**Settings**]({{< ref "/amplify/user-interface/account-settings" >}}). {{< /note >}}
5050

0 commit comments

Comments
 (0)