Skip to content

Commit b5da2a3

Browse files
sjbermantatarutyciarams87salonichf5
authored
docs: NGF release 2.3 docs (#1604)
--------- Co-authored-by: Tina U. <t.usova@f5.com> Co-authored-by: Ciara Stacke <18287516+ciarams87@users.noreply.github.com> Co-authored-by: Saloni Choudhary <146118978+salonichf5@users.noreply.github.com>
1 parent e4b8653 commit b5da2a3

File tree

5 files changed

+312
-378
lines changed

5 files changed

+312
-378
lines changed

content/ngf/how-to/data-plane-configuration.md

Lines changed: 43 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,44 @@ of a few arguments. {{< /call-out >}}
272272

273273
---
274274

275+
## Configure the data plane log format
276+
277+
NGINX records client requests immediately after each request is processed. You can use the `NginxProxy` resource to dynamically configure the access log format.
278+
279+
The following command creates a basic `NginxProxy` that defines a custom log format `$remote_addr - [$time_local] "$request" $status $body_bytes_sent`:
280+
281+
```yaml
282+
kubectl apply -f - <<EOF
283+
apiVersion: gateway.nginx.org/v1alpha2
284+
kind: NginxProxy
285+
metadata:
286+
name: ngf-proxy-config
287+
spec:
288+
logging:
289+
accessLog:
290+
format: $remote_addr - [$time_local] "$request" $status $body_bytes_sent
291+
EOF
292+
```
293+
294+
You can disable access logging entirely with the following configuration:
295+
296+
```yaml
297+
kubectl apply -f - <<EOF
298+
apiVersion: gateway.nginx.org/v1alpha2
299+
kind: NginxProxy
300+
metadata:
301+
name: ngf-proxy-config
302+
spec:
303+
logging:
304+
accessLog:
305+
disable: true
306+
EOF
307+
```
308+
309+
{{< call-out "note" >}} File destinations in `logging.accessLog` are not currently supported it is always set to `/dev/stdout`. {{< /call-out >}}
310+
311+
---
312+
275313
### Run NGINX Gateway Fabric with NGINX in debug mode
276314

277315
To run NGINX Gateway Fabric with NGINX in debug mode, during [installation]({{< ref "/ngf/install/" >}}), follow these additional steps:
@@ -327,12 +365,11 @@ kind: NginxProxy
327365
metadata:
328366
name: ngf-proxy-config
329367
spec:
330-
config:
331-
rewriteClientIP:
332-
mode: ProxyProtocol
333-
trustedAddresses:
334-
- type: CIDR
335-
value: "76.89.90.11/24"
368+
rewriteClientIP:
369+
mode: ProxyProtocol
370+
trustedAddresses:
371+
- type: CIDR
372+
value: "76.89.90.11/24"
336373
EOF
337374
```
338375

@@ -364,8 +401,6 @@ spec:
364401
terminationGracePeriodSeconds: 90
365402
replicas: 2
366403
service:
367-
annotations:
368-
service.beta.kubernetes.io/aws-load-balancer-type: "nlb"
369404
type: LoadBalancer
370405
loadBalancerIP: "192.87.9.1"
371406
EOF

content/ngf/overview/gateway-api-compatibility.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Learn which Gateway API resources NGINX Gateway Fabric supports and to which lev
2222
| [TLSRoute](#tlsroute) | Supported | Not supported | Not supported | v1alpha2 | Experimental |
2323
| [TCPRoute](#tcproute) | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
2424
| [UDPRoute](#udproute) | Not supported | Not supported | Not supported | v1alpha2 | Experimental |
25-
| [BackendTLSPolicy](#backendtlspolicy) | Partially Supported | Supported | Partially supported | v1alpha3 | Experimental |
25+
| [BackendTLSPolicy](#backendtlspolicy) | Partially Supported | Supported | Partially supported | v1 | Standard |
2626
| [Custom policies](#custom-policies) | N/A | N/A | Supported | N/A | N/A |
2727
{{< /table >}}
2828

@@ -73,6 +73,7 @@ NGINX Gateway Fabric supports a single GatewayClass resource configured with the
7373
a different GatewayClass name is provided to the controller via the command-line argument.
7474
- `SupportedVersion/True/SupportedVersion`
7575
- `SupportedVersion/False/UnsupportedVersion`
76+
- `supportedFeatures` - supported.
7677

7778
### Gateway
7879

@@ -107,7 +108,10 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
107108
- `addresses`: Valid IPAddresses will be added to the `externalIP` field in the related Services fronting NGINX. Users should ensure that the IP Family of the address matches the IP Family set in the NginxProxy resource (default is dual, meaning both IPv4 and IPv6), otherwise there may be networking issues.
108109
- `type`: Partially supported. Allowed value: `IPAddress`.
109110
- `value`: Partially supported. Dynamic address allocation when value is unspecified is not supported.
110-
- `backendTLS`: Not supported.
111+
- `TLS`:
112+
- `frontend`: Not supported.
113+
- `backend`:
114+
- `clientCertificateRef`: Supported.
111115
- `allowedListeners`: Not supported.
112116
- `status`
113117
- `addresses`: Partially supported (LoadBalancer and ClusterIP).
@@ -322,7 +326,7 @@ Fields:
322326
{{< table >}}
323327
| Resource | Core Support Level | Extended Support Level | Implementation-Specific Support Level | API Version | API Release Channel |
324328
|------------------|---------------------|------------------------|---------------------------------------|-------------|---------------------|
325-
| BackendTLSPolicy | Partially Supported | Supported | Partially Supported | v1alpha3 | Experimental |
329+
| BackendTLSPolicy | Supported | Supported | Partially Supported | v1 | Standard |
326330
{{< /table >}}
327331

328332
Fields:
@@ -348,6 +352,10 @@ Fields:
348352
- `conditions`: Partially supported. Supported (Condition/Status/Reason):
349353
- `Accepted/True/PolicyReasonAccepted`
350354
- `Accepted/False/PolicyReasonInvalid`
355+
- `Accepted/False/NoValidCACertificate`
356+
- `ResolvedRefs/True/ResolvedRefs`
357+
- `ResolvedRefs/False/InvalidCACertificateRef`
358+
- `ResolvedRefs/False/InvalidKind`
351359

352360
{{< call-out "note" >}} If multiple `backendRefs` are defined for a HTTPRoute rule, all the referenced Services *must* have matching BackendTLSPolicy configuration. BackendTLSPolicy configuration is considered to be matching if 1. CACertRefs reference the same ConfigMap, or 2. WellKnownCACerts are the same, and 3. Hostname is the same. {{< /call-out >}}
353361

0 commit comments

Comments
 (0)