env var

akshaysngupta · akshaysngupta · commit 400e248e6b38 · 2024-11-01T01:30:41.000-07:00
diff --git a/cmd/appgw-ingress/main.go b/cmd/appgw-ingress/main.go
@@ -215,7 +215,7 @@ func main() {
 		klog.Fatal(errorLine)
 	}
 
-	if err := cni.ReconcileCNI(context.Background(), azClient, ctrlClient, env.AGICPodNamespace, cpConfig, appGw); err != nil {
+	if err := cni.ReconcileCNI(context.Background(), azClient, ctrlClient, env.AGICPodNamespace, cpConfig, appGw, env.AddonMode); err != nil {
 		if agicPod != nil {
 			recorder.Event(agicPod, v1.EventTypeWarning, events.ReasonFailedCNIConfiguration, err.Error())
 		}
diff --git a/helm/ingress-azure/templates/cleanup-job.yaml b/helm/ingress-azure/templates/cleanup-job.yaml
@@ -31,7 +31,13 @@ spec:
           - "--wait"
           - "-n"
           - "$(AGIC_POD_NAMESPACE)"
-          - "overlayextensionconfigs.acn.azure.com/agic-overlay-extension-config"
+          - "overlayextensionconfigs.acn.azure.com"
+          - "-l"
+{{- if .Values.addon }}
+          - "app.kubernetes.io/managed-by=ingress-azure-addon"
+{{- else }}
+          - "app.kubernetes.io/managed-by=ingress-azure-helm"
+{{- end }}
         securityContext:
           capabilities:
             drop:
diff --git a/helm/ingress-azure/tests/snapshots/sample-config-empty/ingress-azure/templates/cleanup-job.yaml b/helm/ingress-azure/tests/snapshots/sample-config-empty/ingress-azure/templates/cleanup-job.yaml
@@ -33,7 +33,9 @@ spec:
           - "--wait"
           - "-n"
           - "$(AGIC_POD_NAMESPACE)"
-          - "overlayextensionconfigs.acn.azure.com/agic-overlay-extension-config"
+          - "overlayextensionconfigs.acn.azure.com"
+          - "-l"
+          - "app.kubernetes.io/managed-by=ingress-azure-helm"
         securityContext:
           capabilities:
             drop:
diff --git a/helm/ingress-azure/tests/snapshots/sample-config-existing-secret/ingress-azure/templates/cleanup-job.yaml b/helm/ingress-azure/tests/snapshots/sample-config-existing-secret/ingress-azure/templates/cleanup-job.yaml
@@ -33,7 +33,9 @@ spec:
           - "--wait"
           - "-n"
           - "$(AGIC_POD_NAMESPACE)"
-          - "overlayextensionconfigs.acn.azure.com/agic-overlay-extension-config"
+          - "overlayextensionconfigs.acn.azure.com"
+          - "-l"
+          - "app.kubernetes.io/managed-by=ingress-azure-helm"
         securityContext:
           capabilities:
             drop:
diff --git a/helm/ingress-azure/tests/snapshots/sample-config-prohibited-target/ingress-azure/templates/cleanup-job.yaml b/helm/ingress-azure/tests/snapshots/sample-config-prohibited-target/ingress-azure/templates/cleanup-job.yaml
@@ -33,7 +33,9 @@ spec:
           - "--wait"
           - "-n"
           - "$(AGIC_POD_NAMESPACE)"
-          - "overlayextensionconfigs.acn.azure.com/agic-overlay-extension-config"
+          - "overlayextensionconfigs.acn.azure.com"
+          - "-l"
+          - "app.kubernetes.io/managed-by=ingress-azure-helm"
         securityContext:
           capabilities:
             drop:
diff --git a/helm/ingress-azure/tests/snapshots/sample-config-workload-identity/ingress-azure/templates/cleanup-job.yaml b/helm/ingress-azure/tests/snapshots/sample-config-workload-identity/ingress-azure/templates/cleanup-job.yaml
@@ -33,7 +33,9 @@ spec:
           - "--wait"
           - "-n"
           - "$(AGIC_POD_NAMESPACE)"
-          - "overlayextensionconfigs.acn.azure.com/agic-overlay-extension-config"
+          - "overlayextensionconfigs.acn.azure.com"
+          - "-l"
+          - "app.kubernetes.io/managed-by=ingress-azure-helm"
         securityContext:
           capabilities:
             drop:
diff --git a/helm/ingress-azure/tests/snapshots/sample-config/ingress-azure/templates/cleanup-job.yaml b/helm/ingress-azure/tests/snapshots/sample-config/ingress-azure/templates/cleanup-job.yaml
@@ -33,7 +33,9 @@ spec:
           - "--wait"
           - "-n"
           - "$(AGIC_POD_NAMESPACE)"
-          - "overlayextensionconfigs.acn.azure.com/agic-overlay-extension-config"
+          - "overlayextensionconfigs.acn.azure.com"
+          - "-l"
+          - "app.kubernetes.io/managed-by=ingress-azure-helm"
         securityContext:
           capabilities:
             drop:
diff --git a/helm/ingress-azure/values.yaml b/helm/ingress-azure/values.yaml
@@ -120,3 +120,7 @@ nodeSelector: {}
 # Specify if the cluster is RBAC enabled or not
 rbac:
   enabled: false # true/false
+
+################################################################################
+# Specify if the controller is running as an addon.
+addon: false # true/false
diff --git a/pkg/cni/cni.go b/pkg/cni/cni.go
@@ -15,13 +15,15 @@ type Reconciler struct {
 	armClient azure.AzClient
 	client    client.Client
 	namespace string
+	addonMode bool
 }
 
-func ReconcileCNI(ctx context.Context, armClient azure.AzClient, client client.Client, namespace string, cpConfig *azure.CloudProviderConfig, appGw n.ApplicationGateway) error {
+func ReconcileCNI(ctx context.Context, armClient azure.AzClient, client client.Client, namespace string, cpConfig *azure.CloudProviderConfig, appGw n.ApplicationGateway, addonMode bool) error {
 	r := &Reconciler{
 		armClient: armClient,
 		client:    client,
 		namespace: namespace,
+		addonMode: addonMode,
 	}
 
 	return r.Reconcile(ctx, cpConfig, appGw)
diff --git a/pkg/cni/kubenet_test.go b/pkg/cni/kubenet_test.go
@@ -52,7 +52,7 @@ var _ = Describe("Kubenet CNI", func() {
 				SubscriptionID:          "test-sub",
 				RouteTableResourceGroup: "test-rg",
 				RouteTableName:          "test-rt",
-			}, appGw)
+			}, appGw, false)
 			Expect(err).To(BeNil())
 		})
 
@@ -64,7 +64,7 @@ var _ = Describe("Kubenet CNI", func() {
 
 			err := cni.ReconcileCNI(ctx, azClient, k8sClient, "test", &azure.CloudProviderConfig{
 				RouteTableName: "",
-			}, appGw)
+			}, appGw, false)
 			Expect(err).To(BeNil())
 		})
 	})
diff --git a/pkg/cni/overlay.go b/pkg/cni/overlay.go
@@ -13,6 +13,12 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
+const (
+	ResourceManagedByLabel      = "app.kubernetes.io/managed-by"
+	ResourceManagedByAddonValue = "ingress-appgw-addon"
+	ResourceManagedByHelmValue  = "ingress-appgw-helm"
+)
+
 const (
 	// OverlayExtensionConfigName is the name of the overlay extension config resource
 	OverlayExtensionConfigName = "agic-overlay-extension-config"
@@ -66,10 +72,18 @@ func (r *Reconciler) reconcileOverlayExtensionConfig(ctx context.Context, subnet
 			return errors.Wrap(err, "failed to get overlay extension config")
 		}
 
+		managedByValue := ResourceManagedByHelmValue
+		if r.addonMode {
+			managedByValue = ResourceManagedByAddonValue
+		}
+
 		config = overlayextensionconfig_v1alpha1.OverlayExtensionConfig{
 			ObjectMeta: meta_v1.ObjectMeta{
 				Name:      OverlayExtensionConfigName,
 				Namespace: r.namespace,
+				Labels: map[string]string{
+					ResourceManagedByLabel: managedByValue,
+				},
 			},
 			Spec: overlayextensionconfig_v1alpha1.OverlayExtensionConfigSpec{
 				ExtensionIPRange: subnetCIDR,
diff --git a/pkg/cni/overlay_test.go b/pkg/cni/overlay_test.go
@@ -61,7 +61,7 @@ var _ = Describe("Overlay CNI", func() {
 	})
 
 	Context("reconcileOverlayCniIfNeeded", func() {
-		It("should apply route table", func() {
+		It("should create overlay extension config with addon if controller is addon", func() {
 			azClient.GetSubnetFunc = func(subnetID string) (n.Subnet, error) {
 				return n.Subnet{
 					SubnetPropertiesFormat: &n.SubnetPropertiesFormat{
@@ -70,7 +70,7 @@ var _ = Describe("Overlay CNI", func() {
 				}, nil
 			}
 
-			err := cni.ReconcileCNI(context.TODO(), azClient, k8sClient, namespace, nil, appGw)
+			err := cni.ReconcileCNI(context.TODO(), azClient, k8sClient, namespace, nil, appGw, true)
 			Expect(err).To(BeNil())
 
 			var config overlayextensionconfig_v1alpha1.OverlayExtensionConfig
@@ -80,6 +80,32 @@ var _ = Describe("Overlay CNI", func() {
 			}, &config)
 			Expect(err).To(BeNil())
 
+			Expect(config.Labels).To(HaveLen(1))
+			Expect(config.Labels[cni.ResourceManagedByLabel]).To(Equal(cni.ResourceManagedByAddonValue))
+			Expect(config.Spec.ExtensionIPRange).To(Equal(subnetCIDR))
+		})
+
+		It("should create overlay extension config with addon if controller is addon", func() {
+			azClient.GetSubnetFunc = func(subnetID string) (n.Subnet, error) {
+				return n.Subnet{
+					SubnetPropertiesFormat: &n.SubnetPropertiesFormat{
+						AddressPrefix: to.StringPtr(subnetCIDR),
+					},
+				}, nil
+			}
+
+			err := cni.ReconcileCNI(context.TODO(), azClient, k8sClient, namespace, nil, appGw, false)
+			Expect(err).To(BeNil())
+
+			var config overlayextensionconfig_v1alpha1.OverlayExtensionConfig
+			err = k8sClient.Get(ctx, ctrl_client.ObjectKey{
+				Name:      cni.OverlayExtensionConfigName,
+				Namespace: namespace,
+			}, &config)
+			Expect(err).To(BeNil())
+
+			Expect(config.Labels).To(HaveLen(1))
+			Expect(config.Labels[cni.ResourceManagedByLabel]).To(Equal(cni.ResourceManagedByHelmValue))
 			Expect(config.Spec.ExtensionIPRange).To(Equal(subnetCIDR))
 		})
 
@@ -88,7 +114,7 @@ var _ = Describe("Overlay CNI", func() {
 				return n.Subnet{}, errors.New("failed to get subnet")
 			}
 
-			err := cni.ReconcileCNI(context.TODO(), azClient, k8sClient, namespace, nil, appGw)
+			err := cni.ReconcileCNI(context.TODO(), azClient, k8sClient, namespace, nil, appGw, false)
 			Expect(err).ToNot(BeNil())
 		})
 	})
diff --git a/pkg/environment/environment.go b/pkg/environment/environment.go
@@ -112,6 +112,9 @@ const (
 
 	// MultiClusterModeVarName is an environment variable to control whether AGIC monitors Ingresses or MutliClusterIngresses
 	MultiClusterModeVarName = "MULTI_CLUSTER_MODE"
+
+	// AddonModeVarName is an environment variable to inform if the controller is running as an addon.
+	AddonModeVarName = "ADDON_MODE"
 )
 
 const (
@@ -162,6 +165,7 @@ type EnvVariables struct {
 	HostedOnUnderlay            bool
 	ReconcilePeriodSeconds      string
 	MultiClusterMode            bool
+	AddonMode					bool
 }
 
 // Consolidate sets defaults and missing values using cpConfig
@@ -241,6 +245,7 @@ func GetEnv() EnvVariables {
 		HostedOnUnderlay:            GetEnvironmentVariable(HostedOnUnderlayVarName, "false", boolValidator) == "true",
 		ReconcilePeriodSeconds:      os.Getenv(ReconcilePeriodSecondsVarName),
 		MultiClusterMode:            multiClusterMode,
+		AddonMode: 					 GetEnvironmentVariable(AddonModeVarName, "false", boolValidator) == "true",
 	}
 
 	return env

Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ func main() {`
`215`	`215`	`klog.Fatal(errorLine)`
`216`	`216`	`}`
`217`	`217`
`218`		`- if err := cni.ReconcileCNI(context.Background(), azClient, ctrlClient, env.AGICPodNamespace, cpConfig, appGw); err != nil {`
	`218`	`+ if err := cni.ReconcileCNI(context.Background(), azClient, ctrlClient, env.AGICPodNamespace, cpConfig, appGw, env.AddonMode); err != nil {`
`219`	`219`	`if agicPod != nil {`
`220`	`220`	`recorder.Event(agicPod, v1.EventTypeWarning, events.ReasonFailedCNIConfiguration, err.Error())`
`221`	`221`	`}`