Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update linter version and fix issues #1302

Merged
merged 1 commit into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ jobs:
- name: Checkout Repository
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- uses: DavidAnson/markdownlint-cli2-action@ed4dec634fd2ef689c7061d5647371d8248064f1 # v13.0.0
- uses: DavidAnson/markdownlint-cli2-action@455b6612a7b7a80f28be9e019b70abdd11696e4e # v14.0.0
with:
config: ${{ github.workspace }}/.markdownlint-cli2.yaml
globs: "**/*.md"
Expand Down
3 changes: 3 additions & 0 deletions conformance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ make install-ngf-local-build
```

#### *Option 2* Install NGINX Gateway Fabric from local already built image to configured kind cluster

You can optionally skip the actual *build* step.

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

#### *Option 3* Install NGINX Gateway Fabric from edge to configured kind cluster

You can also skip the build NGF image step and prepare the environment to instead use the `edge` image

```makefile
Expand Down Expand Up @@ -148,6 +150,7 @@ make uninstall-ngf
```

### Step 6 - Revert changes to Go modules

**Optional** Not required if you aren't running the `main` Gateway API tests.

```makefile
Expand Down
1 change: 1 addition & 0 deletions site/content/how-to/monitoring/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This topic describes possible issues users might encounter when using NGINX Gate
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`

#### Resolution

To resolve this issue you will need to set `allowPrivilegeEscalation` to `true`.

- If using Helm, you can set the `nginxGateway.securityContext.allowPrivilegeEscalation` value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Follow the steps in this guide to:
- 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.

## Overview

{{<img src="img/cert-manager-gateway-workflow.png" alt="cert-manager ACME challenge and certificate management with Gateway API">}}

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.
Expand Down Expand Up @@ -141,6 +142,7 @@ cafe-secret kubernetes.io/tls 2 20s
```

### Deploy our application and HTTPRoute

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:

```yaml
Expand Down
1 change: 1 addition & 0 deletions site/content/overview/resource-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ Error from server: error when creating "some-gateway.yaml": admission webhook "v
> If this happens, Step 3 will reject the invalid values.

### Step 3 - Webhook validation by NGF

To ensure that the resources are validated with the webhook validation rules, even if the webhook is not running,
NGF performs the same validation. However, NGF performs the validation *after* the Kubernetes API server accepts
the resource.
Expand Down
4 changes: 4 additions & 0 deletions tests/graceful-recovery/results/1.0.0/1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,11 @@ Platform:"linux/arm64"}
## Tests

### Restart nginx-gateway container

Passes test with no errors.

### Restart NGINX container

The NGF Pod was unable to recover after sending a SIGKILL signal to the NGINX master process.
The following appeared in the NGINX logs:

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


### Restart Node with draining

Passes test with no errors.

### Restart Node without draining

The NGF Pod was unable to recover the majority of times after running `docker restart kind-control-plane`.

The following appeared in the NGINX logs:
Expand Down
1 change: 1 addition & 0 deletions tests/reconfig/results/1.0.0/1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ NGF deployment:


## NumResources -> Total Resources

| NumResources | Gateways | Secrets | ReferenceGrants | Namespaces | application Pods | application Services | HTTPRoutes | Total Resources |
| ------------ | -------- | ------- | --------------- | ---------- | ---------------- | -------------------- | ---------- | --------------- |
| x | 1 | 1 | 1 | x+1 | 2x | 2x | 3x | <total> |
Expand Down
1 change: 1 addition & 0 deletions tests/zero-downtime-scaling/results/1.0.0/1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@ Logs:
- 288,528 200s

## 10 Node Cluster

### Scale Up Gradually

HTTP wrk output:
Expand Down
Loading