Skip to content

Fixed deletion of invalid Access Log Policies #471

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 2, 2023
Merged

Fixed deletion of invalid Access Log Policies #471

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
30 changes: 15 additions & 15 deletions controllers/accesslogpolicy_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,21 +128,6 @@ func (r *accessLogPolicyReconciler) reconcile(ctx context.Context, req ctrl.Requ

r.eventRecorder.Event(alp, corev1.EventTypeNormal, k8s.ReconcilingEvent, "Started reconciling")

if alp.Spec.TargetRef.Group != gwv1beta1.GroupName {
message := fmt.Sprintf("The targetRef's Group must be \"%s\" but was \"%s\"",
gwv1beta1.GroupName, alp.Spec.TargetRef.Group)
r.eventRecorder.Event(alp, corev1.EventTypeWarning, k8s.FailedReconcileEvent, message)
return r.updateAccessLogPolicyStatus(ctx, alp, gwv1alpha2.PolicyReasonInvalid, message)
}

validKinds := []string{"Gateway", "HTTPRoute", "GRPCRoute"}
if !slices.Contains(validKinds, string(alp.Spec.TargetRef.Kind)) {
message := fmt.Sprintf("The targetRef's Kind must be \"Gateway\", \"HTTPRoute\", or \"GRPCRoute\""+
" but was \"%s\"", alp.Spec.TargetRef.Kind)
r.eventRecorder.Event(alp, corev1.EventTypeWarning, k8s.FailedReconcileEvent, message)
return r.updateAccessLogPolicyStatus(ctx, alp, gwv1alpha2.PolicyReasonInvalid, message)
}

if !alp.DeletionTimestamp.IsZero() {
return r.reconcileDelete(ctx, alp)
} else {
Expand Down Expand Up @@ -175,6 +160,21 @@ func (r *accessLogPolicyReconciler) reconcileUpsert(ctx context.Context, alp *an
return err
}

if alp.Spec.TargetRef.Group != gwv1beta1.GroupName {
message := fmt.Sprintf("The targetRef's Group must be \"%s\" but was \"%s\"",
gwv1beta1.GroupName, alp.Spec.TargetRef.Group)
r.eventRecorder.Event(alp, corev1.EventTypeWarning, k8s.FailedReconcileEvent, message)
return r.updateAccessLogPolicyStatus(ctx, alp, gwv1alpha2.PolicyReasonInvalid, message)
}

validKinds := []string{"Gateway", "HTTPRoute", "GRPCRoute"}
if !slices.Contains(validKinds, string(alp.Spec.TargetRef.Kind)) {
message := fmt.Sprintf("The targetRef's Kind must be \"Gateway\", \"HTTPRoute\", or \"GRPCRoute\""+
" but was \"%s\"", alp.Spec.TargetRef.Kind)
r.eventRecorder.Event(alp, corev1.EventTypeWarning, k8s.FailedReconcileEvent, message)
return r.updateAccessLogPolicyStatus(ctx, alp, gwv1alpha2.PolicyReasonInvalid, message)
}

targetRefNamespace := k8s.NamespaceOrDefault(alp.Spec.TargetRef.Namespace)
if targetRefNamespace != alp.Namespace {
message := fmt.Sprintf("The targetRef's namespace, \"%s\", does not match the Access Log Policy's"+
Expand Down
22 changes: 13 additions & 9 deletions pkg/gateway/model_build_access_log_subscription.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"context"
"fmt"

"github.com/aws/aws-sdk-go/aws"
"sigs.k8s.io/controller-runtime/pkg/client"

anv1alpha1 "github.com/aws/aws-application-networking-k8s/pkg/apis/applicationnetworking/v1alpha1"
Expand Down Expand Up @@ -57,26 +58,29 @@ type accessLogSubscriptionModelBuildTask struct {
}

func (t *accessLogSubscriptionModelBuildTask) run(ctx context.Context) error {
var eventType = core.CreateEvent
if t.accessLogPolicy.DeletionTimestamp != nil {
eventType = core.DeleteEvent
} else if _, ok := t.accessLogPolicy.Annotations[anv1alpha1.AccessLogSubscriptionAnnotationKey]; ok {
eventType = core.UpdateEvent
}

sourceType := model.ServiceSourceType
if t.accessLogPolicy.Spec.TargetRef.Kind == "Gateway" {
sourceType = model.ServiceNetworkSourceType
}

sourceName, err := utils.TargetRefToLatticeResourceName(t.accessLogPolicy.Spec.TargetRef, t.accessLogPolicy.Namespace)
if err != nil {
if err != nil && eventType != core.DeleteEvent {
return err
}

destinationArn := t.accessLogPolicy.Spec.DestinationArn
if destinationArn == nil {
return fmt.Errorf("access log policy's destinationArn cannot be nil")
}

var eventType = core.CreateEvent
if t.accessLogPolicy.DeletionTimestamp != nil {
eventType = core.DeleteEvent
} else if _, ok := t.accessLogPolicy.Annotations[anv1alpha1.AccessLogSubscriptionAnnotationKey]; ok {
eventType = core.UpdateEvent
if eventType != core.DeleteEvent {
return fmt.Errorf("access log policy's destinationArn cannot be nil")
}
destinationArn = aws.String("")
Comment on lines +80 to +83
Copy link
Contributor

@mikhail-aws mikhail-aws Nov 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I dont have good suggestion yet, but it bothers me that we do conditional code branching on every step - reconciler, model, synthezier. Every time we do something that checks if it's delete/update/create, makes it harder to reason about how it actually works.

I'm thinking that create/update/delete branching should happen at Reconcile function. The rest of the code should not have these. It might create code duplicates, but those can be written into smaller functions. Right now I have to look at every stage and assemble little pieces of what is delete logic and build some mental map of it.

It's not a blocker, but I believe we come back to this code soon.

Copy link
Member Author

@xWink xWink Nov 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Agreed, I think this is going to be related to #439 and #463

}

var status *model.AccessLogSubscriptionStatus
Expand Down
61 changes: 61 additions & 0 deletions pkg/gateway/model_build_access_log_subscription_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,67 @@ func Test_BuildAccessLogSubscription(t *testing.T) {
onlyCompareSpecs: true,
expectedError: nil,
},
{
description: "Delete event skips targetRef validation",
input: &anv1alpha1.AccessLogPolicy{
ObjectMeta: apimachineryv1.ObjectMeta{
Namespace: namespace,
Name: name,
DeletionTimestamp: &apimachineryv1.Time{},
Annotations: map[string]string{
anv1alpha1.AccessLogSubscriptionAnnotationKey: "arn:aws:vpc-lattice:us-west-2:123456789012:accesslogsubscription/als-12345678901234567",
},
},
Spec: anv1alpha1.AccessLogPolicySpec{
DestinationArn: aws.String(s3DestinationArn),
TargetRef: &gwv1alpha2.PolicyTargetReference{
Kind: "Foo",
Name: name,
},
},
},
expectedOutput: &lattice.AccessLogSubscription{
Spec: lattice.AccessLogSubscriptionSpec{
SourceType: lattice.ServiceSourceType,
SourceName: "",
DestinationArn: s3DestinationArn,
ALPNamespacedName: expectedNamespacedName,
EventType: core.DeleteEvent,
},
},
onlyCompareSpecs: true,
expectedError: nil,
},
{
description: "Delete event skips destinationArn validation",
input: &anv1alpha1.AccessLogPolicy{
ObjectMeta: apimachineryv1.ObjectMeta{
Namespace: namespace,
Name: name,
DeletionTimestamp: &apimachineryv1.Time{},
Annotations: map[string]string{
anv1alpha1.AccessLogSubscriptionAnnotationKey: "arn:aws:vpc-lattice:us-west-2:123456789012:accesslogsubscription/als-12345678901234567",
},
},
Spec: anv1alpha1.AccessLogPolicySpec{
TargetRef: &gwv1alpha2.PolicyTargetReference{
Kind: gatewayKind,
Name: name,
},
},
},
expectedOutput: &lattice.AccessLogSubscription{
Spec: lattice.AccessLogSubscriptionSpec{
SourceType: lattice.ServiceNetworkSourceType,
SourceName: name,
DestinationArn: "",
ALPNamespacedName: expectedNamespacedName,
EventType: core.DeleteEvent,
},
},
onlyCompareSpecs: true,
expectedError: nil,
},
}

for _, tt := range tests {
Expand Down