Doc: Add note for rename behavior of IngressGroup (#3283)

* Add warning for rename behavior of IngressGroup * Change wording per suggestion from code review * Apply grammar suggestions from code review Co-authored-by: John Gardiner Myers <[email protected]> --------- Co-authored-by: John Gardiner Myers <[email protected]>
kubernetes-sigs · Aug 7, 2023 · 78d101d · 78d101d
1 parent 9b27d26
commit 78d101d
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/guide/ingress/annotations.md b/docs/guide/ingress/annotations.md
@@ -79,6 +79,13 @@ By default, Ingresses don't belong to any IngressGroup, and we treat it as a "im
         other Kubernetes users may create/modify their Ingresses to belong to the same IngressGroup, and can thus add more rules or overwrite existing rules with higher priority to the ALB for your Ingress.
 
         We'll add more fine-grained access-control in future versions.
+
+    !!!note "Rename behavior"
+        The ALB for an IngressGroup is found by searching for an AWS tag `ingress.k8s.aws/stack` tag with the name of the IngressGroup as its value. For an implicit IngressGroup, the value is `namespace/ingressname`.
+
+        When the groupName of an IngressGroup for an Ingress is changed, the Ingress will be moved to a new IngressGroup and be supported by the ALB for the new IngressGroup. If the ALB for the new IngressGroup doesn't exist, a new ALB will be created.
+
+        If an IngressGroup no longer contains any Ingresses, the ALB for that IngressGroup will be deleted and any deletion protection of that ALB will be ignored.
 
     !!!example
         ```