Skip to content

Commit 640ccea

Browse files
FIX (docs): Extend docs with HTTP route support
1 parent 80e573f commit 640ccea

File tree

2 files changed

+44
-2
lines changed

2 files changed

+44
-2
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,8 @@ Access Postgresus at `http://<EXTERNAL-IP>` (port 80).
184184

185185
To customize the installation (e.g., storage size, NodePort instead of LoadBalancer), see the [Helm chart README](deploy/helm/README.md) for all configuration options.
186186

187+
Config uses by default LoadBalancer, but has predefined values for Ingress and HTTPRoute as well.
188+
187189
---
188190

189191
## 🚀 Usage

deploy/helm/README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,17 @@ Access Postgresus at `http://<EXTERNAL-IP>` (port 80).
5555
| `service.targetPort` | Container port | `4005` |
5656
| `service.headless.enabled` | Enable headless service | `true` |
5757

58-
### Ingress (Optional)
58+
### Traffic Exposure (3 Options)
5959

60-
Ingress is disabled by default. The chart uses LoadBalancer service for direct IP access.
60+
The chart supports 3 ways to expose Postgresus:
61+
62+
| Method | Use Case | Default |
63+
| ------ | -------- | ------- |
64+
| **LoadBalancer/NodePort** | Simple cloud clusters | Enabled |
65+
| **Ingress** | Traditional nginx/traefik ingress controllers | Disabled |
66+
| **HTTPRoute (Gateway API)** | Modern gateways (Istio, Envoy, Cilium) | Disabled |
67+
68+
#### Ingress
6169

6270
| Parameter | Description | Default Value |
6371
| ----------------------- | ----------------- | ------------------------ |
@@ -66,6 +74,16 @@ Ingress is disabled by default. The chart uses LoadBalancer service for direct I
6674
| `ingress.hosts[0].host` | Hostname | `postgresus.example.com` |
6775
| `ingress.tls` | TLS configuration | `[]` |
6876

77+
#### HTTPRoute (Gateway API)
78+
79+
| Parameter | Description | Default Value |
80+
| --------------------- | -------------------------- | ---------------------------------- |
81+
| `route.enabled` | Enable HTTPRoute | `false` |
82+
| `route.apiVersion` | Gateway API version | `gateway.networking.k8s.io/v1` |
83+
| `route.hostnames` | Hostnames for the route | `["postgresus.example.com"]` |
84+
| `route.parentRefs` | Gateway references | `[]` |
85+
| `route.annotations` | Route annotations | `{}` |
86+
6987
### Health Checks
7088

7189
| Parameter | Description | Default Value |
@@ -136,6 +154,28 @@ ingress:
136154
helm install postgresus ./deploy/helm -n postgresus --create-namespace -f ingress-values.yaml
137155
```
138156

157+
### HTTPRoute (Gateway API)
158+
159+
For clusters using Istio, Envoy Gateway, Cilium, or other Gateway API implementations:
160+
161+
```yaml
162+
# httproute-values.yaml
163+
service:
164+
type: ClusterIP
165+
166+
route:
167+
enabled: true
168+
hostnames:
169+
- backup.example.com
170+
parentRefs:
171+
- name: my-gateway
172+
namespace: istio-system
173+
```
174+
175+
```bash
176+
helm install postgresus ./deploy/helm -n postgresus --create-namespace -f httproute-values.yaml
177+
```
178+
139179
### Custom Storage Size
140180

141181
```yaml

0 commit comments

Comments
 (0)