-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathgcp_client.go
More file actions
672 lines (588 loc) · 20 KB
/
gcp_client.go
File metadata and controls
672 lines (588 loc) · 20 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
// Copyright (c) Codesphere Inc.
// SPDX-License-Identifier: Apache-2.0
package gcp
import (
"context"
"fmt"
"strings"
"sync"
"slices"
artifact "cloud.google.com/go/artifactregistry/apiv1"
artifactpb "cloud.google.com/go/artifactregistry/apiv1/artifactregistrypb"
compute "cloud.google.com/go/compute/apiv1"
"cloud.google.com/go/compute/apiv1/computepb"
"cloud.google.com/go/iam/apiv1/iampb"
resourcemanager "cloud.google.com/go/resourcemanager/apiv3"
"cloud.google.com/go/resourcemanager/apiv3/resourcemanagerpb"
serviceusage "cloud.google.com/go/serviceusage/apiv1"
"cloud.google.com/go/serviceusage/apiv1/serviceusagepb"
"github.com/codesphere-cloud/oms/internal/bootstrap"
"github.com/codesphere-cloud/oms/internal/util"
"github.com/lithammer/shortuuid"
"google.golang.org/api/cloudbilling/v1"
"google.golang.org/api/dns/v1"
"google.golang.org/api/iam/v1"
"google.golang.org/api/iterator"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
// Interface for high-level GCP operations
type GCPClientManager interface {
GetProjectByName(folderID string, displayName string) (*resourcemanagerpb.Project, error)
CreateProjectID(projectName string) string
CreateProject(parent, projectName, displayName string) (string, error)
GetBillingInfo(projectID string) (*cloudbilling.ProjectBillingInfo, error)
EnableBilling(projectID, billingAccount string) error
EnableAPIs(projectID string, apis []string) error
GetArtifactRegistry(projectID, region, repoName string) (*artifactpb.Repository, error)
CreateArtifactRegistry(projectID, region, repoName string) (*artifactpb.Repository, error)
CreateServiceAccount(projectID, name, displayName string) (string, bool, error)
CreateServiceAccountKey(projectID, saEmail string) (string, error)
AssignIAMRole(projectID, saEmail string, saProjectID string, roles []string) error
CreateVPC(projectID, region, networkName, subnetName, routerName, natName string) error
CreateFirewallRule(projectID string, rule *computepb.Firewall) error
CreateInstance(projectID, zone string, instance *computepb.Instance) error
GetInstance(projectID, zone, instanceName string) (*computepb.Instance, error)
CreateAddress(projectID, region string, address *computepb.Address) (string, error)
GetAddress(projectID, region, addressName string) (*computepb.Address, error)
EnsureDNSManagedZone(projectID, zoneName, dnsName, description string) error
EnsureDNSRecordSets(projectID, zoneName string, records []*dns.ResourceRecordSet) error
}
// Concrete implementation
type GCPClient struct {
ctx context.Context
st *bootstrap.StepLogger
CredentialsFile string
}
func NewGCPClient(ctx context.Context, st *bootstrap.StepLogger, credentialsFile string) *GCPClient {
return &GCPClient{
ctx: ctx,
st: st,
CredentialsFile: credentialsFile,
}
}
// GetProjectByName retrieves a GCP project by its display name within the specified folder.
func (c *GCPClient) GetProjectByName(folderID string, displayName string) (*resourcemanagerpb.Project, error) {
client, err := resourcemanager.NewProjectsClient(c.ctx)
if err != nil {
return nil, err
}
defer util.IgnoreError(client.Close)
req := &resourcemanagerpb.ListProjectsRequest{
Parent: fmt.Sprintf("folders/%s", folderID),
ShowDeleted: false,
}
it := client.ListProjects(c.ctx, req)
for {
project, err := it.Next()
if err == iterator.Done {
// No more results found
return nil, fmt.Errorf("project not found: %s", displayName)
}
if err != nil {
return nil, fmt.Errorf("error iterating projects: %w", err)
}
// Because the filter is a prefix search on the display name,
// we should perform an exact match check here to be sure.
if project.GetDisplayName() == displayName {
return project, nil
}
}
}
// CreateProjectID generates a unique project ID based on the given project name.
func (c *GCPClient) CreateProjectID(projectName string) string {
projectGuid := strings.ToLower(shortuuid.New()[:8])
return projectName + "-" + projectGuid
}
// CreateProject creates a new GCP project under the specified parent (folder or organization).
// It returns the project ID of the newly created project.
func (c *GCPClient) CreateProject(parent, projectID, displayName string) (string, error) {
client, err := resourcemanager.NewProjectsClient(c.ctx)
if err != nil {
return "", err
}
defer util.IgnoreError(client.Close)
project := &resourcemanagerpb.Project{
ProjectId: projectID,
DisplayName: displayName,
Parent: parent,
}
op, err := client.CreateProject(c.ctx, &resourcemanagerpb.CreateProjectRequest{Project: project})
if err != nil {
return "", err
}
resp, err := op.Wait(c.ctx)
if err != nil {
return "", err
}
return resp.ProjectId, nil
}
func getProjectResourceName(projectID string) string {
return fmt.Sprintf("projects/%s", projectID)
}
// GetBillingInfo retrieves the billing information for the given project.
func (c *GCPClient) GetBillingInfo(projectID string) (*cloudbilling.ProjectBillingInfo, error) {
billingService, err := cloudbilling.NewService(context.Background())
if err != nil {
return nil, err
}
projectName := getProjectResourceName(projectID)
billingInfo, err := billingService.Projects.GetBillingInfo(projectName).Do()
if err != nil {
return nil, err
}
return billingInfo, nil
}
// EnableBilling enables billing for the given project using the specified billing account.
func (c *GCPClient) EnableBilling(projectID, billingAccount string) error {
billingService, err := cloudbilling.NewService(c.ctx)
if err != nil {
return err
}
projectName := getProjectResourceName(projectID)
billingInfo := &cloudbilling.ProjectBillingInfo{
BillingAccountName: fmt.Sprintf("billingAccounts/%s", billingAccount),
}
_, err = billingService.Projects.UpdateBillingInfo(projectName, billingInfo).Context(c.ctx).Do()
return err
}
// EnableAPIs enables the specified APIs for the given project.
func (c *GCPClient) EnableAPIs(projectID string, apis []string) error {
client, err := serviceusage.NewClient(c.ctx)
if err != nil {
return err
}
defer util.IgnoreError(client.Close)
// enable APIs in parallel
wg := sync.WaitGroup{}
errCh := make(chan error, len(apis))
for _, api := range apis {
serviceName := fmt.Sprintf("projects/%s/services/%s", projectID, api)
wg.Add(1)
go func(serviceName, api string) {
defer wg.Done()
c.st.Logf("Enabling API %s", api)
op, err := client.EnableService(c.ctx, &serviceusagepb.EnableServiceRequest{Name: serviceName})
if status.Code(err) == codes.AlreadyExists {
c.st.Logf("API %s already enabled", api)
return
}
if err != nil {
errCh <- fmt.Errorf("failed to enable API %s: %w", api, err)
}
if _, err := op.Wait(c.ctx); err != nil {
errCh <- fmt.Errorf("failed to enable API %s: %w", api, err)
}
c.st.Logf("API %s enabled", api)
}(serviceName, api)
}
wg.Wait()
close(errCh)
errStr := ""
for err := range errCh {
errStr += err.Error() + "; "
}
if len(errStr) > 0 {
return fmt.Errorf("errors occurred while enabling APIs: %s", errStr)
}
return nil
}
// CreateArtifactRegistry creates and returns an Artifact Registry repository by its name.
func (c *GCPClient) CreateArtifactRegistry(projectID, region, repoName string) (*artifactpb.Repository, error) {
client, err := artifact.NewClient(c.ctx)
if err != nil {
return nil, err
}
defer util.IgnoreError(client.Close)
parent := fmt.Sprintf("projects/%s/locations/%s", projectID, region)
repoReq := &artifactpb.CreateRepositoryRequest{
Parent: parent,
RepositoryId: repoName,
Repository: &artifactpb.Repository{
Format: artifactpb.Repository_DOCKER,
Description: "Codesphere managed registry",
},
}
op, err := client.CreateRepository(c.ctx, repoReq)
if err != nil && !strings.Contains(err.Error(), "already exists") {
return nil, err
}
var repo *artifactpb.Repository
if err == nil {
_, err = op.Wait(c.ctx)
if err != nil {
return nil, err
}
}
// get repo again to ensure all infos are stored, else e.g. uri would be missing
repo, err = c.GetArtifactRegistry(projectID, region, repoName)
if err != nil {
return nil, fmt.Errorf("failed to get newly created artifact registry: %w", err)
}
return repo, nil
}
// GetArtifactRegistry retrieves an existing Artifact Registry repository by its name.
func (c *GCPClient) GetArtifactRegistry(projectID, region, repoName string) (*artifactpb.Repository, error) {
client, err := artifact.NewClient(c.ctx)
if err != nil {
return nil, err
}
defer util.IgnoreError(client.Close)
fullRepoName := fmt.Sprintf("projects/%s/locations/%s/repositories/%s", projectID, region, repoName)
repo, err := client.GetRepository(c.ctx, &artifactpb.GetRepositoryRequest{
Name: fullRepoName,
})
if err != nil {
return nil, fmt.Errorf("failed to get artifact registry repository: %w", err)
}
return repo, nil
}
// CreateServiceAccount creates a new service account with the given name and display name.
// It returns the email of the created service account, a boolean indicating whether the account was newly created,
// and an error if any occurred during the process.
func (c *GCPClient) CreateServiceAccount(projectID, name, displayName string) (string, bool, error) {
saMail := fmt.Sprintf("%s@%s.iam.gserviceaccount.com", name, projectID)
iamService, err := iam.NewService(c.ctx)
if err != nil {
return saMail, false, err
}
saReq := &iam.CreateServiceAccountRequest{
AccountId: name,
ServiceAccount: &iam.ServiceAccount{
DisplayName: displayName,
},
}
_, err = iamService.Projects.ServiceAccounts.Create(fmt.Sprintf("projects/%s", projectID), saReq).Context(c.ctx).Do()
if err != nil && !strings.Contains(err.Error(), "already exists") {
return saMail, false, err
}
if err != nil && strings.Contains(err.Error(), "already exists") {
return saMail, false, nil
}
return saMail, true, nil
}
// CreateServiceAccountKey creates a new key for the specified service account.
// It returns the private key data in PEM format and an error if any occurred during the process.
func (c *GCPClient) CreateServiceAccountKey(projectID, saEmail string) (string, error) {
iamService, err := iam.NewService(c.ctx)
if err != nil {
return "", err
}
keyReq := &iam.CreateServiceAccountKeyRequest{}
saName := fmt.Sprintf("projects/%s/serviceAccounts/%s", projectID, saEmail)
key, err := iamService.Projects.ServiceAccounts.Keys.Create(saName, keyReq).Context(c.ctx).Do()
if err != nil {
return "", err
}
return string(key.PrivateKeyData), nil
}
// AssignIAMRole assigns the specified IAM role to a service account in a project.
func (c *GCPClient) AssignIAMRole(projectID, saName string, saProjectID string, roles []string) error {
saEmail := fmt.Sprintf("%s@%s.iam.gserviceaccount.com", saName, saProjectID)
member := fmt.Sprintf("serviceAccount:%s", saEmail)
resource := fmt.Sprintf("projects/%s", projectID)
return c.addRoleBindingToProject(member, roles, resource)
}
func (c *GCPClient) addRoleBindingToProject(member string, roles []string, resource string) error {
client, err := resourcemanager.NewProjectsClient(c.ctx)
if err != nil {
return err
}
defer util.IgnoreError(client.Close)
getReq := &iampb.GetIamPolicyRequest{
Resource: resource,
}
policy, err := client.GetIamPolicy(c.ctx, getReq)
if err != nil {
return err
}
// Add role bindings to policy
updated := false
for _, role := range roles {
bindingExists := false
for _, binding := range policy.Bindings {
if binding.Role == role {
if !slices.Contains(binding.Members, member) {
binding.Members = append(binding.Members, member)
updated = true
}
bindingExists = true
break
}
}
if bindingExists {
continue
}
// Assign role
policy.Bindings = append(policy.Bindings, &iampb.Binding{
Role: role,
Members: []string{member},
})
updated = true
}
if !updated {
return nil
}
setReq := &iampb.SetIamPolicyRequest{
Resource: resource,
Policy: policy,
}
_, err = client.SetIamPolicy(c.ctx, setReq)
return err
}
// CreateVPC creates a VPC network with the specified subnet, router, and NAT gateway.
func (c *GCPClient) CreateVPC(projectID, region, networkName, subnetName, routerName, natName string) error {
// Create Network
networksClient, err := compute.NewNetworksRESTClient(c.ctx)
if err != nil {
return err
}
defer util.IgnoreError(networksClient.Close)
network := &computepb.Network{
Name: &networkName,
AutoCreateSubnetworks: protoBool(false),
}
op, err := networksClient.Insert(c.ctx, &computepb.InsertNetworkRequest{
Project: projectID,
NetworkResource: network,
})
if err != nil && !strings.Contains(err.Error(), "already exists") {
return err
}
if err == nil {
if err := op.Wait(c.ctx); err != nil {
return err
}
}
c.st.Logf("Network %s ensured", networkName)
// Create Subnet
subnetsClient, err := compute.NewSubnetworksRESTClient(c.ctx)
if err != nil {
return err
}
defer util.IgnoreError(subnetsClient.Close)
subnet := &computepb.Subnetwork{
Name: &subnetName,
IpCidrRange: protoString("10.10.0.0/20"),
Region: ®ion,
Network: protoString(fmt.Sprintf("projects/%s/global/networks/%s", projectID, networkName)),
}
op, err = subnetsClient.Insert(c.ctx, &computepb.InsertSubnetworkRequest{
Project: projectID,
Region: region,
SubnetworkResource: subnet,
})
if err != nil && !strings.Contains(err.Error(), "already exists") {
return err
}
if err == nil {
if err := op.Wait(c.ctx); err != nil {
return err
}
}
c.st.Logf("Subnetwork %s ensured", subnetName)
// Create Router
routersClient, err := compute.NewRoutersRESTClient(c.ctx)
if err != nil {
return fmt.Errorf("failed to create routers client: %w", err)
}
defer util.IgnoreError(routersClient.Close)
router := &computepb.Router{
Name: &routerName,
Region: ®ion,
Network: protoString(fmt.Sprintf("projects/%s/global/networks/%s", projectID, networkName)),
}
op, err = routersClient.Insert(c.ctx, &computepb.InsertRouterRequest{
Project: projectID,
Region: region,
RouterResource: router,
})
if err != nil && !isAlreadyExistsError(err) {
return fmt.Errorf("failed to create router: %w", err)
}
if err == nil {
if err := op.Wait(c.ctx); err != nil {
return fmt.Errorf("failed to wait for router creation: %w", err)
}
}
c.st.Logf("Router %s ensured", routerName)
// Create NAT Gateway
natsClient, err := compute.NewRoutersRESTClient(c.ctx)
if err != nil {
return fmt.Errorf("failed to create routers client for NAT: %w", err)
}
defer util.IgnoreError(natsClient.Close)
nat := &computepb.RouterNat{
Name: &natName,
SourceSubnetworkIpRangesToNat: protoString("ALL_SUBNETWORKS_ALL_IP_RANGES"),
NatIpAllocateOption: protoString("AUTO_ONLY"),
LogConfig: &computepb.RouterNatLogConfig{
Enable: protoBool(false),
Filter: protoString("ERRORS_ONLY"),
},
}
// Patch NAT config to router
_, err = routersClient.Patch(c.ctx, &computepb.PatchRouterRequest{
Project: projectID,
Region: region,
Router: routerName,
RouterResource: &computepb.Router{
Name: &routerName,
Nats: []*computepb.RouterNat{nat},
},
})
if err != nil && !isAlreadyExistsError(err) {
return fmt.Errorf("failed to create NAT gateway: %w", err)
}
c.st.Logf("NAT gateway %s ensured", natName)
return nil
}
// CreateFirewallRule creates a firewall rule in the specified project.
func (c *GCPClient) CreateFirewallRule(projectID string, rule *computepb.Firewall) error {
firewallsClient, err := compute.NewFirewallsRESTClient(c.ctx)
if err != nil {
return err
}
defer util.IgnoreError(firewallsClient.Close)
_, err = firewallsClient.Insert(c.ctx, &computepb.InsertFirewallRequest{
Project: projectID,
FirewallResource: rule,
})
if err != nil && !strings.Contains(err.Error(), "already exists") {
return err
}
return nil
}
// CreateInstance creates a new Compute Engine instance in the specified project and zone.
func (c *GCPClient) CreateInstance(projectID, zone string, instance *computepb.Instance) error {
client, err := compute.NewInstancesRESTClient(c.ctx)
if err != nil {
return err
}
defer util.IgnoreError(client.Close)
op, err := client.Insert(c.ctx, &computepb.InsertInstanceRequest{
Project: projectID,
Zone: zone,
InstanceResource: instance,
})
if err != nil {
return err
}
return op.Wait(c.ctx)
}
// GetInstance retrieves a Compute Engine instance by its name in the specified project and zone.
func (c *GCPClient) GetInstance(projectID, zone, instanceName string) (*computepb.Instance, error) {
client, err := compute.NewInstancesRESTClient(c.ctx)
if err != nil {
return nil, err
}
defer util.IgnoreError(client.Close)
return client.Get(c.ctx, &computepb.GetInstanceRequest{
Project: projectID,
Zone: zone,
Instance: instanceName,
})
}
// CreateAddress creates a new static IP address in the specified project and region.
func (c *GCPClient) CreateAddress(projectID, region string, address *computepb.Address) (string, error) {
client, err := compute.NewAddressesRESTClient(c.ctx)
if err != nil {
return "", err
}
defer util.IgnoreError(client.Close)
op, err := client.Insert(c.ctx, &computepb.InsertAddressRequest{
Project: projectID,
Region: region,
AddressResource: address,
})
if err != nil {
return "", err
}
if err = op.Wait(c.ctx); err != nil {
return "", err
}
// Fetch the created address to get the IP
createdAddress, err := client.Get(c.ctx, &computepb.GetAddressRequest{
Project: projectID,
Region: region,
Address: *address.Name,
})
if err != nil {
return "", err
}
return *createdAddress.Address, nil
}
// GetAddress retrieves a static IP address by its name in the specified project and region.
func (c *GCPClient) GetAddress(projectID, region, addressName string) (*computepb.Address, error) {
client, err := compute.NewAddressesRESTClient(c.ctx)
if err != nil {
return nil, err
}
defer util.IgnoreError(client.Close)
return client.Get(c.ctx, &computepb.GetAddressRequest{
Project: projectID,
Region: region,
Address: addressName,
})
}
// EnsureDNSManagedZone ensures that a DNS managed zone exists in the specified project.
func (c *GCPClient) EnsureDNSManagedZone(projectID, zoneName, dnsName, description string) error {
service, err := dns.NewService(c.ctx)
if err != nil {
return fmt.Errorf("failed to create DNS service: %w", err)
}
// Check if zone exists
_, err = service.ManagedZones.Get(projectID, zoneName).Context(c.ctx).Do()
if err == nil {
// Zone exists
return nil
}
// Create zone
zone := &dns.ManagedZone{
Name: zoneName,
DnsName: dnsName,
Description: description,
}
_, err = service.ManagedZones.Create(projectID, zone).Context(c.ctx).Do()
if err != nil {
return fmt.Errorf("failed to create DNS zone: %w", err)
}
return nil
}
// EnsureDNSRecordSets ensures that the specified DNS record sets exist in the given managed zone.
func (c *GCPClient) EnsureDNSRecordSets(projectID, zoneName string, records []*dns.ResourceRecordSet) error {
service, err := dns.NewService(c.ctx)
if err != nil {
return fmt.Errorf("failed to create DNS service: %w", err)
}
deletions := []*dns.ResourceRecordSet{}
// Clean up existing records
for _, record := range records {
existingRecord, err := service.ResourceRecordSets.Get(projectID, zoneName, record.Name, record.Type).Context(c.ctx).Do()
if err == nil && existingRecord != nil {
deletions = append(deletions, existingRecord)
}
}
if len(deletions) > 0 {
delChange := &dns.Change{
Deletions: deletions,
}
_, err = service.Changes.Create(projectID, zoneName, delChange).Context(c.ctx).Do()
if err != nil {
return fmt.Errorf("failed to delete existing DNS records: %w", err)
}
}
change := &dns.Change{
Additions: records,
}
_, err = service.Changes.Create(projectID, zoneName, change).Context(c.ctx).Do()
if err != nil {
return fmt.Errorf("failed to create DNS records: %w", err)
}
return nil
}
// Helper functions
func protoString(s string) *string { return &s }
func protoBool(b bool) *bool { return &b }
func protoInt32(i int32) *int32 { return &i }
func protoInt64(i int64) *int64 { return &i }