• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

Azure / aks-app-routing-operator / 16654906631

31 Jul 2025 04:43PM UTC coverage: 81.322% (-0.07%) from 81.389%
16654906631

push

github

OliverMKing
fix tests

4010 of 4931 relevant lines covered (81.32%)

23.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

42.44
/pkg/controller/controller.go
1
// Copyright (c) Microsoft Corporation.
2
// Licensed under the MIT License.
3

4
package controller
5

6
import (
7
        "context"
8
        "fmt"
9
        "net/http"
10

11
        approutingv1alpha1 "github.com/Azure/aks-app-routing-operator/api/v1alpha1"
12
        "github.com/Azure/aks-app-routing-operator/pkg/controller/defaultdomaincert"
13
        placeholderpod "github.com/Azure/aks-app-routing-operator/pkg/controller/keyvault/placeholderpod"
14
        "github.com/Azure/aks-app-routing-operator/pkg/controller/keyvault/spc"
15
        "github.com/Azure/aks-app-routing-operator/pkg/controller/nginxingress"
16
        "github.com/Azure/aks-app-routing-operator/pkg/controller/service"
17
        "github.com/Azure/aks-app-routing-operator/pkg/store"
18
        "github.com/Azure/aks-app-routing-operator/pkg/util"
19
        "github.com/go-logr/logr"
20
        cfgv1alpha2 "github.com/openservicemesh/osm/pkg/apis/config/v1alpha2"
21
        policyv1alpha1 "github.com/openservicemesh/osm/pkg/apis/policy/v1alpha1"
22
        ubzap "go.uber.org/zap"
23
        appsv1 "k8s.io/api/apps/v1"
24
        corev1 "k8s.io/api/core/v1"
25
        netv1 "k8s.io/api/networking/v1"
26
        apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
27
        "k8s.io/apimachinery/pkg/api/errors"
28
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
29
        "k8s.io/apimachinery/pkg/runtime"
30
        utilruntime "k8s.io/apimachinery/pkg/util/runtime"
31
        "k8s.io/client-go/kubernetes"
32
        clientgoscheme "k8s.io/client-go/kubernetes/scheme"
33
        "k8s.io/client-go/rest"
34
        "k8s.io/klog/v2"
35
        ctrl "sigs.k8s.io/controller-runtime"
36
        "sigs.k8s.io/controller-runtime/pkg/cache"
37
        "sigs.k8s.io/controller-runtime/pkg/client"
38
        "sigs.k8s.io/controller-runtime/pkg/log/zap"
39
        metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
40
        gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
41
        secv1 "sigs.k8s.io/secrets-store-csi-driver/apis/v1"
42

43
        "github.com/Azure/aks-app-routing-operator/pkg/config"
44
        "github.com/Azure/aks-app-routing-operator/pkg/controller/dns"
45
        "github.com/Azure/aks-app-routing-operator/pkg/controller/ingress"
46
        "github.com/Azure/aks-app-routing-operator/pkg/controller/osm"
47
)
48

49
var scheme = runtime.NewScheme()
50

51
const (
52
        nicIngressClassIndex     = "spec.ingressClassName"
53
        gatewayListenerIndexName = "spec.listeners.tls.options.kubernetes.azure.com/tls-cert-service-account"
54
)
55

56
func init() {
1✔
57
        registerSchemes(scheme)
1✔
58
        ctrl.SetLogger(getLogger())
1✔
59
        // need to set klog logger to same logger to get consistent logging format for all logs.
1✔
60
        // without this things like leader election that use klog will not have the same format.
1✔
61
        // https://github.com/kubernetes/client-go/blob/560efb3b8995da3adcec09865ca78c1ddc917cc9/tools/leaderelection/leaderelection.go#L250
1✔
62
        klog.SetLogger(getLogger())
1✔
63
}
1✔
64

65
func getLogger(opts ...zap.Opts) logr.Logger {
3✔
66
        // use raw opts to add caller info to logs
3✔
67
        rawOpts := zap.RawZapOpts(ubzap.AddCaller())
3✔
68

3✔
69
        // zap is the default recommended logger for controller-runtime when wanting json structured output
3✔
70
        return zap.New(append(opts, rawOpts)...)
3✔
71
}
3✔
72

73
func registerSchemes(s *runtime.Scheme) {
1✔
74
        utilruntime.Must(clientgoscheme.AddToScheme(s))
1✔
75
        utilruntime.Must(secv1.Install(s))
1✔
76
        utilruntime.Must(cfgv1alpha2.AddToScheme(s))
1✔
77
        utilruntime.Must(policyv1alpha1.AddToScheme(s))
1✔
78
        utilruntime.Must(approutingv1alpha1.AddToScheme(s))
1✔
79
        utilruntime.Must(apiextensionsv1.AddToScheme(s))
1✔
80
        utilruntime.Must(gatewayv1.Install(s))
1✔
81
}
1✔
82

83
func NewRestConfig(conf *config.Config) *rest.Config {
×
84
        rc := ctrl.GetConfigOrDie()
×
85
        if conf.ServiceAccountTokenPath != "" {
×
86
                rc.BearerTokenFile = conf.ServiceAccountTokenPath
×
87
        }
×
88

89
        return rc
×
90
}
91

92
func NewManagerForRestConfig(conf *config.Config, rc *rest.Config) (ctrl.Manager, error) {
×
93
        // client creates ListWatch cache for all resources that are
×
94
        // GET or LISTed. this uses too much memory on large clusters.
×
95
        var clientOpts *client.CacheOptions
×
96
        cacheOpts := cache.Options{}
×
97
        if conf.DisableExpensiveCache {
×
98
                clientOpts = &client.CacheOptions{
×
99
                        // we only interact with a small subset of pods
×
100
                        // but there's no good filter to only cache the pods we care about
×
101
                        // so we disable caching them for now.
×
102
                        DisableFor: []client.Object{&corev1.Pod{}},
×
103
                }
×
104

×
105
                cacheOpts.ByObject = map[client.Object]cache.ByObject{
×
106
                        &corev1.Event{}: {
×
107
                                Field: placeholderpod.EventMirrorSelector,
×
108
                        },
×
109
                }
×
110
        }
×
111

112
        m, err := ctrl.NewManager(rc, ctrl.Options{
×
113
                Metrics:                metricsserver.Options{BindAddress: conf.MetricsAddr},
×
114
                HealthProbeBindAddress: conf.ProbeAddr,
×
115
                Scheme:                 scheme,
×
116

×
117
                // we use an active-passive HA model meaning only the leader performs actions
×
118
                LeaderElection:          true,
×
119
                LeaderElectionNamespace: "kube-system",
×
120
                LeaderElectionID:        "aks-app-routing-operator-leader",
×
121

×
122
                Client: client.Options{Cache: clientOpts},
×
123
                Cache:  cacheOpts,
×
124
        })
×
125
        if err != nil {
×
126
                return nil, fmt.Errorf("creating manager: %w", err)
×
127
        }
×
128

129
        storeLog := m.GetLogger().WithName("store")
×
130
        store, err := store.New(storeLog, context.Background())
×
131
        if err != nil {
×
132
                return nil, fmt.Errorf("creating store: %w", err)
×
133
        }
×
134

135
        setupLog := m.GetLogger().WithName("setup")
×
136
        if err := setupProbes(conf, m, setupLog); err != nil {
×
137
                setupLog.Error(err, "failed to set up probes")
×
138
                return nil, fmt.Errorf("setting up probes: %w", err)
×
139
        }
×
140

141
        // create non-caching clients, non-caching for use before manager has started
142
        cl, err := client.New(rc, client.Options{Scheme: scheme})
×
143
        if err != nil {
×
144
                setupLog.Error(err, "unable to create non-caching client")
×
145
                return nil, fmt.Errorf("creating non-caching client: %w", err)
×
146
        }
×
147

148
        if err := loadCRDs(cl, conf, setupLog); err != nil {
×
149
                setupLog.Error(err, "failed to load CRDs")
×
150
                return nil, fmt.Errorf("loading CRDs: %w", err)
×
151
        }
×
152

153
        if err := setupIndexers(m, setupLog, conf); err != nil {
×
154
                setupLog.Error(err, "unable to setup indexers")
×
155
                return nil, fmt.Errorf("setting up indexers: %w", err)
×
156
        }
×
157

158
        if err := setupControllers(m, conf, setupLog, cl, store); err != nil {
×
159
                setupLog.Error(err, "unable to setup controllers")
×
160
                return nil, fmt.Errorf("setting up controllers: %w", err)
×
161
        }
×
162

163
        return m, nil
×
164
}
165

166
func setupIndexers(mgr ctrl.Manager, lgr logr.Logger, conf *config.Config) error {
1✔
167
        lgr.Info("setting up indexers")
1✔
168

1✔
169
        lgr.Info("adding Nginx Ingress Controller IngressClass indexer")
1✔
170
        if err := nginxingress.AddIngressClassNameIndex(mgr.GetFieldIndexer(), nicIngressClassIndex); err != nil {
1✔
171
                lgr.Error(err, "adding Nginx Ingress Controller IngressClass indexer")
×
172
                return fmt.Errorf("adding Nginx Ingress Controller IngressClass indexer: %w", err)
×
173
        }
×
174

175
        if conf.EnableGateway {
1✔
176
                if err := util.AddGatewayServiceAccountIndex(mgr.GetFieldIndexer(), gatewayListenerIndexName); err != nil {
×
177
                        lgr.Error(err, "adding Gateway Service Account indexer")
×
178
                        return fmt.Errorf("adding Gateway Service Account indexer: %w", err)
×
179
                }
×
180
        }
181

182
        lgr.Info("finished setting up indexers")
1✔
183
        return nil
1✔
184
}
185

186
func setupControllers(mgr ctrl.Manager, conf *config.Config, lgr logr.Logger, cl client.Client, store store.Store) error {
1✔
187
        lgr.Info("setting up controllers")
1✔
188

1✔
189
        lgr.Info("determining default IngressClass controller class")
1✔
190
        defaultCc, err := nginxingress.GetDefaultIngressClassControllerClass(cl)
1✔
191
        if err != nil {
1✔
192
                return fmt.Errorf("determining default IngressClass controller class: %w", err)
×
193
        }
×
194

195
        lgr.Info("setting up ExternalDNS controller")
1✔
196
        if err := dns.NewExternalDns(mgr, conf); err != nil {
1✔
197
                return fmt.Errorf("setting up external dns controller: %w", err)
×
198
        }
×
199

200
        lgr.Info("setting up Nginx Ingress Controller reconciler")
1✔
201
        if err := nginxingress.NewReconciler(conf, mgr, defaultCc); err != nil {
1✔
202
                return fmt.Errorf("setting up nginx ingress controller reconciler: %w", err)
×
203
        }
×
204

205
        lgr.Info("setting up ingress cert config reconciler")
1✔
206
        if err = osm.NewIngressCertConfigReconciler(mgr, conf); err != nil {
1✔
207
                return fmt.Errorf("setting up ingress cert config reconciler: %w", err)
×
208
        }
×
209

210
        defaultNic := nginxingress.GetDefaultNginxIngressController()
1✔
211
        if err := service.NewNginxIngressReconciler(mgr, nginxingress.ToNginxIngressConfig(&defaultNic, defaultCc)); err != nil {
1✔
212
                return fmt.Errorf("setting up nginx ingress reconciler: %w", err)
×
213
        }
×
214

215
        lgr.Info("setting up default Nginx Ingress Controller reconciler")
1✔
216
        if err := nginxingress.NewDefaultReconciler(mgr, conf); err != nil {
1✔
217
                return fmt.Errorf("setting up nginx ingress default controller reconciler: %w", err)
×
218
        }
×
219

220
        lgr.Info("setting up ingress concurrency watchdog")
1✔
221
        if err := ingress.NewConcurrencyWatchdog(mgr, conf, ingress.GetListNginxWatchdogTargets(mgr.GetClient(), defaultCc)); err != nil {
1✔
222
                return fmt.Errorf("setting up ingress concurrency watchdog: %w", err)
×
223
        }
×
224

225
        ingressManager := util.NewIngressManagerFromFn(func(ing *netv1.Ingress) (bool, error) {
1✔
226
                return nginxingress.IsIngressManaged(context.Background(), mgr.GetClient(), ing, nicIngressClassIndex)
×
227
        })
×
228
        lgr.Info("setting up keyvault secret provider class reconciler")
1✔
229
        if err := spc.NewIngressSecretProviderClassReconciler(mgr, conf, ingressManager); err != nil {
1✔
230
                return fmt.Errorf("setting up ingress secret provider class reconciler: %w", err)
×
231
        }
×
232
        lgr.Info("setting up nginx keyvault secret provider class reconciler")
1✔
233
        if err := spc.NewNginxSecretProviderClassReconciler(mgr, conf); err != nil {
1✔
234
                return fmt.Errorf("setting up nginx secret provider class reconciler: %w", err)
×
235
        }
×
236
        lgr.Info("setting up keyvault placeholder pod controller")
1✔
237
        if err := placeholderpod.NewPlaceholderPodController(mgr, conf, ingressManager); err != nil {
1✔
238
                return fmt.Errorf("setting up placeholder pod controller: %w", err)
×
239
        }
×
240
        lgr.Info("setting up keyvault event mirror")
1✔
241
        if err = placeholderpod.NewEventMirror(mgr, conf); err != nil {
1✔
242
                return fmt.Errorf("setting up event mirror: %w", err)
×
243
        }
×
244

245
        ingressSourceSpecer := osm.NewIngressControllerSourceSpecerFromFn(func(ing *netv1.Ingress) (policyv1alpha1.IngressSourceSpec, bool, error) {
1✔
246
                return nginxingress.IngressSource(context.Background(), mgr.GetClient(), conf, defaultCc, ing, nicIngressClassIndex)
×
247
        })
×
248
        lgr.Info("setting up ingress backend reconciler")
1✔
249
        if err := osm.NewIngressBackendReconciler(mgr, conf, ingressSourceSpecer); err != nil {
1✔
250
                return fmt.Errorf("setting up ingress backend reconciler: %w", err)
×
251
        }
×
252

253
        if conf.EnableGateway {
1✔
254
                lgr.Info("setting up gateway reconcilers")
×
255
                if err := spc.NewGatewaySecretClassProviderReconciler(mgr, conf, gatewayListenerIndexName); err != nil {
×
256
                        return fmt.Errorf("setting up Gateway SPC reconciler: %w", err)
×
257
                }
×
258
        }
259

260
        if conf.EnableDefaultDomain {
1✔
261
                lgr.Info("setting up default domain reconcilers")
×
262
                if err := defaultdomaincert.NewReconciler(conf, mgr, store); err != nil {
×
263
                        return fmt.Errorf("setting up default domain reconciler: %w", err)
×
264
                }
×
265
        }
266

267
        lgr.Info("finished setting up controllers")
1✔
268
        return nil
1✔
269
}
270

271
func setupProbes(conf *config.Config, mgr ctrl.Manager, log logr.Logger) error {
1✔
272
        log.Info("adding probes to manager")
1✔
273

1✔
274
        check := func(req *http.Request) error { return nil }
1✔
275

276
        if err := mgr.AddReadyzCheck("readyz", check); err != nil {
1✔
277
                return fmt.Errorf("adding readyz check: %w", err)
×
278
        }
×
279

280
        if err := mgr.AddHealthzCheck("healthz", check); err != nil {
1✔
281
                return fmt.Errorf("adding healthz check: %w", err)
×
282
        }
×
283

284
        log.Info("added probes to manager")
1✔
285
        return nil
1✔
286
}
287

288
func getSelfDeploy(kcs kubernetes.Interface, conf *config.Config, log logr.Logger) (*appsv1.Deployment, error) {
2✔
289
        // this doesn't actually work today. operator ns is not the same as resource ns which means we can't set this operator
2✔
290
        // as the owner of any child resources. https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/#owner-references-in-object-specifications
2✔
291
        // dynamic provisioning through a crd will fix this and fix our garbage collection.
2✔
292

2✔
293
        deploy, err := kcs.AppsV1().Deployments(conf.NS).Get(context.Background(), conf.OperatorDeployment, metav1.GetOptions{})
2✔
294
        if errors.IsNotFound(err) {
3✔
295
                // It's okay if we don't find the deployment - just skip setting ownership references latter
1✔
296
                log.Info("self deploy not found")
1✔
297
                return nil, nil
1✔
298
        }
1✔
299
        if err != nil {
1✔
300
                return nil, err
×
301
        }
×
302
        return deploy, nil
1✔
303
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc