forked from RedHatInsights/frontend-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreconcile.go
1517 lines (1271 loc) · 45.1 KB
/
reconcile.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
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
package controllers
import (
"context"
"crypto/sha256"
_ "embed"
"encoding/json"
"fmt"
"slices"
"sort"
"strings"
crd "github.com/RedHatInsights/frontend-operator/api/v1alpha1"
localUtil "github.com/RedHatInsights/frontend-operator/controllers/utils"
resCache "github.com/RedHatInsights/rhc-osdk-utils/resourceCache"
"github.com/RedHatInsights/rhc-osdk-utils/utils"
"github.com/go-logr/logr"
prom "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
apps "k8s.io/api/apps/v1"
v1 "k8s.io/api/core/v1"
networking "k8s.io/api/networking/v1"
apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
k8serr "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/client-go/tools/record"
batchv1 "k8s.io/api/batch/v1"
"sigs.k8s.io/controller-runtime/pkg/client"
)
const (
RoutePrefixDefault = "apps"
AkamaiSecretNameDefault = "akamai"
)
type FrontendReconciliation struct {
Log logr.Logger
Recorder record.EventRecorder
Cache resCache.ObjectCache
FRE *FrontendReconciler
FrontendEnvironment *crd.FrontendEnvironment
Frontend *crd.Frontend
Ctx context.Context
Client client.Client
}
//go:embed templates/Caddyfile
var caddyFileTemplate string
func (r *FrontendReconciliation) run() error {
configMap, err := r.setupConfigMaps()
if err != nil {
return err
}
configHash, err := createConfigmapHash(configMap)
if err != nil {
return err
}
var annotationHashes []map[string]string
annotationHashes = append(annotationHashes, map[string]string{"configHash": configHash})
if r.Frontend.Spec.Image != "" {
if err := r.createFrontendDeployment(annotationHashes); err != nil {
return err
}
if err := r.createFrontendService(); err != nil {
return err
}
// If cache busting is enabled for the environment, add the akamai cache bust container
if r.FrontendEnvironment.Spec.EnableAkamaiCacheBust && r.FrontendEnvironment.Spec.AkamaiCacheBustImage != "" {
if err := r.createOrUpdateCacheBustJob(); err != nil {
return err
}
}
}
if err := r.createFrontendIngress(); err != nil {
return err
}
if r.FrontendEnvironment.Spec.Monitoring != nil && !r.Frontend.Spec.ServiceMonitor.Disabled && !r.FrontendEnvironment.Spec.Monitoring.Disabled {
if err := r.createServiceMonitor(); err != nil {
return err
}
}
return nil
}
func populateContainerVolumeMounts(frontendEnvironment *crd.FrontendEnvironment, frontend *crd.Frontend) []v1.VolumeMount {
volumeMounts := []v1.VolumeMount{}
if frontendEnvironment.Spec.GenerateNavJSON {
// If we are generating all of the JSON config (nav and fed-modules)
// then we just need to mount the while configmap over the whole chrome directory
volumeMounts = append(volumeMounts, v1.VolumeMount{
Name: "config",
MountPath: "/opt/app-root/src/build/chrome",
})
}
// We always want to mount the config map under the operator-generated directory
// This will allow chrome to incorperate the generated nav and fed-modules.json
// at run time. This means chrome can merge the config in mixed environments
volumeMounts = append(volumeMounts, v1.VolumeMount{
Name: "config",
MountPath: "/opt/app-root/src/build/stable/operator-generated",
})
if frontendEnvironment.Spec.OverwriteCaddyConfig && frontend.Name != "chrome" {
volumeMounts = append(volumeMounts, v1.VolumeMount{
Name: "caddy",
MountPath: "/opt/app-root/src/Caddyfile",
SubPath: "Caddyfile",
})
}
// We generate SSL cert mounts conditionally
if frontendEnvironment.Spec.SSL {
volumeMounts = append(volumeMounts, v1.VolumeMount{
Name: "certs",
MountPath: "/opt/certs",
})
}
return volumeMounts
}
// GetResourceRequirements handles defaults and conditional overrides
func GetResourceRequirements(frontendEnvironment *crd.FrontendEnvironment) (resource.Quantity, resource.Quantity, resource.Quantity, resource.Quantity) {
// Default values
cpuRequests := resource.MustParse("30m")
memoryRequests := resource.MustParse("50Mi")
cpuLimit := resource.MustParse("40m")
memoryLimit := resource.MustParse("100Mi")
// Handle Requests
if frontendEnvironment.Spec.Requests != nil {
if cpu, ok := frontendEnvironment.Spec.Requests[v1.ResourceCPU]; ok {
cpuRequests = cpu
}
if memory, ok := frontendEnvironment.Spec.Requests[v1.ResourceMemory]; ok {
memoryRequests = memory
}
}
// Handle Limits
if frontendEnvironment.Spec.Limits != nil {
if cpu, ok := frontendEnvironment.Spec.Limits[v1.ResourceCPU]; ok {
cpuLimit = cpu
}
if memory, ok := frontendEnvironment.Spec.Limits[v1.ResourceMemory]; ok {
memoryLimit = memory
}
}
return cpuRequests, memoryRequests, cpuLimit, memoryLimit
}
func populateContainer(d *apps.Deployment, frontend *crd.Frontend, frontendEnvironment *crd.FrontendEnvironment) {
// Get the resource requirements
cpuRequests, memoryRequests, cpuLimit, memoryLimit := GetResourceRequirements(frontendEnvironment)
// set the URI Scheme for the probe
probeScheme := v1.URISchemeHTTP
if frontendEnvironment.Spec.SSL {
probeScheme = v1.URISchemeHTTPS
}
d.SetOwnerReferences([]metav1.OwnerReference{frontend.MakeOwnerReference()})
// Modify the object to set the things we care about
d.Spec.Template.Spec.Containers = []v1.Container{{
Name: "fe-image",
Image: frontend.Spec.Image,
Ports: []v1.ContainerPort{
{
Name: "web",
ContainerPort: 80,
Protocol: "TCP",
},
{
Name: "metrics",
ContainerPort: 9000,
Protocol: "TCP",
},
},
VolumeMounts: populateContainerVolumeMounts(frontendEnvironment, frontend),
Resources: v1.ResourceRequirements{
Requests: v1.ResourceList{
v1.ResourceCPU: cpuRequests,
v1.ResourceMemory: memoryRequests,
},
Limits: v1.ResourceList{
v1.ResourceCPU: cpuLimit,
v1.ResourceMemory: memoryLimit,
},
},
LivenessProbe: &v1.Probe{
ProbeHandler: v1.ProbeHandler{
HTTPGet: &v1.HTTPGetAction{
Path: "/",
Port: intstr.FromInt(8000),
Scheme: probeScheme,
},
},
InitialDelaySeconds: 10,
PeriodSeconds: 60,
FailureThreshold: 3,
},
ReadinessProbe: &v1.Probe{
ProbeHandler: v1.ProbeHandler{
HTTPGet: &v1.HTTPGetAction{
Path: "/",
Port: intstr.FromInt(8000),
Scheme: probeScheme,
},
},
InitialDelaySeconds: 10,
},
}}
}
func getAkamaiSecretName(frontendEnvironment *crd.FrontendEnvironment) string {
if frontendEnvironment.Spec.AkamaiSecretName == "" {
return AkamaiSecretNameDefault
}
return frontendEnvironment.Spec.AkamaiSecretName
}
// getAkamaiSecret gets the akamai secret from the cluster
func getAkamaiSecret(ctx context.Context, client client.Client, frontend *crd.Frontend, secretName string) (*v1.Secret, error) {
secret := &v1.Secret{}
if err := client.Get(ctx, types.NamespacedName{Name: secretName, Namespace: frontend.Namespace}, secret); err != nil {
return nil, err
}
return secret, nil
}
// constructAkamaiEdgercFileFromSecret constructs the akamai edgerc file from the secret
func makeAkamaiEdgercFileFromSecret(secret *v1.Secret) string {
edgercFile := "[default]\n"
edgercFile += fmt.Sprintf("host = %s\n", secret.Data["host"])
edgercFile += fmt.Sprintf("access_token = %s\n", secret.Data["access_token"])
edgercFile += fmt.Sprintf("client_token = %s\n", secret.Data["client_token"])
edgercFile += fmt.Sprintf("client_secret = %s\n", secret.Data["client_secret"])
edgercFile += "[ccu]\n"
edgercFile += fmt.Sprintf("host = %s\n", secret.Data["host"])
edgercFile += fmt.Sprintf("access_token = %s\n", secret.Data["access_token"])
edgercFile += fmt.Sprintf("client_token = %s\n", secret.Data["client_token"])
edgercFile += fmt.Sprintf("client_secret = %s\n", secret.Data["client_secret"])
return edgercFile
}
func createCachePurgePathList(frontend *crd.Frontend, frontendEnvironment *crd.FrontendEnvironment) []string {
var purgePaths []string
// Helper function to check if a path is already in the list
contains := func(slice []string, item string) bool {
for _, existing := range slice {
if existing == item {
return true
}
}
return false
}
cacheBustUrls := frontendEnvironment.Spec.AkamaiCacheBustURLs
if frontendEnvironment.Spec.AkamaiCacheBustURL != "" {
cacheBustUrls = append(cacheBustUrls, frontendEnvironment.Spec.AkamaiCacheBustURL)
}
// Return early if we have no cache bust URLs of any kind to process
if len(cacheBustUrls) == 0 {
return purgePaths
}
for _, cacheBustURL := range cacheBustUrls {
// Ensure the URL begins with https:// and has no trailing /
purgeHost := strings.TrimSuffix(fmt.Sprintf("https://%s", strings.TrimPrefix(cacheBustURL, "https://")), "/")
// Add default path if AkamaiCacheBustPaths is nil
if frontend.Spec.AkamaiCacheBustPaths == nil {
defaultPath := fmt.Sprintf("%s/apps/%s/fed-mods.json", purgeHost, frontend.Name)
if !contains(purgePaths, defaultPath) {
purgePaths = append(purgePaths, defaultPath)
}
continue
}
// Append paths based on AkamaiCacheBustPaths
for _, path := range frontend.Spec.AkamaiCacheBustPaths {
var fullPath string
if strings.HasPrefix(path, "http://") || strings.HasPrefix(path, "https://") {
// Add full URL path directly
fullPath = path
} else {
// Ensure each path has a leading slash but no double slashes
if !strings.HasPrefix(path, "/") {
path = "/" + path
}
fullPath = purgeHost + path
}
// Append the fullPath only if it doesn't already exist in purgePaths
if !contains(purgePaths, fullPath) {
purgePaths = append(purgePaths, fullPath)
}
}
}
return purgePaths
}
// populateCacheBustContainer adds the akamai cache bust container to the deployment
func (r *FrontendReconciliation) populateCacheBustContainer(j *batchv1.Job) error {
// Get the akamai secret
akamaiSecretName := getAkamaiSecretName(r.FrontendEnvironment)
secret, err := getAkamaiSecret(r.Ctx, r.Client, r.Frontend, akamaiSecretName)
if err != nil {
return err
}
// Make the akamai file from the secret
edgercFile := makeAkamaiEdgercFileFromSecret(secret)
configMap := &v1.ConfigMap{}
configMap.SetName("akamai-edgerc")
configMap.SetNamespace(r.Frontend.Namespace)
nn := types.NamespacedName{
Name: "akamai-edgerc",
Namespace: r.Frontend.Namespace,
}
labels := r.FrontendEnvironment.GetLabels()
labler := utils.GetCustomLabeler(labels, nn, r.FrontendEnvironment)
labler(configMap)
configMap.SetOwnerReferences([]metav1.OwnerReference{r.Frontend.MakeOwnerReference()})
// Add the akamai edgerc file to the configmap
configMap.Data = map[string]string{
"edgerc": edgercFile,
}
// Create the configmap with the Client if it doesn't already exist
if err := r.Client.Create(r.Ctx, configMap); err != nil {
if !k8serr.IsAlreadyExists(err) {
return err
}
}
akamaiVolume := v1.Volume{
Name: "akamai-edgerc",
VolumeSource: v1.VolumeSource{
ConfigMap: &v1.ConfigMapVolumeSource{
LocalObjectReference: v1.LocalObjectReference{
Name: "akamai-edgerc",
},
},
},
}
j.Spec.Template.Spec.Volumes = []v1.Volume{akamaiVolume}
// Get the paths to cache bust
pathsToCacheBust := createCachePurgePathList(r.Frontend, r.FrontendEnvironment)
// Construct the akamai cache bust command
command := fmt.Sprintf("sleep 120; /cli/.akamai-cli/src/cli-purge/bin/akamai-purge --edgerc /opt/app-root/edgerc delete %s", strings.Join(pathsToCacheBust, " "))
// Modify the obejct to set the things we care about
cacheBustContainer := v1.Container{
Name: "akamai-cache-bust",
Image: r.FrontendEnvironment.Spec.AkamaiCacheBustImage,
// Mount the akamai edgerc file from the configmap
VolumeMounts: []v1.VolumeMount{
{
Name: "akamai-edgerc",
MountPath: "/opt/app-root/edgerc",
SubPath: "edgerc",
},
},
// Run the akamai cache bust script
Command: []string{"/bin/bash", "-c", command},
}
// add the container to the spec containers
j.Spec.Template.Spec.Containers = []v1.Container{cacheBustContainer}
// Add the restart policy
j.Spec.Template.Spec.RestartPolicy = v1.RestartPolicyNever
annotations := j.Spec.Template.ObjectMeta.Annotations
if annotations == nil {
annotations = make(map[string]string)
}
annotations["kube-linter.io/ignore-all"] = "we don't need no any checking"
j.Spec.Template.ObjectMeta.SetAnnotations(annotations)
// Add the akamai edgerc configmap to the deployment
return nil
}
func populateVolumes(d *apps.Deployment, frontend *crd.Frontend, frontendEnvironment *crd.FrontendEnvironment) {
// By default we just want the config and caddy volume
volumes := []v1.Volume{}
volumes = append(volumes, v1.Volume{
Name: "config",
VolumeSource: v1.VolumeSource{
ConfigMap: &v1.ConfigMapVolumeSource{
LocalObjectReference: v1.LocalObjectReference{
Name: frontend.Spec.EnvName,
},
},
},
}, v1.Volume{
Name: "caddy",
VolumeSource: v1.VolumeSource{
ConfigMap: &v1.ConfigMapVolumeSource{
LocalObjectReference: v1.LocalObjectReference{
Name: frontend.Spec.EnvName,
},
Items: []v1.KeyToPath{{
Key: "Caddyfile",
Path: "Caddyfile",
}},
},
},
})
if frontendEnvironment.Spec.SSL {
volumes = append(volumes, v1.Volume{
Name: "certs",
VolumeSource: v1.VolumeSource{
Secret: &v1.SecretVolumeSource{
SecretName: fmt.Sprintf("%s-cert", frontend.Name),
},
},
})
}
// Set the volumes on the deployment
d.Spec.Template.Spec.Volumes = volumes
}
// Add the env vars if eny are set
func (r *FrontendReconciliation) populateEnvVars(d *apps.Deployment, frontendEnvironment *crd.FrontendEnvironment) {
envVars := []v1.EnvVar{}
if frontendEnvironment.Spec.SSL {
envVars = append(envVars, v1.EnvVar{
Name: "CADDY_TLS_MODE",
Value: "https_port 8000",
})
envVars = append(envVars, v1.EnvVar{
Name: "CADDY_TLS_CERT",
Value: "tls /opt/certs/tls.crt /opt/certs/tls.key",
})
}
// Add the HTTP Headers to the env vars if the frontend environment has them
if frontendEnvironment.Spec.HTTPHeaders != nil {
envVars = append(envVars, v1.EnvVar{
Name: "CADDY_HTTP_HEADERS",
Value: createCaddyfileHeaderBlock(frontendEnvironment.Spec.HTTPHeaders),
})
}
envVars = append(envVars, v1.EnvVar{
Name: "APP_NAME",
Value: r.Frontend.Name,
})
envVars = append(envVars, v1.EnvVar{
Name: "ROUTE_PATH",
Value: "/apps/$(APP_NAME)",
})
envVars = append(envVars, v1.EnvVar{
Name: "BETA_ROUTE_PATH",
Value: "/beta$(ROUTE_PATH)",
})
envVars = append(envVars, v1.EnvVar{
Name: "PREVIEW_ROUTE_PATH",
Value: "/preview$(ROUTE_PATH)",
})
d.Spec.Template.Spec.Containers[0].Env = envVars
}
// Create a Caddyfile header block from the FrontenbdEnvironment httpHeaders
func createCaddyfileHeaderBlock(httpHeaders map[string]string) string {
if len(httpHeaders) == 0 {
return ""
}
var keys []string
for key := range httpHeaders {
keys = append(keys, key)
}
// Sort keys alphabetically
// We do this to ensure the order of the headers is consistent
// without this tests will be flaky
sort.Strings(keys)
headerBlock := "header {\n"
for _, key := range keys {
headerBlock += fmt.Sprintf("%s %s\n", key, httpHeaders[key])
}
headerBlock += "}"
return headerBlock
}
func (r *FrontendReconciliation) createFrontendDeployment(annotationHashes []map[string]string) error {
// Create new empty struct
d := &apps.Deployment{}
deploymentName := r.Frontend.Name + "-frontend"
// Define name of resource
nn := types.NamespacedName{
Name: deploymentName,
Namespace: r.Frontend.Namespace,
}
// Create object in cache (will populate cache if exists)
if err := r.Cache.Create(CoreDeployment, nn, d); err != nil {
return err
}
// Label with the right labels
labels := r.Frontend.GetLabels()
labeler := utils.GetCustomLabeler(labels, nn, r.Frontend)
labeler(d)
// Set the replicas if specified, otherwise default to 1
if r.Frontend.Spec.Replicas != nil {
d.Spec.Replicas = r.Frontend.Spec.Replicas
} else {
if r.FrontendEnvironment.Spec.DefaultReplicas != nil {
d.Spec.Replicas = r.FrontendEnvironment.Spec.DefaultReplicas
} else {
d.Spec.Replicas = utils.Int32Ptr(1)
}
}
populateVolumes(d, r.Frontend, r.FrontendEnvironment)
populateContainer(d, r.Frontend, r.FrontendEnvironment)
r.populateEnvVars(d, r.FrontendEnvironment)
d.Spec.Template.ObjectMeta.Labels = labels
d.Spec.Selector = &metav1.LabelSelector{MatchLabels: labels}
utils.UpdateAnnotations(&d.Spec.Template, annotationHashes...)
// This is a temporary measure to silence DVO from opening 600 million tickets for each frontend - Issue fix ETA is TBD
deploymentAnnotation := d.ObjectMeta.GetAnnotations()
if deploymentAnnotation == nil {
deploymentAnnotation = make(map[string]string)
}
// Gabor wrote the string "we don't need no any checking" and we will never change it
deploymentAnnotation["kube-linter.io/ignore-all"] = "we don't need no any checking"
d.ObjectMeta.SetAnnotations(deploymentAnnotation)
// Inform the cache that our updates are complete
err := r.Cache.Update(CoreDeployment, d)
return err
}
func createPorts() []v1.ServicePort {
appProtocol := "http"
return []v1.ServicePort{
{
Name: "public",
Port: 8000,
TargetPort: intstr.FromInt(8000),
Protocol: "TCP",
AppProtocol: &appProtocol,
},
{
Name: "metrics",
Port: 9000,
TargetPort: intstr.FromInt(9000),
Protocol: "TCP",
AppProtocol: &appProtocol,
},
}
}
func (r *FrontendReconciliation) generateJobName() string {
return r.Frontend.Name + "-frontend-cachebust"
}
// getExistingJob returns the existing job if it exists
// and a bool indicating if it exists or not
func (r *FrontendReconciliation) getExistingJob() (*batchv1.Job, bool, error) {
// Job we'll fill up
j := &batchv1.Job{}
jobName := r.generateJobName()
// Define name of resource
nn := types.NamespacedName{
Name: jobName,
Namespace: r.Frontend.Namespace,
}
// Try and get the job
err := r.Client.Get(r.Ctx, nn, j)
if err != nil {
if k8serr.IsNotFound(err) {
// It doesn't exist so we can return false and no error
return j, false, nil
}
// Something is wrong so we return the error
return j, false, err
}
// It exists so we return true and no error
return j, true, nil
}
func (r *FrontendReconciliation) isJobFromCurrentFrontendImage(j *batchv1.Job) bool {
return j.Spec.Template.ObjectMeta.Annotations["frontend-image"] == r.Frontend.Spec.Image
}
// manageExistingJob will delete the existing job if it exists and is not from the current frontend image
// It will return true if the job exists and is from the current frontend image
func (r *FrontendReconciliation) manageExistingJob() (bool, error) {
j, exists, err := r.getExistingJob()
if err != nil {
return false, err
}
// If it doesn't exist we can return false and no error
if !exists {
return false, nil
}
// If it exists but is not from the current frontend image we delete it
if !r.isJobFromCurrentFrontendImage(j) {
backgroundDeletion := metav1.DeletePropagationBackground
return false, r.Client.Delete(r.Ctx, j, &client.DeleteOptions{
PropagationPolicy: &backgroundDeletion,
})
}
// If it exists and is from the current frontend image we return true and no error
return true, nil
}
// createOrUpdateCacheBustJob will create a new job if it doesn't exist
// If it does exist and is from the current frontend image it will return
// If it does exist and is not from the current frontend image it will delete it and create a new one
func (r *FrontendReconciliation) createOrUpdateCacheBustJob() error {
// Guard on frontend opting out of cache busting
if r.Frontend.Spec.AkamaiCacheBustDisable {
return nil
}
// If the job exists and is from the current frontend image we can return
// If the job exists and is not from the current frontend image we delete it
// If the job doesn't exist we create it
existsAndMatchesCurrentFrontendImage, err := r.manageExistingJob()
if err != nil {
return err
}
if existsAndMatchesCurrentFrontendImage {
return nil
}
// Create job
j := &batchv1.Job{}
jobName := r.generateJobName()
// Set name
j.SetName(jobName)
// Set namespace
j.SetNamespace(r.Frontend.Namespace)
// Label with the right labels
labels := r.Frontend.GetLabels()
// Define name of resource
nn := types.NamespacedName{
Name: jobName,
Namespace: r.Frontend.Namespace,
}
labeler := utils.GetCustomLabeler(labels, nn, r.Frontend)
labeler(j)
j.SetOwnerReferences([]metav1.OwnerReference{r.Frontend.MakeOwnerReference()})
j.Spec.Template.Spec.RestartPolicy = v1.RestartPolicyNever
j.Spec.Completions = utils.Int32Ptr(1)
// Set the image frontend image annotation
annotations := j.Spec.Template.ObjectMeta.Annotations
if annotations == nil {
annotations = make(map[string]string)
}
annotations["frontend-image"] = r.Frontend.Spec.Image
annotations["kube-linter.io/ignore-all"] = "we don't need no any checking"
j.Spec.Template.ObjectMeta.SetAnnotations(annotations)
errr := r.populateCacheBustContainer(j)
if errr != nil {
return errr
}
return r.Client.Create(r.Ctx, j)
}
// Will need to create a service resource ident in provider like CoreDeployment
func (r *FrontendReconciliation) createFrontendService() error {
// Create empty service
s := &v1.Service{}
// Define name of resource
nn := types.NamespacedName{
Name: r.Frontend.Name,
Namespace: r.Frontend.Namespace,
}
// Create object in cache (will populate cache if exists)
if err := r.Cache.Create(CoreService, nn, s); err != nil {
return err
}
if r.FrontendEnvironment.Spec.SSL {
annotations := s.GetAnnotations()
if annotations == nil {
annotations = make(map[string]string)
}
annotations["service.beta.openshift.io/serving-cert-secret-name"] = fmt.Sprintf("%s-%s", r.Frontend.Name, "cert")
s.SetAnnotations(annotations)
}
labels := make(map[string]string)
labels["frontend"] = r.Frontend.Name
labeler := utils.GetCustomLabeler(labels, nn, r.Frontend)
labeler(s)
// We should also set owner reference to the pod
s.SetOwnerReferences([]metav1.OwnerReference{r.Frontend.MakeOwnerReference()})
ports := createPorts()
s.Spec.Selector = labels
utils.MakeService(s, nn, labels, ports, r.Frontend, false)
// Inform the cache that our updates are complete
err := r.Cache.Update(CoreService, s)
return err
}
func (r *FrontendReconciliation) createFrontendIngress() error {
netobj := &networking.Ingress{}
nn := types.NamespacedName{
Name: r.Frontend.Name,
Namespace: r.Frontend.Namespace,
}
if err := r.Cache.Create(WebIngress, nn, netobj); err != nil {
return err
}
labels := r.Frontend.GetLabels()
labler := utils.GetCustomLabeler(labels, nn, r.Frontend)
labler(netobj)
netobj.SetOwnerReferences([]metav1.OwnerReference{r.Frontend.MakeOwnerReference()})
r.createAnnotationsAndPopulate(nn, netobj)
err := r.Cache.Update(WebIngress, netobj)
return err
}
func (r *FrontendReconciliation) createAnnotationsAndPopulate(nn types.NamespacedName, netobj *networking.Ingress) {
ingressClass := r.FrontendEnvironment.Spec.IngressClass
if ingressClass == "" {
ingressClass = "nginx"
}
if r.FrontendEnvironment.Spec.IngressAnnotations != nil {
annotations := netobj.GetAnnotations()
if annotations == nil {
annotations = map[string]string{}
}
for k, v := range r.FrontendEnvironment.Spec.IngressAnnotations {
annotations[k] = v
}
netobj.SetAnnotations(annotations)
}
if len(r.FrontendEnvironment.Spec.Whitelist) != 0 {
annotations := netobj.GetAnnotations()
if annotations == nil {
annotations = map[string]string{}
}
annotations["haproxy.router.openshift.io/ip_whitelist"] = strings.Join(r.FrontendEnvironment.Spec.Whitelist, " ")
annotations["nginx.ingress.kubernetes.io/whitelist-source-range"] = strings.Join(r.FrontendEnvironment.Spec.Whitelist, ",")
netobj.SetAnnotations(annotations)
}
if r.FrontendEnvironment.Spec.SSL {
annotations := netobj.GetAnnotations()
if annotations == nil {
annotations = map[string]string{}
}
annotations["route.openshift.io/termination"] = "reencrypt"
netobj.SetAnnotations(annotations)
}
if r.Frontend.Spec.Image != "" {
r.populateConsoleDotIngress(netobj, ingressClass, nn.Name)
} else {
r.populateConsoleDotIngress(netobj, ingressClass, r.Frontend.Spec.Service)
}
}
func (r *FrontendReconciliation) getFrontendPaths() []string {
frontendPaths := r.Frontend.Spec.Frontend.Paths
defaultPath := fmt.Sprintf("/apps/%s", r.Frontend.Name)
if r.Frontend.Spec.AssetsPrefix != "" {
defaultPath = fmt.Sprintf("/%s/%s", r.Frontend.Spec.AssetsPrefix, r.Frontend.Name)
}
if !r.Frontend.Spec.Frontend.HasPath(defaultPath) {
frontendPaths = append(frontendPaths, defaultPath)
}
return frontendPaths
}
func (r *FrontendReconciliation) populateConsoleDotIngress(netobj *networking.Ingress, ingressClass, serviceName string) {
frontendPaths := r.getFrontendPaths()
var ingressPaths []networking.HTTPIngressPath
for _, a := range frontendPaths {
newPath := createNewIngressPath(a, serviceName)
ingressPaths = append(ingressPaths, newPath)
}
host := r.FrontendEnvironment.Spec.Hostname
if host == "" {
host = r.Frontend.Spec.EnvName
}
// we need to add /api fallback here as well
netobj.Spec = defaultNetSpec(ingressClass, host, ingressPaths)
}
func createNewIngressPath(a, serviceName string) networking.HTTPIngressPath {
prefixType := "Prefix"
return networking.HTTPIngressPath{
Path: a,
PathType: (*networking.PathType)(&prefixType),
Backend: networking.IngressBackend{
Service: &networking.IngressServiceBackend{
Name: serviceName,
Port: networking.ServiceBackendPort{
Number: 8000,
},
},
},
}
}
func defaultNetSpec(ingressClass, host string, ingressPaths []networking.HTTPIngressPath) networking.IngressSpec {
return networking.IngressSpec{
TLS: []networking.IngressTLS{{
Hosts: []string{},
}},
IngressClassName: &ingressClass,
Rules: []networking.IngressRule{
{
Host: host,
IngressRuleValue: networking.IngressRuleValue{
HTTP: &networking.HTTPIngressRuleValue{
Paths: ingressPaths,
},
},
},
},
}
}
func setupFedModules(feEnv *crd.FrontendEnvironment, frontendList *crd.FrontendList, fedModules map[string]crd.FedModule) error {
for _, frontend := range frontendList.Items {
if (frontend.Name == "chrome" || frontend.Spec.FeoConfigEnabled) && frontend.Spec.Module != nil {
// module names in fed-modules.json must be camelCase
// K8s does not allow camelCase names, only
// whatever-this-case-is, so we convert.
modName := localUtil.ToCamelCase(frontend.GetName())
if frontend.Spec.Module.ModuleID != "" {
modName = frontend.Spec.Module.ModuleID
}
fedModules[modName] = *frontend.Spec.Module
module := fedModules[modName]
if frontend.Spec.Module.FullProfile == nil || !*frontend.Spec.Module.FullProfile {
module.FullProfile = crd.FalsePtr()
} else {
module.FullProfile = crd.TruePtr()
}
if frontend.Name == "chrome" {
var configSource apiextensions.JSON
err := configSource.UnmarshalJSON([]byte(`{}`))
if err != nil {
return fmt.Errorf("error unmarshaling base config: %w", err)
}
if module.Config == nil {
module.Config = &configSource
} else {
configSource = *module.Config
}
innerConfig := make(map[string]interface{})
if err := json.Unmarshal(configSource.Raw, &innerConfig); err != nil {
fmt.Printf("error unpacking custom config")
}
innerConfig["ssoUrl"] = feEnv.Spec.SSO
bytes, err := json.Marshal(innerConfig)
if err != nil {
fmt.Print(err)
}
err = module.Config.UnmarshalJSON(bytes)
if err != nil {
return fmt.Errorf("error unmarshaling config: %w", err)
}
}
fedModules[modName] = module
}
}
return nil
}
func adjustSearchEntry(searchEntry *crd.SearchEntry, frontend crd.Frontend) crd.SearchEntry {
altTitleCopy := make([]string, len(searchEntry.AltTitle))
copy(altTitleCopy, searchEntry.AltTitle)
newSearchEntry := crd.SearchEntry{
// make the id environment and frontend specific to reduce duplicate ids across Frontend resources
ID: fmt.Sprintf("%s-%s-%s", frontend.Name, frontend.Spec.EnvName, searchEntry.ID),
Title: searchEntry.Title,
Description: searchEntry.Description,
Href: searchEntry.Href,
AltTitle: altTitleCopy,
IsExternal: searchEntry.IsExternal,
FrontendRef: frontend.Name,
}
return newSearchEntry
}
func setupSearchIndex(feList *crd.FrontendList) []crd.SearchEntry {
searchIndex := []crd.SearchEntry{}
for _, frontend := range feList.Items {
if frontend.Spec.FeoConfigEnabled && frontend.Spec.SearchEntries != nil {
for _, searchEntry := range frontend.Spec.SearchEntries {
if searchEntry != nil {
searchIndex = append(searchIndex, adjustSearchEntry(searchEntry, frontend))
}
}
}
}
return searchIndex