Skip to content

Commit 8391a78

Browse files
prasadkattiTimothy-Dougherty
authored andcommitted
Misc minor fixes to docs (kubernetes-sigs#2568)
* Misc minor fixes to docs * more fixes
1 parent 835cb02 commit 8391a78

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/guide/ingress/annotations.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,22 +61,22 @@ You can add annotations to kubernetes Ingress and Service objects to customize t
6161
## IngressGroup
6262
IngressGroup feature enables you to group multiple Ingress resources together.
6363
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.
6565

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.
6767

6868
- <a name="group.name">`alb.ingress.kubernetes.io/group.name`</a> specifies the group name that this Ingress belongs to.
6969

7070
!!!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".
7272
- groupName must consist of lower case alphanumeric characters, `-` or `.`, and must start and end with an alphanumeric character.
7373
- groupName must be no more than 63 character.
7474

7575
!!!warning "Security Risk"
7676
IngressGroup feature should only be used when all Kubernetes users with RBAC permission to create/modify Ingress resources are within trust boundary.
7777

7878
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.
8080

8181
We'll add more fine-grained access-control in future versions.
8282

@@ -89,8 +89,8 @@ By default, Ingresses don't belong to any IngressGroup, and we treat it as a "im
8989

9090
!!!note ""
9191
- 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.
9494

9595
!!!warning ""
9696
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
101101
```
102102

103103
## Traffic Listening
104-
Traffic Listening can be controlled with following annotations:
104+
Traffic Listening can be controlled with the following annotations:
105105

106-
- <a name="listen-ports">`alb.ingress.kubernetes.io/listen-ports`</a> specifies the ports that ALB used to listen on.
106+
- <a name="listen-ports">`alb.ingress.kubernetes.io/listen-ports`</a> specifies the ports that ALB listens on.
107107

108108
!!!note "Merge Behavior"
109109
`listen-ports` is merged across all Ingresses in IngressGroup.
@@ -112,7 +112,7 @@ Traffic Listening can be controlled with following annotations:
112112
- If same listen-port is defined by multiple Ingress within IngressGroup, Ingress rules will be merged with respect to their group order within IngressGroup.
113113

114114
!!!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.
116116

117117
!!!warning ""
118118
You may not have duplicate load balancer ports defined.
@@ -130,7 +130,7 @@ Traffic Listening can be controlled with following annotations:
130130
- Once defined on a single Ingress, it impacts every Ingress within IngressGroup.
131131

132132
!!!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.
134134
- The SSL port that redirects to must exists on LoadBalancer. See [alb.ingress.kubernetes.io/listen-ports](#listen-ports) for the listen ports configuration.
135135

136136
!!!example
@@ -218,13 +218,13 @@ Traffic Routing can be controlled with following annotations:
218218
alb.ingress.kubernetes.io/backend-protocol-version: GRPC
219219
```
220220

221-
- <a name="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+
- <a name="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.
222222

223223
!!!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.
225225

226226
!!!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.
228228

229229
!!!example
230230
```

0 commit comments

Comments
 (0)