/
reconciler.go
605 lines (514 loc) · 19.7 KB
/
reconciler.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
package google_cdn_reconciler
import (
"context"
"errors"
"fmt"
"net/http"
"slices"
"strings"
"time"
"github.com/nais/api-reconcilers/internal/reconcilers"
cloudcompute "cloud.google.com/go/compute/apiv1"
"cloud.google.com/go/compute/apiv1/computepb"
"cloud.google.com/go/storage"
"github.com/nais/api-reconcilers/internal/gcp"
"github.com/nais/api-reconcilers/internal/google_token_source"
gcpReconciler "github.com/nais/api-reconcilers/internal/reconcilers/google/gcp"
str "github.com/nais/api-reconcilers/internal/strings"
"github.com/nais/api/pkg/apiclient"
"github.com/nais/api/pkg/protoapi"
"github.com/sirupsen/logrus"
"google.golang.org/api/cloudresourcemanager/v3"
"google.golang.org/api/compute/v1"
"google.golang.org/api/googleapi"
"google.golang.org/api/iam/v1"
"google.golang.org/api/option"
"k8s.io/utils/ptr"
)
const (
managedByLabelName = "managed-by"
managedByLabelValue = "api-reconcilers"
reconcilerName = "google:gcp:cdn"
urlMapName = "nais-cdn"
auditActionDeletedCdn = "cdn:delete-resources"
auditActionCreatedCdn = "cdn:provision-resources"
)
type Services struct {
BackendBuckets *cloudcompute.BackendBucketsClient
CloudResourceManagerProjects *cloudresourcemanager.ProjectsService
Iam *iam.Service
Storage *storage.Client
UrlMap *compute.UrlMapsService
}
type cdnReconciler struct {
cacheReconcilerRoleID string
googleManagementProjectID string
services *Services
tenantName string
workloadIdentityPoolName string
}
func (r *cdnReconciler) Name() string {
return reconcilerName
}
type OverrideFunc func(reconciler *cdnReconciler)
func WithGcpServices(gcpServices *Services) OverrideFunc {
return func(r *cdnReconciler) {
r.services = gcpServices
}
}
func New(ctx context.Context, serviceAccountEmail, googleManagementProjectID, tenantName string, workloadIdentityPoolName string, testOverrides ...OverrideFunc) (*cdnReconciler, error) {
roleID := fmt.Sprintf("projects/%s/roles/cdnCacheInvalidator", googleManagementProjectID)
reconciler := &cdnReconciler{
cacheReconcilerRoleID: roleID,
googleManagementProjectID: googleManagementProjectID,
tenantName: tenantName,
workloadIdentityPoolName: workloadIdentityPoolName,
}
for _, override := range testOverrides {
override(reconciler)
}
if reconciler.services == nil {
s, err := gcpServices(ctx, serviceAccountEmail)
if err != nil {
return nil, fmt.Errorf("get gcp services: %w", err)
}
reconciler.services = s
}
return reconciler, nil
}
func gcpServices(ctx context.Context, serviceAccountEmail string) (*Services, error) {
ts, err := google_token_source.GcpTokenSource(ctx, serviceAccountEmail)
if err != nil {
return nil, fmt.Errorf("get delegated token source: %w", err)
}
opts := []option.ClientOption{
option.WithTokenSource(ts),
}
cloudResourceManagerService, err := cloudresourcemanager.NewService(ctx, opts...)
if err != nil {
return nil, fmt.Errorf("retrieve cloud resource manager service: %w", err)
}
computeService, err := compute.NewService(ctx, opts...)
if err != nil {
return nil, fmt.Errorf("retrieve compute service: %w", err)
}
iamService, err := iam.NewService(ctx, opts...)
if err != nil {
return nil, fmt.Errorf("retrieve IAM service service: %w", err)
}
storageClient, err := storage.NewClient(ctx, opts...)
if err != nil {
return nil, fmt.Errorf("retrieve storage client: %w", err)
}
backendBucketsClient, err := cloudcompute.NewBackendBucketsRESTClient(ctx, opts...)
if err != nil {
return nil, fmt.Errorf("retrieve backend buckets client: %w", err)
}
return &Services{
Iam: iamService,
BackendBuckets: backendBucketsClient,
CloudResourceManagerProjects: cloudResourceManagerService.Projects,
Storage: storageClient,
UrlMap: computeService.UrlMaps,
}, nil
}
func (r *cdnReconciler) Configuration() *protoapi.NewReconciler {
return &protoapi.NewReconciler{
Name: r.Name(),
DisplayName: "Google CDN",
Description: "Provision CDN resources for team",
MemberAware: false,
}
}
func (r *cdnReconciler) Reconcile(ctx context.Context, client *apiclient.APIClient, naisTeam *protoapi.Team, log logrus.FieldLogger) error {
if naisTeam.GoogleGroupEmail == nil {
return fmt.Errorf("team %s has no google group email", naisTeam.Slug)
}
// if no authorized repositories, return early
resp, err := client.Teams().ListAuthorizedRepositories(ctx, &protoapi.ListAuthorizedRepositoriesRequest{
TeamSlug: naisTeam.Slug,
})
if err != nil {
return fmt.Errorf("get authorized team repositories: %w", err)
}
if len(resp.GithubRepositories) == 0 {
log.Infof("no authorized repositories for team %s, skipping cdn setup", naisTeam.Slug)
return nil
}
teamEmail := *naisTeam.GoogleGroupEmail
bucketName := r.bucketName(naisTeam)
googleServiceAccount, err := r.getOrCreateServiceAccount(ctx, naisTeam.Slug, log)
if err != nil {
return fmt.Errorf("get or create service account: %w", err)
}
err = r.setServiceAccountPolicy(ctx, googleServiceAccount, naisTeam.Slug, client)
if err != nil {
return fmt.Errorf("set service account policy: %w", err)
}
log.Infof("set service account policy for %s", googleServiceAccount.Email)
err = r.createBucketIfNotExists(ctx, bucketName, naisTeam.Slug, log)
if err != nil {
return fmt.Errorf("create bucket: %w", err)
}
// set up iam policy for the bucket
err = r.setBucketPolicy(ctx, bucketName, teamEmail, googleServiceAccount)
if err != nil {
return fmt.Errorf("set bucket policy: %w", err)
}
log.Infof("set bucket policy for %s", bucketName)
backendBucket, err := r.getOrCreateBackendBucket(ctx, naisTeam, bucketName, log)
if err != nil {
return fmt.Errorf("get or create backend bucket: %w", err)
}
err = r.setCacheInvalidationIamPolicy(ctx, teamEmail, googleServiceAccount, log)
if err != nil {
return fmt.Errorf("create team access for cache invalidation: %w", err)
}
updated, err := r.ensureUrlMapPathRule(naisTeam, backendBucket, log)
if err != nil {
return fmt.Errorf("create urlMap: %w", err)
}
log.Infof("reconciled cdn for %q", naisTeam.Slug)
if updated {
reconcilers.AuditLogForTeam(
ctx,
client,
r,
auditActionCreatedCdn,
naisTeam.Slug,
"Provisioned CDN resources for team %q", naisTeam.Slug,
)
}
return nil
}
func (r *cdnReconciler) Delete(ctx context.Context, client *apiclient.APIClient, naisTeam *protoapi.Team, log logrus.FieldLogger) error {
// reverse order of creation
bucketName := r.bucketName(naisTeam)
// get backendbucket
backendBucket, err := r.services.BackendBuckets.Get(ctx, &computepb.GetBackendBucketRequest{
BackendBucket: bucketName,
Project: r.googleManagementProjectID,
})
if err != nil {
return fmt.Errorf("get backend bucket, %w", err)
}
// remove entry from urlmap
urlMap, err := r.services.UrlMap.Get(r.googleManagementProjectID, urlMapName).Do()
if err != nil {
return fmt.Errorf("get urlmap: %w", err)
}
for _, pm := range urlMap.PathMatchers {
seen := make(map[string]bool)
for _, pr := range pm.PathRules {
if !seen[pr.Service] {
seen[pr.Service] = true
}
}
pm.PathRules = slices.DeleteFunc(pm.PathRules, func(rule *compute.PathRule) bool {
return rule.Service == *backendBucket.SelfLink
})
}
_, err = r.services.UrlMap.Update(r.googleManagementProjectID, urlMapName, urlMap).Do()
if err != nil {
return fmt.Errorf("update urlMap: %w", err)
}
log.Infof("removed path rule for %q from url map %q", naisTeam.Slug, urlMapName)
// delete backendbucket
if backendBucket != nil {
_, err = r.services.BackendBuckets.Delete(ctx, &computepb.DeleteBackendBucketRequest{
BackendBucket: bucketName,
Project: r.googleManagementProjectID,
})
if err != nil {
return fmt.Errorf("delete backend bucket: %w", err)
}
log.Infof("deleted backend bucket %q", *backendBucket.Name)
}
// remove bucket
_, err = r.services.Storage.Bucket(bucketName).Attrs(ctx)
if err != nil && !errors.Is(err, storage.ErrBucketNotExist) {
return fmt.Errorf("get bucket: %w", err)
}
if err == nil {
err = r.services.Storage.Bucket(bucketName).Delete(ctx)
if err != nil {
return fmt.Errorf("delete bucket: %w", err)
}
log.Infof("deleted bucket %q", bucketName)
}
// get iam policy for project
managementProjectName := "projects/" + r.googleManagementProjectID
projectPolicy, err := r.services.CloudResourceManagerProjects.GetIamPolicy(managementProjectName, &cloudresourcemanager.GetIamPolicyRequest{}).Context(ctx).Do()
if err != nil {
return fmt.Errorf("retrieve existing GCP project IAM policy: %w", err)
}
// get existing service account
serviceAccountName, _ := r.serviceAccountNameAndAccountID(naisTeam.Slug)
serviceAccount, err := r.services.Iam.Projects.ServiceAccounts.Get(serviceAccountName).Context(ctx).Do()
if err != nil {
return fmt.Errorf("get service account: %w", err)
}
// remove access to cache invalidation
for _, binding := range projectPolicy.Bindings {
if binding.Role == r.cacheReconcilerRoleID {
binding.Members = slices.DeleteFunc(binding.Members, func(member string) bool {
return member == fmt.Sprintf("group:%s", *naisTeam.GoogleGroupEmail)
})
binding.Members = slices.DeleteFunc(binding.Members, func(member string) bool {
return member == fmt.Sprintf("serviceAccount:%s", serviceAccount.Email)
})
}
}
_, err = r.services.CloudResourceManagerProjects.SetIamPolicy(managementProjectName, &cloudresourcemanager.SetIamPolicyRequest{
Policy: projectPolicy,
}).Context(ctx).Do()
if err != nil {
return fmt.Errorf("assign GCP project IAM policy: %w", err)
}
log.Infof("removed cache invalidation IAM policy for %q", naisTeam.Slug)
// delete service account
_, err = r.services.Iam.Projects.ServiceAccounts.Delete(serviceAccountName).Context(ctx).Do()
if err != nil {
return fmt.Errorf("delete service account: %w", err)
}
log.Infof("deleted service account %q", serviceAccount.Email)
log.Infof("deleted cdn resources for team %q", naisTeam.Slug)
reconcilers.AuditLogForTeam(
ctx,
client,
r,
auditActionDeletedCdn,
naisTeam.Slug,
"Deleted CDN resources for %s", naisTeam.Slug,
)
return nil
}
// bucketName returns a globally unique bucket name for the given team
func (r *cdnReconciler) bucketName(naisTeam *protoapi.Team) string {
tenantTeamName := fmt.Sprintf("%s-%s", strings.ReplaceAll(r.tenantName, ".", "-"), naisTeam.Slug)
bucketName := str.SlugHashPrefixTruncate(tenantTeamName, "nais-cdn", gcp.StorageBucketNameMaxLength)
return bucketName
}
func (r *cdnReconciler) createBucketIfNotExists(ctx context.Context, bucketName string, teamSlug string, log logrus.FieldLogger) error {
_, err := r.services.Storage.Bucket(bucketName).Attrs(ctx)
if err != nil && !errors.Is(err, storage.ErrBucketNotExist) {
return fmt.Errorf("get bucket: %w", err)
}
if errors.Is(err, storage.ErrBucketNotExist) {
attrs := &storage.BucketAttrs{
UniformBucketLevelAccess: storage.UniformBucketLevelAccess{Enabled: true},
Location: "europe-north1",
Labels: map[string]string{
"team": teamSlug,
"tenant": r.tenantName,
managedByLabelName: managedByLabelValue,
},
CORS: []storage.CORS{
{
MaxAge: time.Hour,
Methods: []string{"GET"},
Origins: []string{"*"},
ResponseHeaders: []string{"Content-Type"},
},
},
}
err = r.services.Storage.Bucket(bucketName).Create(ctx, r.googleManagementProjectID, attrs)
if err != nil {
return err
}
log.Infof("created bucket %q", bucketName)
}
return nil
}
func (r *cdnReconciler) setBucketPolicy(ctx context.Context, bucketName string, email string, googleServiceAccount *iam.ServiceAccount) error {
policy, err := r.services.Storage.Bucket(bucketName).IAM().Policy(ctx)
if err != nil {
return fmt.Errorf("get bucket policy: %w", err)
}
policy.Add("allUsers", "roles/storage.objectViewer")
policy.Add(fmt.Sprintf("group:%s", email), "roles/storage.objectAdmin")
policy.Add(fmt.Sprintf("serviceAccount:%s", googleServiceAccount.Email), "roles/storage.objectAdmin")
err = r.services.Storage.Bucket(bucketName).IAM().SetPolicy(ctx, policy)
if err != nil {
return fmt.Errorf("add object viewer role to allUsers: %w", err)
}
return nil
}
// ensureUrlMapPathRule ensures that the backend bucket exists for at least one path rule in the given urlMap
func (r *cdnReconciler) ensureUrlMapPathRule(naisTeam *protoapi.Team, backendBucket *computepb.BackendBucket, log logrus.FieldLogger) (bool, error) {
urlMap, err := r.services.UrlMap.Get(r.googleManagementProjectID, urlMapName).Do()
if err != nil {
return false, fmt.Errorf("get urlmap: %w", err)
}
if len(urlMap.PathMatchers) == 0 {
return false, fmt.Errorf("url map didn't contain any path matchers; ensure that terraform has run")
}
if backendBucket.SelfLink == nil {
return false, fmt.Errorf("backend bucket self link was nil; ensure that the bucket was created successfully")
}
updatedUrlMap := false
for _, pm := range urlMap.PathMatchers {
seen := make(map[string]bool)
for _, pr := range pm.PathRules {
if !seen[pr.Service] {
seen[pr.Service] = true
}
}
pr := compute.PathRule{
Paths: []string{fmt.Sprintf("/%s/*", naisTeam.Slug)},
Service: *backendBucket.SelfLink,
}
if !seen[*backendBucket.SelfLink] {
pm.PathRules = append(pm.PathRules, &pr)
updatedUrlMap = true
}
}
if updatedUrlMap {
_, err := r.services.UrlMap.Update(r.googleManagementProjectID, urlMapName, urlMap).Do()
if err != nil {
return false, fmt.Errorf("update urlMap: %w", err)
}
log.Infof("added path rule for %q to url map %q", naisTeam.Slug, urlMapName)
}
return updatedUrlMap, nil
}
func (r *cdnReconciler) getOrCreateBackendBucket(ctx context.Context, naisTeam *protoapi.Team, bucketName string, log logrus.FieldLogger) (*computepb.BackendBucket, error) {
needsBackendBucket := false
backendBucket, err := r.services.BackendBuckets.Get(ctx, &computepb.GetBackendBucketRequest{
BackendBucket: bucketName,
Project: r.googleManagementProjectID,
})
if err != nil {
var gapiError *googleapi.Error
if errors.As(err, &gapiError) {
// retry transient errors
if gapiError.Code != http.StatusNotFound {
return nil, fmt.Errorf("googleapi error: %w", err)
}
needsBackendBucket = true
} else {
return nil, fmt.Errorf("unknown error: %w", err)
}
}
if !needsBackendBucket {
return backendBucket, nil
}
const defaultTTL = int32(3600) // 1 hour
const defaultMaxTTL = int32(86400) // 1 year
req := &computepb.InsertBackendBucketRequest{
BackendBucketResource: &computepb.BackendBucket{
BucketName: &bucketName,
CdnPolicy: &computepb.BackendBucketCdnPolicy{
// Enables Cloud CDN to cache all static content served from the backend
// bucket. This includes content with a file extension that is typically
// associated with static content, such as .html, .css, and .js.
CacheMode: ptr.To("CACHE_ALL_STATIC"),
ClientTtl: ptr.To(defaultTTL),
DefaultTtl: ptr.To(defaultTTL),
MaxTtl: ptr.To(defaultMaxTTL),
// If true then Cloud CDN will combine multiple concurrent cache fill
// requests into a small number of requests to the origin.
RequestCoalescing: ptr.To(true),
},
// When enabled, Cloud CDN automatically compresses content served from the
// backend bucket using gzip compression. This can reduce the amount of data
// sent over the network, resulting in faster load times for end users.
// Enum of "AUTOMATIC", "DISABLED".
CompressionMode: ptr.To("AUTOMATIC"),
Description: ptr.To(fmt.Sprintf("Backend bucket for %s", naisTeam.Slug)),
EnableCdn: ptr.To(true),
Name: &bucketName,
},
Project: r.googleManagementProjectID,
}
backendBucketInsertion, err := r.services.BackendBuckets.Insert(ctx, req)
if err != nil {
return nil, fmt.Errorf("insert backend bucket: %w", err)
}
err = backendBucketInsertion.Wait(ctx)
if err != nil {
return nil, fmt.Errorf("wait for insert backend bucket operation: %w", err)
}
backendBucket, err = r.services.BackendBuckets.Get(ctx, &computepb.GetBackendBucketRequest{
BackendBucket: bucketName,
Project: r.googleManagementProjectID,
})
if err != nil {
return nil, fmt.Errorf("get created backend bucket: %w", err)
}
log.Infof("created backend bucket %q", *backendBucket.Name)
return backendBucket, nil
}
func (r *cdnReconciler) setCacheInvalidationIamPolicy(ctx context.Context, teamEmail string, googleServiceAccount *iam.ServiceAccount, log logrus.FieldLogger) error {
// grant teams access to cache invalidation
managementProjectName := "projects/" + r.googleManagementProjectID
projectPolicy, err := r.services.CloudResourceManagerProjects.GetIamPolicy(managementProjectName, &cloudresourcemanager.GetIamPolicyRequest{}).Context(ctx).Do()
if err != nil {
return fmt.Errorf("retrieve existing GCP project IAM policy: %w", err)
}
newBindings, updated := gcpReconciler.CalculateRoleBindings(projectPolicy.Bindings, map[string][]string{
r.cacheReconcilerRoleID: {
fmt.Sprintf("group:%s", teamEmail),
fmt.Sprintf("serviceAccount:%s", googleServiceAccount.Email),
},
})
if updated {
projectPolicy.Bindings = newBindings
_, err = r.services.CloudResourceManagerProjects.SetIamPolicy(managementProjectName, &cloudresourcemanager.SetIamPolicyRequest{
Policy: projectPolicy,
}).Context(ctx).Do()
if err != nil {
return fmt.Errorf("assign GCP project IAM policy: %w", err)
}
log.Infof("set cache invalidation IAM policy for %q", teamEmail)
log.Infof("set cache invalidation IAM policy for %q", googleServiceAccount.Email)
}
return nil
}
func (r *cdnReconciler) getOrCreateServiceAccount(ctx context.Context, teamSlug string, log logrus.FieldLogger) (*iam.ServiceAccount, error) {
serviceAccountName, accountID := r.serviceAccountNameAndAccountID(teamSlug)
existing, err := r.services.Iam.Projects.ServiceAccounts.Get(serviceAccountName).Context(ctx).Do()
if err == nil {
return existing, nil
}
created, err := r.services.Iam.Projects.ServiceAccounts.Create("projects/"+r.googleManagementProjectID, &iam.CreateServiceAccountRequest{
AccountId: accountID,
ServiceAccount: &iam.ServiceAccount{
Description: fmt.Sprintf("service account for uploading to cdn buckets and cache invalidation for %s", teamSlug),
DisplayName: fmt.Sprintf("CDN uploader for %s", teamSlug),
},
}).Context(ctx).Do()
log.Infof("created service account %s", created.Email)
return created, err
}
func (r *cdnReconciler) serviceAccountNameAndAccountID(teamSlug string) (serviceAccountName, accountID string) {
projectID := r.googleManagementProjectID
accountID = str.SlugHashPrefixTruncate(teamSlug, "cdn", gcp.GoogleServiceAccountMaxLength)
emailAddress := fmt.Sprintf("%s@%s.iam.gserviceaccount.com", accountID, projectID)
serviceAccountName = fmt.Sprintf("projects/%s/serviceAccounts/%s", projectID, emailAddress)
return
}
func (r *cdnReconciler) setServiceAccountPolicy(ctx context.Context, serviceAccount *iam.ServiceAccount, teamSlug string, client *apiclient.APIClient) error {
resp, err := client.Teams().ListAuthorizedRepositories(ctx, &protoapi.ListAuthorizedRepositoriesRequest{
TeamSlug: teamSlug,
})
if err != nil {
return fmt.Errorf("get authorized team repositories: %w", err)
}
members := make([]string, len(resp.GithubRepositories))
for i, repo := range resp.GithubRepositories {
members[i] = "principalSet://iam.googleapis.com/" + r.workloadIdentityPoolName + "/attribute.repository/" + repo
}
req := iam.SetIamPolicyRequest{
Policy: &iam.Policy{
Bindings: []*iam.Binding{
{
Members: members,
Role: "roles/iam.workloadIdentityUser",
},
},
},
}
_, err = r.services.Iam.Projects.ServiceAccounts.SetIamPolicy(serviceAccount.Name, &req).Context(ctx).Do()
return err
}