Skip to content

Commit dfd48b9

Browse files
piyush-tiwaripiyush-tiwari
committed
add default tag support for IngressClass
1 parent 50589fd commit dfd48b9

File tree

4 files changed

+300
-7
lines changed

4 files changed

+300
-7
lines changed

‎pkg/controllers/ingressclass/ingressclass.go‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,13 @@ func (c *Controller) createLoadBalancer(ctx context.Context, ic *networkingv1.In
357357
return nil, err
358358
}
359359

360+
defaultTags := getImplicitDefaultTagsForNewLoadBalancer(lb.DefinedTags, definedTags)
361+
klog.Infof("Back-filling default tags %+v in LB %s for IC %s", defaultTags, *lb.Id, ic.Name)
362+
err = updateImplicitDefaultTagsAnnotation(wrapperClient.GetK8Client(), ic, defaultTags)
363+
if err != nil {
364+
return nil, fmt.Errorf("unable to update implicit-default-tags for IC %s: %w", ic.Name, err)
365+
}
366+
360367
return lb, nil
361368
}
362369

@@ -392,21 +399,34 @@ func (c *Controller) checkForIngressClassParameterUpdates(ctx context.Context, i
392399

393400
// check LoadBalancerName, Defined and Freeform tags
394401
displayName := util.GetIngressClassLoadBalancerName(ic, icp)
395-
definedTags, err := util.GetIngressClassDefinedTags(ic)
402+
implicitDefaultTags, err := util.GetIngressClassImplicitDefaultTags(ic)
396403
if err != nil {
397404
return err
398405
}
406+
407+
definedTags, updatedImplicitDefaultTags, err := getUpdatedDefinedAndImplicitDefaultTags(lb.DefinedTags, ic)
408+
if err != nil {
409+
return err
410+
}
411+
399412
freeformTags, err := util.GetIngressClassFreeformTags(ic)
400413
if err != nil {
401414
return err
402415
}
403416

404-
if *lb.DisplayName != displayName || !reflect.DeepEqual(lb.DefinedTags, definedTags) || !reflect.DeepEqual(lb.FreeformTags, freeformTags) {
417+
if *lb.DisplayName != displayName || !isDefinedTagsEqual(lb.DefinedTags, definedTags) || !reflect.DeepEqual(lb.FreeformTags, freeformTags) {
405418
_, err = wrapperClient.GetLbClient().UpdateLoadBalancer(context.Background(), *lb.Id, displayName, definedTags, freeformTags)
406419
if err != nil {
407420
return err
408421
}
422+
}
409423

424+
if !isDefinedTagsEqual(implicitDefaultTags, updatedImplicitDefaultTags) {
425+
klog.Infof("Updating implicit default tags %+v in LB %s for IC %s", updatedImplicitDefaultTags, *lb.Id, ic.Name)
426+
err = updateImplicitDefaultTagsAnnotation(wrapperClient.GetK8Client(), ic, updatedImplicitDefaultTags)
427+
if err != nil {
428+
return err
429+
}
410430
}
411431

412432
// refresh lb, etag information after last call

‎pkg/controllers/ingressclass/util.go‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
/*
2+
*
3+
* * OCI Native Ingress Controller
4+
* *
5+
* * Copyright (c) 2024 Oracle America, Inc. and its affiliates.
6+
* * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
7+
*
8+
*/
9+
10+
package ingressclass
11+
12+
import (
13+
"encoding/json"
14+
"github.com/oracle/oci-native-ingress-controller/pkg/util"
15+
networkingv1 "k8s.io/api/networking/v1"
16+
"k8s.io/client-go/kubernetes"
17+
"k8s.io/klog/v2"
18+
"reflect"
19+
"strings"
20+
)
21+
22+
func isDefinedTagsEqual(dt1, dt2 util.DefinedTagsType) bool {
23+
return reflect.DeepEqual(getLowerCaseDefinedTags(dt1), getLowerCaseDefinedTags(dt2))
24+
}
25+
26+
func getImplicitDefaultTagsForNewLoadBalancer(actualDefinedTags, suppliedDefinedTags util.DefinedTagsType) util.DefinedTagsType {
27+
defaultTags := util.DefinedTagsType{}
28+
lowerCaseSuppliedDefinedTags := getLowerCaseDefinedTags(suppliedDefinedTags)
29+
30+
klog.Infof("Calculating implicit default tags where actualTags: %+v, suppliedTags: %+v",
31+
actualDefinedTags, suppliedDefinedTags)
32+
33+
for namespace, _ := range actualDefinedTags {
34+
for key, value := range actualDefinedTags[namespace] {
35+
if !containsDefinedTagIgnoreCase(lowerCaseSuppliedDefinedTags, namespace, key) {
36+
insertDefinedTag(defaultTags, namespace, key, value)
37+
}
38+
}
39+
}
40+
41+
return defaultTags
42+
}
43+
44+
func getUpdatedDefinedAndImplicitDefaultTags(actualTags util.DefinedTagsType,
45+
ic *networkingv1.IngressClass) (util.DefinedTagsType, util.DefinedTagsType, error) {
46+
updatedDefinedTags := util.DefinedTagsType{}
47+
updatedDefaultTags := util.DefinedTagsType{}
48+
49+
definedTags, err := util.GetIngressClassDefinedTags(ic)
50+
if err != nil {
51+
return nil, nil, err
52+
}
53+
54+
defaultTags, err := util.GetIngressClassImplicitDefaultTags(ic)
55+
if err != nil {
56+
return nil, nil, err
57+
}
58+
59+
klog.Infof("Calculating defined/default tags where actualTags: %+v, suppliedDefinedTags: %+v, implicitDefaultTags: %+v",
60+
actualTags, definedTags, defaultTags)
61+
62+
// Preserve default tags
63+
lcDefinedTags := getLowerCaseDefinedTags(definedTags)
64+
lcDefaultTags := getLowerCaseDefinedTags(defaultTags)
65+
for namespace, _ := range actualTags {
66+
for key, value := range actualTags[namespace] {
67+
if !containsDefinedTagIgnoreCase(lcDefinedTags, namespace, key) &&
68+
containsDefinedTagIgnoreCase(lcDefaultTags, namespace, key) {
69+
insertDefinedTag(updatedDefinedTags, namespace, key, value)
70+
insertDefinedTag(updatedDefaultTags, namespace, key, value)
71+
}
72+
}
73+
}
74+
75+
// Add supplied defined tags
76+
// We use only lower-case (namespace, key) pairs to avoid case-related conflicts
77+
lcUpdatedDefinedTags := getLowerCaseDefinedTags(updatedDefinedTags)
78+
for namespace, _ := range lcDefinedTags {
79+
for key, value := range lcDefinedTags[namespace] {
80+
insertDefinedTag(lcUpdatedDefinedTags, namespace, key, value)
81+
}
82+
}
83+
84+
klog.Infof("Calculated defined/default tags for IngressClass %s: definedTags: %+v, implicitDefaultTags: %+v",
85+
ic.Name, lcUpdatedDefinedTags, updatedDefaultTags)
86+
return lcUpdatedDefinedTags, updatedDefaultTags, nil
87+
}
88+
89+
func updateImplicitDefaultTagsAnnotation(client kubernetes.Interface, ic *networkingv1.IngressClass,
90+
defaultTags util.DefinedTagsType) error {
91+
defaultTagsBytes, err := json.Marshal(defaultTags)
92+
if err != nil {
93+
return err
94+
}
95+
96+
patchError, notComplete := util.PatchIngressClassWithAnnotation(client, ic,
97+
util.IngressClassImplicitDefaultTagsAnnotation, string(defaultTagsBytes))
98+
if notComplete {
99+
return patchError
100+
}
101+
102+
return nil
103+
}
104+
105+
func getLowerCaseDefinedTags(tags util.DefinedTagsType) util.DefinedTagsType {
106+
lowerCaseTags := util.DefinedTagsType{}
107+
108+
for k, _ := range tags {
109+
lowerCaseTags[strings.ToLower(k)] = map[string]interface{}{}
110+
for ik, iv := range tags[k] {
111+
lowerCaseTags[strings.ToLower(k)][strings.ToLower(ik)] = iv
112+
}
113+
}
114+
115+
return lowerCaseTags
116+
}
117+
118+
func containsDefinedTagIgnoreCase(lowerCaseTags util.DefinedTagsType, namespace string, key string) bool {
119+
if lowerCaseTags == nil {
120+
return false
121+
}
122+
123+
containsNamespace := false
124+
containsKey := false
125+
126+
_, containsNamespace = lowerCaseTags[strings.ToLower(namespace)]
127+
if containsNamespace {
128+
_, containsKey = lowerCaseTags[strings.ToLower(namespace)][strings.ToLower(key)]
129+
}
130+
131+
return containsNamespace && containsKey
132+
}
133+
134+
func insertDefinedTag(definedTags util.DefinedTagsType, namespace string, key string, value interface{}) {
135+
if definedTags == nil {
136+
return
137+
}
138+
139+
_, ok := definedTags[namespace]
140+
if !ok {
141+
definedTags[namespace] = map[string]interface{}{}
142+
}
143+
144+
definedTags[namespace][key] = value
145+
}

‎pkg/controllers/ingressclass/util_test.go‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/*
2+
*
3+
* * OCI Native Ingress Controller
4+
* *
5+
* * Copyright (c) 2024 Oracle America, Inc. and its affiliates.
6+
* * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
7+
*
8+
*/
9+
10+
package ingressclass
11+
12+
import (
13+
. "github.com/onsi/gomega"
14+
"github.com/oracle/oci-native-ingress-controller/pkg/util"
15+
networkingv1 "k8s.io/api/networking/v1"
16+
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
17+
"testing"
18+
)
19+
20+
func TestIsDefinedTagsEqual(t *testing.T) {
21+
RegisterTestingT(t)
22+
23+
emptyTags := util.DefinedTagsType{}
24+
dt1 := util.DefinedTagsType{"N1": {"k1": "v1"}, "n2": {"K2": "V2", "k3": "v3"}}
25+
dt2 := util.DefinedTagsType{"n1": {"K1": "v1"}, "N2": {"k2": "V2", "K3": "v3"}}
26+
dt3 := util.DefinedTagsType{"n1": {"k1": "v1"}, "n2": {"k2": "v2", "k3": "v3"}}
27+
28+
Expect(isDefinedTagsEqual(nil, emptyTags)).Should(BeTrue())
29+
Expect(isDefinedTagsEqual(dt1, dt2)).Should(BeTrue())
30+
Expect(isDefinedTagsEqual(dt1, dt3)).Should(BeFalse())
31+
Expect(isDefinedTagsEqual(dt2, dt3)).Should(BeFalse())
32+
}
33+
34+
func TestGetImplicitDefaultTagsForNewLoadBalancer(t *testing.T) {
35+
RegisterTestingT(t)
36+
37+
actualDefinedTags := util.DefinedTagsType{"n1": {"k1": "v1", "KI1": "vi1"}, "n2": {"k2": "V2", "K3": "v3"}, "n3": {"k4": "v4"}}
38+
suppliedDefinedTags := util.DefinedTagsType{"N1": {"k1": "v1"}, "n2": {"K2": "V2", "k3": "v3"}}
39+
expectedImplicitDefaultTags := util.DefinedTagsType{"n1": {"KI1": "vi1"}, "n3": {"k4": "v4"}}
40+
41+
Expect(expectedImplicitDefaultTags).Should(Equal(getImplicitDefaultTagsForNewLoadBalancer(actualDefinedTags, suppliedDefinedTags)))
42+
}
43+
44+
func TestGetUpdatedDefinedAndImplicitDefaultTags(t *testing.T) {
45+
RegisterTestingT(t)
46+
47+
actualTags := util.DefinedTagsType{"n1": {"k1": "v1", "KI1": "vi1"}, "n2": {"K2": "V2", "k3": "v3"}, "n3": {"K4": "v5"}}
48+
49+
ingressClass := &networkingv1.IngressClass{
50+
ObjectMeta: v1.ObjectMeta{
51+
Annotations: map[string]string{
52+
util.IngressClassDefinedTagsAnnotation: `{"n1": {"k1": "v1"}, "N2": {"k2": "v3", "K3": "V3"}}`,
53+
util.IngressClassImplicitDefaultTagsAnnotation: `{"n1": {"KI1": "vi1"}, "n2": {"K2": "V2"}, "n3": {"k4": "V4"}}`,
54+
},
55+
},
56+
}
57+
58+
expectedDefinedTags := util.DefinedTagsType{"n1": {"k1": "v1", "ki1": "vi1"}, "n2": {"k2": "v3", "k3": "V3"}, "n3": {"k4": "v5"}}
59+
expectedDefaultTags := util.DefinedTagsType{"n1": {"KI1": "vi1"}, "n3": {"K4": "v5"}}
60+
61+
definedTags, defaultTags, err := getUpdatedDefinedAndImplicitDefaultTags(actualTags, ingressClass)
62+
Expect(err).To(BeNil())
63+
Expect(expectedDefinedTags).Should(Equal(definedTags))
64+
Expect(expectedDefaultTags).Should(Equal(defaultTags))
65+
}
66+
67+
func TestGetLowerCaseDefinedTags(t *testing.T) {
68+
RegisterTestingT(t)
69+
70+
emptyTags := util.DefinedTagsType{}
71+
definedTags := util.DefinedTagsType{"N1": {"k1": "v1"}, "n2": {"K2": "V2", "k3": "v3"}}
72+
expectedTags := util.DefinedTagsType{"n1": {"k1": "v1"}, "n2": {"k2": "V2", "k3": "v3"}}
73+
74+
Expect(getLowerCaseDefinedTags(nil)).Should(Equal(emptyTags))
75+
Expect(getLowerCaseDefinedTags(definedTags)).Should(Equal(expectedTags))
76+
}
77+
78+
func TestContainsDefinedTagIgnoreCase(t *testing.T) {
79+
RegisterTestingT(t)
80+
81+
definedTags := util.DefinedTagsType{"n1": {"k1": "v1"}, "n2": {"k2": "V2", "k3": "v3"}}
82+
83+
Expect(containsDefinedTagIgnoreCase(nil, "namespace", "key")).Should(BeFalse())
84+
Expect(containsDefinedTagIgnoreCase(definedTags, "N1", "k1")).Should(BeTrue())
85+
Expect(containsDefinedTagIgnoreCase(definedTags, "n2", "K3")).Should(BeTrue())
86+
Expect(containsDefinedTagIgnoreCase(definedTags, "n4", "k1")).Should(BeFalse())
87+
Expect(containsDefinedTagIgnoreCase(definedTags, "n2", "k1")).Should(BeFalse())
88+
}
89+
90+
func TestInsertDefinedTag(t *testing.T) {
91+
RegisterTestingT(t)
92+
93+
definedtags := util.DefinedTagsType{}
94+
insertDefinedTag(definedtags, "n1", "k1", "v1")
95+
insertDefinedTag(definedtags, "n1", "K2", "V2")
96+
insertDefinedTag(definedtags, "N2", "k3", "v3")
97+
insertDefinedTag(definedtags, "n1", "k4", "V4")
98+
99+
expectedTags := util.DefinedTagsType{"n1": {"k1": "v1", "K2": "V2", "k4": "V4"}, "N2": {"k3": "v3"}}
100+
Expect(expectedTags).Should(Equal(definedtags))
101+
}

‎pkg/util/util.go‎

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ const (
7070
IngressClassDeleteProtectionEnabledAnnotation = "oci-native-ingress.oraclecloud.com/delete-protection-enabled"
7171
IngressClassDefinedTagsAnnotation = "oci-native-ingress.oraclecloud.com/defined-tags"
7272
IngressClassFreeformTagsAnnotation = "oci-native-ingress.oraclecloud.com/freeform-tags"
73+
IngressClassImplicitDefaultTagsAnnotation = "oci-native-ingress.oraclecloud.com/implicit-default-tags"
7374

7475
IngressHealthCheckProtocolAnnotation = "oci-native-ingress.oraclecloud.com/healthcheck-protocol"
7576
IngressHealthCheckPortAnnotation = "oci-native-ingress.oraclecloud.com/healthcheck-port"
@@ -104,6 +105,8 @@ const (
104105
WrapperClient = "wrapperClient"
105106
)
106107

108+
type DefinedTagsType = map[string]map[string]interface{}
109+
107110
var ErrIngressClassNotReady = errors.New("ingress class not ready")
108111

109112
func GetIngressClassCompartmentId(p *v1beta1.IngressClassParameters, defaultCompartment string) string {
@@ -191,13 +194,13 @@ func GetIngressClassDeleteProtectionEnabled(ic *networkingv1.IngressClass) bool
191194
return result
192195
}
193196

194-
func GetIngressClassDefinedTags(ic *networkingv1.IngressClass) (map[string]map[string]interface{}, error) {
197+
func GetIngressClassDefinedTags(ic *networkingv1.IngressClass) (DefinedTagsType, error) {
195198
annotation := IngressClassDefinedTagsAnnotation
196199
value, ok := ic.Annotations[annotation]
197200

198201
// value of defined tags can only be strings for now, but we will allow anything that fits the type
199202
// specified by LoadBalancer.DefinedTags
200-
definedTags := map[string]map[string]interface{}{}
203+
definedTags := DefinedTagsType{}
201204

202205
if !ok || strings.TrimSpace(value) == "" {
203206
return definedTags, nil
@@ -211,6 +214,24 @@ func GetIngressClassDefinedTags(ic *networkingv1.IngressClass) (map[string]map[s
211214
return definedTags, nil
212215
}
213216

217+
func GetIngressClassImplicitDefaultTags(ic *networkingv1.IngressClass) (DefinedTagsType, error) {
218+
annotation := IngressClassImplicitDefaultTagsAnnotation
219+
value, ok := ic.Annotations[annotation]
220+
221+
defaultTags := DefinedTagsType{}
222+
223+
if !ok || strings.TrimSpace(value) == "" {
224+
return defaultTags, nil
225+
}
226+
227+
err := json.Unmarshal([]byte(value), &defaultTags)
228+
if err != nil {
229+
return nil, fmt.Errorf("error parsing value %s for annotation %s: %w", value, annotation, err)
230+
}
231+
232+
return defaultTags, nil
233+
}
234+
214235
func GetIngressClassFreeformTags(ic *networkingv1.IngressClass) (map[string]string, error) {
215236
annotation := IngressClassFreeformTagsAnnotation
216237
value, ok := ic.Annotations[annotation]
@@ -552,10 +573,16 @@ func GetTimeDifferenceInSeconds(startTime, endTime int64) float64 {
552573
}
553574

554575
func PatchIngressClassWithAnnotation(client kubernetes.Interface, ic *networkingv1.IngressClass, annotationName string, annotationValue string) (error, bool) {
576+
patchMap := map[string]map[string]map[string]string{
577+
"metadata": {"annotations": {annotationName: annotationValue}},
578+
}
579+
patchBytes, err := json.Marshal(patchMap)
580+
if err != nil {
581+
return err, true
582+
}
555583

556-
patchBytes := []byte(fmt.Sprintf(`{"metadata":{"annotations":{"%s":"%s"}}}`, annotationName, annotationValue))
557-
558-
err := retry.RetryOnConflict(retry.DefaultBackoff, func() error {
584+
klog.Infof("Will try patching IngressClass %s for annotation %s: %s", ic.Name, annotationName, annotationValue)
585+
err = retry.RetryOnConflict(retry.DefaultBackoff, func() error {
559586
_, err := client.NetworkingV1().IngressClasses().Patch(context.TODO(), ic.Name, types.StrategicMergePatchType, patchBytes, metav1.PatchOptions{})
560587
return err
561588
})

0 commit comments

Comments
 (0)