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

Azure / aks-app-routing-operator / 20033475488

08 Dec 2025 03:30PM UTC coverage: 78.874% (-0.7%) from 79.563%
20033475488

push

github

OliverMKing
add e2e

4189 of 5311 relevant lines covered (78.87%)

23.86 hits per line

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

37.29
/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/Azure/go-autorest/autorest/azure"
21
        "github.com/go-logr/logr"
22
        cfgv1alpha2 "github.com/openservicemesh/osm/pkg/apis/config/v1alpha2"
23
        policyv1alpha1 "github.com/openservicemesh/osm/pkg/apis/policy/v1alpha1"
24
        ubzap "go.uber.org/zap"
25
        appsv1 "k8s.io/api/apps/v1"
26
        corev1 "k8s.io/api/core/v1"
27
        netv1 "k8s.io/api/networking/v1"
28
        apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
29
        "k8s.io/apimachinery/pkg/api/errors"
30
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
31
        "k8s.io/apimachinery/pkg/runtime"
32
        utilruntime "k8s.io/apimachinery/pkg/util/runtime"
33
        "k8s.io/client-go/kubernetes"
34
        clientgoscheme "k8s.io/client-go/kubernetes/scheme"
35
        "k8s.io/client-go/rest"
36
        "k8s.io/klog/v2"
37
        ctrl "sigs.k8s.io/controller-runtime"
38
        "sigs.k8s.io/controller-runtime/pkg/cache"
39
        "sigs.k8s.io/controller-runtime/pkg/client"
40
        "sigs.k8s.io/controller-runtime/pkg/log/zap"
41
        metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
42
        gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
43
        secv1 "sigs.k8s.io/secrets-store-csi-driver/apis/v1"
44

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

51
var scheme = runtime.NewScheme()
52

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

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

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

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

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

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

91
        return rc
×
92
}
93

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

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

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

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

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

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

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

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

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

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

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

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

168
        return m, nil
×
169
}
170

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

1✔
174
        lgr.Info("adding Nginx Ingress Controller IngressClass indexer")
1✔
175
        if err := nginxingress.AddIngressClassNameIndex(mgr.GetFieldIndexer(), nicIngressClassIndex); err != nil {
1✔
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
        if conf.EnableGateway {
1✔
181
                if err := util.AddGatewayServiceAccountIndex(mgr.GetFieldIndexer(), gatewayListenerIndexName); err != nil {
×
182
                        lgr.Error(err, "adding Gateway Service Account indexer")
×
183
                        return fmt.Errorf("adding Gateway Service Account indexer: %w", err)
×
184
                }
×
185
        }
186

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

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

1✔
194
        lgr.Info("determining default IngressClass controller class")
1✔
195
        defaultCc, err := nginxingress.GetDefaultIngressClassControllerClass(cl)
1✔
196
        if err != nil {
1✔
197
                return fmt.Errorf("determining default IngressClass controller class: %w", err)
×
198
        }
×
199

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

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

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

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

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

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

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

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

258
        if conf.EnableGateway {
1✔
259
                lgr.Info("setting up gateway reconcilers")
×
260
                if err := spc.NewGatewaySecretClassProviderReconciler(mgr, conf, gatewayListenerIndexName); err != nil {
×
261
                        return fmt.Errorf("setting up Gateway SPC reconciler: %w", err)
×
262
                }
×
263
        }
264

265
        if conf.EnableDefaultDomain {
1✔
266
                lgr.Info("setting up default domain reconcilers")
×
267

×
268
                // Parse the DefaultDomainZoneID to extract subscription, resource group, and cluster name
×
269
                parsedZone, err := azure.ParseResourceID(conf.DefaultDomainZoneID)
×
270
                if err != nil {
×
271
                        return fmt.Errorf("parsing default domain zone ID: %w", err)
×
272
                }
×
273

274
                // Create default domain client for fetching TLS certificates
275
                defaultDomainClient := defaultdomain.NewCachedClient(
×
276
                        context.Background(),
×
277
                        defaultdomain.CachedClientOpts{
×
278
                                Opts: defaultdomain.Opts{
×
279
                                        ServerAddress: conf.DefaultDomainServerAddress,
×
280
                                },
×
281
                                SubscriptionID: parsedZone.SubscriptionID,
×
282
                                ResourceGroup:  parsedZone.ResourceGroup,
×
283
                                ClusterName:    parsedZone.ResourceName,
×
284
                                CCPID:          conf.ClusterUid,
×
285
                        },
×
286
                        mgr.GetLogger().WithName("default-domain-client"),
×
287
                )
×
288

×
289
                // Add the health checker to the list
×
290
                healthCheckers.addCheck(defaultDomainClient)
×
291

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

297
        lgr.Info("finished setting up controllers")
1✔
298
        return nil
1✔
299
}
300

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

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

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

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

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

322
        log.Info("added probes to manager")
1✔
323
        return nil
1✔
324
}
325

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

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