-
Notifications
You must be signed in to change notification settings - Fork 591
/
run.go
468 lines (418 loc) · 16.4 KB
/
run.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
// Package manager implements the controller manager for all controllers
package manager
import (
"context"
"errors"
"fmt"
"net/http"
"net/url"
"os"
"time"
"github.com/avast/retry-go/v4"
"github.com/blang/semver/v4"
"github.com/go-logr/logr"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/tools/record"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/manager"
"github.com/kong/kubernetes-ingress-controller/v3/internal/adminapi"
"github.com/kong/kubernetes-ingress-controller/v3/internal/clients"
"github.com/kong/kubernetes-ingress-controller/v3/internal/controllers/gateway"
ctrlref "github.com/kong/kubernetes-ingress-controller/v3/internal/controllers/reference"
"github.com/kong/kubernetes-ingress-controller/v3/internal/dataplane"
dpconf "github.com/kong/kubernetes-ingress-controller/v3/internal/dataplane/config"
"github.com/kong/kubernetes-ingress-controller/v3/internal/dataplane/configfetcher"
"github.com/kong/kubernetes-ingress-controller/v3/internal/dataplane/sendconfig"
"github.com/kong/kubernetes-ingress-controller/v3/internal/dataplane/translator"
"github.com/kong/kubernetes-ingress-controller/v3/internal/gatewayapi"
"github.com/kong/kubernetes-ingress-controller/v3/internal/konnect"
"github.com/kong/kubernetes-ingress-controller/v3/internal/konnect/nodes"
"github.com/kong/kubernetes-ingress-controller/v3/internal/manager/featuregates"
"github.com/kong/kubernetes-ingress-controller/v3/internal/manager/metadata"
"github.com/kong/kubernetes-ingress-controller/v3/internal/manager/telemetry"
"github.com/kong/kubernetes-ingress-controller/v3/internal/manager/utils/kongconfig"
"github.com/kong/kubernetes-ingress-controller/v3/internal/store"
"github.com/kong/kubernetes-ingress-controller/v3/internal/util"
"github.com/kong/kubernetes-ingress-controller/v3/internal/util/kubernetes/object/status"
)
// -----------------------------------------------------------------------------
// Controller Manager - Setup & Run
// -----------------------------------------------------------------------------
// Run starts the controller manager and blocks until it exits.
func Run(
ctx context.Context,
c *Config,
diagnostic util.ConfigDumpDiagnostic,
logger logr.Logger,
) error {
setupLog := ctrl.LoggerFrom(ctx).WithName("setup")
setupLog.Info("Starting controller manager", "release", metadata.Release, "repo", metadata.Repo, "commit", metadata.Commit)
setupLog.Info("The ingress class name has been set", "value", c.IngressClassName)
gateway.SetControllerName(gatewayapi.GatewayController(c.GatewayAPIControllerName))
setupLog.Info("Getting enabled options and features")
featureGates, err := featuregates.New(setupLog, c.FeatureGates)
if err != nil {
return fmt.Errorf("failed to configure feature gates: %w", err)
}
setupLog.Info("Getting the kubernetes client configuration")
kubeconfig, err := c.GetKubeconfig()
if err != nil {
return fmt.Errorf("get kubeconfig from file %q: %w", c.KubeconfigPath, err)
}
setupLog.Info("Starting standalone health check server")
healthServer := &healthCheckServer{}
healthServer.setHealthzCheck(healthz.Ping)
healthServer.Start(ctx, c.ProbeAddr, setupLog.WithName("health-check"))
adminAPIsDiscoverer, err := adminapi.NewDiscoverer(sets.New(c.KongAdminSvcPortNames...), c.GatewayDiscoveryDNSStrategy)
if err != nil {
return fmt.Errorf("failed to create admin apis discoverer: %w", err)
}
err = c.Resolve()
if err != nil {
return fmt.Errorf("failed to resolve configuration: %w", err)
}
adminAPIClientsFactory := adminapi.NewClientFactoryForWorkspace(c.KongWorkspace, c.KongAdminAPIConfig, c.KongAdminToken)
setupLog.Info("Getting the kong admin api client configuration")
initialKongClients, err := c.adminAPIClients(
ctx,
setupLog.WithName("initialize-kong-clients"),
adminAPIsDiscoverer,
adminAPIClientsFactory,
)
if err != nil {
return fmt.Errorf("unable to build kong api client(s): %w", err)
}
// Get Kong configuration root(s) to validate them and extract Kong's version.
kongRoots, err := kongconfig.GetRoots(ctx, setupLog, c.KongAdminInitializationRetries, c.KongAdminInitializationRetryDelay, initialKongClients)
if err != nil {
return fmt.Errorf("could not retrieve Kong admin root(s): %w", err)
}
kongStartUpConfig, err := kongconfig.ValidateRoots(kongRoots, c.SkipCACertificates)
if err != nil {
return fmt.Errorf("could not validate Kong admin root(s) configuration: %w", err)
}
dbMode := kongStartUpConfig.DBMode
routerFlavor := kongStartUpConfig.RouterFlavor
v := kongStartUpConfig.Version
kongSemVersion := semver.Version{Major: v.Major(), Minor: v.Minor(), Patch: v.Patch()}
kongConfig := sendconfig.Config{
Version: kongSemVersion,
InMemory: dbMode.IsDBLessMode(),
Concurrency: c.Concurrency,
FilterTags: c.FilterTags,
SkipCACertificates: c.SkipCACertificates,
EnableReverseSync: c.EnableReverseSync,
ExpressionRoutes: dpconf.ShouldEnableExpressionRoutes(routerFlavor),
SanitizeKonnectConfigDumps: featureGates.Enabled(featuregates.SanitizeKonnectConfigDumps),
}
kongConfig.Init(ctx, setupLog, initialKongClients)
setupLog.Info("Configuring and building the controller manager")
managerOpts, err := setupManagerOptions(ctx, setupLog, c, dbMode)
if err != nil {
return fmt.Errorf("unable to setup manager options: %w", err)
}
mgr, err := ctrl.NewManager(kubeconfig, managerOpts)
if err != nil {
return fmt.Errorf("unable to create controller manager: %w", err)
}
if err := waitForKubernetesAPIReadiness(ctx, setupLog, mgr); err != nil {
return fmt.Errorf("unable to connect to Kubernetes API: %w", err)
}
setupLog.Info("Initializing Dataplane Client")
var eventRecorder record.EventRecorder
if c.EmitKubernetesEvents {
setupLog.Info("Emitting Kubernetes events enabled, creating an event recorder for " + KongClientEventRecorderComponentName)
eventRecorder = mgr.GetEventRecorderFor(KongClientEventRecorderComponentName)
} else {
setupLog.Info("Emitting Kubernetes events disabled, discarding all events")
// Create an empty record.FakeRecorder with no Events channel to discard all events.
eventRecorder = &record.FakeRecorder{}
}
readinessChecker := clients.NewDefaultReadinessChecker(adminAPIClientsFactory, setupLog.WithName("readiness-checker"))
clientsManager, err := clients.NewAdminAPIClientsManager(
ctx,
logger,
initialKongClients,
readinessChecker,
)
if err != nil {
return fmt.Errorf("failed to create AdminAPIClientsManager: %w", err)
}
clientsManager = clientsManager.WithDBMode(dbMode)
if c.KongAdminSvc.IsPresent() {
setupLog.Info("Running AdminAPIClientsManager loop")
clientsManager.Run()
}
translatorFeatureFlags := translator.NewFeatureFlags(
featureGates,
routerFlavor,
c.UpdateStatus,
kongStartUpConfig.Version.IsKongGatewayEnterprise(),
)
referenceIndexers := ctrlref.NewCacheIndexers(setupLog.WithName("reference-indexers"))
cache := store.NewCacheStores()
storer := store.New(cache, c.IngressClassName, logger)
configTranslator, err := translator.NewTranslator(
logger,
storer,
c.KongWorkspace,
translatorFeatureFlags,
)
if err != nil {
return fmt.Errorf("failed to create translator: %w", err)
}
setupLog.Info("Starting Admission Server")
if err := setupAdmissionServer(ctx, c, clientsManager, referenceIndexers, mgr.GetClient(), logger, translatorFeatureFlags, storer); err != nil {
return err
}
updateStrategyResolver := sendconfig.NewDefaultUpdateStrategyResolver(kongConfig, logger)
configurationChangeDetector := sendconfig.NewDefaultConfigurationChangeDetector(logger)
kongConfigFetcher := configfetcher.NewDefaultKongLastGoodConfigFetcher(translatorFeatureFlags.FillIDs, c.KongWorkspace)
dataplaneClient, err := dataplane.NewKongClient(
logger,
time.Duration(c.ProxyTimeoutSeconds*float32(time.Second)),
diagnostic,
kongConfig,
eventRecorder,
dbMode,
clientsManager,
updateStrategyResolver,
configurationChangeDetector,
kongConfigFetcher,
configTranslator,
cache,
)
if err != nil {
return fmt.Errorf("failed to initialize kong data-plane client: %w", err)
}
setupLog.Info("Initializing Dataplane Synchronizer")
synchronizer, err := setupDataplaneSynchronizer(logger, mgr, dataplaneClient, c.ProxySyncSeconds, c.InitCacheSyncDuration)
if err != nil {
return fmt.Errorf("unable to initialize dataplane synchronizer: %w", err)
}
var kubernetesStatusQueue *status.Queue
if c.UpdateStatus {
setupLog.Info("Starting Status Updater")
kubernetesStatusQueue = status.NewQueue(status.WithBufferSize(c.UpdateStatusQueueBufferSize))
dataplaneClient.EnableKubernetesObjectReports(kubernetesStatusQueue)
} else {
setupLog.Info("Status updates disabled, skipping status updater")
}
setupLog.Info("Initializing Dataplane address Discovery")
dataplaneAddressFinder, udpDataplaneAddressFinder, err := setupDataplaneAddressFinder(mgr.GetClient(), c, setupLog)
if err != nil {
return err
}
setupLog.Info("Starting Enabled Controllers")
controllers := setupControllers(
ctx,
mgr,
dataplaneClient,
referenceIndexers,
dataplaneAddressFinder,
udpDataplaneAddressFinder,
kubernetesStatusQueue,
c,
featureGates,
clientsManager,
adminAPIsDiscoverer,
)
for _, c := range controllers {
if err := c.MaybeSetupWithManager(mgr); err != nil {
return fmt.Errorf("unable to create controller %q: %w", c.Name(), err)
}
}
// BUG: kubebuilder (at the time of writing - 3.0.0-rc.1) does not allow this tag anywhere else than main.go
// See https://github.com/kubernetes-sigs/kubebuilder/issues/932
// +kubebuilder:scaffold:builder
setupLog.Info("Add readiness probe to health server")
healthServer.setReadyzCheck(readyzHandler(mgr, synchronizer))
instanceIDProvider := NewInstanceIDProvider()
if c.Konnect.ConfigSynchronizationEnabled {
konnectNodesAPIClient, err := nodes.NewClient(c.Konnect)
if err != nil {
return fmt.Errorf("failed creating konnect client: %w", err)
}
// In case of failures when building Konnect related objects, we're not returning errors as Konnect is not
// considered critical feature, and it should not break the basic functionality of the controller.
// Run the Konnect Admin API client initialization in a separate goroutine to not block while ensuring
// connection.
go setupKonnectAdminAPIClientWithClientsMgr(ctx, c.Konnect, clientsManager, setupLog)
// Setup Konnect NodeAgent with manager.
if err := setupKonnectNodeAgentWithMgr(
c,
mgr,
konnectNodesAPIClient,
dataplaneClient,
clientsManager,
setupLog,
instanceIDProvider,
); err != nil {
setupLog.Error(err, "Failed to setup Konnect NodeAgent with manager, skipping")
}
}
// Setup and inject license getter.
licenseGetter, err := setupLicenseGetter(
ctx,
c,
setupLog,
mgr,
kubernetesStatusQueue,
)
if err != nil {
setupLog.Error(err, "Failed to create a license getter from configuration")
return err
}
if licenseGetter != nil {
setupLog.Info("Inject license getter to config translator",
"license_getter_type", fmt.Sprintf("%T", licenseGetter))
configTranslator.InjectLicenseGetter(licenseGetter)
}
if c.AnonymousReports {
stopAnonymousReports, err := telemetry.SetupAnonymousReports(
ctx,
logger.WithName("telemetry"),
kubeconfig,
clientsManager,
telemetry.ReportConfig{
SplunkEndpoint: c.SplunkEndpoint,
SplunkEndpointInsecureSkipVerify: c.SplunkEndpointInsecureSkipVerify,
TelemetryPeriod: c.TelemetryPeriod,
ReportValues: telemetry.ReportValues{
PublishServiceNN: c.PublishService.OrEmpty(),
FeatureGates: featureGates,
MeshDetection: len(c.WatchNamespaces) == 0,
KonnectSyncEnabled: c.Konnect.ConfigSynchronizationEnabled,
GatewayServiceDiscoveryEnabled: c.KongAdminSvc.IsPresent(),
},
},
instanceIDProvider,
)
if err != nil {
setupLog.Error(err, "Failed setting up anonymous reports")
} else {
defer stopAnonymousReports()
}
setupLog.Info("Anonymous reports enabled")
} else {
setupLog.Info("Anonymous reports disabled, skipping")
}
setupLog.Info("Starting manager")
return mgr.Start(ctx)
}
// waitForKubernetesAPIReadiness waits for the Kubernetes API to be ready. It's used as a prerequisite to run any
// controller components (i.e. Manager along with its Runnables).
// It retries with a timeout of 1m and a fixed delay of 1s.
func waitForKubernetesAPIReadiness(ctx context.Context, logger logr.Logger, mgr manager.Manager) error {
const (
timeout = time.Minute
delay = time.Second
)
ctx, cancel := context.WithTimeout(ctx, timeout)
defer cancel()
readinessEndpointURL, err := url.JoinPath(mgr.GetConfig().Host, "readyz")
if err != nil {
return fmt.Errorf("failed to build readiness check URL: %w", err)
}
return retry.Do(func() error {
// Call the readiness check of the Kubernetes API server: https://kubernetes.io/docs/reference/using-api/health-checks/.
resp, err := mgr.GetHTTPClient().Get(readinessEndpointURL)
if err != nil {
return fmt.Errorf("failed to connect to %q: %w", readinessEndpointURL, err)
}
defer resp.Body.Close()
// We're waiting for the readiness check to return status 200.
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("readiness check %q returned status %d", readinessEndpointURL, resp.StatusCode)
}
return nil
},
retry.Context(ctx),
retry.Delay(delay),
retry.DelayType(retry.FixedDelay),
retry.Attempts(0), // We're using a context with timeout, so we don't need to limit the number of attempts.
retry.LastErrorOnly(true),
retry.OnRetry(func(n uint, err error) {
logger.Info("Retrying Kubernetes API readiness check after error", "error", err.Error())
}),
)
}
// setupKonnectNodeAgentWithMgr creates and adds Konnect NodeAgent as the manager's Runnable.
// Returns error if failed to create Konnect NodeAgent.
func setupKonnectNodeAgentWithMgr(
c *Config,
mgr manager.Manager,
konnectNodeAPIClient *nodes.Client,
dataplaneClient *dataplane.KongClient,
clientsManager *clients.AdminAPIClientsManager,
logger logr.Logger,
instanceIDProvider *InstanceIDProvider,
) error {
var hostname string
nn, err := util.GetPodNN()
if err != nil {
logger.Error(err, "Failed getting pod name and/or namespace, fallback to use hostname as node name in Konnect")
hostname, _ = os.Hostname()
} else {
hostname = nn.String()
logger.Info(fmt.Sprintf("Using %s as controller's node name in Konnect", hostname))
}
version := metadata.Release
// Set channel to send config status.
configStatusNotifier := clients.NewChannelConfigNotifier(logger)
dataplaneClient.SetConfigStatusNotifier(configStatusNotifier)
agent := konnect.NewNodeAgent(
hostname,
version,
c.Konnect.RefreshNodePeriod,
logger,
konnectNodeAPIClient,
configStatusNotifier,
konnect.NewGatewayClientGetter(logger, clientsManager),
clientsManager,
instanceIDProvider,
)
if err := mgr.Add(agent); err != nil {
return fmt.Errorf("failed adding konnect.NodeAgent runnable to the manager: %w", err)
}
return nil
}
// setupKonnectAdminAPIClientWithClientsMgr initializes Konnect Admin API client and sets it to clientsManager.
// If it fails to initialize the client, it logs the error and returns.
func setupKonnectAdminAPIClientWithClientsMgr(
ctx context.Context,
config adminapi.KonnectConfig,
clientsManager *clients.AdminAPIClientsManager,
logger logr.Logger,
) {
konnectAdminAPIClient, err := adminapi.NewKongClientForKonnectControlPlane(config)
if err != nil {
logger.Error(err, "Failed creating Konnect Control Plane Admin API client, skipping synchronisation")
return
}
if err := adminapi.EnsureKonnectConnection(ctx, konnectAdminAPIClient.AdminAPIClient(), logger); err != nil {
logger.Error(err, "Failed to ensure connection to Konnect Admin API, skipping synchronisation")
return
}
clientsManager.SetKonnectClient(konnectAdminAPIClient)
logger.Info("Initialized Konnect Admin API client")
}
type IsReady interface {
IsReady() bool
}
func readyzHandler(mgr manager.Manager, dataplaneSynchronizer IsReady) func(*http.Request) error {
return func(_ *http.Request) error {
select {
// If we're elected as leader then report readiness based on the readiness
// of dataplane synchronizer.
case <-mgr.Elected():
if !dataplaneSynchronizer.IsReady() {
return errors.New("synchronizer not yet configured")
}
// If we're not the leader then just report as ready.
default:
}
return nil
}
}