Skip to content

Commit 6b8805b

Browse files
Kamil PrzybylKamil Przybyl
authored andcommitted
chore: add websocket and WAF docs
1 parent bbfffb7 commit 6b8805b

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

docs/albcm.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,3 +104,33 @@ spec:
104104
port:
105105
number: 80
106106
```
107+
108+
### WebSockets Support
109+
You can enable WebSocket support for your applications by adding a specific annotation to your Ingress resource. Note that in this initial release, enabling this annotation applies globally to all routing rules defined within that specific Ingress.
110+
111+
To enable it, add the alb.stackit.cloud/websocket annotation to your Ingress metadata:
112+
```
113+
apiVersion: networking.k8s.io/v1
114+
kind: Ingress
115+
metadata:
116+
name: alb-ingress
117+
namespace: default
118+
annotations:
119+
alb.stackit.cloud/websocket: "true"
120+
spec:
121+
# ... rest of your ingress spec
122+
```
123+
124+
### Web Application Firewall (WAF)
125+
You can secure your applications by attaching a WAF configuration using the `alb.stackit.cloud/web-application-firewall-name` annotation:
126+
127+
IngressClass Level (Global): Applies the WAF configuration to all listeners created by any Ingress using this class. Note: This takes precedence and overwrites any WAF configuration specified on individual Ingress resources.
128+
129+
Ingress Level (Specific): Applies the WAF configuration only to the listeners created by that individual Ingress, provided the IngressClass does not enforce a global WAF.
130+
131+
Example:
132+
```
133+
metadata:
134+
annotations:
135+
alb.stackit.cloud/web-application-firewall-name: "my-waf-config"
136+
```

0 commit comments

Comments
 (0)