Skip to content

Commit

Permalink
Limit subnet/subnetset tags to 26, if exceed, update status error
Browse files Browse the repository at this point in the history 
nsxapi would report `._vpc_subnet.tags has exceeded maximum size 26` if we don't specify
the max limit.

Signed-off-by: Xie Zheng <[email protected]>
  • Loading branch information
@zhengxiexie
zhengxiexie committed Jan 15, 2024
1 parent 7910e52 commit d29607e
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 25 deletions.
32 changes: 20 additions & 12 deletions pkg/controllers/subnet/subnet_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func (r *SubnetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
controllerutil.AddFinalizer(obj, servicecommon.SubnetFinalizerName)
if err := r.Client.Update(ctx, obj); err != nil {
log.Error(err, "add finalizer", "subnet", req.NamespacedName)
updateFail(r, &ctx, obj)
updateFail(r, &ctx, obj, "")
return ResultRequeue, err
}
log.V(1).Info("added finalizer on subnet CR", "subnet", req.NamespacedName)
Expand All @@ -78,7 +78,7 @@ func (r *SubnetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
if vpcNetworkConfig == nil {
err := fmt.Errorf("operate failed: cannot get configuration for Subnet CR")
log.Error(nil, "failed to find VPCNetworkConfig for Subnet CR", "subnet", req.NamespacedName, "namespace %s", obj.Namespace)
updateFail(r, &ctx, obj)
updateFail(r, &ctx, obj, "")
return ResultRequeue, err
}
if obj.Spec.AccessMode == "" {
Expand All @@ -95,7 +95,7 @@ func (r *SubnetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
}
if err := r.Client.Get(context.Background(), namespacedName, namespace); err != nil {
log.Error(err, "unable to fetch namespace of Subnet CR", "req", req.NamespacedName)
updateFail(r, &ctx, obj)
updateFail(r, &ctx, obj, "")
return ResultRequeue, err
}
tags := r.Service.GenerateSubnetNSTags(obj, string(nsObj.UID))
Expand All @@ -107,13 +107,18 @@ func (r *SubnetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
return ResultRequeueAfter10sec, nil
}
if _, err := r.Service.CreateOrUpdateSubnet(obj, *vpcInfo, tags); err != nil {
if errors.As(err, &util.ExceedTagsError{}) {
log.Error(err, "exceed tags limit, would not retry", "subnet", req.NamespacedName)
updateFail(r, &ctx, obj, err.Error())
return ResultNormal, nil
}
log.Error(err, "operate failed, would retry exponentially", "subnet", req.NamespacedName)
updateFail(r, &ctx, obj)
updateFail(r, &ctx, obj, "")
return ResultRequeue, err
}
if err := r.updateSubnetStatus(obj); err != nil {
log.Error(err, "update subnet status failed, would retry exponentially", "subnet", req.NamespacedName)
updateFail(r, &ctx, obj)
updateFail(r, &ctx, obj, "")
return ResultRequeue, err
}
updateSuccess(r, &ctx, obj)
Expand All @@ -122,13 +127,13 @@ func (r *SubnetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
metrics.CounterInc(r.Service.NSXConfig, metrics.ControllerDeleteTotal, MetricResTypeSubnet)
if err := r.DeleteSubnet(*obj); err != nil {
log.Error(err, "deletion failed, would retry exponentially", "subnet", req.NamespacedName)
deleteFail(r, &ctx, obj)
deleteFail(r, &ctx, obj, "")
return ResultRequeue, err
}
controllerutil.RemoveFinalizer(obj, servicecommon.SubnetFinalizerName)
if err := r.Client.Update(ctx, obj); err != nil {
log.Error(err, "deletion failed, would retry exponentially", "subnet", req.NamespacedName)
deleteFail(r, &ctx, obj)
deleteFail(r, &ctx, obj, "")
return ResultRequeue, err
}
log.V(1).Info("removed finalizer", "subnet", req.NamespacedName)
Expand Down Expand Up @@ -184,7 +189,7 @@ func (r *SubnetReconciler) setSubnetReadyStatusTrue(ctx *context.Context, subnet
r.updateSubnetStatusConditions(ctx, subnet, newConditions)
}

func (r *SubnetReconciler) setSubnetReadyStatusFalse(ctx *context.Context, subnet *v1alpha1.Subnet) {
func (r *SubnetReconciler) setSubnetReadyStatusFalse(ctx *context.Context, subnet *v1alpha1.Subnet, msg string) {
newConditions := []v1alpha1.Condition{
{
Type: v1alpha1.Ready,
Expand All @@ -193,6 +198,9 @@ func (r *SubnetReconciler) setSubnetReadyStatusFalse(ctx *context.Context, subne
Reason: "SubnetNotReady",
},
}
if msg != "" {
newConditions[0].Message = msg
}
r.updateSubnetStatusConditions(ctx, subnet, newConditions)
}

Expand Down Expand Up @@ -237,13 +245,13 @@ func getExistingConditionOfType(conditionType v1alpha1.ConditionType, existingCo
return nil
}

func updateFail(r *SubnetReconciler, c *context.Context, o *v1alpha1.Subnet) {
r.setSubnetReadyStatusFalse(c, o)
func updateFail(r *SubnetReconciler, c *context.Context, o *v1alpha1.Subnet, m string) {
r.setSubnetReadyStatusFalse(c, o, m)
metrics.CounterInc(r.Service.NSXConfig, metrics.ControllerUpdateFailTotal, MetricResTypeSubnet)
}

func deleteFail(r *SubnetReconciler, c *context.Context, o *v1alpha1.Subnet) {
r.setSubnetReadyStatusFalse(c, o)
func deleteFail(r *SubnetReconciler, c *context.Context, o *v1alpha1.Subnet, m string) {
r.setSubnetReadyStatusFalse(c, o, m)
metrics.CounterInc(r.Service.NSXConfig, metrics.ControllerDeleteFailTotal, MetricResTypeSubnet)
}

Expand Down
28 changes: 19 additions & 9 deletions pkg/controllers/subnetset/subnetset_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func (r *SubnetSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
if vpcNetworkConfig == nil {
err := fmt.Errorf("failed to find VPCNetworkConfig for namespace %s", obj.Namespace)
log.Error(err, "operate failed, would retry exponentially", "subnet", req.NamespacedName)
updateFail(r, &ctx, obj)
updateFail(r, &ctx, obj, "")
return ResultRequeue, err
}
if obj.Spec.AccessMode == "" {
Expand All @@ -72,7 +72,7 @@ func (r *SubnetSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
}
if err := r.Client.Update(ctx, obj); err != nil {
log.Error(err, "add finalizer", "subnetset", req.NamespacedName)
updateFail(r, &ctx, obj)
updateFail(r, &ctx, obj, "")
return ResultRequeue, err
}
log.V(1).Info("added finalizer on subnetset CR", "subnetset", req.NamespacedName)
Expand All @@ -91,6 +91,13 @@ func (r *SubnetSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
for k, v := range nsObj.Labels {
tags = append(tags, model.Tag{Scope: servicecommon.String(k), Tag: servicecommon.String(v)})
}
// tags cannot exceed maximum size 26
if len(tags) > servicecommon.TagsCountMax {
errorMsg := fmt.Sprintf("tags cannot exceed maximum size 26, tags length: %d", len(tags))
log.Error(nil, "exceed tags limit, would not retry", "subnet", req.NamespacedName)
updateFail(r, &ctx, obj, errorMsg)
return ResultNormal, nil
}
if err := r.Service.UpdateSubnetSetTags(obj.Namespace, nsxSubnets, tags); err != nil {
log.Error(err, "failed to update subnetset tags")
}
Expand All @@ -101,13 +108,13 @@ func (r *SubnetSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
metrics.CounterInc(r.Service.NSXConfig, metrics.ControllerDeleteTotal, MetricResTypeSubnetSet)
if err := r.DeleteSubnetForSubnetSet(*obj, false); err != nil {
log.Error(err, "deletion failed, would retry exponentially", "subnetset", req.NamespacedName)
deleteFail(r, &ctx, obj)
deleteFail(r, &ctx, obj, "")
return ResultRequeue, err
}
controllerutil.RemoveFinalizer(obj, servicecommon.SubnetSetFinalizerName)
if err := r.Client.Update(ctx, obj); err != nil {
log.Error(err, "deletion failed, would retry exponentially", "subnetset", req.NamespacedName)
deleteFail(r, &ctx, obj)
deleteFail(r, &ctx, obj, "")
return ResultRequeue, err
}
log.V(1).Info("removed finalizer", "subnetset", req.NamespacedName)
Expand All @@ -119,13 +126,13 @@ func (r *SubnetSetReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
return ctrl.Result{}, nil
}

func updateFail(r *SubnetSetReconciler, c *context.Context, o *v1alpha1.SubnetSet) {
r.setSubnetSetReadyStatusFalse(c, o)
func updateFail(r *SubnetSetReconciler, c *context.Context, o *v1alpha1.SubnetSet, m string) {
r.setSubnetSetReadyStatusFalse(c, o, m)
metrics.CounterInc(r.Service.NSXConfig, metrics.ControllerUpdateFailTotal, MetricResTypeSubnetSet)
}

func deleteFail(r *SubnetSetReconciler, c *context.Context, o *v1alpha1.SubnetSet) {
r.setSubnetSetReadyStatusFalse(c, o)
func deleteFail(r *SubnetSetReconciler, c *context.Context, o *v1alpha1.SubnetSet, m string) {
r.setSubnetSetReadyStatusFalse(c, o, m)
metrics.CounterInc(r.Service.NSXConfig, metrics.ControllerDeleteFailTotal, MetricResTypeSubnetSet)
}

Expand All @@ -150,7 +157,7 @@ func (r *SubnetSetReconciler) setSubnetSetReadyStatusTrue(ctx *context.Context,
r.updateSubnetSetStatusConditions(ctx, subnetset, newConditions)
}

func (r *SubnetSetReconciler) setSubnetSetReadyStatusFalse(ctx *context.Context, subnetset *v1alpha1.SubnetSet) {
func (r *SubnetSetReconciler) setSubnetSetReadyStatusFalse(ctx *context.Context, subnetset *v1alpha1.SubnetSet, m string) {
newConditions := []v1alpha1.Condition{
{
Type: v1alpha1.Ready,
Expand All @@ -159,6 +166,9 @@ func (r *SubnetSetReconciler) setSubnetSetReadyStatusFalse(ctx *context.Context,
Reason: "SubnetNotReady",
},
}
if m != "" {
newConditions[0].Message = m
}
r.updateSubnetSetStatusConditions(ctx, subnetset, newConditions)
}

Expand Down
9 changes: 5 additions & 4 deletions pkg/nsx/services/subnet/builder.go
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
package subnet

import (
"fmt"

"github.com/google/uuid"
"github.com/vmware/vsphere-automation-sdk-go/services/nsxt/model"
"sigs.k8s.io/controller-runtime/pkg/client"

"github.com/vmware-tanzu/nsx-operator/pkg/apis/v1alpha1"
"github.com/vmware-tanzu/nsx-operator/pkg/nsx/services/common"
util2 "github.com/vmware-tanzu/nsx-operator/pkg/nsx/util"
"github.com/vmware-tanzu/nsx-operator/pkg/util"
)

Expand Down Expand Up @@ -67,10 +70,8 @@ func (service *SubnetService) buildSubnet(obj client.Object, tags []model.Tag) (
}
// tags cannot exceed maximum size 26
if len(tags) > common.TagsCountMax {
// can't use tags = tags[:common.TagsCountMax] directly, otherwise nsx would report error
newTags := make([]model.Tag, common.TagsCountMax)
copy(newTags, tags[:common.TagsCountMax])
tags = newTags
errorMsg := fmt.Sprintf("tags cannot exceed maximum size 26, tags length: %d", len(tags))
return nil, util2.ExceedTagsError{Desc: errorMsg}
}
nsxSubnet.Tags = tags
nsxSubnet.AdvancedConfig = &model.SubnetAdvancedConfig{
Expand Down
6 changes: 6 additions & 0 deletions pkg/nsx/util/errors.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -574,3 +574,9 @@ type IPBlockAllExhaustedError struct {
func (err IPBlockAllExhaustedError) Error() string {
return err.Desc
}

type ExceedTagsError struct {
Desc string
}

func (err ExceedTagsError) Error() string { return err.Desc }

0 comments on commit d29607e

Please sign in to comment.