Skip to content

Commit 7b7cc92

Browse files
authored
update migration doc to include more information (#1541)
1 parent f18b7f2 commit 7b7cc92

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

docs/guide/upgrade/migrate_v1_v2.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,50 @@ This document contains the information necessary to migrate from an existing ins
66

77
!!!warning ""
88
If you have AWSALBIngressController(<1.1.3) installed, you need to upgrade to version>=v1.1.3(e.g. v1.1.9) first.
9-
9+
1010

1111
## Backwards compatibility
1212
The AWSLoadBalancerController(v2.0.0) is backwards-compatible with AWSALBIngressController(>=v1.1.3).
1313

14-
It supports existing AWS resources provisioned by AWSALBIngressController(>=v1.1.3) for Ingress resources.
14+
It supports existing AWS resources provisioned by AWSALBIngressController(>=v1.1.3) for Ingress resources with below caveats:
15+
16+
1. The AWS LoadBalancer resource created for your Ingress will be preserved.
17+
18+
2. If a numeric TargetPort is used in your service, the AWS TargetGroups created for your Ingress will be re-created.
19+
20+
!!!warning "downtimes"
21+
This would cause downtimes to your service during targets registration into new TargetGroups created.
22+
23+
!!!tip "details"
24+
* The AWSALBIngressController always used `1` as TargetGroup's port.
25+
* The AWSLoadBalancerController will use
26+
* the actual numeric TargetPort as TargetGroup's port if a numeric TargetPort used.
27+
* `1` as TargetGroup's port if a lexical TargetPort used.
28+
* The AWSLoadBalancerController will automatically create new TargetGroups and cleanup old TargetGroups if any.
29+
30+
3. If [security-groups](../../guide/ingress/annotations.md#security-groups) annotation used, the SecurityGroup rule on worker node's SecurityGroup that allow LoadBalancer traffic should be manually adjusted post migration.
31+
32+
!!!tip "details"
33+
when [security-groups](../../guide/ingress/annotations.md#security-groups) annotation used:
34+
35+
* a managed SecurityGroup will be created and attached to ALB. This SecurityGroup will be preserved.
36+
* an inbound rule will be added to your worker node securityGroups which allow traffic from the above managed SecurityGroup for ALB.
37+
* The AWSALBIngressController didn't add any description for that inbound rule.
38+
* The AWSLoadBalancerController will use `elbv2.k8s.aws/targetGroupBinding=shared` for that inbound rule
39+
* You'll need to manually add `elbv2.k8s.aws/targetGroupBinding=shared` description to that inbound rule so that AWSLoadBalancerController can delete such rule when you delete your Ingress.
40+
41+
!!!tip "sample"
42+
inbound rule on worker node securityGroups that allow traffic from the managed LB securityGroup before migration:
43+
44+
|Type | Protocol |Port range|Source |Description - optional|
45+
|--------|----------|----------|---------------------------|----------------------|
46+
|All TCP |TCP |0 - 65535 |sg-008c920b1(managed LB SG)|- |
47+
48+
inbound rule on worker node securityGroups that allow traffic from the managed LB securityGroup after migration:
49+
50+
|Type | Protocol |Port range|Source |Description - optional|
51+
|--------|----------|----------|---------------------------|----------------------|
52+
|All TCP |TCP |0 - 65535 |sg-008c920b1(managed LB SG)|elbv2.k8s.aws/targetGroupBinding=shared| |
1553

1654
## Upgrade steps
1755
1. Determine existing installed AWSALBIngressController version.

0 commit comments

Comments
 (0)