Skip to content

Commit 6d4cfd7

Browse files
authored
Update linter version and fix issues (#1302)
1 parent 2331a25 commit 6d4cfd7

File tree

8 files changed

+14
-1
lines changed

8 files changed

+14
-1
lines changed

.github/workflows/lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jobs:
7777
- name: Checkout Repository
7878
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
7979

80-
- uses: DavidAnson/markdownlint-cli2-action@ed4dec634fd2ef689c7061d5647371d8248064f1 # v13.0.0
80+
- uses: DavidAnson/markdownlint-cli2-action@455b6612a7b7a80f28be9e019b70abdd11696e4e # v14.0.0
8181
with:
8282
config: ${{ github.workspace }}/.markdownlint-cli2.yaml
8383
globs: "**/*.md"

conformance/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ make install-ngf-local-build
8888
```
8989

9090
#### *Option 2* Install NGINX Gateway Fabric from local already built image to configured kind cluster
91+
9192
You can optionally skip the actual *build* step.
9293

9394
```makefile
@@ -101,6 +102,7 @@ make update-ngf-manifest PREFIX=<ngf_repo_name> TAG=<ngf_image_tag>
101102
```
102103

103104
#### *Option 3* Install NGINX Gateway Fabric from edge to configured kind cluster
105+
104106
You can also skip the build NGF image step and prepare the environment to instead use the `edge` image
105107

106108
```makefile
@@ -148,6 +150,7 @@ make uninstall-ngf
148150
```
149151

150152
### Step 6 - Revert changes to Go modules
153+
151154
**Optional** Not required if you aren't running the `main` Gateway API tests.
152155

153156
```makefile

site/content/how-to/monitoring/troubleshooting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ This topic describes possible issues users might encounter when using NGINX Gate
1717
Depending on your environment's configuration, the control plane may not have the proper permissions to reload NGINX. The NGINX configuration will not be applied and you will see the following error in the _nginx-gateway_ logs: `failed to reload NGINX: failed to send the HUP signal to NGINX main: operation not permitted`
1818

1919
#### Resolution
20+
2021
To resolve this issue you will need to set `allowPrivilegeEscalation` to `true`.
2122

2223
- If using Helm, you can set the `nginxGateway.securityContext.allowPrivilegeEscalation` value.

site/content/how-to/traffic-management/integrating-cert-manager.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Follow the steps in this guide to:
2222
- A DNS-resolvable domain name is required. It must resolve to the public endpoint of the NGINX Gateway Fabric deployment, and this public endpoint must be an external IP address or alias accessible over the internet. The process here will depend on your DNS provider. This DNS name will need to be resolvable from the Let’s Encrypt servers, which may require that you wait for the record to propagate before it will work.
2323

2424
## Overview
25+
2526
{{<img src="img/cert-manager-gateway-workflow.png" alt="cert-manager ACME challenge and certificate management with Gateway API">}}
2627

2728
The diagram above shows a simplified representation of the cert-manager ACME challenge and certificate issuance process using Gateway API. Please note that not all of the kubernetes objects created in this process are represented in this diagram.
@@ -141,6 +142,7 @@ cafe-secret kubernetes.io/tls 2 20s
141142
```
142143

143144
### Deploy our application and HTTPRoute
145+
144146
Now we can create our coffee deployment and service, and configure the routing rules. You can use the following manifest to create the deployment and service:
145147

146148
```yaml

site/content/overview/resource-validation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ Error from server: error when creating "some-gateway.yaml": admission webhook "v
114114
> If this happens, Step 3 will reject the invalid values.
115115
116116
### Step 3 - Webhook validation by NGF
117+
117118
To ensure that the resources are validated with the webhook validation rules, even if the webhook is not running,
118119
NGF performs the same validation. However, NGF performs the validation *after* the Kubernetes API server accepts
119120
the resource.

tests/graceful-recovery/results/1.0.0/1.0.0.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,11 @@ Platform:"linux/arm64"}
4545
## Tests
4646

4747
### Restart nginx-gateway container
48+
4849
Passes test with no errors.
4950

5051
### Restart NGINX container
52+
5153
The NGF Pod was unable to recover after sending a SIGKILL signal to the NGINX master process.
5254
The following appeared in the NGINX logs:
5355

@@ -84,9 +86,11 @@ Issue Filed: https://github.com/nginxinc/nginx-gateway-fabric/issues/1108
8486

8587

8688
### Restart Node with draining
89+
8790
Passes test with no errors.
8891

8992
### Restart Node without draining
93+
9094
The NGF Pod was unable to recover the majority of times after running `docker restart kind-control-plane`.
9195

9296
The following appeared in the NGINX logs:

tests/reconfig/results/1.0.0/1.0.0.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ NGF deployment:
5454

5555

5656
## NumResources -> Total Resources
57+
5758
| NumResources | Gateways | Secrets | ReferenceGrants | Namespaces | application Pods | application Services | HTTPRoutes | Total Resources |
5859
| ------------ | -------- | ------- | --------------- | ---------- | ---------------- | -------------------- | ---------- | --------------- |
5960
| x | 1 | 1 | 1 | x+1 | 2x | 2x | 3x | <total> |

tests/zero-downtime-scaling/results/1.0.0/1.0.0.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,7 @@ Logs:
330330
- 288,528 200s
331331

332332
## 10 Node Cluster
333+
333334
### Scale Up Gradually
334335

335336
HTTP wrk output:

0 commit comments

Comments
 (0)