Skip to content

label nodes with the name of the autoscaling group they belong to #1239

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

label nodes with the name of the autoscaling group they belong to #1239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b314d3d
label nodes with the name of the autoscaling group they belong to
luckyganesh Aug 26, 2025
3130971
Merge branch 'kubernetes:master' into issue-884
luckyganesh Aug 30, 2025
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
12 changes: 12 additions & 0 deletions pkg/providers/v1/aws.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -990,6 +990,18 @@ func (c *Cloud) getInstanceType(instance *ec2types.Instance) string {
return string(instance.InstanceType)
}

func (c *Cloud) getInstanceTag(instance *ec2types.Instance, key string) *string {
for _, tag := range instance.Tags {
if strings.EqualFold(*tag.Key, key) { // case-insensitive match
if tag.Value == nil || *tag.Value == "" {
return nil
}
return tag.Value
}
}
return nil // return empty string if tag not found
}

// InstanceType returns the type of the node with the specified nodeName.
func (c *Cloud) InstanceType(ctx context.Context, nodeName types.NodeName) (string, error) {
if c.selfAWSInstance.nodeName == nodeName {
Expand Down
10 changes: 5 additions & 5 deletions pkg/providers/v1/aws_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,14 +487,14 @@ func testHasNodeAddress(t *testing.T, addrs []v1.NodeAddress, addressType v1.Nod
}

func makeMinimalInstance(instanceID string) ec2types.Instance {
return makeInstance(instanceID, "", "", "", "", nil, false)
return makeInstance(instanceID, "", "", "", "", nil, false, nil)
}

func makeInstance(instanceID string, privateIP, publicIP, privateDNSName, publicDNSName string, ipv6s []string, setNetInterface bool) ec2types.Instance {
func makeInstance(instanceID string, privateIP, publicIP, privateDNSName, publicDNSName string, ipv6s []string, setNetInterface bool, additionalTags []ec2types.Tag) ec2types.Instance {
var tag ec2types.Tag
tag.Key = aws.String(TagNameKubernetesClusterLegacy)
tag.Value = aws.String(TestClusterID)
tags := []ec2types.Tag{tag}
tags := append(additionalTags, tag)

instance := ec2types.Instance{
InstanceId: &instanceID,
Expand Down Expand Up @@ -584,7 +584,7 @@ func TestNodeAddressesByProviderID(t *testing.T) {
},
} {
t.Run(tc.Name, func(t *testing.T) {
instance := makeInstance(tc.InstanceID, tc.PrivateIP, tc.PublicIP, tc.PrivateDNSName, tc.PublicDNSName, tc.Ipv6s, tc.SetNetInterface)
instance := makeInstance(tc.InstanceID, tc.PrivateIP, tc.PublicIP, tc.PrivateDNSName, tc.PublicDNSName, tc.Ipv6s, tc.SetNetInterface, nil)
aws1, _ := mockInstancesResp(&instance, []*ec2types.Instance{&instance})
_, err := aws1.NodeAddressesByProviderID(context.TODO(), "i-xxx")
if err == nil {
Expand Down Expand Up @@ -690,7 +690,7 @@ func TestNodeAddresses(t *testing.T) {
},
} {
t.Run(tc.Name, func(t *testing.T) {
instance := makeInstance(tc.InstanceID, tc.PrivateIP, tc.PublicIP, tc.PrivateDNSName, tc.PublicDNSName, tc.Ipv6s, tc.SetNetInterface)
instance := makeInstance(tc.InstanceID, tc.PrivateIP, tc.PublicIP, tc.PrivateDNSName, tc.PublicDNSName, tc.Ipv6s, tc.SetNetInterface, nil)
aws1, _ := mockInstancesResp(&instance, []*ec2types.Instance{&instance})
_, err := aws1.NodeAddresses(context.TODO(), "instance-mismatch.ec2.internal")
if err == nil {
Expand Down
12 changes: 10 additions & 2 deletions pkg/providers/v1/instances_v2.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func (c *Cloud) InstanceShutdown(ctx context.Context, node *v1.Node) (bool, erro
}

func (c *Cloud) getAdditionalLabels(ctx context.Context, zoneName string, instanceID string, instanceType string,
region string, existingLabels map[string]string) (map[string]string, error) {
region string, existingLabels map[string]string, asgName *string) (map[string]string, error) {
additionalLabels := map[string]string{}

// If zone ID label is already set, skip.
Expand Down Expand Up @@ -107,6 +107,12 @@ func (c *Cloud) getAdditionalLabels(ctx context.Context, zoneName string, instan
}
}

if _, ok := existingLabels[LabelAutoScalingGroupName]; !ok {
if asgName != nil {
additionalLabels[LabelAutoScalingGroupName] = *asgName
}
}

return additionalLabels, nil
}

Expand All @@ -129,6 +135,7 @@ func (c *Cloud) InstanceMetadata(ctx context.Context, node *v1.Node) (*cloudprov
instanceType string
zone cloudprovider.Zone
nodeAddresses []v1.NodeAddress
asg_name *string
)
if variant.IsVariantNode(string(instanceID)) {
instanceType, err = c.InstanceTypeByProviderID(ctx, providerID)
Expand Down Expand Up @@ -157,9 +164,10 @@ func (c *Cloud) InstanceMetadata(ctx context.Context, node *v1.Node) (*cloudprov
if err != nil {
return nil, fmt.Errorf("failed to get node addresses for instance %s: %w", instanceID, err)
}
asg_name = c.getInstanceTag(instance, "aws:autoscaling:groupName")
}

additionalLabels, err := c.getAdditionalLabels(ctx, zone.FailureDomain, string(instanceID), instanceType, zone.Region, node.Labels)
additionalLabels, err := c.getAdditionalLabels(ctx, zone.FailureDomain, string(instanceID), instanceType, zone.Region, node.Labels, asg_name)
if err != nil {
return nil, err
}
Expand Down
107 changes: 102 additions & 5 deletions pkg/providers/v1/instances_v2_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,104 @@ func TestInstanceShutdown(t *testing.T) {

func TestInstanceMetadata(t *testing.T) {
t.Run("Should return populated InstanceMetadata", func(t *testing.T) {
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true)
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true, nil)
c, _ := mockInstancesResp(&instance, []*ec2types.Instance{&instance})
var mockedTopologyManager MockedInstanceTopologyManager
c.instanceTopologyManager = &mockedTopologyManager
mockedTopologyManager.On("GetNodeTopology", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(&ec2types.InstanceTopology{
AvailabilityZone: aws.String("us-west-2b"),
GroupName: new(string),
InstanceId: aws.String("i-123456789"),
InstanceType: new(string),
NetworkNodes: []string{"nn-123456789", "nn-234567890", "nn-345678901"},
ZoneId: aws.String("az2"),
}, nil)
node := &v1.Node{
Spec: v1.NodeSpec{
ProviderID: fmt.Sprintf("aws:///us-west-2c/1abc-2def/%s", *instance.InstanceId),
},
}

result, err := c.InstanceMetadata(context.TODO(), node)
if err != nil {
t.Errorf("Should not error getting InstanceMetadata: %s", err)
}

mockedTopologyManager.AssertNumberOfCalls(t, "GetNodeTopology", 1)
assert.Equal(t, "aws:///us-west-2c/1abc-2def/i-00000000000000000", result.ProviderID)
assert.Equal(t, "c3.large", result.InstanceType)
assert.Equal(t, []v1.NodeAddress{
{Type: "InternalIP", Address: "192.168.0.1"},
{Type: "ExternalIP", Address: "1.2.3.4"},
{Type: "InternalDNS", Address: "instance-same.ec2.internal"},
{Type: "Hostname", Address: "instance-same.ec2.internal"},
{Type: "ExternalDNS", Address: "instance-same.ec2.external"},
}, result.NodeAddresses)
assert.Equal(t, "us-west-2a", result.Zone)
assert.Equal(t, "us-west-2", result.Region)
assert.Equal(t, map[string]string{
LabelZoneID: "az1",
LabelNetworkNodePrefix + "1": "nn-123456789",
LabelNetworkNodePrefix + "2": "nn-234567890",
LabelNetworkNodePrefix + "3": "nn-345678901",
}, result.AdditionalLabels)
})

t.Run("Should return populated InstanceMetadata with asg label when asg tag is present", func(t *testing.T) {
asgTag := ec2types.Tag{
Key: aws.String("aws:autoscaling:groupName"),
Value: aws.String("test-asg"),
}
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true, []ec2types.Tag{asgTag})
c, _ := mockInstancesResp(&instance, []*ec2types.Instance{&instance})
var mockedTopologyManager MockedInstanceTopologyManager
c.instanceTopologyManager = &mockedTopologyManager
mockedTopologyManager.On("GetNodeTopology", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(&ec2types.InstanceTopology{
AvailabilityZone: aws.String("us-west-2b"),
GroupName: new(string),
InstanceId: aws.String("i-123456789"),
InstanceType: new(string),
NetworkNodes: []string{"nn-123456789", "nn-234567890", "nn-345678901"},
ZoneId: aws.String("az2"),
}, nil)
node := &v1.Node{
Spec: v1.NodeSpec{
ProviderID: fmt.Sprintf("aws:///us-west-2c/1abc-2def/%s", *instance.InstanceId),
},
}

result, err := c.InstanceMetadata(context.TODO(), node)
if err != nil {
t.Errorf("Should not error getting InstanceMetadata: %s", err)
}

mockedTopologyManager.AssertNumberOfCalls(t, "GetNodeTopology", 1)
assert.Equal(t, "aws:///us-west-2c/1abc-2def/i-00000000000000000", result.ProviderID)
assert.Equal(t, "c3.large", result.InstanceType)
assert.Equal(t, []v1.NodeAddress{
{Type: "InternalIP", Address: "192.168.0.1"},
{Type: "ExternalIP", Address: "1.2.3.4"},
{Type: "InternalDNS", Address: "instance-same.ec2.internal"},
{Type: "Hostname", Address: "instance-same.ec2.internal"},
{Type: "ExternalDNS", Address: "instance-same.ec2.external"},
}, result.NodeAddresses)
assert.Equal(t, "us-west-2a", result.Zone)
assert.Equal(t, "us-west-2", result.Region)
assert.Equal(t, map[string]string{
LabelZoneID: "az1",
LabelNetworkNodePrefix + "1": "nn-123456789",
LabelNetworkNodePrefix + "2": "nn-234567890",
LabelNetworkNodePrefix + "3": "nn-345678901",
LabelAutoScalingGroupName: "test-asg",
}, result.AdditionalLabels)
})

t.Run("Should return populated InstanceMetadata without asg label when asg tag value is empty", func(t *testing.T) {
asgTag := ec2types.Tag{
Key: aws.String("aws:autoscaling:groupName"),
Value: aws.String(""),
}
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true, []ec2types.Tag{asgTag})
c, _ := mockInstancesResp(&instance, []*ec2types.Instance{&instance})
var mockedTopologyManager MockedInstanceTopologyManager
c.instanceTopologyManager = &mockedTopologyManager
Expand Down Expand Up @@ -211,7 +308,7 @@ func TestInstanceMetadata(t *testing.T) {
})

t.Run("Should skip additional labels if already set", func(t *testing.T) {
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true)
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true, nil)
c, _ := mockInstancesResp(&instance, []*ec2types.Instance{&instance})
var mockedTopologyManager MockedInstanceTopologyManager
c.instanceTopologyManager = &mockedTopologyManager
Expand Down Expand Up @@ -239,7 +336,7 @@ func TestInstanceMetadata(t *testing.T) {
})

t.Run("Should swallow errors if getting node topology fails if instance type not expected to be supported", func(t *testing.T) {
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true)
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true, nil)
c, _ := mockInstancesResp(&instance, []*ec2types.Instance{&instance})
var mockedTopologyManager MockedInstanceTopologyManager
c.instanceTopologyManager = &mockedTopologyManager
Expand All @@ -264,7 +361,7 @@ func TestInstanceMetadata(t *testing.T) {
})

t.Run("Should not swallow errors if getting node topology fails if instance type is expected to be supported", func(t *testing.T) {
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true)
instance := makeInstance("i-00000000000000000", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true, nil)
c, _ := mockInstancesResp(&instance, []*ec2types.Instance{&instance})
var mockedTopologyManager MockedInstanceTopologyManager
c.instanceTopologyManager = &mockedTopologyManager
Expand All @@ -286,7 +383,7 @@ func TestInstanceMetadata(t *testing.T) {
})

t.Run("Should limit ec2:DescribeInstances calls to a single request per instance", func(t *testing.T) {
instance := makeInstance("i-00000000000001234", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true)
instance := makeInstance("i-00000000000001234", "192.168.0.1", "1.2.3.4", "instance-same.ec2.internal", "instance-same.ec2.external", nil, true, nil)
c, awsServices := mockInstancesResp(&instance, []*ec2types.Instance{&instance})

// Add mock for DescribeInstanceTopology on the EC2 mock
Expand Down
2 changes: 2 additions & 0 deletions pkg/providers/v1/well_known_labels.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,6 @@ const (
// but will be initially applied to nodes. The suffix should be an incremented
// integer starting at 1.
LabelNetworkNodePrefix = "topology.k8s.aws/network-node-layer-"

LabelAutoScalingGroupName = "node.k8s.aws/auto-scaling-group-name"
)