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

Add guide for UpstreamSettingsPolicy #2987

Merged
merged 5 commits into from
Jan 9, 2025
Merged

Add guide for UpstreamSettingsPolicy #2987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0bd558a
Add guide for UpstreamSettingsPolicy
kate-osborn Jan 7, 2025
47596ec
Update site/content/how-to/traffic-management/upstream-settings.md
kate-osborn Jan 8, 2025
1faf490
Add section breaks
kate-osborn Jan 8, 2025
72e01e6
Move NGF_POD_NAME to setup
kate-osborn Jan 8, 2025
0b1e851
One last section break
kate-osborn Jan 8, 2025
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
13 changes: 13 additions & 0 deletions examples/upstream-settings-policy/1m-zone-size.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
apiVersion: gateway.nginx.org/v1alpha1
kind: UpstreamSettingsPolicy
metadata:
name: 1m-zone-size
spec:
targetRefs:
- group: core
kind: Service
name: tea
- group: core
kind: Service
name: coffee
zoneSize: 1m
3 changes: 1 addition & 2 deletions examples/upstream-settings-policy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# UpstreamSettingsPolicy

This directory contains example YAMLs for testing the UpstreamSettingsPolicy CRD. Eventually, this will be converted
into a how-to-guide.
This directory contains the YAML files used in the [UpstreamSettingsPolicy](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/upstream-settings/) guide.
0 examples/upstream-settings-policy/cafe.yaml → examples/upstream-settings-policy/app.yaml
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...upstream-settings-policy/cafe-routes.yaml → .../upstream-settings-policy/httproutes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ spec:
rules:
- matches:
- path:
type: PathPrefix
type: Exact
value: /coffee
backendRefs:
- name: coffee
Expand Down
6 changes: 1 addition & 5 deletions ...ings-policy/upstream-settings-policy.yaml → ...-settings-policy/upstream-keepalives.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
apiVersion: gateway.nginx.org/v1alpha1
kind: UpstreamSettingsPolicy
metadata:
name: upstream-settings-policy
name: upstream-keepalives
spec:
zoneSize: 512k
targetRefs:
- group: core
kind: Service
name: coffee
keepAlive:
connections: 32
requests: 1001
time: 300s
timeout: 60s
2 changes: 1 addition & 1 deletion site/content/how-to/monitoring/tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ To enable tracing, you must configure two resources:

The `NginxProxy` resource contains configuration for the collector, and applies to all Gateways and routes under the GatewayClass. It does not enable tracing, but is a prerequisite to the next piece of configuration.

- `ObservabilityPolicy`: This resource is a [Direct PolicyAttachment](https://gateway-api.sigs.k8s.io/reference/policy-attachment/) that targets HTTPRoutes or GRPCRoutes. It is created by the [application developer](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/) and enables tracing for a specific route or routes. It requires the `NginxProxy` resource to exist in order to complete the tracing configuration.
- `ObservabilityPolicy`: This resource is a [Direct Policy Attachment](https://gateway-api.sigs.k8s.io/reference/policy-attachment/) that targets HTTPRoutes or GRPCRoutes. It is created by the [application developer](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/) and enables tracing for a specific route or routes. It requires the `NginxProxy` resource to exist in order to complete the tracing configuration.

For all the possible configuration options for these resources, see the [API reference]({{< relref "reference/api.md" >}}).

Expand Down
2 changes: 1 addition & 1 deletion site/content/how-to/traffic-management/client-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The settings in `ClientSettingsPolicy` correspond to the following NGINX directi
- [`keepalive_time`](<https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_time>)
- [`keepalive_timeout`](<https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout>)

`ClientSettingsPolicy` is an [Inherited PolicyAttachment](https://gateway-api.sigs.k8s.io/reference/policy-attachment/) that can be applied to a Gateway, HTTPRoute, or GRPCRoute in the same namespace as the `ClientSettingsPolicy`.
`ClientSettingsPolicy` is an [Inherited Policy Attachment](https://gateway-api.sigs.k8s.io/reference/policy-attachment/) that can be applied to a Gateway, HTTPRoute, or GRPCRoute in the same namespace as the `ClientSettingsPolicy`.

When applied to a Gateway, the settings specified in the `ClientSettingsPolicy` affect all HTTPRoutes and GRPCRoutes attached to the Gateway. This allows Cluster Operators to set defaults for all applications using the Gateway.

Expand Down
Loading
Loading