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

Azure / aks-app-routing-operator / 16606772961

29 Jul 2025 08:28PM UTC coverage: 81.381% (-0.3%) from 81.723%
16606772961

push

github

OliverMKing
add store

79 of 124 new or added lines in 2 files covered. (63.71%)

4 existing lines in 1 file now uncovered.

3925 of 4823 relevant lines covered (81.38%)

23.48 hits per line

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

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

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

48
var scheme = runtime.NewScheme()
49

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

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

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

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

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

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

88
        return rc
×
89
}
90

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

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

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

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

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

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

NEW
134
        if conf.EnableDefaultDomain {
×
NEW
135
                store.AddFile(conf.DefaultDomainCertPath)
×
NEW
136

×
NEW
137
                // validate that the default domain cert path exists
×
NEW
138
                _, ok := store.GetContent(conf.DefaultDomainCertPath)
×
NEW
139
                if !ok {
×
NEW
140
                        return nil, fmt.Errorf("default domain cert %s was not loaded to store", conf.DefaultDomainCertPath)
×
NEW
141
                }
×
142
        }
143

144
        setupLog := m.GetLogger().WithName("setup")
×
145
        if err := setupProbes(conf, m, setupLog); err != nil {
×
146
                setupLog.Error(err, "failed to set up probes")
×
147
                return nil, fmt.Errorf("setting up probes: %w", err)
×
148
        }
×
149

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

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

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

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

172
        return m, nil
×
173
}
174

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

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

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

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

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

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

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

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

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

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

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

234
        ingressManager := util.NewIngressManagerFromFn(func(ing *netv1.Ingress) (bool, error) {
1✔
235
                return nginxingress.IsIngressManaged(context.Background(), mgr.GetClient(), ing, nicIngressClassIndex)
×
236
        })
×
237
        lgr.Info("setting up keyvault secret provider class reconciler")
1✔
238
        if err := spc.NewIngressSecretProviderClassReconciler(mgr, conf, ingressManager); err != nil {
1✔
239
                return fmt.Errorf("setting up ingress secret provider class reconciler: %w", err)
×
240
        }
×
241
        lgr.Info("setting up nginx keyvault secret provider class reconciler")
1✔
242
        if err := spc.NewNginxSecretProviderClassReconciler(mgr, conf); err != nil {
1✔
243
                return fmt.Errorf("setting up nginx secret provider class reconciler: %w", err)
×
244
        }
×
245
        lgr.Info("setting up keyvault placeholder pod controller")
1✔
246
        if err := placeholderpod.NewPlaceholderPodController(mgr, conf, ingressManager); err != nil {
1✔
247
                return fmt.Errorf("setting up placeholder pod controller: %w", err)
×
248
        }
×
249
        lgr.Info("setting up keyvault event mirror")
1✔
250
        if err = placeholderpod.NewEventMirror(mgr, conf); err != nil {
1✔
251
                return fmt.Errorf("setting up event mirror: %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
        if conf.EnableGateway {
1✔
263
                lgr.Info("setting up gateway reconcilers")
×
264
                if err := spc.NewGatewaySecretClassProviderReconciler(mgr, conf, gatewayListenerIndexName); err != nil {
×
265
                        return fmt.Errorf("setting up Gateway SPC reconciler: %w", err)
×
266
                }
×
267
        }
268

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

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

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

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

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

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

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

2✔
295
        deploy, err := kcs.AppsV1().Deployments(conf.NS).Get(context.Background(), conf.OperatorDeployment, metav1.GetOptions{})
2✔
296
        if errors.IsNotFound(err) {
3✔
297
                // It's okay if we don't find the deployment - just skip setting ownership references latter
1✔
298
                log.Info("self deploy not found")
1✔
299
                return nil, nil
1✔
300
        }
1✔
301
        if err != nil {
1✔
302
                return nil, err
×
303
        }
×
304
        return deploy, nil
1✔
305
}
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