You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guide/ingress/annotations.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -61,22 +61,22 @@ You can add annotations to kubernetes Ingress and Service objects to customize t
61
61
## IngressGroup
62
62
IngressGroup feature enables you to group multiple Ingress resources together.
63
63
The controller will automatically merge Ingress rules for all Ingresses within IngressGroup and support them with a single ALB.
64
-
In addition, most annotations defined on a Ingress only applies to the paths defined by that Ingress.
64
+
In addition, most annotations defined on an Ingress only apply to the paths defined by that Ingress.
65
65
66
-
By default, Ingresses don't belong to any IngressGroup, and we treat it as a "implicit IngressGroup" consisted of the Ingress itself.
66
+
By default, Ingresses don't belong to any IngressGroup, and we treat it as a "implicit IngressGroup" consisting of the Ingress itself.
67
67
68
68
- <aname="group.name">`alb.ingress.kubernetes.io/group.name`</a> specifies the group name that this Ingress belongs to.
69
69
70
70
!!!note ""
71
-
- Ingresses with same `group.name` annotation will form as a "explicit IngressGroup".
71
+
- Ingresses with same `group.name` annotation will form an "explicit IngressGroup".
72
72
- groupName must consist of lower case alphanumeric characters, `-` or `.`, and must start and end with an alphanumeric character.
73
73
- groupName must be no more than 63 character.
74
74
75
75
!!!warning "Security Risk"
76
76
IngressGroup feature should only be used when all Kubernetes users with RBAC permission to create/modify Ingress resources are within trust boundary.
77
77
78
78
If you turn your Ingress to belong a "explicit IngressGroup" by adding `group.name` annotation,
79
-
other Kubernetes user may create/modify their Ingresses to belong same IngressGroup, thus can add more rules or overwrite existing rules with higher priority to the ALB for your Ingress.
79
+
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.
80
80
81
81
We'll add more fine-grained access-control in future versions.
82
82
@@ -89,8 +89,8 @@ By default, Ingresses don't belong to any IngressGroup, and we treat it as a "im
89
89
90
90
!!!note ""
91
91
- You can explicitly denote the order using a number between 1-1000
92
-
- The smaller the order, the rule will be evaluated first. All Ingresses without explicit order setting get order value as 0
93
-
- By default the rule order between Ingresses within IngressGroup are determined by the lexical order of Ingress’s namespace/name.
92
+
- The smaller the order, the rule will be evaluated first. All Ingresses without an explicit order setting get order value as 0
93
+
- By default the rule order between Ingresses within IngressGroup is determined by the lexical order of Ingress’s namespace/name.
94
94
95
95
!!!warning ""
96
96
You may not have duplicate group order explicitly defined for Ingresses within IngressGroup.
@@ -101,9 +101,9 @@ By default, Ingresses don't belong to any IngressGroup, and we treat it as a "im
101
101
```
102
102
103
103
## Traffic Listening
104
-
Traffic Listening can be controlled with following annotations:
104
+
Traffic Listening can be controlled with the following annotations:
105
105
106
-
- <aname="listen-ports">`alb.ingress.kubernetes.io/listen-ports`</a> specifies the ports that ALB used to listen on.
106
+
- <aname="listen-ports">`alb.ingress.kubernetes.io/listen-ports`</a> specifies the ports that ALB listens on.
107
107
108
108
!!!note "Merge Behavior"
109
109
`listen-ports` is merged across all Ingresses in IngressGroup.
@@ -112,7 +112,7 @@ Traffic Listening can be controlled with following annotations:
112
112
- If same listen-port is defined by multiple Ingress within IngressGroup, Ingress rules will be merged with respect to their group order within IngressGroup.
113
113
114
114
!!!note "Default"
115
-
- defaults to `'[{"HTTP": 80}]'` or `'[{"HTTPS": 443}]'`depends on whether `certificate-arn` is specified.
115
+
- defaults to `'[{"HTTP": 80}]'` or `'[{"HTTPS": 443}]'`depending on whether `certificate-arn` is specified.
116
116
117
117
!!!warning ""
118
118
You may not have duplicate load balancer ports defined.
@@ -130,7 +130,7 @@ Traffic Listening can be controlled with following annotations:
130
130
- Once defined on a single Ingress, it impacts every Ingress within IngressGroup.
131
131
132
132
!!!note ""
133
-
- Once enabled SSLRedirect, every HTTP listener will be configured with default action which redirects to HTTPS, other rules will be ignored.
133
+
- Once enabled SSLRedirect, every HTTP listener will be configured with a default action which redirects to HTTPS, other rules will be ignored.
134
134
- The SSL port that redirects to must exists on LoadBalancer. See [alb.ingress.kubernetes.io/listen-ports](#listen-ports) for the listen ports configuration.
135
135
136
136
!!!example
@@ -218,13 +218,13 @@ Traffic Routing can be controlled with following annotations:
- <aname="subnets">`alb.ingress.kubernetes.io/subnets`</a> specifies the [Availability Zone](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) that ALB will route traffic to. See [Load Balancer subnets](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-subnets.html) for more details.
221
+
- <aname="subnets">`alb.ingress.kubernetes.io/subnets`</a> specifies the [Availability Zone](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html)s that the ALB will route traffic to. See [Load Balancer subnets](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-subnets.html) for more details.
222
222
223
223
!!!note ""
224
-
You must specify at least two subnets in different AZ. both subnetID or subnetName(Name tag on subnets) can be used.
224
+
You must specify at least two subnets in different AZs. Either subnetID or subnetName(Name tag on subnets) can be used.
225
225
226
226
!!!tip
227
-
You can enable subnet auto discovery to avoid specify this annotation on every Ingress. See [Subnet Discovery](../../deploy/subnet_discovery.md) for instructions.
227
+
You can enable subnet auto discovery to avoid specifying this annotation on every Ingress. See [Subnet Discovery](../../deploy/subnet_discovery.md) for instructions.
0 commit comments