diff --git a/docs/GATEWAY.md b/docs/GATEWAY.md index 73dc595..e9191d8 100644 --- a/docs/GATEWAY.md +++ b/docs/GATEWAY.md @@ -398,17 +398,17 @@ The following fields can be set in the Dataplane `spec` to customize the provisi | `args` | `list` | Command line arguments for the [dataplane container](https://pkg.go.dev/k8s.io/api/core/v1#Container). | No | | `envFrom` | `list` | List of sources to populate environment variables for the [dataplane container](https://pkg.go.dev/k8s.io/api/core/v1#Container). Default: empty. | No | | `env` | `list` | List of environment variables for the [dataplane container](https://pkg.go.dev/k8s.io/api/core/v1#Container). Default: empty. | No | -| `containerSecurityContext` | `object` | Container-level security attributes for the [dataplane](/cmd/stunnerd/README.md) pods. Default: none. | No | | `replicas` | `int` | Number of dataplane pods per Gateway to provision. Not enforced if the [dataplane](/cmd/stunnerd/README.md) Deployment replica count is overwritten manually or by an autoscaler. Default: 1. | No | -| `hostNetwork` | `bool` | Deploy the [dataplane](/cmd/stunnerd/README.md) into the host network namespace of Kubernetes nodes. Useful for implementing headless TURN services. May require elevated privileges. Default: false. | No | | `resources` | `object` | Compute resources per [dataplane](/cmd/stunnerd/README.md) pod. Default: none. | No | | `affinity` | `object` | Scheduling constraints for the [dataplane](/cmd/stunnerd/README.md) pods. Default: none. | No | | `tolerations` | `object` | Tolerations for the [dataplane](/cmd/stunnerd/README.md) pods. Default: none. | No | | `securityContext` | `object` | Pod-level security attributes for the [dataplane](/cmd/stunnerd/README.md) pods. Default: none. | No | +| `containerSecurityContext` | `object` | Container-level security attributes for the [dataplane](/cmd/stunnerd/README.md) pods. Default: none. | No | | `topologySpreadConstraints` | `object` | Description of how the [dataplane](/cmd/stunnerd/README.md) pods for a Gateway ought to spread across topology domains. Default: none. | No | +| `terminationGracePeriodSeconds` | `duration` | Optional duration in seconds for `stunnerd` to terminate gracefully. Default: 30 seconds. | No | +| `hostNetwork` | `bool` | Deploy the [dataplane](/cmd/stunnerd/README.md) into the host network namespace of Kubernetes nodes. Useful for implementing headless TURN services. May require elevated privileges. Default: false. | No | | `disableHealthCheck` | `bool` | Disable health-checking. If true, enable HTTP health-checks on port 8086: liveness probe responder will be exposed on path `/live` and readiness probe on path `/ready`. Default: true. | No | | `enableMetricsEndpoint` | `bool` | Enable Prometheus metrics scraping. If true, a metrics endpoint will be available at `http://0.0.0.0:8080`. Default: false. | No | -| `terminationGracePeriodSeconds` | `duration` | Optional duration in seconds for `stunnerd` to terminate gracefully. Default: 30 seconds. | No | There can be multiple Dataplane resources defined in a cluster, say, one for the production workload and one for development. Use the `spec.dataplane` field in the GatewayConfig to choose the Dataplane per each STUNner install.