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

Azure / aks-app-routing-operator / 13862889410

14 Mar 2025 06:17PM UTC coverage: 82.03% (-0.02%) from 82.052%
13862889410

push

github

OliverMKing
fix externaldns crds with controller gen

3702 of 4513 relevant lines covered (82.03%)

20.45 hits per line

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

49.44
/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
        netv1 "k8s.io/api/networking/v1"
20
        apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
21
        "k8s.io/apimachinery/pkg/api/errors"
22
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
23
        "k8s.io/apimachinery/pkg/runtime"
24
        utilruntime "k8s.io/apimachinery/pkg/util/runtime"
25
        "k8s.io/client-go/kubernetes"
26
        clientgoscheme "k8s.io/client-go/kubernetes/scheme"
27
        "k8s.io/client-go/rest"
28
        "k8s.io/klog/v2"
29
        ctrl "sigs.k8s.io/controller-runtime"
30
        "sigs.k8s.io/controller-runtime/pkg/client"
31
        "sigs.k8s.io/controller-runtime/pkg/log/zap"
32
        metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
33
        gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
34
        secv1 "sigs.k8s.io/secrets-store-csi-driver/apis/v1"
35

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

43
var scheme = runtime.NewScheme()
44

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

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

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

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

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

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

83
        return rc
×
84
}
85

86
func NewManagerForRestConfig(conf *config.Config, rc *rest.Config) (ctrl.Manager, error) {
×
87
        m, err := ctrl.NewManager(rc, ctrl.Options{
×
88
                Metrics:                metricsserver.Options{BindAddress: conf.MetricsAddr},
×
89
                HealthProbeBindAddress: conf.ProbeAddr,
×
90
                Scheme:                 scheme,
×
91

×
92
                // we use an active-passive HA model meaning only the leader performs actions
×
93
                LeaderElection:          true,
×
94
                LeaderElectionNamespace: "kube-system",
×
95
                LeaderElectionID:        "aks-app-routing-operator-leader",
×
96
        })
×
97
        if err != nil {
×
98
                return nil, fmt.Errorf("creating manager: %w", err)
×
99
        }
×
100

101
        setupLog := m.GetLogger().WithName("setup")
×
102
        if err := setupProbes(conf, m, setupLog); err != nil {
×
103
                setupLog.Error(err, "failed to set up probes")
×
104
                return nil, fmt.Errorf("setting up probes: %w", err)
×
105
        }
×
106

107
        // create non-caching clients, non-caching for use before manager has started
108
        cl, err := client.New(rc, client.Options{Scheme: scheme})
×
109
        if err != nil {
×
110
                setupLog.Error(err, "unable to create non-caching client")
×
111
                return nil, fmt.Errorf("creating non-caching client: %w", err)
×
112
        }
×
113

114
        if err := loadCRDs(cl, conf, setupLog); err != nil {
×
115
                setupLog.Error(err, "failed to load CRDs")
×
116
                return nil, fmt.Errorf("loading CRDs: %w", err)
×
117
        }
×
118

119
        if err := setupIndexers(m, setupLog, conf); err != nil {
×
120
                setupLog.Error(err, "unable to setup indexers")
×
121
                return nil, fmt.Errorf("setting up indexers: %w", err)
×
122
        }
×
123

124
        if err := setupControllers(m, conf, setupLog, cl); err != nil {
×
125
                setupLog.Error(err, "unable to setup controllers")
×
126
                return nil, fmt.Errorf("setting up controllers: %w", err)
×
127
        }
×
128

129
        return m, nil
×
130
}
131

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

1✔
135
        lgr.Info("adding Nginx Ingress Controller IngressClass indexer")
1✔
136
        if err := nginxingress.AddIngressClassNameIndex(mgr.GetFieldIndexer(), nicIngressClassIndex); err != nil {
1✔
137
                lgr.Error(err, "adding Nginx Ingress Controller IngressClass indexer")
×
138
                return fmt.Errorf("adding Nginx Ingress Controller IngressClass indexer: %w", err)
×
139
        }
×
140

141
        if conf.EnableGateway {
1✔
142
                if err := keyvault.AddGatewayServiceAccountIndex(mgr.GetFieldIndexer(), gatewayListenerIndexName); err != nil {
×
143
                        lgr.Error(err, "adding Gateway Service Account indexer")
×
144
                        return fmt.Errorf("adding Gateway Service Account indexer: %w", err)
×
145
                }
×
146
        }
147

148
        lgr.Info("finished setting up indexers")
1✔
149
        return nil
1✔
150
}
151

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

1✔
155
        lgr.Info("determining default IngressClass controller class")
1✔
156
        defaultCc, err := nginxingress.GetDefaultIngressClassControllerClass(cl)
1✔
157
        if err != nil {
1✔
158
                return fmt.Errorf("determining default IngressClass controller class: %w", err)
×
159
        }
×
160

161
        lgr.Info("settup up ExternalDNS controller")
1✔
162
        if err := dns.NewExternalDns(mgr, conf); err != nil {
1✔
163
                return fmt.Errorf("setting up external dns controller: %w", err)
×
164
        }
×
165

166
        lgr.Info("setting up Nginx Ingress Controller reconciler")
1✔
167
        if err := nginxingress.NewReconciler(conf, mgr, defaultCc); err != nil {
1✔
168
                return fmt.Errorf("setting up nginx ingress controller reconciler: %w", err)
×
169
        }
×
170

171
        lgr.Info("setting up ingress cert config reconciler")
1✔
172
        if err = osm.NewIngressCertConfigReconciler(mgr, conf); err != nil {
1✔
173
                return fmt.Errorf("setting up ingress cert config reconciler: %w", err)
×
174
        }
×
175

176
        defaultNic := nginxingress.GetDefaultNginxIngressController()
1✔
177
        if err := service.NewNginxIngressReconciler(mgr, nginxingress.ToNginxIngressConfig(&defaultNic, defaultCc)); err != nil {
1✔
178
                return fmt.Errorf("setting up nginx ingress reconciler: %w", err)
×
179
        }
×
180

181
        lgr.Info("setting up default Nginx Ingress Controller reconciler")
1✔
182
        if err := nginxingress.NewDefaultReconciler(mgr, conf); err != nil {
1✔
183
                return fmt.Errorf("setting up nginx ingress default controller reconciler: %w", err)
×
184
        }
×
185

186
        lgr.Info("setting up ingress concurrency watchdog")
1✔
187
        if err := ingress.NewConcurrencyWatchdog(mgr, conf, ingress.GetListNginxWatchdogTargets(mgr.GetClient(), defaultCc)); err != nil {
1✔
188
                return fmt.Errorf("setting up ingress concurrency watchdog: %w", err)
×
189
        }
×
190

191
        ingressManager := keyvault.NewIngressManagerFromFn(func(ing *netv1.Ingress) (bool, error) {
1✔
192
                return nginxingress.IsIngressManaged(context.Background(), mgr.GetClient(), ing, nicIngressClassIndex)
×
193
        })
×
194
        lgr.Info("setting up keyvault secret provider class reconciler")
1✔
195
        if err := keyvault.NewIngressSecretProviderClassReconciler(mgr, conf, ingressManager); err != nil {
1✔
196
                return fmt.Errorf("setting up ingress secret provider class reconciler: %w", err)
×
197
        }
×
198
        lgr.Info("setting up nginx keyvault secret provider class reconciler")
1✔
199
        if err := keyvault.NewNginxSecretProviderClassReconciler(mgr, conf); err != nil {
1✔
200
                return fmt.Errorf("setting up nginx secret provider class reconciler: %w", err)
×
201
        }
×
202
        lgr.Info("setting up keyvault placeholder pod controller")
1✔
203
        if err := keyvault.NewPlaceholderPodController(mgr, conf, ingressManager); err != nil {
1✔
204
                return fmt.Errorf("setting up placeholder pod controller: %w", err)
×
205
        }
×
206
        lgr.Info("setting up ingress tls reconciler")
1✔
207
        if err := keyvault.NewIngressTlsReconciler(mgr, conf, ingressManager); err != nil {
1✔
208
                return fmt.Errorf("setting up ingress tls reconciler: %w", err)
×
209
        }
×
210
        lgr.Info("setting up keyvault event mirror")
1✔
211
        if err = keyvault.NewEventMirror(mgr, conf); err != nil {
1✔
212
                return fmt.Errorf("setting up event mirror: %w", err)
×
213
        }
×
214

215
        ingressSourceSpecer := osm.NewIngressControllerSourceSpecerFromFn(func(ing *netv1.Ingress) (policyv1alpha1.IngressSourceSpec, bool, error) {
1✔
216
                return nginxingress.IngressSource(context.Background(), mgr.GetClient(), conf, defaultCc, ing, nicIngressClassIndex)
×
217
        })
×
218
        lgr.Info("setting up ingress backend reconciler")
1✔
219
        if err := osm.NewIngressBackendReconciler(mgr, conf, ingressSourceSpecer); err != nil {
1✔
220
                return fmt.Errorf("setting up ingress backend reconciler: %w", err)
×
221
        }
×
222

223
        if conf.EnableGateway {
1✔
224
                lgr.Info("setting up gateway reconcilers")
×
225
                if err := keyvault.NewGatewaySecretClassProviderReconciler(mgr, conf, gatewayListenerIndexName); err != nil {
×
226
                        return fmt.Errorf("setting up Gateway SPC reconciler: %w", err)
×
227
                }
×
228
        }
229

230
        lgr.Info("finished setting up controllers")
1✔
231
        return nil
1✔
232
}
233

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

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

239
        if err := mgr.AddReadyzCheck("readyz", check); err != nil {
1✔
240
                return fmt.Errorf("adding readyz check: %w", err)
×
241
        }
×
242

243
        if err := mgr.AddHealthzCheck("healthz", check); err != nil {
1✔
244
                return fmt.Errorf("adding healthz check: %w", err)
×
245
        }
×
246

247
        log.Info("added probes to manager")
1✔
248
        return nil
1✔
249
}
250

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

2✔
256
        deploy, err := kcs.AppsV1().Deployments(conf.NS).Get(context.Background(), conf.OperatorDeployment, metav1.GetOptions{})
2✔
257
        if errors.IsNotFound(err) {
3✔
258
                // It's okay if we don't find the deployment - just skip setting ownership references latter
1✔
259
                log.Info("self deploy not found")
1✔
260
                return nil, nil
1✔
261
        }
1✔
262
        if err != nil {
1✔
263
                return nil, err
×
264
        }
×
265
        return deploy, nil
1✔
266
}
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