Skip to content

Refactor AllocENI (#2640) #2656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2023
Merged

Refactor AllocENI (#2640) #2656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 29 additions & 9 deletions pkg/awsutils/awsutils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ var (
// APIs defines interfaces calls for adding/getting/deleting ENIs/secondary IPs. The APIs are not thread-safe.
type APIs interface {
// AllocENI creates an ENI and attaches it to the instance
AllocENI(useCustomCfg bool, sg []*string, subnet string) (eni string, err error)
AllocENI(useCustomCfg bool, sg []*string, subnet string, numIPs int) (eni string, err error)

// FreeENI detaches ENI interface and deletes it
FreeENI(eniName string) error
Expand Down Expand Up @@ -740,8 +740,8 @@ func (cache *EC2InstanceMetadataCache) awsGetFreeDeviceNumber() (int, error) {

// AllocENI creates an ENI and attaches it to the instance
// returns: newly created ENI ID
func (cache *EC2InstanceMetadataCache) AllocENI(useCustomCfg bool, sg []*string, subnet string) (string, error) {
eniID, err := cache.createENI(useCustomCfg, sg, subnet)
func (cache *EC2InstanceMetadataCache) AllocENI(useCustomCfg bool, sg []*string, subnet string, numIPs int) (string, error) {
eniID, err := cache.createENI(useCustomCfg, sg, subnet, numIPs)
if err != nil {
return "", errors.Wrap(err, "AllocENI: failed to create ENI")
}
Expand Down Expand Up @@ -812,7 +812,7 @@ func (cache *EC2InstanceMetadataCache) attachENI(eniID string) (string, error) {
}

// return ENI id, error
func (cache *EC2InstanceMetadataCache) createENI(useCustomCfg bool, sg []*string, subnet string) (string, error) {
func (cache *EC2InstanceMetadataCache) createENI(useCustomCfg bool, sg []*string, subnet string, numIPs int) (string, error) {
eniDescription := eniDescriptionPrefix + cache.instanceID
tags := map[string]string{
eniCreatedAtTagKey: time.Now().Format(time.RFC3339),
Expand All @@ -826,14 +826,34 @@ func (cache *EC2InstanceMetadataCache) createENI(useCustomCfg bool, sg []*string
Tags: convertTagsToSDKTags(tags),
},
}
var needIPs = numIPs

input := &ec2.CreateNetworkInterfaceInput{
Description: aws.String(eniDescription),
Groups: aws.StringSlice(cache.securityGroups.SortedList()),
SubnetId: aws.String(cache.subnetID),
TagSpecifications: tagSpec,
ipLimit := cache.GetENIIPv4Limit()
if ipLimit < needIPs {
needIPs = ipLimit
}

log.Infof("Trying to allocate %d IP addresses on new ENI", needIPs)
log.Debugf("PD enabled - %t", cache.enablePrefixDelegation)
input := &ec2.CreateNetworkInterfaceInput{}

if cache.enablePrefixDelegation {
input = &ec2.CreateNetworkInterfaceInput{
Description: aws.String(eniDescription),
Groups: aws.StringSlice(cache.securityGroups.SortedList()),
SubnetId: aws.String(cache.subnetID),
TagSpecifications: tagSpec,
Ipv4PrefixCount: aws.Int64(int64(needIPs)),
}
} else {
input = &ec2.CreateNetworkInterfaceInput{
Description: aws.String(eniDescription),
Groups: aws.StringSlice(cache.securityGroups.SortedList()),
SubnetId: aws.String(cache.subnetID),
TagSpecifications: tagSpec,
SecondaryPrivateIpAddressCount: aws.Int64(int64(needIPs)),
}
}
if useCustomCfg {
log.Info("Using a custom network config for the new ENI")
if len(sg) != 0 {
Expand Down
137 changes: 128 additions & 9 deletions pkg/awsutils/awsutils_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,11 +401,12 @@ func TestAllocENI(t *testing.T) {
mockEC2.EXPECT().ModifyNetworkInterfaceAttributeWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, nil)

cache := &EC2InstanceMetadataCache{
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
instanceType: "c5n.18xlarge",
}

_, err := cache.AllocENI(false, nil, "")
_, err := cache.AllocENI(false, nil, "", 5)
assert.NoError(t, err)
}

Expand Down Expand Up @@ -435,11 +436,12 @@ func TestAllocENINoFreeDevice(t *testing.T) {
mockEC2.EXPECT().DeleteNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, nil)

cache := &EC2InstanceMetadataCache{
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
instanceType: "c5n.18xlarge",
}

_, err := cache.AllocENI(false, nil, "")
_, err := cache.AllocENI(false, nil, "", 5)
assert.Error(t, err)
}

Expand Down Expand Up @@ -471,11 +473,128 @@ func TestAllocENIMaxReached(t *testing.T) {
mockEC2.EXPECT().DeleteNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, nil)

cache := &EC2InstanceMetadataCache{
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
instanceType: "c5n.18xlarge",
}

_, err := cache.AllocENI(false, nil, "")
_, err := cache.AllocENI(false, nil, "", 5)
assert.Error(t, err)
}

func TestAllocENIWithIPAddresses(t *testing.T) {
ctrl, mockEC2 := setup(t)
defer ctrl.Finish()

// when required IP numbers(5) is below ENI's limit(30)
currentEniID := eniID
eni := ec2.CreateNetworkInterfaceOutput{NetworkInterface: &ec2.NetworkInterface{NetworkInterfaceId: &currentEniID}}
mockEC2.EXPECT().CreateNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(&eni, nil)

ec2ENIs := make([]*ec2.InstanceNetworkInterface, 0)
deviceNum1 := int64(0)
ec2ENI := &ec2.InstanceNetworkInterface{Attachment: &ec2.InstanceNetworkInterfaceAttachment{DeviceIndex: &deviceNum1}}
ec2ENIs = append(ec2ENIs, ec2ENI)

deviceNum2 := int64(3)
ec2ENI = &ec2.InstanceNetworkInterface{Attachment: &ec2.InstanceNetworkInterfaceAttachment{DeviceIndex: &deviceNum2}}
ec2ENIs = append(ec2ENIs, ec2ENI)

result := &ec2.DescribeInstancesOutput{
Reservations: []*ec2.Reservation{{Instances: []*ec2.Instance{{NetworkInterfaces: ec2ENIs}}}}}
mockEC2.EXPECT().DescribeInstancesWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(result, nil)
attachmentID := "eni-attach-58ddda9d"
attachResult := &ec2.AttachNetworkInterfaceOutput{
AttachmentId: &attachmentID}
mockEC2.EXPECT().AttachNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(attachResult, nil)
mockEC2.EXPECT().ModifyNetworkInterfaceAttributeWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, nil)

cache := &EC2InstanceMetadataCache{ec2SVC: mockEC2, instanceType: "c5n.18xlarge"}
_, err := cache.AllocENI(false, nil, subnetID, 5)
assert.NoError(t, err)

// when required IP numbers(50) is higher than ENI's limit(49)
mockEC2.EXPECT().CreateNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(&eni, nil)
mockEC2.EXPECT().DescribeInstancesWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(result, nil)
mockEC2.EXPECT().AttachNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(attachResult, nil)
mockEC2.EXPECT().ModifyNetworkInterfaceAttributeWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, nil)
cache = &EC2InstanceMetadataCache{ec2SVC: mockEC2, instanceType: "c5n.18xlarge"}
_, err = cache.AllocENI(false, nil, subnetID, 49)
assert.NoError(t, err)
}

func TestAllocENIWithIPAddressesAlreadyFull(t *testing.T) {
ctrl, mockEC2 := setup(t)
defer ctrl.Finish()

mockMetadata := testMetadata(nil)

retErr := awserr.New("PrivateIpAddressLimitExceeded", "Too many IPs already allocated", nil)
mockEC2.EXPECT().CreateNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, retErr)

cache := &EC2InstanceMetadataCache{
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
instanceType: "t3.xlarge",
}
_, err := cache.AllocENI(true, nil, "", 14)
assert.Error(t, err)
}

func TestAllocENIWithPrefixAddresses(t *testing.T) {
ctrl, mockEC2 := setup(t)
defer ctrl.Finish()

mockMetadata := testMetadata(nil)

currentEniID := eniID
eni := ec2.CreateNetworkInterfaceOutput{NetworkInterface: &ec2.NetworkInterface{NetworkInterfaceId: &currentEniID}}
mockEC2.EXPECT().CreateNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(&eni, nil)

ec2ENIs := make([]*ec2.InstanceNetworkInterface, 0)
deviceNum1 := int64(0)
ec2ENI := &ec2.InstanceNetworkInterface{Attachment: &ec2.InstanceNetworkInterfaceAttachment{DeviceIndex: &deviceNum1}}
ec2ENIs = append(ec2ENIs, ec2ENI)

deviceNum2 := int64(3)
ec2ENI = &ec2.InstanceNetworkInterface{Attachment: &ec2.InstanceNetworkInterfaceAttachment{DeviceIndex: &deviceNum2}}
ec2ENIs = append(ec2ENIs, ec2ENI)

result := &ec2.DescribeInstancesOutput{
Reservations: []*ec2.Reservation{{Instances: []*ec2.Instance{{NetworkInterfaces: ec2ENIs}}}}}
mockEC2.EXPECT().DescribeInstancesWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(result, nil)
attachmentID := "eni-attach-58ddda9d"
attachResult := &ec2.AttachNetworkInterfaceOutput{
AttachmentId: &attachmentID}
mockEC2.EXPECT().AttachNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(attachResult, nil)
mockEC2.EXPECT().ModifyNetworkInterfaceAttributeWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, nil)

cache := &EC2InstanceMetadataCache{
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
instanceType: "c5n.18xlarge",
enablePrefixDelegation: true,
}
_, err := cache.AllocENI(false, nil, subnetID, 1)
assert.NoError(t, err)
}

func TestAllocENIWithPrefixesAlreadyFull(t *testing.T) {
ctrl, mockEC2 := setup(t)
defer ctrl.Finish()

mockMetadata := testMetadata(nil)

retErr := awserr.New("PrivateIpAddressLimitExceeded", "Too many IPs already allocated", nil)
mockEC2.EXPECT().CreateNetworkInterfaceWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, retErr)

cache := &EC2InstanceMetadataCache{
ec2SVC: mockEC2,
imds: TypedIMDS{mockMetadata},
instanceType: "c5n.18xlarge",
enablePrefixDelegation: true,
}
_, err := cache.AllocENI(true, nil, "", 1)
assert.Error(t, err)
}

Expand Down
Loading