Skip to content

Commit 7ee36fe

Browse files
authored
Merge branch 'main' into nap-release-5.5
2 parents f3ab3ed + 8bb96eb commit 7ee36fe

File tree

89 files changed

+11433
-384
lines changed

Some content is hidden

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

89 files changed

+11433
-384
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,18 @@ Closes #ISSUE
1919

2020
### Checklist
2121

22-
Before creating a PR, run through this checklist and mark each as complete.
22+
Before merging a pull request, run through this checklist and mark each as complete.
2323

2424
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
2525
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
26+
- [ ] I have ensured that documentation content adheres to [the style guide](/templates/style-guide.md)
27+
- [ ] If the change involves potentially sensitive changes, I have assessed the possible impact
2628
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
2729
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
2830
- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and [`CHANGELOG.md`](/CHANGELOG.md))
2931
- [ ] I have rebased my branch onto main
3032
- [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
31-
- [ ] If the change involves:
32-
- Code
33-
- Anything that resembles Personally identifying information (PII)
34-
- Make sure to use placeholders such as `<username>` in place of PII
35-
- URLs (watch for [typosquatting](https://support.microsoft.com/en-us/topic/what-is-typosquatting-54a18872-8459-4d47-b3e3-d84d9a362eb0))
36-
- Significant new/revised content
37-
38-
In these cases, the change will require at least two (2) approvals before merging
33+
34+
Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.
35+
36+
Please refer to [our style guide](/templates/style-guide.md) for guidance about placeholder content.

.github/workflows/daily-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
- cron: '0 1 * * *'
99
jobs:
1010
trigger:
11-
uses: nginxinc/docs/.github/workflows/build-push.yml@main
11+
uses: nginx/documentation/.github/workflows/build-push.yml@main
1212
with:
1313
environment: "prod"
1414
secrets:

.github/workflows/fossa.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ jobs:
2525
uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 # v4.2.2
2626

2727
- name: Scan
28-
uses: fossas/fossa-action@09bcf127dc0ccb4b5a023f6f906728878e8610ba # v1.4.0
28+
uses: fossas/fossa-action@93a52ecf7c3ac7eb40f5de77fd69b1a19524de94 # v1.5.0
2929
with:
3030
api-key: ${{ secrets.FOSSA_TOKEN }}

.github/workflows/linkchecker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ env:
3131
--ignore-url ^https://lightstep.com --ignore-url ^https://www.owasp.org/ --ignore-url ^https://www.maxmind.com --ignore-url ^https://www.splunk.com/
3232
--ignore-url ^https://oauth2.googleapis.com --ignore-url ^https://openidconnect.googleapis.com --ignore-url ^https://www.base64url.com/
3333
--ignore-url ^https://go.googlesource.com/ --ignore-url ^https://go.googlesource.com/sync --ignore-url ^https://linkerd.io/2.13/
34-
--ignore-url ^http://www.redirectpage.com/
34+
--ignore-url ^http://www.redirectpage.com/ --ignore-url ^https://www.gnu.org/
3535
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginx-ingress-controller/css
3636
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginxaas/azure/css
3737
--ignore-url ^https://\([a-zA-Z0-9-]+\).nginx.com/nginx-gateway-fabric/css

.github/workflows/ossf_scorecard.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@ jobs:
5656

5757
# Upload the results to GitHub's code scanning dashboard.
5858
- name: Upload SARIF results to code scanning
59-
uses: github/codeql-action/upload-sarif@b6a472f63d85b9c78a3ac5e89422239fc15e9b3c # v3.28.1
59+
uses: github/codeql-action/upload-sarif@f6091c0113d1dcf9b98e269ee48e8a7e51b7bdd4 # v3.28.5
6060
with:
6161
sarif_file: results.sarif

.github/workflows/stale.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
pull-requests: write # for actions/stale to close stale PRs
1919
runs-on: ubuntu-latest
2020
steps:
21-
- uses: actions/stale@v9.0.0
21+
- uses: actions/stale@v9.1.0
2222
with:
2323
repo-token: ${{ secrets.GITHUB_TOKEN }}
2424
stale-issue-message: 'This issue is stale because it has been open for 90 days with no activity. Remove the stale label or add a comment to keep it open. If you do not take action, this will be closed in 10 days.'

config/_default/config.toml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ pygmentsUseClasses = true
77
enableGitInfo = true
88

99
[permalinks]
10+
amplify = '/nginx-amplify/:sections[1:]/:filename'
1011
controller = '/nginx-controller/:sections[1:]/:filename'
12+
mesh = '/nginx-service-mesh/:sections[1:]/:filename'
1113
modsec-waf = '/nginx-waf/:sections[1:]/:filename'
1214
nap-dos = '/nginx-app-protect-dos/:sections[1:]/:filename'
1315
nap-waf = '/nginx-app-protect-waf/:sections[1:]/:filename'
14-
nms = '/nginx-management-suite/:sections[1:]/:filename'
15-
amplify = '/nginx-amplify/:sections[1:]/:filename'
16-
mesh = '/nginx-service-mesh/:sections[1:]/:filename'
16+
ngf = '/nginx-gateway-fabric/:sections[1:]/:filename'
1717
nim = '/nginx-instance-manager/:sections[1:]/:filename'
18+
nms = '/nginx-management-suite/:sections[1:]/:filename'
1819

1920
[caches]
2021
[caches.modules]
@@ -36,7 +37,7 @@ enableGitInfo = true
3637
buildtype = "webdocs"
3738
RSSLink = "/index.xml"
3839
author = "NGINX Inc." # add your company name
39-
github = "nginxinc" # add your github profile name
40+
github = "nginx" # add your github profile name
4041
twitter = "@nginx" # add your twitter profile
4142
noindex_kinds = [
4243
"taxonomy",
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
docs:
3+
---
4+
5+
Monitor the [NGINX error log](https://nginx.org/en/docs/ngx_core_module.html#error_log), typically located at `/var/log/nginx/error.log`, for subscription-related issues — such as failed usage reports or approaching license expirations — to catch problems early and keep your subscription compliant.
6+
7+
<br>
8+
9+
Examples of subscription-related log entries include:
10+
11+
- **Failure to upload usage reports**:
12+
13+
``` text
14+
[error] 36387#36387: server returned 500 for <fqdn>:<port> during usage report
15+
[error] 36528#36528: <fqdn>:<port> could not be resolved (host not found) during usage report
16+
[error] 36619#36619: connect() failed (111: Connection refused) for <fqdn>:<port> during usage report
17+
[error] 38888#88: server returned 401 for <ip_address>:443 during usage report
18+
```
19+
20+
- **License approaching expiration**:
21+
22+
``` text
23+
[warn] license will expire in 14 days
24+
```
25+
26+
- **License expiration**:
27+
28+
``` text
29+
[alert] license expiry; grace period will end in 89 days
30+
[emerg] license expired
31+
```
32+
33+
{{<important>}}When a license expires, NGINX Plus stops processing traffic.{{</important>}}

content/includes/ngf/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
headless: true
3+
---
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
docs: "DOCS-1441"
3+
---
4+
5+
To avoid client service interruptions when upgrading NGINX Gateway Fabric, you can configure [`PreStop` hooks](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/) to delay terminating the NGINX Gateway Fabric pod, allowing the pod to complete certain actions before shutting down. This ensures a smooth upgrade without any downtime, also known as a zero downtime upgrade.
6+
7+
For an in-depth explanation of how Kubernetes handles pod termination, see the [Termination of Pods](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination) topic on their official website.
8+
9+
{{<note>}}Keep in mind that NGINX won't shut down while WebSocket or other long-lived connections are open. NGINX will only stop when these connections are closed by the client or the backend. If these connections stay open during an upgrade, Kubernetes might need to shut down NGINX forcefully. This sudden shutdown could interrupt service for clients.{{</note>}}

0 commit comments

Comments
 (0)