Skip to content

Commit 5bdec63

Browse files
Kamil PrzybylKamil Przybyl
authored andcommitted
chore: add network mode annotation
1 parent 17a8d57 commit 5bdec63

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

docs/albcm.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ If you need to explicitly prioritize certain rules over others, you can override
3535

3636
Note that this sorting only applies across different Ingress resources. The top-to-bottom sequence of rules and paths defined within a single Ingress YAML is not preserved and is processed non-deterministically. If you need to preserve the exact top-to-bottom order specified in your YAML, you must separate them into distinct Ingress resources and use the priority annotation.
3737

38+
### Network Routing Mode
39+
The network routing mode determines how the ALB forwards external traffic to your applications within the cluster. Specifying this mode is mandatory. If omitted, your resource will be rejected by the validation webhook.
40+
41+
You must set the `alb.stackit.cloud/network-mode` annotation on your IngressClass.
42+
43+
Currently `NodePort` is the only supported mode. The ALB routes traffic to the cluster nodes, which then forward it to your pods. Future releases will introduce direct-to-pod routing as an additional mode. Setting `NodePort` now ensures your current configurations remain backwards compatible when new modes are added.
44+
3845
### WebSockets Support
3946
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.
4047

@@ -69,6 +76,7 @@ metadata:
6976

7077
| Annotation | Allowed On | Requirement | Description |
7178
| :--- | :--- | :--- | :--- |
79+
| `alb.stackit.cloud/network-mode` | IngressClass | Mandatory | Routing mode (currently only `NodePort` supported). |
7280
| `alb.stackit.cloud/external-address` | IngressClass | Optional | Uses a specific STACKIT floating IP instead of an ephemeral one. |
7381
| `alb.stackit.cloud/internal` | IngressClass | Optional | If `true`, the ALB is not exposed via a public IP. |
7482
| `alb.stackit.cloud/plan-id` | IngressClass | Optional | Sets the service plan for the ALB. |
@@ -82,4 +90,4 @@ metadata:
8290
| `alb.stackit.cloud/priority` | Ingress | Optional | Defines the evaluation priority of the Ingress. |
8391
| `alb.stackit.cloud/traget-pool-tls-enabled` | IngressClass, Ingress, Service | Optional | Enables TLS bridging using OS trusted CAs. |
8492
| `alb.stackit.cloud/traget-pool-tls-custom-ca` | IngressClass, Ingress, Service | Optional | Enables TLS bridging with a custom CA. |
85-
| `alb.stackit.cloud/traget-pool-tls-skip-certificate-validation`| IngressClass, Ingress, Service | Optional | Enables TLS bridging but skips certificate validation. |
93+
| `alb.stackit.cloud/traget-pool-tls-skip-certificate-validation`| IngressClass, Ingress, Service | Optional | Enables TLS bridging but skips certificate validation. |

0 commit comments

Comments
 (0)