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

Azure / aks-app-routing-operator / 22314389768

23 Feb 2026 04:08PM UTC coverage: 79.049% (-0.03%) from 79.077%
22314389768

push

github

OliverMKing
write right version

4290 of 5427 relevant lines covered (79.05%)

48.39 hits per line

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

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

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

50
var scheme = runtime.NewScheme()
51

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

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

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

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

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

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

90
        return rc
×
91
}
92

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

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

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

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

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

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

136
        setupLog := m.GetLogger().WithName("setup")
×
137

×
138
        // Health checkers will be populated during controller setup
×
139
        healthCheckers := newHealthCheckers()
×
140
        if err := setupProbes(conf, m, setupLog, healthCheckers); err != nil {
×
141
                setupLog.Error(err, "failed to set up probes")
×
142
                return nil, fmt.Errorf("setting up probes: %w", err)
×
143
        }
×
144

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

152
        if err := loadCRDs(cl, conf, setupLog); err != nil {
×
153
                setupLog.Error(err, "failed to load CRDs")
×
154
                return nil, fmt.Errorf("loading CRDs: %w", err)
×
155
        }
×
156

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

162
        if err := setupControllers(m, conf, setupLog, cl, store, healthCheckers); err != nil {
×
163
                setupLog.Error(err, "unable to setup controllers")
×
164
                return nil, fmt.Errorf("setting up controllers: %w", err)
×
165
        }
×
166

167
        return m, nil
×
168
}
169

170
func setupIndexers(mgr ctrl.Manager, lgr logr.Logger, conf *config.Config) error {
2✔
171
        lgr.Info("setting up indexers")
2✔
172

2✔
173
        if !conf.DisableIngressNginx {
4✔
174
                lgr.Info("adding Nginx Ingress Controller IngressClass indexer")
2✔
175
                if err := nginxingress.AddIngressClassNameIndex(mgr.GetFieldIndexer(), nicIngressClassIndex); err != nil {
2✔
176
                        lgr.Error(err, "adding Nginx Ingress Controller IngressClass indexer")
×
177
                        return fmt.Errorf("adding Nginx Ingress Controller IngressClass indexer: %w", err)
×
178
                }
×
179
        }
180

181
        if conf.EnableGatewayTLS {
2✔
182
                if err := util.AddGatewayServiceAccountIndex(mgr.GetFieldIndexer(), gatewayListenerIndexName); err != nil {
×
183
                        lgr.Error(err, "adding Gateway Service Account indexer")
×
184
                        return fmt.Errorf("adding Gateway Service Account indexer: %w", err)
×
185
                }
×
186
        }
187

188
        lgr.Info("finished setting up indexers")
2✔
189
        return nil
2✔
190
}
191

192
func setupControllers(mgr ctrl.Manager, conf *config.Config, lgr logr.Logger, cl client.Client, store store.Store, healthCheckers *healthCheckers) error {
2✔
193
        lgr.Info("setting up controllers")
2✔
194

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

200
        var ingressManager util.IngressManager
2✔
201
        if !conf.DisableIngressNginx {
4✔
202
                lgr.Info("determining default IngressClass controller class")
2✔
203
                defaultCc, err := nginxingress.GetDefaultIngressClassControllerClass(cl)
2✔
204
                if err != nil {
2✔
205
                        return fmt.Errorf("determining default IngressClass controller class: %w", err)
×
206
                }
×
207

208
                lgr.Info("setting up Nginx Ingress Controller reconciler")
2✔
209
                if err := nginxingress.NewReconciler(conf, mgr, defaultCc); err != nil {
2✔
210
                        return fmt.Errorf("setting up nginx ingress controller reconciler: %w", err)
×
211
                }
×
212

213
                lgr.Info("setting up ingress cert config reconciler")
2✔
214
                if err = osm.NewIngressCertConfigReconciler(mgr, conf); err != nil {
2✔
215
                        return fmt.Errorf("setting up ingress cert config reconciler: %w", err)
×
216
                }
×
217

218
                defaultNic := nginxingress.GetDefaultNginxIngressController()
2✔
219
                if err := service.NewNginxIngressReconciler(mgr, nginxingress.ToNginxIngressConfig(&defaultNic, defaultCc)); err != nil {
2✔
220
                        return fmt.Errorf("setting up nginx ingress reconciler: %w", err)
×
221
                }
×
222

223
                lgr.Info("setting up default Nginx Ingress Controller reconciler")
2✔
224
                if err := nginxingress.NewDefaultReconciler(mgr, conf); err != nil {
2✔
225
                        return fmt.Errorf("setting up nginx ingress default controller reconciler: %w", err)
×
226
                }
×
227

228
                lgr.Info("setting up ingress concurrency watchdog")
2✔
229
                if err := ingress.NewConcurrencyWatchdog(mgr, conf, ingress.GetListNginxWatchdogTargets(mgr.GetClient(), defaultCc)); err != nil {
2✔
230
                        return fmt.Errorf("setting up ingress concurrency watchdog: %w", err)
×
231
                }
×
232

233
                ingressManager = util.NewIngressManagerFromFn(func(ing *netv1.Ingress) (bool, error) {
2✔
234
                        return nginxingress.IsIngressManaged(context.Background(), mgr.GetClient(), ing, nicIngressClassIndex)
×
235
                })
×
236
                lgr.Info("setting up keyvault secret provider class reconciler")
2✔
237
                if err := spc.NewIngressSecretProviderClassReconciler(mgr, conf, ingressManager); err != nil {
2✔
238
                        return fmt.Errorf("setting up ingress secret provider class reconciler: %w", err)
×
239
                }
×
240
                lgr.Info("setting up nginx keyvault secret provider class reconciler")
2✔
241
                if err := spc.NewNginxSecretProviderClassReconciler(mgr, conf); err != nil {
2✔
242
                        return fmt.Errorf("setting up nginx secret provider class reconciler: %w", err)
×
243
                }
×
244

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

254
        lgr.Info("setting up keyvault placeholder pod controller")
2✔
255
        if err := placeholderpod.NewPlaceholderPodController(mgr, conf, ingressManager); err != nil {
2✔
256
                return fmt.Errorf("setting up placeholder pod controller: %w", err)
×
257
        }
×
258
        lgr.Info("setting up keyvault event mirror")
2✔
259
        if err := placeholderpod.NewEventMirror(mgr, conf); err != nil {
2✔
260
                return fmt.Errorf("setting up event mirror: %w", err)
×
261
        }
×
262

263
        if conf.EnableGatewayTLS {
2✔
264
                lgr.Info("setting up gateway reconcilers")
×
265
                if err := spc.NewGatewaySecretClassProviderReconciler(mgr, conf, gatewayListenerIndexName); err != nil {
×
266
                        return fmt.Errorf("setting up Gateway SPC reconciler: %w", err)
×
267
                }
×
268
        }
269

270
        if conf.EnableDefaultDomain {
2✔
271
                lgr.Info("setting up default domain reconcilers")
×
272

×
273
                // Create default domain client for fetching TLS certificates
×
274
                defaultDomainClient := defaultdomain.NewCachedClient(
×
275
                        context.Background(),
×
276
                        defaultdomain.CachedClientOpts{
×
277
                                Opts: defaultdomain.Opts{
×
278
                                        ServerAddress: conf.DefaultDomainServerAddress,
×
279
                                },
×
280
                        },
×
281
                        mgr.GetLogger().WithName("default-domain-client"),
×
282
                )
×
283

×
284
                // We no longer want to have the default domain client directly impact the health of the operator.
×
285
                // Issues calling default-domain-svc are unlikely to be operator errors and are almost always errors
×
286
                // outside the operator's control (network issues, default-domain-svc down, etc). Instead we use Prometheus
×
287
                // metrics to monitor the health of default domain calls so we can alert and view trends on them.
×
288
                // healthCheckers.addCheck(defaultDomainClient)
×
289

×
290
                if err := defaultdomaincert.NewReconciler(conf, mgr, defaultDomainClient); err != nil {
×
291
                        return fmt.Errorf("setting up default domain reconciler: %w", err)
×
292
                }
×
293
        }
294

295
        lgr.Info("finished setting up controllers")
2✔
296
        return nil
2✔
297
}
298

299
func setupProbes(conf *config.Config, mgr ctrl.Manager, log logr.Logger, healthCheckers *healthCheckers) error {
2✔
300
        log.Info("adding probes to manager")
2✔
301

2✔
302
        check := func(req *http.Request) error { return nil }
2✔
303

304
        if err := mgr.AddReadyzCheck("readyz", check); err != nil {
2✔
305
                return fmt.Errorf("adding readyz check: %w", err)
×
306
        }
×
307

308
        // Create health check that includes all registered health checkers
309
        healthCheck := func(req *http.Request) error {
2✔
310
                if !healthCheckers.isHealthy() {
×
311
                        return fmt.Errorf("health checker is unhealthy")
×
312
                }
×
313
                return nil
×
314
        }
315

316
        if err := mgr.AddHealthzCheck("healthz", healthCheck); err != nil {
2✔
317
                return fmt.Errorf("adding healthz check: %w", err)
×
318
        }
×
319

320
        log.Info("added probes to manager")
2✔
321
        return nil
2✔
322
}
323

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

4✔
329
        deploy, err := kcs.AppsV1().Deployments(conf.NS).Get(context.Background(), conf.OperatorDeployment, metav1.GetOptions{})
4✔
330
        if errors.IsNotFound(err) {
6✔
331
                // It's okay if we don't find the deployment - just skip setting ownership references latter
2✔
332
                log.Info("self deploy not found")
2✔
333
                return nil, nil
2✔
334
        }
2✔
335
        if err != nil {
2✔
336
                return nil, err
×
337
        }
×
338
        return deploy, nil
2✔
339
}
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