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

Azure / aks-app-routing-operator / 13953816170

19 Mar 2025 06:15PM UTC coverage: 81.652% (-0.4%) from 82.094%
13953816170

push

github

OliverMKing
add event filter

11 of 14 new or added lines in 2 files covered. (78.57%)

66 existing lines in 4 files now uncovered.

3707 of 4540 relevant lines covered (81.65%)

20.34 hits per line

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

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

38
        "github.com/Azure/aks-app-routing-operator/pkg/config"
39
        "github.com/Azure/aks-app-routing-operator/pkg/controller/dns"
40
        "github.com/Azure/aks-app-routing-operator/pkg/controller/ingress"
41
        "github.com/Azure/aks-app-routing-operator/pkg/controller/keyvault"
42
        "github.com/Azure/aks-app-routing-operator/pkg/controller/osm"
43
)
44

45
var scheme = runtime.NewScheme()
46

47
const (
48
        nicIngressClassIndex     = "spec.ingressClassName"
49
        gatewayListenerIndexName = "spec.listeners.tls.options.kubernetes.azure.com/tls-cert-service-account"
50
)
51

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

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

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

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

79
func NewRestConfig(conf *config.Config) *rest.Config {
×
80
        rc := ctrl.GetConfigOrDie()
×
UNCOV
81
        if conf.ServiceAccountTokenPath != "" {
×
82
                rc.BearerTokenFile = conf.ServiceAccountTokenPath
×
UNCOV
83
        }
×
84

85
        return rc
×
86
}
87

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

×
101
                cacheOpts.ByObject = map[client.Object]cache.ByObject{
×
102
                        &corev1.Event{}: {
×
NEW
103
                                Field: keyvault.EventMirrorSelector,
×
104
                        },
×
UNCOV
105
                }
×
UNCOV
106
        }
×
107

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

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

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

125
        setupLog := m.GetLogger().WithName("setup")
×
126
        if err := setupProbes(conf, m, setupLog); err != nil {
×
UNCOV
127
                setupLog.Error(err, "failed to set up probes")
×
128
                return nil, fmt.Errorf("setting up probes: %w", err)
×
UNCOV
129
        }
×
130

131
        // create non-caching clients, non-caching for use before manager has started
UNCOV
132
        cl, err := client.New(rc, client.Options{Scheme: scheme})
×
UNCOV
133
        if err != nil {
×
UNCOV
134
                setupLog.Error(err, "unable to create non-caching client")
×
UNCOV
135
                return nil, fmt.Errorf("creating non-caching client: %w", err)
×
136
        }
×
137

138
        if err := loadCRDs(cl, conf, setupLog); err != nil {
×
UNCOV
139
                setupLog.Error(err, "failed to load CRDs")
×
UNCOV
140
                return nil, fmt.Errorf("loading CRDs: %w", err)
×
141
        }
×
142

143
        if err := setupIndexers(m, setupLog, conf); err != nil {
×
144
                setupLog.Error(err, "unable to setup indexers")
×
UNCOV
145
                return nil, fmt.Errorf("setting up indexers: %w", err)
×
UNCOV
146
        }
×
147

UNCOV
148
        if err := setupControllers(m, conf, setupLog, cl); err != nil {
×
UNCOV
149
                setupLog.Error(err, "unable to setup controllers")
×
UNCOV
150
                return nil, fmt.Errorf("setting up controllers: %w", err)
×
UNCOV
151
        }
×
152

UNCOV
153
        return m, nil
×
154
}
155

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

1✔
159
        lgr.Info("adding Nginx Ingress Controller IngressClass indexer")
1✔
160
        if err := nginxingress.AddIngressClassNameIndex(mgr.GetFieldIndexer(), nicIngressClassIndex); err != nil {
1✔
UNCOV
161
                lgr.Error(err, "adding Nginx Ingress Controller IngressClass indexer")
×
162
                return fmt.Errorf("adding Nginx Ingress Controller IngressClass indexer: %w", err)
×
163
        }
×
164

165
        if conf.EnableGateway {
1✔
UNCOV
166
                if err := keyvault.AddGatewayServiceAccountIndex(mgr.GetFieldIndexer(), gatewayListenerIndexName); err != nil {
×
167
                        lgr.Error(err, "adding Gateway Service Account indexer")
×
168
                        return fmt.Errorf("adding Gateway Service Account indexer: %w", err)
×
UNCOV
169
                }
×
170
        }
171

172
        lgr.Info("finished setting up indexers")
1✔
173
        return nil
1✔
174
}
175

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

1✔
179
        lgr.Info("determining default IngressClass controller class")
1✔
180
        defaultCc, err := nginxingress.GetDefaultIngressClassControllerClass(cl)
1✔
181
        if err != nil {
1✔
182
                return fmt.Errorf("determining default IngressClass controller class: %w", err)
×
183
        }
×
184

185
        lgr.Info("settup up ExternalDNS controller")
1✔
186
        if err := dns.NewExternalDns(mgr, conf); err != nil {
1✔
187
                return fmt.Errorf("setting up external dns controller: %w", err)
×
188
        }
×
189

190
        lgr.Info("setting up Nginx Ingress Controller reconciler")
1✔
191
        if err := nginxingress.NewReconciler(conf, mgr, defaultCc); err != nil {
1✔
192
                return fmt.Errorf("setting up nginx ingress controller reconciler: %w", err)
×
UNCOV
193
        }
×
194

195
        lgr.Info("setting up ingress cert config reconciler")
1✔
196
        if err = osm.NewIngressCertConfigReconciler(mgr, conf); err != nil {
1✔
UNCOV
197
                return fmt.Errorf("setting up ingress cert config reconciler: %w", err)
×
UNCOV
198
        }
×
199

200
        defaultNic := nginxingress.GetDefaultNginxIngressController()
1✔
201
        if err := service.NewNginxIngressReconciler(mgr, nginxingress.ToNginxIngressConfig(&defaultNic, defaultCc)); err != nil {
1✔
UNCOV
202
                return fmt.Errorf("setting up nginx ingress reconciler: %w", err)
×
203
        }
×
204

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

210
        lgr.Info("setting up ingress concurrency watchdog")
1✔
211
        if err := ingress.NewConcurrencyWatchdog(mgr, conf, ingress.GetListNginxWatchdogTargets(mgr.GetClient(), defaultCc)); err != nil {
1✔
212
                return fmt.Errorf("setting up ingress concurrency watchdog: %w", err)
×
UNCOV
213
        }
×
214

215
        ingressManager := keyvault.NewIngressManagerFromFn(func(ing *netv1.Ingress) (bool, error) {
1✔
216
                return nginxingress.IsIngressManaged(context.Background(), mgr.GetClient(), ing, nicIngressClassIndex)
×
UNCOV
217
        })
×
218
        lgr.Info("setting up keyvault secret provider class reconciler")
1✔
219
        if err := keyvault.NewIngressSecretProviderClassReconciler(mgr, conf, ingressManager); err != nil {
1✔
220
                return fmt.Errorf("setting up ingress secret provider class reconciler: %w", err)
×
UNCOV
221
        }
×
222
        lgr.Info("setting up nginx keyvault secret provider class reconciler")
1✔
223
        if err := keyvault.NewNginxSecretProviderClassReconciler(mgr, conf); err != nil {
1✔
224
                return fmt.Errorf("setting up nginx secret provider class reconciler: %w", err)
×
225
        }
×
226
        lgr.Info("setting up keyvault placeholder pod controller")
1✔
227
        if err := keyvault.NewPlaceholderPodController(mgr, conf, ingressManager); err != nil {
1✔
UNCOV
228
                return fmt.Errorf("setting up placeholder pod controller: %w", err)
×
UNCOV
229
        }
×
230
        lgr.Info("setting up ingress tls reconciler")
1✔
231
        if err := keyvault.NewIngressTlsReconciler(mgr, conf, ingressManager); err != nil {
1✔
UNCOV
232
                return fmt.Errorf("setting up ingress tls reconciler: %w", err)
×
UNCOV
233
        }
×
234
        lgr.Info("setting up keyvault event mirror")
1✔
235
        if err = keyvault.NewEventMirror(mgr, conf); err != nil {
1✔
UNCOV
236
                return fmt.Errorf("setting up event mirror: %w", err)
×
UNCOV
237
        }
×
238

239
        ingressSourceSpecer := osm.NewIngressControllerSourceSpecerFromFn(func(ing *netv1.Ingress) (policyv1alpha1.IngressSourceSpec, bool, error) {
1✔
240
                return nginxingress.IngressSource(context.Background(), mgr.GetClient(), conf, defaultCc, ing, nicIngressClassIndex)
×
UNCOV
241
        })
×
242
        lgr.Info("setting up ingress backend reconciler")
1✔
243
        if err := osm.NewIngressBackendReconciler(mgr, conf, ingressSourceSpecer); err != nil {
1✔
244
                return fmt.Errorf("setting up ingress backend reconciler: %w", err)
×
UNCOV
245
        }
×
246

247
        if conf.EnableGateway {
1✔
UNCOV
248
                lgr.Info("setting up gateway reconcilers")
×
UNCOV
249
                if err := keyvault.NewGatewaySecretClassProviderReconciler(mgr, conf, gatewayListenerIndexName); err != nil {
×
UNCOV
250
                        return fmt.Errorf("setting up Gateway SPC reconciler: %w", err)
×
UNCOV
251
                }
×
252
        }
253

254
        lgr.Info("finished setting up controllers")
1✔
255
        return nil
1✔
256
}
257

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

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

263
        if err := mgr.AddReadyzCheck("readyz", check); err != nil {
1✔
UNCOV
264
                return fmt.Errorf("adding readyz check: %w", err)
×
UNCOV
265
        }
×
266

267
        if err := mgr.AddHealthzCheck("healthz", check); err != nil {
1✔
UNCOV
268
                return fmt.Errorf("adding healthz check: %w", err)
×
UNCOV
269
        }
×
270

271
        log.Info("added probes to manager")
1✔
272
        return nil
1✔
273
}
274

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

2✔
280
        deploy, err := kcs.AppsV1().Deployments(conf.NS).Get(context.Background(), conf.OperatorDeployment, metav1.GetOptions{})
2✔
281
        if errors.IsNotFound(err) {
3✔
282
                // It's okay if we don't find the deployment - just skip setting ownership references latter
1✔
283
                log.Info("self deploy not found")
1✔
284
                return nil, nil
1✔
285
        }
1✔
286
        if err != nil {
1✔
UNCOV
287
                return nil, err
×
UNCOV
288
        }
×
289
        return deploy, nil
1✔
290
}
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