Skip to content

fix: propagate AdditionalTags from AWSCluster to storage volumes #4512

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 3 commits into from
Sep 23, 2023
Merged

fix: propagate AdditionalTags from AWSCluster to storage volumes #4512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f528a75
fix: propagate AdditionalTags from AWSCluster to storage volumes
philjb Sep 21, 2023
577bcda
tests(awsmachine controller): fix test that matched bug behavior
philjb Sep 22, 2023
b805082
tests(awsmachine controller): improve test for precedence of tags
philjb Sep 22, 2023
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
8 changes: 4 additions & 4 deletions controllers/awsmachine_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,7 @@ func (r *AWSMachineReconciler) reconcileNormal(_ context.Context, machineScope *
}

if instance != nil {
r.ensureStorageTags(ec2svc, instance, machineScope.AWSMachine)
r.ensureStorageTags(ec2svc, instance, machineScope.AWSMachine, machineScope.AdditionalTags())
}

if err := r.reconcileLBAttachment(machineScope, elbScope, instance); err != nil {
Expand Down Expand Up @@ -1111,20 +1111,20 @@ func (r *AWSMachineReconciler) indexAWSMachineByInstanceID(o client.Object) []st
return nil
}

func (r *AWSMachineReconciler) ensureStorageTags(ec2svc services.EC2Interface, instance *infrav1.Instance, machine *infrav1.AWSMachine) {
func (r *AWSMachineReconciler) ensureStorageTags(ec2svc services.EC2Interface, instance *infrav1.Instance, machine *infrav1.AWSMachine, additionalTags map[string]string) {
annotations, err := r.machineAnnotationJSON(machine, VolumeTagsLastAppliedAnnotation)
if err != nil {
r.Log.Error(err, "Failed to fetch the annotations for volume tags")
}
for _, volumeID := range instance.VolumeIDs {
if subAnnotation, ok := annotations[volumeID].(map[string]interface{}); ok {
newAnnotation, err := r.ensureVolumeTags(ec2svc, aws.String(volumeID), subAnnotation, machine.Spec.AdditionalTags)
newAnnotation, err := r.ensureVolumeTags(ec2svc, aws.String(volumeID), subAnnotation, additionalTags)
if err != nil {
r.Log.Error(err, "Failed to fetch the changed volume tags in EC2 instance")
}
annotations[volumeID] = newAnnotation
} else {
newAnnotation, err := r.ensureVolumeTags(ec2svc, aws.String(volumeID), make(map[string]interface{}), machine.Spec.AdditionalTags)
newAnnotation, err := r.ensureVolumeTags(ec2svc, aws.String(volumeID), make(map[string]interface{}), additionalTags)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line change didn't make it into 2.2.4 release through https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/4535/files

if err != nil {
r.Log.Error(err, "Failed to fetch the changed volume tags in EC2 instance")
}
Expand Down
25 changes: 16 additions & 9 deletions controllers/awsmachine_controller_unit_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,34 +481,41 @@ func TestAWSMachineReconciler(t *testing.T) {
}
})

t.Run("should tag instances from machine and cluster tags", func(t *testing.T) {
t.Run("should tag instances and volumes with machine and cluster tags", func(t *testing.T) {
g := NewWithT(t)
awsMachine := getAWSMachine()
setup(t, g, awsMachine)
defer teardown(t, g)
instanceCreate(t, g)
getCoreSecurityGroups(t, g)

ms.AWSMachine.Spec.AdditionalTags = infrav1.Tags{"kind": "alicorn"}
cs.AWSCluster.Spec.AdditionalTags = infrav1.Tags{"colour": "lavender"}
ms.AWSMachine.Spec.AdditionalTags = infrav1.Tags{"kind": "alicorn", "colour": "pink"} // takes precedence
cs.AWSCluster.Spec.AdditionalTags = infrav1.Tags{"colour": "lavender", "shape": "round"}

ec2Svc.EXPECT().GetAdditionalSecurityGroupsIDs(gomock.Any()).Return(nil, nil)

// expect one call first to tag the instance and two calls for tagging each of two volumes
// the volumes get the tags from the AWSCluster _and_ the AWSMachine

ec2Svc.EXPECT().UpdateResourceTags(
gomock.Any(),
PointsTo("myMachine"),
map[string]string{
"kind": "alicorn",
"colour": "pink",
"shape": "round",
"kind": "alicorn",
},
map[string]string{},
).Return(nil).Times(2)
).Return(nil)

ec2Svc.EXPECT().UpdateResourceTags(
PointsTo("myMachine"),
gomock.Any(),
map[string]string{
"colour": "lavender",
"colour": "pink",
"shape": "round",
"kind": "alicorn",
},
map[string]string{},
).Return(nil)
).Return(nil).Times(2)

_, err := reconciler.reconcileNormal(context.Background(), ms, cs, cs, cs, cs)
g.Expect(err).To(BeNil())
Expand Down