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

Azure / aks-app-routing-operator / 27553835163

15 Jun 2026 02:25PM UTC coverage: 79.465% (-0.004%) from 79.469%
27553835163

push

github

OliverMKing
Merge remote-tracking branch 'upstream/main' into kingoliver/upsert-status-event

# Conflicts:
#	pkg/controller/defaultdomaincert/default_domain_cert_controller.go

56 of 65 new or added lines in 3 files covered. (86.15%)

76 existing lines in 5 files now uncovered.

4454 of 5605 relevant lines covered (79.46%)

34.06 hits per line

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

38.72
/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 err := setupIndexers(m, setupLog, conf); err != nil {
×
160
                setupLog.Error(err, "unable to setup indexers")
×
161
                return nil, fmt.Errorf("setting up indexers: %w", err)
×
162
        }
×
163

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

169
        return m, nil
×
170
}
171

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

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

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

190
        lgr.Info("finished setting up indexers")
1✔
191
        return nil
1✔
192
}
193

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

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

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

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

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

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

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

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

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

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

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

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

272
        if conf.EnableDefaultDomain {
1✔
273
                lgr.Info("setting up default domain reconcilers")
×
274

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

×
286
                // We no longer want to have the default domain client directly impact the health of the operator.
×
287
                // Issues calling default-domain-svc are unlikely to be operator errors and are almost always errors
×
288
                // outside the operator's control (network issues, default-domain-svc down, etc). Instead we use Prometheus
×
289
                // metrics to monitor the health of default domain calls so we can alert and view trends on them.
×
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✔
UNCOV
307
                return fmt.Errorf("adding readyz check: %w", err)
×
UNCOV
308
        }
×
309

310
        // Create health check that includes all registered health checkers
311
        healthCheck := func(req *http.Request) error {
1✔
UNCOV
312
                if !healthCheckers.isHealthy() {
×
UNCOV
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✔
UNCOV
338
                return nil, err
×
UNCOV
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