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

Azure / aks-app-routing-operator / 28035021866

23 Jun 2026 02:49PM UTC coverage: 79.404% (-0.05%) from 79.457%
28035021866

push

github

web-flow
Merge branch 'main' into kingoliver/includefix

9 of 13 new or added lines in 3 files covered. (69.23%)

2 existing lines in 1 file now uncovered.

4480 of 5642 relevant lines covered (79.4%)

33.89 hits per line

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

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

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

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

74
func registerSchemes(s *runtime.Scheme) {
1✔
75
        utilruntime.Must(clientgoscheme.AddToScheme(s))
1✔
76
        utilruntime.Must(secv1.Install(s))
1✔
77
        utilruntime.Must(cfgv1alpha2.AddToScheme(s))
1✔
78
        utilruntime.Must(policyv1alpha1.AddToScheme(s))
1✔
79
        utilruntime.Must(approutingv1alpha1.AddToScheme(s))
1✔
80
        utilruntime.Must(apiextensionsv1.AddToScheme(s))
1✔
81
        utilruntime.Must(gatewayv1.Install(s))
1✔
82
}
1✔
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 and events,
×
101
                        // but there's no good filter to only cache the ones we care about,
×
102
                        // so we disable caching them entirely and fetch live from the API server.
×
103
                        DisableFor: []client.Object{
×
104
                                &corev1.Pod{},
×
105
                                &corev1.Event{},
×
106
                        },
×
107
                }
×
108
        }
×
109

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

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

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

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

133
        setupLog := m.GetLogger().WithName("setup")
×
134

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

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

149
        if err := removeDisabledCRDs(cl, conf, setupLog); err != nil {
×
150
                setupLog.Error(err, "failed to remove disabled CRDs")
×
151
                return nil, fmt.Errorf("removing disabled CRDs: %w", err)
×
152
        }
×
153

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

159
        if !conf.EnableDefaultDomain {
×
160
                if err := dns.CleanDefaultDomainDNS(context.Background(), cl, conf, setupLog); err != nil {
×
161
                        setupLog.Error(err, "failed to clean up disabled default domain dns resources")
×
162
                        return nil, fmt.Errorf("cleaning up disabled default domain dns resources: %w", err)
×
163
                }
×
164
        }
165

166
        if err := setupIndexers(m, setupLog, conf); err != nil {
×
167
                setupLog.Error(err, "unable to setup indexers")
×
168
                return nil, fmt.Errorf("setting up indexers: %w", err)
×
169
        }
×
170

171
        if err := setupControllers(m, conf, setupLog, cl, store, healthCheckers); err != nil {
×
172
                setupLog.Error(err, "unable to setup controllers")
×
173
                return nil, fmt.Errorf("setting up controllers: %w", err)
×
174
        }
×
175

176
        return m, nil
×
177
}
178

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

1✔
182
        if !conf.DisableIngressNginx {
2✔
183
                lgr.Info("adding Nginx Ingress Controller IngressClass indexer")
1✔
184
                if err := nginxingress.AddIngressClassNameIndex(mgr.GetFieldIndexer(), nicIngressClassIndex); err != nil {
1✔
185
                        lgr.Error(err, "adding Nginx Ingress Controller IngressClass indexer")
×
186
                        return fmt.Errorf("adding Nginx Ingress Controller IngressClass indexer: %w", err)
×
187
                }
×
188
        }
189

190
        if conf.EnableGatewayTLS {
1✔
191
                if err := util.AddGatewayServiceAccountIndex(mgr.GetFieldIndexer(), gatewayListenerIndexName); err != nil {
×
192
                        lgr.Error(err, "adding Gateway Service Account indexer")
×
193
                        return fmt.Errorf("adding Gateway Service Account indexer: %w", err)
×
194
                }
×
195
        }
196

197
        lgr.Info("finished setting up indexers")
1✔
198
        return nil
1✔
199
}
200

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

1✔
204
        lgr.Info("setting up ExternalDNS controller")
1✔
205
        if err := dns.NewExternalDns(mgr, conf); err != nil {
1✔
206
                return fmt.Errorf("setting up external dns controller: %w", err)
×
207
        }
×
208

209
        var ingressManager util.IngressManager
1✔
210
        if !conf.DisableIngressNginx {
2✔
211
                lgr.Info("determining default IngressClass controller class")
1✔
212
                defaultCc, err := nginxingress.GetDefaultIngressClassControllerClass(cl)
1✔
213
                if err != nil {
1✔
214
                        return fmt.Errorf("determining default IngressClass controller class: %w", err)
×
215
                }
×
216

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

222
                lgr.Info("setting up ingress cert config reconciler")
1✔
223
                if err = osm.NewIngressCertConfigReconciler(mgr, conf); err != nil {
1✔
224
                        return fmt.Errorf("setting up ingress cert config reconciler: %w", err)
×
225
                }
×
226

227
                defaultNic := nginxingress.GetDefaultNginxIngressController()
1✔
228
                if err := service.NewNginxIngressReconciler(mgr, nginxingress.ToNginxIngressConfig(&defaultNic, defaultCc)); err != nil {
1✔
229
                        return fmt.Errorf("setting up nginx ingress reconciler: %w", err)
×
230
                }
×
231

232
                lgr.Info("setting up default Nginx Ingress Controller reconciler")
1✔
233
                if err := nginxingress.NewDefaultReconciler(mgr, conf); err != nil {
1✔
234
                        return fmt.Errorf("setting up nginx ingress default controller reconciler: %w", err)
×
235
                }
×
236

237
                lgr.Info("setting up ingress concurrency watchdog")
1✔
238
                if err := ingress.NewConcurrencyWatchdog(mgr, conf, ingress.GetListNginxWatchdogTargets(mgr.GetClient(), defaultCc)); err != nil {
1✔
239
                        return fmt.Errorf("setting up ingress concurrency watchdog: %w", err)
×
240
                }
×
241

242
                ingressManager = util.NewIngressManagerFromFn(func(ing *netv1.Ingress) (bool, error) {
1✔
243
                        return nginxingress.IsIngressManaged(context.Background(), mgr.GetClient(), ing, nicIngressClassIndex)
×
244
                })
×
245
                lgr.Info("setting up keyvault secret provider class reconciler")
1✔
246
                if err := spc.NewIngressSecretProviderClassReconciler(mgr, conf, ingressManager); err != nil {
1✔
247
                        return fmt.Errorf("setting up ingress secret provider class reconciler: %w", err)
×
248
                }
×
249
                lgr.Info("setting up nginx keyvault secret provider class reconciler")
1✔
250
                if err := spc.NewNginxSecretProviderClassReconciler(mgr, conf); err != nil {
1✔
251
                        return fmt.Errorf("setting up nginx secret provider class reconciler: %w", err)
×
252
                }
×
253

254
                ingressSourceSpecer := osm.NewIngressControllerSourceSpecerFromFn(func(ing *netv1.Ingress) (policyv1alpha1.IngressSourceSpec, bool, error) {
1✔
255
                        return nginxingress.IngressSource(context.Background(), mgr.GetClient(), conf, defaultCc, ing, nicIngressClassIndex)
×
256
                })
×
257
                lgr.Info("setting up ingress backend reconciler")
1✔
258
                if err := osm.NewIngressBackendReconciler(mgr, conf, ingressSourceSpecer); err != nil {
1✔
259
                        return fmt.Errorf("setting up ingress backend reconciler: %w", err)
×
260
                }
×
261
        }
262

263
        lgr.Info("setting up keyvault placeholder pod controller")
1✔
264
        if err := placeholderpod.NewPlaceholderPodController(mgr, conf, ingressManager); err != nil {
1✔
265
                return fmt.Errorf("setting up placeholder pod controller: %w", err)
×
266
        }
×
267
        lgr.Info("setting up keyvault event mirror")
1✔
268
        if err := placeholderpod.NewEventMirror(mgr, conf); err != nil {
1✔
269
                return fmt.Errorf("setting up event mirror: %w", err)
×
270
        }
×
271

272
        if conf.EnableGatewayTLS {
1✔
273
                lgr.Info("setting up gateway reconcilers")
×
274
                if err := spc.NewGatewaySecretClassProviderReconciler(mgr, conf, gatewayListenerIndexName); err != nil {
×
275
                        return fmt.Errorf("setting up Gateway SPC reconciler: %w", err)
×
276
                }
×
277
        }
278

279
        if conf.EnableDefaultDomain {
1✔
280
                lgr.Info("setting up default domain reconcilers")
×
281

×
282
                // Create default domain client for fetching TLS certificates
×
283
                defaultDomainClient := defaultdomain.NewCachedClient(
×
284
                        context.Background(),
×
285
                        defaultdomain.CachedClientOpts{
×
286
                                Opts: defaultdomain.Opts{
×
287
                                        ServerAddress: conf.DefaultDomainServerAddress,
×
288
                                },
×
NEW
289
                                CacheTTL: conf.DefaultDomainCertCacheTTL,
×
290
                        },
×
291
                        mgr.GetLogger().WithName("default-domain-client"),
×
292
                )
×
293

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

×
300
                if err := defaultdomaincert.NewReconciler(conf, mgr, defaultDomainClient); err != nil {
×
301
                        return fmt.Errorf("setting up default domain reconciler: %w", err)
×
302
                }
×
303
        }
304

305
        lgr.Info("finished setting up controllers")
1✔
306
        return nil
1✔
307
}
308

309
func setupProbes(conf *config.Config, mgr ctrl.Manager, log logr.Logger, healthCheckers *healthCheckers) error {
1✔
310
        log.Info("adding probes to manager")
1✔
311

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

314
        if err := mgr.AddReadyzCheck("readyz", check); err != nil {
1✔
315
                return fmt.Errorf("adding readyz check: %w", err)
×
316
        }
×
317

318
        // Create health check that includes all registered health checkers
319
        healthCheck := func(req *http.Request) error {
1✔
320
                if !healthCheckers.isHealthy() {
×
321
                        return fmt.Errorf("health checker is unhealthy")
×
322
                }
×
323
                return nil
×
324
        }
325

326
        if err := mgr.AddHealthzCheck("healthz", healthCheck); err != nil {
1✔
327
                return fmt.Errorf("adding healthz check: %w", err)
×
328
        }
×
329

330
        log.Info("added probes to manager")
1✔
331
        return nil
1✔
332
}
333

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

2✔
339
        deploy, err := kcs.AppsV1().Deployments(conf.NS).Get(context.Background(), conf.OperatorDeployment, metav1.GetOptions{})
2✔
340
        if errors.IsNotFound(err) {
3✔
341
                // It's okay if we don't find the deployment - just skip setting ownership references latter
1✔
342
                log.Info("self deploy not found")
1✔
343
                return nil, nil
1✔
344
        }
1✔
345
        if err != nil {
1✔
346
                return nil, err
×
347
        }
×
348
        return deploy, nil
1✔
349
}
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