Skip to content

Commit 59cbce4

Browse files
committed
Update Gateway API related documentation for clarity and deactivate it by default
1 parent 17bf063 commit 59cbce4

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Official [Helm chart](https://helm.sh/docs/) to deploy [BunkerWeb](https://www.b
1919
- Kubernetes 1.19+
2020
- Helm 3.8+
2121
- PV provisioner support in the underlying infrastructure (for persistence)
22+
- Kubernetes Gateway API CRDs installed (required for Gateway API support, see the [Gateway API install guide](https://gateway-api.sigs.k8s.io/guides/getting-started/#installing-gateway-api))
2223

2324
**Important**: Please first refer to the [BunkerWeb documentation](https://docs.bunkerweb.io/latest/?utm_campaign=self&utm_source=github), particularly the [Kubernetes integration](https://docs.bunkerweb.io/latest/integrations/?utm_campaign=self&utm_source=bunkerwebio#kubernetes) section.
2425

@@ -80,6 +81,8 @@ settings:
8081
8182
### Kubernetes Integration
8283
84+
**Controller selection**: The controller runs as either a `GatewayController` or an `IngressController`, never both. If both are configured, `GatewayController` takes priority.
85+
8386
```yaml
8487
settings:
8588
kubernetes:
@@ -262,4 +265,4 @@ See [`examples/`](examples/) directory for complete configuration examples.
262265

263266
## License
264267

265-
This Helm chart is licensed under the same terms as BunkerWeb itself.
268+
This Helm chart is licensed under the same terms as BunkerWeb itself.

charts/bunkerweb/values.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1329,7 +1329,8 @@ redis:
13291329

13301330
gatewayClass:
13311331
# Create GatewayClass resource
1332-
enabled: true
1332+
# Requires Kubernetes Gateway API CRDs to be installed in the cluster: https://gateway-api.sigs.k8s.io/guides/getting-started/#installing-gateway-api
1333+
enabled: false
13331334

13341335
# GatewayClass name (used in gateway resources)
13351336
name: "bunkerweb"

docs/values.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,8 @@ Manages BunkerWeb configuration and coordination
368368
## controller
369369

370370
Kubernetes controller for automatic Ingress management
371+
The controller runs as either a `GatewayController` or an `IngressController`, never both. If both are configured, `GatewayController` takes priority.
372+
Gateway API support requires Kubernetes Gateway API CRDs to be installed in the cluster. See the [Gateway API install guide](https://gateway-api.sigs.k8s.io/guides/getting-started/#installing-gateway-api).
371373

372374
| Parameter | Description | Type | Default |
373375
|-----------|-------------|------|---------|
@@ -693,4 +695,3 @@ Configuration for BunkerWeb behavior in Kubernetes environment
693695
| `settings.ui.ingress.tlsSecretName` | Secret name containing TLS certificate Leave empty to disable HTTPS | `string` | `""` |
694696

695697
---
696-

0 commit comments

Comments
 (0)