Skip to content

Commit c589ea7

Browse files
authored
NGF: Update Helm values where required for 2.0 (#550)
Update tracing doc and Helm install doc
1 parent 45b70e1 commit c589ea7

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

content/ngf/how-to/monitoring/tracing.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,14 @@ Visit [http://127.0.0.1:16686](http://127.0.0.1:16686) to view the dashboard.
7070

7171
To enable tracing, you must configure two resources:
7272

73-
- `NginxProxy`: This resource contains global settings relating to the NGINX data plane. It is created and managed by the [cluster operator](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/), and is referenced in the `parametersRef` field of the GatewayClass. This resource can be created and linked when we install NGINX Gateway Fabric using its helm chart, or it can be added later. This guide installs the resource using the helm chart, but the resource can also be created for an existing deployment.
73+
- `NginxProxy`: This resource contains global settings relating to the NGINX data plane. It is created and managed by the [cluster operator](https://gateway-api.sigs.k8s.io/concepts/roles-and-personas/), and is referenced in the `parametersRef` field of the GatewayClass. By default, an `NginxProxy` resource is created in the same namespace where NGINX Gateway Fabric is installed, attached to the GatewayClass. You can set configuration options in the `nginx` Helm value section, and the resource will be created and attached using the set values.
74+
75+
When installed using the Helm chart, the NginxProxy resource is named `<release-name>-proxy-config` and is created in the release Namespace.
7476

7577
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.
7678

79+
{{< note >}} You can also override the tracing configuration for a particular Gateway by manually creating and attaching specific `NginxProxy` resources to target the different Gateways. This guide covers the global tracing configuration only. {{< /note >}}
80+
7781
- `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.
7882

7983
For all the possible configuration options for these resources, see the [API reference]({{< ref "/ngf/reference/api.md" >}}).
@@ -110,11 +114,11 @@ helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric --create-namesp
110114
You should see the following configuration:
111115

112116
```shell
113-
kubectl get nginxproxies.gateway.nginx.org ngf-proxy-config -o yaml
117+
kubectl get nginxproxies.gateway.nginx.org ngf-proxy-config -n nginx-gateway -o yaml
114118
```
115119

116120
```yaml
117-
apiVersion: gateway.nginx.org/v1alpha1
121+
apiVersion: gateway.nginx.org/v1alpha2
118122
kind: NginxProxy
119123
metadata:
120124
name: ngf-proxy-config
@@ -164,10 +168,10 @@ status:
164168
type: ResolvedRefs
165169
```
166170
167-
If you already have NGINX Gateway Fabric installed, then you can create the `NginxProxy` resource and link it to the GatewayClass `parametersRef`:
171+
If you already have NGINX Gateway Fabric installed, then you can modify the `NginxProxy` resource to include the tracing configuration:
168172

169173
```shell
170-
kubectl edit gatewayclasses.gateway.networking.k8s.io nginx
174+
kubectl edit nginxproxies.gateway.nginx.org ngf-proxy-config -n nginx-gateway
171175
```
172176

173177
You can now create the application, route, and tracing policy.
@@ -351,5 +355,6 @@ The trace includes the attribute from the global NginxProxy resource as well as
351355

352356
## See also
353357

358+
- [Data plane configuration]({{< ref "/ngf/how-to/data-plane-configuration.md" >}}): learn how to dynamically update the NGINX Gateway Fabric global data plane configuration, including how to override the telemetry configuration for a particular Gateway.
354359
- [Custom policies]({{< ref "/ngf/overview/custom-policies.md" >}}): learn about how NGINX Gateway Fabric custom policies work.
355360
- [API reference]({{< ref "/ngf/reference/api.md" >}}): all configuration fields for the policies mentioned in this guide

content/ngf/installation/installing-ngf/helm.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -147,13 +147,7 @@ By default, the NGINX Gateway Fabric helm chart deploys a LoadBalancer Service.
147147
To use a NodePort Service instead:
148148

149149
```shell
150-
helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway --set service.type=NodePort
151-
```
152-
153-
To disable the creation of a Service:
154-
155-
```shell
156-
helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway --set service.create=false
150+
helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway --set nginx.service.type=NodePort
157151
```
158152

159153
---

0 commit comments

Comments
 (0)