-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathgateway_controller.go
More file actions
2730 lines (2381 loc) · 100 KB
/
Copy pathgateway_controller.go
File metadata and controls
2730 lines (2381 loc) · 100 KB
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// SPDX-License-Identifier: AGPL-3.0-only
package controller
import (
"context"
"crypto/tls"
"fmt"
"slices"
"strconv"
"strings"
"time"
cmv1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
cmmeta "github.com/cert-manager/cert-manager/pkg/apis/meta/v1"
envoygatewayv1alpha1 "github.com/envoyproxy/gateway/api/v1alpha1"
"github.com/prometheus/client_golang/prometheus"
corev1 "k8s.io/api/core/v1"
discoveryv1 "k8s.io/api/discovery/v1"
"k8s.io/apimachinery/pkg/api/equality"
apierrors "k8s.io/apimachinery/pkg/api/errors"
apimeta "k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
"sigs.k8s.io/controller-runtime/pkg/cluster"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
mcbuilder "sigs.k8s.io/multicluster-runtime/pkg/builder"
mchandler "sigs.k8s.io/multicluster-runtime/pkg/handler"
mcmanager "sigs.k8s.io/multicluster-runtime/pkg/manager"
"sigs.k8s.io/multicluster-runtime/pkg/multicluster"
mcreconcile "sigs.k8s.io/multicluster-runtime/pkg/reconcile"
mcsource "sigs.k8s.io/multicluster-runtime/pkg/source"
networkingv1alpha "go.datum.net/network-services-operator/api/v1alpha"
"go.datum.net/network-services-operator/internal/config"
downstreamclient "go.datum.net/network-services-operator/internal/downstreamclient"
gatewayutil "go.datum.net/network-services-operator/internal/util/gateway"
"go.datum.net/network-services-operator/internal/util/resourcename"
dnsv1alpha1 "go.miloapis.com/dns-operator/api/v1alpha1"
)
const gatewayControllerFinalizer = "gateway.networking.datumapis.com/gateway-controller"
const gatewayControllerGCFinalizer = "gateway.networking.datumapis.com/gateway-controller-gc"
const certificateIssuerTLSOption = "gateway.networking.datumapis.com/certificate-issuer"
// autoIssuerSentinel is the placeholder value the defaulting webhook stamps
// onto the operator-injected default-https listener via
// listenerTLSOptions. It means "use whichever real issuer the user's other
// TLS listener on this gateway specified" — see resolveAutoIssuer.
const autoIssuerSentinel = "auto"
const annotationReissuanceCount = "networking.datumapis.com/reissuance-count"
const KindGateway = "Gateway"
const KindHTTPRoute = "HTTPRoute"
const KindService = "Service"
const KindEndpointSlice = "EndpointSlice"
// GatewayReconciler reconciles a Gateway object
type GatewayReconciler struct {
mgr mcmanager.Manager
Config config.NetworkServicesOperator
DownstreamCluster cluster.Cluster
}
// +kubebuilder:rbac:groups=core,resources=services,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=core,resources=services/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=core,resources=services/finalizers,verbs=update
// +kubebuilder:rbac:groups=discovery.k8s.io,resources=endpointslices,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=discovery.k8s.io,resources=endpointslices/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=discovery.k8s.io,resources=endpointslices/finalizers,verbs=update
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=gateways,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=gateways/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=gateways/finalizers,verbs=update
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=httproutes,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=httproutes/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=httproutes/finalizers,verbs=update
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=backendtlspolicies,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=backendtlspolicies/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=gateway.networking.k8s.io,resources=backendtlspolicies/finalizers,verbs=update
// +kubebuilder:rbac:groups=cert-manager.io,resources=certificates,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=externaldns.k8s.io,resources=dnsendpoints,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=externaldns.k8s.io,resources=dnsendpoints/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=externaldns.k8s.io,resources=dnsendpoints/finalizers,verbs=update
func (r *GatewayReconciler) Reconcile(ctx context.Context, req mcreconcile.Request) (ctrl.Result, error) {
logger := log.FromContext(ctx, "cluster", req.ClusterName, "namespace", req.Namespace, jsonKeyName, req.Name)
ctx = log.IntoContext(ctx, logger)
logger.Info("gateway reconcile dequeued")
cl, err := r.mgr.GetCluster(ctx, req.ClusterName)
if err != nil {
logger.Error(err, "failed to get cluster")
return ctrl.Result{}, err
}
logger.Info("got cluster, fetching gateway")
var gateway gatewayv1.Gateway
if err := cl.GetClient().Get(ctx, req.NamespacedName, &gateway); err != nil {
if apierrors.IsNotFound(err) {
logger.Info("gateway not found, skipping")
return ctrl.Result{}, nil
}
logger.Error(err, "failed to get gateway")
return ctrl.Result{}, err
}
// Look up the GatewayClass to determine if it's applicable to this controller
var upstreamGatewayClass gatewayv1.GatewayClass
if err := cl.GetClient().Get(ctx, types.NamespacedName{Name: string(gateway.Spec.GatewayClassName)}, &upstreamGatewayClass); err != nil {
if apierrors.IsNotFound(err) {
logger.Info("gateway class not found, skipping")
return ctrl.Result{}, nil
}
logger.Error(err, "failed to get gateway class")
return ctrl.Result{}, err
}
if upstreamGatewayClass.Spec.ControllerName != r.Config.Gateway.ControllerName {
logger.Info("gateway class controller name mismatch, skipping", "expected", r.Config.Gateway.ControllerName, "actual", upstreamGatewayClass.Spec.ControllerName)
return ctrl.Result{}, nil
}
downstreamStrategy := downstreamclient.NewMappedNamespaceResourceStrategy(string(req.ClusterName), cl.GetClient(), r.DownstreamCluster.GetClient())
if !gateway.DeletionTimestamp.IsZero() {
if controllerutil.ContainsFinalizer(&gateway, gatewayControllerFinalizer) {
if result := r.finalizeGateway(ctx, string(req.ClusterName), cl.GetClient(), &gateway, downstreamStrategy); result.ShouldReturn() {
return result.Complete(ctx)
}
controllerutil.RemoveFinalizer(&gateway, gatewayControllerFinalizer)
if err := cl.GetClient().Update(ctx, &gateway); err != nil {
return ctrl.Result{}, fmt.Errorf("failed to remove finalizer from gateway: %w", err)
}
}
return ctrl.Result{}, nil
}
if r.prepareUpstreamGateway(&gateway) {
logger.Info("preparing upstream gateway (adding finalizer/defaults)")
if err := cl.GetClient().Update(ctx, &gateway); err != nil {
logger.Error(err, "failed preparing upstream gateway")
return ctrl.Result{}, fmt.Errorf("failed preparing upstream gateway: %w", err)
}
return ctrl.Result{}, nil
}
logger.Info("reconciling gateway")
defer logger.Info("reconcile complete")
result, _ := r.ensureDownstreamGateway(ctx, string(req.ClusterName), cl.GetClient(), &gateway, downstreamStrategy)
if result.ShouldReturn() {
return result.Complete(ctx)
}
return result.Complete(ctx)
}
// prepareUpstreamGateway adds a finalizer to the upstream gateway and ensures
// that default listeners have their hostname fields set.
func (r *GatewayReconciler) prepareUpstreamGateway(gateway *gatewayv1.Gateway) (needsUpdate bool) {
if !controllerutil.ContainsFinalizer(gateway, gatewayControllerFinalizer) {
controllerutil.AddFinalizer(gateway, gatewayControllerFinalizer)
needsUpdate = true
}
// Ensure that the default listeners have hostnames set. This is not done in
// the defaulting webhook as the UID is not available, but we still want to
// let users create gateways without listeners and receive sane defaults.
gatewayDefaultHostname := ptr.To(gatewayv1.Hostname(r.gatewayCanonicalHostname(gateway)))
defaultHTTPListener := gatewayutil.GetListenerByName(gateway.Spec.Listeners, gatewayutil.DefaultHTTPListenerName)
if defaultHTTPListener != nil && defaultHTTPListener.Hostname == nil {
needsUpdate = true
defaultHTTPListener.Hostname = gatewayDefaultHostname
}
defaultHTTPSListener := gatewayutil.GetListenerByName(gateway.Spec.Listeners, gatewayutil.DefaultHTTPSListenerName)
if defaultHTTPSListener != nil && defaultHTTPSListener.Hostname == nil {
needsUpdate = true
defaultHTTPSListener.Hostname = gatewayDefaultHostname
}
return needsUpdate
}
func (r *GatewayReconciler) ensureDownstreamGateway(
ctx context.Context,
upstreamClusterName string,
upstreamClient client.Client,
upstreamGateway *gatewayv1.Gateway,
downstreamStrategy downstreamclient.ResourceStrategy,
) (result Result, downstreamGateway *gatewayv1.Gateway) {
// Get the upstream gateway class so that we can pull the controller name out
// of it and use it in route status updates.
var upstreamGatewayClass gatewayv1.GatewayClass
if err := upstreamClient.Get(ctx, types.NamespacedName{Name: string(upstreamGateway.Spec.GatewayClassName)}, &upstreamGatewayClass); err != nil {
result.Err = err
return result, nil
}
upstreamGatewayClassControllerName := string(upstreamGatewayClass.Spec.ControllerName)
var targetDomainHostnames []string
// Keep existing addresses in the status if present.
if len(upstreamGateway.Status.Addresses) > 0 {
for _, addr := range upstreamGateway.Status.Addresses {
if ptr.Deref(addr.Type, "") == gatewayv1.HostnameAddressType {
targetDomainHostnames = append(targetDomainHostnames, addr.Value)
}
}
} else {
gatewayDNSAddress := r.gatewayCanonicalHostname(upstreamGateway)
// targetDomainHostnames are default hostnames that are unique to each gateway, and
// will have DNS records created for them. Any custom hostnames provided in
// listeners WILL NOT be added to the addresses list in the gateway status.
targetDomainHostnames = append(targetDomainHostnames, gatewayDNSAddress)
if r.Config.Gateway.IPv4Enabled() {
targetDomainHostnames = append(targetDomainHostnames, fmt.Sprintf("v4.%s", gatewayDNSAddress))
}
if r.Config.Gateway.IPv6Enabled() {
targetDomainHostnames = append(targetDomainHostnames, fmt.Sprintf("v6.%s", gatewayDNSAddress))
}
}
downstreamClient := downstreamStrategy.GetClient()
downstreamGatewayObjectMeta, err := downstreamStrategy.ObjectMetaFromUpstreamObject(ctx, upstreamGateway)
if err != nil {
result.Err = fmt.Errorf("failed to get downstream gateway object metadata: %w", err)
return result, nil
}
downstreamGateway = &gatewayv1.Gateway{
ObjectMeta: downstreamGatewayObjectMeta,
}
if err := downstreamClient.Get(ctx, client.ObjectKeyFromObject(downstreamGateway), downstreamGateway); client.IgnoreNotFound(err) != nil {
result.Err = fmt.Errorf("failed to get downstream gateway: %w", err)
return result, nil
}
verifiedHostnames, claimedHostnames, notClaimedHostnames, err := r.ensureHostnamesClaimed(
ctx,
upstreamClusterName,
upstreamClient,
upstreamGateway,
downstreamGateway,
)
if err != nil {
result.Err = err
return result, nil
}
// Evaluate certificate health once so the listener we propagate and the
// status we report to the user can never disagree.
listenerCertHealth := r.evaluateListenerCertHealth(
ctx,
downstreamClient,
downstreamGateway.Namespace,
upstreamGateway,
claimedHostnames,
)
desiredDownstreamGateway := r.getDesiredDownstreamGateway(
ctx,
upstreamGateway,
claimedHostnames,
listenerCertHealth,
)
if downstreamGateway.CreationTimestamp.IsZero() {
if err := downstreamStrategy.SetControllerReference(ctx, upstreamGateway, downstreamGateway); err != nil {
result.Err = fmt.Errorf("failed to set controller reference on downstream gateway: %w", err)
return result, nil
}
downstreamGateway.Annotations = desiredDownstreamGateway.Annotations
downstreamGateway.Spec = desiredDownstreamGateway.Spec
if err := downstreamClient.Create(ctx, downstreamGateway); err != nil {
result.Err = fmt.Errorf("failed creating downstream gateway: %w", err)
return result, nil
}
} else {
if !equality.Semantic.DeepEqual(downstreamGateway.Annotations, desiredDownstreamGateway.Annotations) ||
!equality.Semantic.DeepEqual(downstreamGateway.Spec, desiredDownstreamGateway.Spec) {
downstreamGateway.Annotations = desiredDownstreamGateway.Annotations
downstreamGateway.Spec = desiredDownstreamGateway.Spec
if err := downstreamClient.Update(ctx, downstreamGateway); err != nil {
result.Err = fmt.Errorf("failed updating downstream gateway: %w", err)
return result, nil
}
}
}
certResult := r.ensureListenerCertificates(
ctx,
upstreamGateway,
downstreamGateway,
downstreamClient,
downstreamStrategy,
claimedHostnames,
)
if certResult.ShouldReturn() {
return certResult.Merge(result), nil
}
dnsResult := r.ensureDownstreamGatewayDNSEndpoints(
ctx,
downstreamGateway,
downstreamStrategy,
targetDomainHostnames,
)
if dnsResult.Err != nil || dnsResult.StopProcessing {
return dnsResult.Merge(result), nil
}
// Carry RequeueAfter from dnsResult (e.g. IPs not yet available) without
// blocking downstream HTTPRoute creation or gateway status updates.
result = result.Merge(dnsResult)
hostnameStatuses, dnsProgramResult := r.ensureDNSRecordSets(
ctx,
upstreamClient,
upstreamGateway,
claimedHostnames,
)
if dnsProgramResult.ShouldReturn() {
return dnsProgramResult.Merge(result), nil
}
result = result.Merge(dnsProgramResult)
if len(hostnameStatuses) > 0 {
dnsStatusResult := r.reconcileDNSStatus(upstreamClient, upstreamGateway, hostnameStatuses)
result = result.Merge(dnsStatusResult)
}
gatewayStatusResult := r.reconcileGatewayStatus(
ctx,
upstreamClient,
upstreamGateway,
downstreamGateway,
)
if gatewayStatusResult.Err != nil || gatewayStatusResult.StopProcessing {
return gatewayStatusResult.Merge(result), nil
}
// Carry RequeueAfter from gatewayStatusResult (e.g. downstream not yet programmed)
// without blocking HTTPRoute creation.
result = result.Merge(gatewayStatusResult)
httpRouteResult := r.ensureDownstreamGatewayHTTPRoutes(
ctx,
upstreamClient,
upstreamGateway,
upstreamGatewayClassControllerName,
downstreamGateway,
downstreamStrategy,
verifiedHostnames,
notClaimedHostnames,
listenerCertHealth,
)
// When a listener is only waiting on a certificate to be issued, check back
// soon so it starts serving promptly once the certificate is ready.
for _, status := range listenerCertHealth {
if !status.healthy && status.pending {
result.RequeueAfter = max(result.RequeueAfter, 1*time.Minute)
break
}
}
addresses := make([]gatewayv1.GatewayStatusAddress, 0, len(targetDomainHostnames))
for _, hostname := range targetDomainHostnames {
addresses = append(addresses, gatewayv1.GatewayStatusAddress{
Type: ptr.To(gatewayv1.HostnameAddressType),
Value: hostname,
})
}
if !equality.Semantic.DeepEqual(upstreamGateway.Status.Addresses, addresses) {
upstreamGateway.Status.Addresses = addresses
result.AddStatusUpdate(upstreamClient, upstreamGateway)
}
return httpRouteResult.Merge(result), downstreamGateway
}
// listenerCertExpiryMargin keeps a certificate that is mid-renewal from briefly
// looking expired and dropping the listener.
const listenerCertExpiryMargin = 1 * time.Minute
// listenerCertStatus describes whether a listener's TLS certificate is usable.
// A listener with no entry is never gated: its certificate is managed elsewhere
// (for example the shared platform certificate) and a customer's certificate
// failure must never disable it.
type listenerCertStatus struct {
healthy bool
// reason is the listener status reason shown when the certificate is unusable.
reason gatewayv1.ListenerConditionReason
// message is a plain-language explanation shown to the customer.
message string
// pending means the listener is only waiting on a certificate to be issued,
// so the reconcile should check back to let it recover.
pending bool
// notAfter is the certificate's expiry time, populated only when the
// certificate is healthy and its expiry is known. Used to set the expiry
// gauge so operators can alert before a cert expires.
notAfter *metav1.Time
// secretName is the downstream Secret that holds the certificate material.
// Carried here so the expiry gauge can be labelled with the secret name
// without recomputing it outside listenerCertHealth.
secretName string
}
// clearListenerCertMetrics removes every certificate-health gauge series for a
// gateway. Used both before re-recording each reconcile and on gateway deletion
// so a removed listener never leaves a series stuck at its last value. The gating
// counter is left alone because it is cumulative.
func clearListenerCertMetrics(namespace, name string) {
labels := prometheus.Labels{jsonKeyNamespace: namespace, jsonKeyName: name}
gatewayListenerCertWithheld.DeletePartialMatch(labels)
gatewayListenerCertExpiryTime.DeletePartialMatch(labels)
gatewayListenerCertManaged.DeletePartialMatch(labels)
}
// evaluateListenerCertHealth reports which listeners have a usable certificate.
// It only considers listeners that own a per-hostname certificate; the same
// selection the rest of the controller uses keeps what we propagate and what we
// report to the customer consistent. A listener with no certificate of its own
// is left out so it is never gated.
func (r *GatewayReconciler) evaluateListenerCertHealth(
ctx context.Context,
downstreamClient client.Client,
downstreamNamespace string,
upstreamGateway *gatewayv1.Gateway,
claimedHostnames []string,
) map[gatewayv1.SectionName]listenerCertStatus {
logger := log.FromContext(ctx)
health := make(map[gatewayv1.SectionName]listenerCertStatus)
wildcardSuffix := "." + r.Config.Gateway.TargetDomain
hasSharedSecret := r.Config.Gateway.HasDefaultListenerTLSSecret()
now := time.Now()
// Drop this gateway's previous certificate metrics up front and re-record the
// current state below, so series for listeners that recovered, changed
// hostname, or were removed don't linger at a stale value.
clearListenerCertMetrics(upstreamGateway.Namespace, upstreamGateway.Name)
for _, l := range upstreamGateway.Spec.Listeners {
// Only listeners that own a per-hostname certificate are gated.
if l.TLS == nil || l.TLS.Options[certificateIssuerTLSOption] == "" || l.Hostname == nil {
continue
}
hostname := string(*l.Hostname)
if !slices.Contains(claimedHostnames, hostname) {
continue
}
// The shared platform certificate is managed by us, not the customer,
// so never gate listeners that use it.
if hasSharedSecret && (strings.HasSuffix(hostname, wildcardSuffix) || hostname == r.Config.Gateway.TargetDomain) {
continue
}
status := r.listenerCertHealth(ctx, downstreamClient, downstreamNamespace, upstreamGateway.Name, l.Name, hostname, now)
health[l.Name] = status
// Mark this listener as managed regardless of its health, so the
// SLI ratio (withheld / managed) can be computed fleet-wide.
gatewayListenerCertManaged.WithLabelValues(
upstreamGateway.Namespace, upstreamGateway.Name, string(l.Name), hostname,
).Set(1)
if !status.healthy {
logArgs := []any{
"listener", l.Name, "hostname", hostname,
"reason", status.reason, "message", status.message,
}
// Include the expiry timestamp when available so log queries can
// identify exactly when the cert stopped being valid.
if status.notAfter != nil {
logArgs = append(logArgs, "cert_not_after", status.notAfter.UTC().Format(time.RFC3339))
}
logger.Info("listener certificate unhealthy", logArgs...)
gatewayListenerCertWithheld.WithLabelValues(
upstreamGateway.Namespace, upstreamGateway.Name,
string(l.Name), hostname, string(status.reason),
).Set(1)
gatewayListenerCertGatingTotal.WithLabelValues(
upstreamGateway.Namespace, upstreamGateway.Name,
string(l.Name), hostname, string(status.reason),
).Inc()
} else if status.notAfter != nil {
// Record the expiry timestamp for healthy certs so operators can
// alert before the next expiry rather than after.
gatewayListenerCertExpiryTime.WithLabelValues(
upstreamGateway.Namespace, upstreamGateway.Name,
string(l.Name), hostname, status.secretName,
).Set(float64(status.notAfter.Unix()))
}
}
return health
}
// listenerCertHealth reports whether a single listener's certificate can be
// used to serve HTTPS right now, covering every way it can be unusable: still
// being issued, not yet valid, expired, or missing.
func (r *GatewayReconciler) listenerCertHealth(
ctx context.Context,
downstreamClient client.Client,
downstreamNamespace string,
gatewayName string,
listenerName gatewayv1.SectionName,
hostname string,
now time.Time,
) listenerCertStatus {
logger := log.FromContext(ctx)
certName := listenerCertificateName(gatewayName, listenerName)
secretName := listenerCertificateSecretName(gatewayName, listenerName)
// The certificate must have been issued.
var cert cmv1.Certificate
if err := downstreamClient.Get(ctx, client.ObjectKey{Namespace: downstreamNamespace, Name: certName}, &cert); err != nil {
if apierrors.IsNotFound(err) {
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certIssuanceFailingMessage(hostname),
pending: true,
secretName: secretName,
}
}
// On a read error, hold the listener back but allow it to recover later.
logger.Error(err, "failed to get listener Certificate", "certificate", certName)
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certIssuanceFailingMessage(hostname),
pending: true,
secretName: secretName,
}
}
if !certIsReady(&cert) {
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certIssuanceFailingMessage(hostname),
pending: true,
secretName: secretName,
}
}
// The certificate must be within its valid dates.
if cert.Status.NotBefore != nil && cert.Status.NotBefore.After(now) {
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certNotYetValidMessage(hostname),
secretName: secretName,
}
}
if cert.Status.NotAfter != nil && !cert.Status.NotAfter.After(now.Add(listenerCertExpiryMargin)) {
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certExpiredMessage(hostname),
notAfter: cert.Status.NotAfter,
secretName: secretName,
}
}
// Finally, load the stored certificate and key and confirm they match and
// are still valid. This catches a broken or mismatched certificate that
// would otherwise be served and break HTTPS for the listener.
var secret corev1.Secret
if err := downstreamClient.Get(ctx, client.ObjectKey{Namespace: downstreamNamespace, Name: secretName}, &secret); err != nil {
if apierrors.IsNotFound(err) {
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certMissingMessage(hostname),
pending: true,
secretName: secretName,
}
}
logger.Error(err, "failed to get listener Secret", "secret", secretName)
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certMissingMessage(hostname),
pending: true,
secretName: secretName,
}
}
keyPair, err := tls.X509KeyPair(secret.Data["tls.crt"], secret.Data["tls.key"])
if err != nil {
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certMissingMessage(hostname),
secretName: secretName,
}
}
if leaf := keyPair.Leaf; leaf != nil && !leaf.NotAfter.After(now) {
return listenerCertStatus{
reason: gatewayv1.ListenerReasonInvalidCertificateRef,
message: certExpiredMessage(hostname),
secretName: secretName,
}
}
return listenerCertStatus{healthy: true, notAfter: cert.Status.NotAfter, secretName: secretName}
}
// certIsReady reports whether a cert-manager Certificate has Ready=True.
func certIsReady(cert *cmv1.Certificate) bool {
for _, c := range cert.Status.Conditions {
if c.Type == cmv1.CertificateConditionReady {
return c.Status == cmmeta.ConditionTrue
}
}
return false
}
// These messages are shown to customers, so they stay plain and name the
// hostname affected.
func certExpiredMessage(hostname string) string {
return fmt.Sprintf("The TLS certificate for %s has expired, so HTTPS for this hostname is paused until a valid certificate is issued. This usually means the domain no longer points to Datum — please check its DNS.", hostname)
}
func certNotYetValidMessage(hostname string) string {
return fmt.Sprintf("The TLS certificate for %s isn't valid yet. HTTPS will start automatically once its start date is reached.", hostname)
}
func certIssuanceFailingMessage(hostname string) string {
return fmt.Sprintf("We couldn't issue a TLS certificate for %s, so HTTPS for this hostname is unavailable. Please confirm the domain points to Datum.", hostname)
}
func certMissingMessage(hostname string) string {
return fmt.Sprintf("The TLS certificate for %s is missing or unreadable, so HTTPS for this hostname is unavailable.", hostname)
}
func (r *GatewayReconciler) getDesiredDownstreamGateway(
ctx context.Context,
upstreamGateway *gatewayv1.Gateway,
claimedHostnames []string,
listenerCertHealth map[gatewayv1.SectionName]listenerCertStatus,
) *gatewayv1.Gateway {
logger := log.FromContext(ctx)
var downstreamGateway gatewayv1.Gateway
var listeners []gatewayv1.Listener
wildcardSuffix := "." + r.Config.Gateway.TargetDomain
for listenerIndex, l := range upstreamGateway.Spec.Listeners {
if l.Hostname != nil && !slices.Contains(claimedHostnames, string(*l.Hostname)) {
logger.Info("skipping downstream gateway listener with unclaimed hostname", "upstream_listener_index", listenerIndex, "hostname", *l.Hostname)
continue
}
// Leave out a listener whose certificate isn't usable. A bad certificate
// then only affects its own hostname, and every other hostname on the
// gateway keeps serving.
if status, gated := listenerCertHealth[l.Name]; gated {
if !status.healthy {
logger.Info("skipping downstream gateway listener with unhealthy certificate",
"upstream_listener_index", listenerIndex, "listener", l.Name,
"reason", status.reason, "message", status.message)
continue
}
// The listener was evaluated (it owns a per-hostname cert) and is
// healthy: it is admitted to the downstream gateway. Log this so
// operators can confirm recovery without correlating metric state.
logger.Info("admitting downstream gateway listener with healthy certificate",
"upstream_listener_index", listenerIndex, "listener", l.Name)
}
// Per-listener TLS decision: hostnames covered by the wildcard
// (*.targetDomain) reference the pre-provisioned shared secret;
// all others reference a per-listener secret populated by a
// Certificate resource created in ensureListenerCertificates.
hostnameUnderWildcard := false
if l.Hostname != nil {
h := string(*l.Hostname)
hostnameUnderWildcard = strings.HasSuffix(h, wildcardSuffix) || h == r.Config.Gateway.TargetDomain
}
useSharedTLS := hostnameUnderWildcard && r.Config.Gateway.HasDefaultListenerTLSSecret()
if l.Hostname != nil {
listenerCopy := l.DeepCopy()
if l.TLS != nil && l.TLS.Options[certificateIssuerTLSOption] != "" {
delete(listenerCopy.TLS.Options, certificateIssuerTLSOption)
tlsMode := gatewayv1.TLSModeTerminate
if useSharedTLS {
listenerCopy.TLS = &gatewayv1.ListenerTLSConfig{
Mode: &tlsMode,
CertificateRefs: []gatewayv1.SecretObjectReference{
{
Group: ptr.To(gatewayv1.Group("")),
Kind: ptr.To(gatewayv1.Kind("Secret")),
Name: gatewayv1.ObjectName(r.Config.Gateway.DefaultListenerTLSSecretName),
},
},
}
} else {
// Secret name must match the Certificate created by
// ensureListenerCertificates for this listener.
listenerCopy.TLS = &gatewayv1.ListenerTLSConfig{
Mode: &tlsMode,
CertificateRefs: []gatewayv1.SecretObjectReference{
{
Group: ptr.To(gatewayv1.Group("")),
Kind: ptr.To(gatewayv1.Kind("Secret")),
Name: gatewayv1.ObjectName(listenerCertificateSecretName(upstreamGateway.Name, l.Name)),
},
},
}
}
}
listeners = append(listeners, *listenerCopy)
}
}
// TODO(jreese) get from "scheduler"
downstreamGateway.Spec.GatewayClassName = gatewayv1.ObjectName(r.Config.Gateway.DownstreamGatewayClassName)
downstreamGateway.Spec.Listeners = listeners
return &downstreamGateway
}
// listenerCertificateSecretName returns the deterministic Secret name that a
// Certificate resource will populate for a given gateway listener.
func listenerCertificateSecretName(gatewayName string, listenerName gatewayv1.SectionName) string {
return resourcename.GetValidDNS1123Name(fmt.Sprintf("%s-%s", gatewayName, listenerName))
}
// listenerCertificateName returns the deterministic Certificate resource name
// for a given gateway listener.
func listenerCertificateName(gatewayName string, listenerName gatewayv1.SectionName) string {
return resourcename.GetValidDNS1123Name(fmt.Sprintf("%s-%s", gatewayName, listenerName))
}
// resolveAutoIssuer returns the first non-`auto` certificate-issuer value
// found on any TLS listener of the gateway, mapped through ClusterIssuerMap.
// Returns "" when no listener carries a real issuer.
//
// This restores the gateway-shim era semantic where the operator set a single
// cert-manager.io/cluster-issuer annotation on the downstream Gateway from
// the first TLS listener with an issuer (see the `if !HasAnnotation` guard
// in pre-`feat: gateway controller certificates` code) and gateway-shim
// minted Certificates for every TLS listener — including the auto-injected
// default-https — using that one annotation.
func (r *GatewayReconciler) resolveAutoIssuer(gateway *gatewayv1.Gateway) string {
for _, l := range gateway.Spec.Listeners {
if l.TLS == nil {
continue
}
issuer := string(l.TLS.Options[certificateIssuerTLSOption])
if issuer == "" || issuer == autoIssuerSentinel {
continue
}
if mapped := r.Config.Gateway.ClusterIssuerMap[issuer]; mapped != "" {
return mapped
}
return issuer
}
return ""
}
// ensureListenerCertificates creates, updates, or deletes cert-manager
// Certificate resources for each listener that requires an individual TLS
// certificate. Listeners whose hostnames fall under the wildcard target domain
// use the shared TLS secret and do not get a Certificate.
func (r *GatewayReconciler) ensureListenerCertificates(
ctx context.Context,
upstreamGateway *gatewayv1.Gateway,
downstreamGateway *gatewayv1.Gateway,
downstreamClient client.Client,
downstreamStrategy downstreamclient.ResourceStrategy,
claimedHostnames []string,
) (result Result) {
logger := log.FromContext(ctx)
wildcardSuffix := "." + r.Config.Gateway.TargetDomain
desiredCerts := make(map[string]bool)
gatewayNeedsUpdate := false
// Wildcard-covered listeners are covered by the shared TLS secret only when
// one is configured (DefaultListenerTLSSecretName). Otherwise they need a
// per-listener Certificate just like any other listener — the downstream
// listener already references a per-listener secret name via
// ensureDownstreamGateway, and nothing else creates that secret.
hasSharedSecret := r.Config.Gateway.HasDefaultListenerTLSSecret()
// The defaulting webhook stamps the operator-injected default-https
// listener with `certificate-issuer: auto` (the listenerTLSOptions
// default). Pre-`feat: gateway controller certificates`, the operator set
// a single cert-manager.io/cluster-issuer annotation on the downstream
// Gateway from the first listener with a real issuer, and gateway-shim
// minted Certificates for every TLS listener from that one annotation —
// so `auto` was implicitly resolved to whatever the user's other listener
// specified. With per-listener Certificate creation, that implicit
// resolution disappeared. Restore it: when a listener's issuer is `auto`,
// fall back to the first real issuer found on any TLS listener of this
// gateway, mapped through ClusterIssuerMap.
autoResolved := r.resolveAutoIssuer(upstreamGateway)
for _, l := range upstreamGateway.Spec.Listeners {
if l.TLS == nil || l.TLS.Options[certificateIssuerTLSOption] == "" || l.Hostname == nil {
continue
}
hostname := string(*l.Hostname)
if !slices.Contains(claimedHostnames, hostname) {
continue
}
if hasSharedSecret && (strings.HasSuffix(hostname, wildcardSuffix) || hostname == r.Config.Gateway.TargetDomain) {
continue
}
// Apply ClusterIssuerMap translation first — this is the admin-level
// override (e.g. mapping the `auto` sentinel to a real ClusterIssuer
// name). Only fall back to the gateway-shim era inter-listener
// resolution when the sentinel survives mapping unchanged, i.e. when
// the admin hasn't provided a translation.
clusterIssuerName := string(l.TLS.Options[certificateIssuerTLSOption])
if mapped := r.Config.Gateway.ClusterIssuerMap[clusterIssuerName]; mapped != "" {
clusterIssuerName = mapped
}
if clusterIssuerName == autoIssuerSentinel {
if autoResolved == "" {
// No real issuer on this gateway to inherit from — match the
// pre-migration behavior of leaving the listener un-programmed
// rather than creating a Certificate with an unresolvable
// IssuerRef.
continue
}
clusterIssuerName = autoResolved
}
certName := listenerCertificateName(upstreamGateway.Name, l.Name)
secretName := listenerCertificateSecretName(upstreamGateway.Name, l.Name)
desiredCerts[certName] = true
cert := &cmv1.Certificate{
ObjectMeta: metav1.ObjectMeta{
Name: certName,
Namespace: downstreamGateway.Namespace,
},
}
if err := downstreamClient.Get(ctx, client.ObjectKeyFromObject(cert), cert); client.IgnoreNotFound(err) != nil {
result.Err = fmt.Errorf("failed to get Certificate %s: %w", certName, err)
return result
}
isNew := cert.CreationTimestamp.IsZero()
if isNew {
if err := downstreamStrategy.SetControllerReference(ctx, upstreamGateway, cert); err != nil {
result.Err = fmt.Errorf("failed to set strategy reference on Certificate %s: %w", certName, err)
return result
}
}
// Ensure the downstream Gateway is the controller owner. The
// downstream certificate solver controller walks the ownership
// chain (Challenge → Order → Certificate → Gateway) to locate
// the Gateway when creating solver HTTPRoutes for HTTP-01
// challenges.
ownerRefChanged := !metav1.IsControlledBy(cert, downstreamGateway)
if ownerRefChanged {
if err := controllerutil.SetControllerReference(downstreamGateway, cert, downstreamClient.Scheme()); err != nil {
result.Err = fmt.Errorf("failed to set controller reference on Certificate %s: %w", certName, err)
return result
}
}
desiredSpec := cmv1.CertificateSpec{
SecretName: secretName,
SecretTemplate: &cmv1.CertificateSecretTemplate{
Labels: map[string]string{
downstreamclient.UpstreamOwnerClusterNameLabel: cert.Labels[downstreamclient.UpstreamOwnerClusterNameLabel],
},
},
DNSNames: []string{hostname},
IssuerRef: cmmeta.ObjectReference{
Name: clusterIssuerName,
Kind: KindClusterIssuer,
},
}
var opResult string
var err error
if isNew {
reissuanceCount := getReissuanceCount(downstreamGateway, certName)
if reissuanceCount > 0 {
if cert.Annotations == nil {
cert.Annotations = make(map[string]string)
}
cert.Annotations[annotationReissuanceCount] = fmt.Sprintf("%d", reissuanceCount)
}
cert.Spec = desiredSpec
err = downstreamClient.Create(ctx, cert)
opResult = "created"
} else if !equality.Semantic.DeepEqual(cert.Spec, desiredSpec) || ownerRefChanged {
cert.Spec = desiredSpec
err = downstreamClient.Update(ctx, cert)
opResult = "updated"
}
if err != nil {
result.Err = fmt.Errorf("failed to ensure Certificate %s: %w", certName, err)
return result
}
if opResult != "" {
logger.Info("Certificate reconciled", "certificate", certName, "operation", opResult)
}
// Check if an existing Certificate is stuck in a failed state and
// should be deleted so we can recreate it fresh on the next reconcile.
if !isNew {
requeueAfter, gwChanged := r.reissueFailedCertificate(ctx, cert, certName, downstreamGateway, downstreamClient)
if gwChanged {
gatewayNeedsUpdate = true
}
if requeueAfter > 0 && (result.RequeueAfter == 0 || requeueAfter < result.RequeueAfter) {
result.RequeueAfter = requeueAfter
}
}
}
// Persist reissuance tracking annotations on the downstream Gateway if
// any Certificates were deleted for re-issuance.
if gatewayNeedsUpdate {
if err := downstreamClient.Update(ctx, downstreamGateway); err != nil {
result.Err = fmt.Errorf("failed to update downstream gateway reissuance annotations: %w", err)
return result
}
}
// Clean up Certificate resources for listeners that no longer need them.
// Two ownership patterns are checked:
// 1. Certificates created by NSO via the downstream strategy (upstream-owner labels)
// 2. Legacy Certificates created by cert-manager's gateway-shim (controller ownerRef
// to the downstream gateway, no upstream-owner labels)
var certList cmv1.CertificateList
if err := downstreamClient.List(ctx, &certList,
client.InNamespace(downstreamGateway.Namespace),
); err != nil {
result.Err = fmt.Errorf("failed to list Certificates: %w", err)
return result
}
for i := range certList.Items {
cert := &certList.Items[i]
if desiredCerts[cert.Name] {
continue
}
ownedByStrategy := cert.Labels[downstreamclient.UpstreamOwnerKindLabel] == KindGateway &&
cert.Labels[downstreamclient.UpstreamOwnerNameLabel] == upstreamGateway.Name &&
cert.Labels[downstreamclient.UpstreamOwnerNamespaceLabel] == upstreamGateway.Namespace
ownedByGatewayShim := metav1.IsControlledBy(cert, downstreamGateway)
if !ownedByStrategy && !ownedByGatewayShim {
continue
}
logger.Info("deleting stale Certificate", "certificate", cert.Name)
if err := downstreamClient.Delete(ctx, cert); client.IgnoreNotFound(err) != nil {
result.Err = fmt.Errorf("failed to delete stale Certificate %s: %w", cert.Name, err)
return result
}
}
return result
}