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.

Sign up for GitHub

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

Jump to bottom

Add how-to for ClientSettingsPolicy #2071

Merged
merged 6 commits into from
Jun 7, 2024
Merged

Add how-to for ClientSettingsPolicy #2071

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b354f29
Add how-to for ClientSettingsPolicy
kate-osborn May 31, 2024
b1954cc
Apply docs suggestions
kate-osborn Jun 4, 2024
46559c4
Remove DNS note and TODOs
kate-osborn Jun 4, 2024
91e1057
Add note about policy limitaton
kate-osborn Jun 4, 2024
6932923
Update note language
kate-osborn Jun 5, 2024
0d66090
Update note wording in cspolicy doc
kate-osborn Jun 7, 2024
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 examples/client-settings-policy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Client Settings Policy

This directory contains YAML files of ClientSettingsPolicies.
This directory contains the YAML files used in the [ClientSettingsPolicy](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/client-settings/) guide.
0 examples/client-settings-policy/cafe.yaml → examples/client-settings-policy/app.yaml
View file
Open in desktop
File renamed without changes.
14 changes: 0 additions & 14 deletions examples/client-settings-policy/csp-grpcroute.yaml
View file
Open in desktop

This file was deleted.

38 changes: 0 additions & 38 deletions examples/client-settings-policy/csp-httproutes.yaml
View file
Open in desktop

This file was deleted.

12 changes: 2 additions & 10 deletions ...s/client-settings-policy/csp-gateway.yaml → ...tings-policy/gateway-client-settings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@
apiVersion: gateway.nginx.org/v1alpha1
kind: ClientSettingsPolicy
metadata:
name: gw
namespace: default
name: gateway-client-settings
spec:
targetRef:
group: gateway.networking.k8s.io
kind: Gateway
name: gateway
body:
maxSize: 10m
timeout: 30s
keepAlive:
requests: 100
time: 5s
timeout:
server: 2s
header: 1s
maxSize: "50" # sizes without a unit are bytes.
4 changes: 0 additions & 4 deletions examples/client-settings-policy/gateway.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,3 @@ spec:
port: 80
protocol: HTTP
hostname: "*.example.com"
- name: http2
port: 8080
protocol: HTTP
hostname: "*.example.org"
11 changes: 11 additions & 0 deletions examples/client-settings-policy/grpc-client-settings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: gateway.nginx.org/v1alpha1
kind: ClientSettingsPolicy
metadata:
name: grpc-client-settings
spec:
targetRef:
group: gateway.networking.k8s.io
kind: GRPCRoute
name: my-grpc-route
body:
maxSize: "75" # sizes without a unit are bytes.
0 ...s/client-settings-policy/cafe-routes.yaml → ...es/client-settings-policy/httproutes.yaml
View file
Open in desktop
File renamed without changes.
11 changes: 11 additions & 0 deletions examples/client-settings-policy/tea-client-settings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: gateway.nginx.org/v1alpha1
kind: ClientSettingsPolicy
metadata:
name: tea-client-settings
spec:
targetRef:
group: gateway.networking.k8s.io
kind: HTTPRoute
name: tea
body:
maxSize: "75" # sizes without a unit are bytes.
4 changes: 4 additions & 0 deletions site/content/how-to/monitoring/tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ NGINX Gateway Fabric supports tracing using [OpenTelemetry](https://opentelemetr

This guide explains how to enable tracing on HTTPRoutes using NGINX Gateway Fabric. It uses the OpenTelemetry Collector and Jaeger to process and collect the traces.

{{< important >}}
Tracing cannot be enabled for [HTTPRoute matches](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteMatch) with `headers`, `params`, or `method` matchers defined. It will be added in a future release.
{{< /important >}}

## Install the Collectors

The first step is to install the collectors. NGINX Gateway Fabric will be configured to export to the OpenTelemetry Collector, which is configured to export to Jaeger. This model allows the visualization collector (Jaeger) to be swapped with something else, or to add more collectors without needing to reconfigure NGINX Gateway Fabric. It is also possible to configure NGINX Gateway Fabric to export directly to Jaeger.
Expand Down
28 changes: 28 additions & 0 deletions site/content/how-to/monitoring/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,31 @@ If using NGINX Gateway Fabric with NGINX Plus as the data plane, you will see th
#### Resolution

To resolve this issue, enable Usage Reporting by following the [Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) guide.

### 413 Request Entity Too Large
kate-osborn marked this conversation as resolved.
Show resolved Hide resolved

#### Description

If you receive the following error:

```text
<html>
<head><title>413 Request Entity Too Large</title></head>
<body>
<center><h1>413 Request Entity Too Large</h1></center>
<hr><center>nginx/1.25.5</center>
</body>
</html>
```

Or view the following error message in the NGINX logs:

```text
2024/05/30 21:48:22 [error] 138#138: *43 client intended to send too large body: 112 bytes, client: 127.0.0.1, server: cafe.example.com, request: "POST /coffee HTTP/1.1", host: "cafe.example.com:8080"
```

The request body exceeds the [client_max_body_size](https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size).

#### Resolution

You can configure the `client_max_body_size` using the `ClientSettingsPolicy` API. Read the [Client Settings Policy]({{< relref "how-to/traffic-management/client-settings.md" >}}) documentation for more information.
Loading
Loading