-
Notifications
You must be signed in to change notification settings - Fork 34
/
cluster_builder.go
545 lines (479 loc) · 17.6 KB
/
cluster_builder.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
package cluster_builder
import (
"encoding/json"
"fmt"
"net"
"os"
"path/filepath"
"sort"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
comm "github.com/berops/claudie/internal/command"
"github.com/berops/claudie/internal/templateUtils"
"github.com/berops/claudie/internal/utils"
"github.com/berops/claudie/proto/pb"
"github.com/berops/claudie/services/terraformer/server/domain/utils/backend"
"github.com/berops/claudie/services/terraformer/server/domain/utils/provider"
"github.com/berops/claudie/services/terraformer/server/domain/utils/terraform"
"github.com/berops/claudie/services/terraformer/templates"
)
const (
Output = "services/terraformer/server/clusters"
subnetCidrKey = "VPC_SUBNET_CIDR"
// <nodepool-name>-subnet-cidr
subnetCidrKeyTemplate = "%s-subnet-cidr"
baseSubnetCIDR = "10.0.0.0/24"
defaultOctetToChange = 2
)
// ClusterBuilder wraps data needed for building a cluster.
type ClusterBuilder struct {
// DesiredClusterInfo contains the information about the
// desired state of the cluster.
DesiredClusterInfo *pb.ClusterInfo
// CurrentClusterInfo contains the information about the
// current state of the cluster.
CurrentClusterInfo *pb.ClusterInfo
// ProjectName is the name of the manifest.
ProjectName string
// ClusterType is the type of the cluster being build
// LoadBalancer or K8s.
ClusterType pb.ClusterType
// Metadata contains data that further describe
// the cluster that is to be build. For example,
// in the case of LoadBalancer this will contain the defined
// roles from the manifest. Can be nil if no data is supplied.
Metadata map[string]any
// SpawnProcessLimit represents a synchronization channel which limits the number of spawned terraform
// processes. This values should always be non-nil and be buffered, where the capacity indicates
// the limit.
SpawnProcessLimit chan struct{}
}
type NodepoolsData struct {
ClusterName string
ClusterHash string
NodePools []NodePoolInfo
Metadata map[string]any
Regions []string
}
type NodePoolInfo struct {
NodePool *pb.DynamicNodePool
Name string
Nodes []*pb.Node
IsControl bool
}
type outputNodepools struct {
IPs map[string]interface{} `json:"-"`
}
// CreateNodepools creates node pools for the cluster.
func (c ClusterBuilder) CreateNodepools() error {
clusterID := utils.GetClusterID(c.DesiredClusterInfo)
clusterDir := filepath.Join(Output, clusterID)
// Calculate CIDR, so they do not change if nodepool order changes
// https://github.com/berops/claudie/issues/647
// Order them by provider and region
for _, nps := range utils.GroupNodepoolsByProviderRegion(c.DesiredClusterInfo) {
if err := c.calculateCIDR(baseSubnetCIDR, utils.GetDynamicNodePools(nps)); err != nil {
return fmt.Errorf("error while generating CIDR for nodepools : %w", err)
}
}
if err := c.generateFiles(clusterID, clusterDir); err != nil {
return fmt.Errorf("failed to generate files: %w", err)
}
terraform := terraform.Terraform{
Directory: clusterDir,
SpawnProcessLimit: c.SpawnProcessLimit,
}
if log.Logger.GetLevel() == zerolog.DebugLevel {
terraform.Stdout = comm.GetStdOut(clusterID)
terraform.Stderr = comm.GetStdErr(clusterID)
}
if err := terraform.Init(); err != nil {
return fmt.Errorf("error while running terraform init in %s : %w", clusterID, err)
}
if err := terraform.Apply(); err != nil {
return fmt.Errorf("error while running terraform apply in %s : %w", clusterID, err)
}
oldNodes := c.getCurrentNodes()
// fill new nodes with output
for _, nodepool := range c.DesiredClusterInfo.NodePools {
if np := nodepool.GetDynamicNodePool(); np != nil {
output, err := terraform.Output(nodepool.Name)
if err != nil {
return fmt.Errorf("error while getting output from terraform for %s : %w", nodepool.Name, err)
}
out, err := readIPs(output)
if err != nil {
return fmt.Errorf("error while reading the terraform output for %s : %w", nodepool.Name, err)
}
fillNodes(&out, nodepool, oldNodes)
}
}
// Clean after terraform
if err := os.RemoveAll(clusterDir); err != nil {
return fmt.Errorf("error while deleting files in %s : %w", clusterDir, err)
}
return nil
}
// DestroyNodepools destroys nodepools for the cluster.
func (c ClusterBuilder) DestroyNodepools() error {
clusterID := utils.GetClusterID(c.CurrentClusterInfo)
clusterDir := filepath.Join(Output, clusterID)
// Calculate CIDR, in case some nodepools do not have it, due to error.
// https://github.com/berops/claudie/issues/647
// Order them by provider and region
for _, nps := range utils.GroupNodepoolsByProviderRegion(c.CurrentClusterInfo) {
if err := c.calculateCIDR(baseSubnetCIDR, utils.GetDynamicNodePools(nps)); err != nil {
return fmt.Errorf("error while generating CIDR for nodepools : %w", err)
}
}
if err := c.generateFiles(clusterID, clusterDir); err != nil {
return fmt.Errorf("failed to generate files: %w", err)
}
terraform := terraform.Terraform{
Directory: clusterDir,
SpawnProcessLimit: c.SpawnProcessLimit,
}
if log.Logger.GetLevel() == zerolog.DebugLevel {
terraform.Stdout = comm.GetStdOut(clusterID)
terraform.Stderr = comm.GetStdErr(clusterID)
}
if err := terraform.Init(); err != nil {
return fmt.Errorf("error while running terraform init in %s : %w", clusterID, err)
}
if err := terraform.Destroy(); err != nil {
return fmt.Errorf("error while running terraform apply in %s : %w", clusterID, err)
}
// Clean after terraform.
if err := os.RemoveAll(clusterDir); err != nil {
return fmt.Errorf("error while deleting files in %s : %w", clusterDir, err)
}
return nil
}
// generateFiles creates all the necessary terraform files used to create/destroy node pools.
func (c *ClusterBuilder) generateFiles(clusterID, clusterDir string) error {
backend := backend.Backend{
ProjectName: c.ProjectName,
ClusterName: clusterID,
Directory: clusterDir,
}
if err := backend.CreateTFFile(); err != nil {
return err
}
// generate Providers terraform configuration
providers := provider.Provider{
ProjectName: c.ProjectName,
ClusterName: clusterID,
Directory: clusterDir,
}
if err := providers.CreateProvider(c.CurrentClusterInfo, c.DesiredClusterInfo); err != nil {
return err
}
var clusterInfo *pb.ClusterInfo
if c.DesiredClusterInfo != nil {
clusterInfo = c.DesiredClusterInfo
} else if c.CurrentClusterInfo != nil {
clusterInfo = c.CurrentClusterInfo
}
// Init node slices if needed
for _, np := range clusterInfo.NodePools {
if n := np.GetDynamicNodePool(); n != nil {
nodes := make([]*pb.Node, 0, n.Count)
nodeNames := make(map[string]struct{}, n.Count)
// Copy existing nodes into new slice
for i, node := range np.Nodes {
if i == int(n.Count) {
break
}
log.Debug().Str("cluster", clusterID).Msgf("Nodepool is reusing node %s", node.Name)
nodes = append(nodes, node)
nodeNames[node.Name] = struct{}{}
}
// Fill the rest of the nodes with assigned names
nodepoolID := fmt.Sprintf("%s-%s", clusterID, np.Name)
for len(nodes) < int(n.Count) {
// Get a unique name for the new node
nodeName := getUniqueNodeName(nodepoolID, nodeNames)
nodeNames[nodeName] = struct{}{}
nodes = append(nodes, &pb.Node{Name: nodeName})
}
np.Nodes = nodes
}
}
suffix := getTplFile(c.ClusterType)
// generate providers.tpl for all nodepools (current, desired).
if err := generateProviderTemplates(c.CurrentClusterInfo, c.DesiredClusterInfo, clusterID, clusterDir, suffix); err != nil {
return fmt.Errorf("error while generating provider templates: %w", err)
}
// sort nodepools by a provider
sortedNodePools := utils.GroupNodepoolsByProviderNames(clusterInfo)
for providerNames, nodepools := range sortedNodePools {
providerName := providerNames.CloudProviderName
// Continue if static node pool provider.
if providerName == pb.StaticNodepoolInfo_STATIC_PROVIDER.String() {
continue
}
nps := make([]NodePoolInfo, 0, len(nodepools))
for _, np := range nodepools {
if np.GetDynamicNodePool() == nil {
continue
}
nps = append(nps, NodePoolInfo{
Name: np.Name,
Nodes: np.Nodes,
NodePool: np.GetDynamicNodePool(),
})
}
// based on the cluster type fill out the nodepools data to be used
nodepoolData := NodepoolsData{
NodePools: nps,
ClusterName: clusterInfo.Name,
ClusterHash: clusterInfo.Hash,
Metadata: c.Metadata,
Regions: utils.GetRegions(utils.GetDynamicNodePools(nodepools)),
}
// Copy subnets CIDR to metadata
copyCIDRsToMetadata(&nodepoolData)
// Load TF files of the specific cloud provider
targetDirectory := templateUtils.Templates{Directory: clusterDir}
// Generate the infra templates.
file, err := templates.CloudProviderTemplates.ReadFile(filepath.Join(providerName, suffix))
if err != nil {
return fmt.Errorf("error while reading template file %s : %w", fmt.Sprintf("%s/%s", providerName, suffix), err)
}
tpl, err := templateUtils.LoadTemplate(string(file))
if err != nil {
return fmt.Errorf("error while parsing template file %s : %w", fmt.Sprintf("%s/%s", providerName, suffix), err)
}
if err := targetDirectory.Generate(tpl, fmt.Sprintf("%s-%s.tf", clusterID, providerNames.SpecName), nodepoolData); err != nil {
return fmt.Errorf("error while generating %s file : %w", fmt.Sprintf("%s-%s.tf", clusterID, providerNames.SpecName), err)
}
// Create publicKey file for a cluster
if err := utils.CreateKeyFile(clusterInfo.PublicKey, clusterDir, "public.pem"); err != nil {
return fmt.Errorf("error creating key file for %s : %w", clusterDir, err)
}
// save keys
if err := utils.CreateKeyFile(nps[0].NodePool.Provider.Credentials, clusterDir, providerNames.SpecName); err != nil {
return fmt.Errorf("error creating provider credential key file for provider %s in %s : %w", providerNames.SpecName, clusterDir, err)
}
}
return nil
}
// getCurrentNodes returns all nodes which are in a current state
func (c *ClusterBuilder) getCurrentNodes() []*pb.Node {
// group all the nodes together to make searching with respect to IP easy
var oldNodes []*pb.Node
if c.CurrentClusterInfo != nil {
for _, oldNodepool := range c.CurrentClusterInfo.NodePools {
if oldNodepool.GetDynamicNodePool() != nil {
oldNodes = append(oldNodes, oldNodepool.Nodes...)
}
}
}
return oldNodes
}
// calculateCIDR will make sure all nodepools have subnet CIDR calculated.
func (c *ClusterBuilder) calculateCIDR(baseCIDR string, nodepools []*pb.DynamicNodePool) error {
exists := make(map[string]struct{})
// Save CIDRs which already exist.
for _, np := range nodepools {
if cidr, ok := np.Metadata[subnetCidrKey]; ok {
exists[cidr.GetCidr()] = struct{}{}
}
}
// Calculate new ones if needed.
for _, np := range nodepools {
// Check if CIDR key is defined and if value is not nil/empty.
if cidr, ok := np.Metadata[subnetCidrKey]; !ok || cidr == nil || cidr.GetCidr() == "" {
cidr, err := getCIDR(baseCIDR, defaultOctetToChange, exists)
if err != nil {
return fmt.Errorf("failed to parse CIDR for nodepool : %w", err)
}
log.Debug().Msgf("Calculating new VPC subnet CIDR for nodepool. New CIDR [%s]", cidr)
if np.Metadata == nil {
np.Metadata = make(map[string]*pb.MetaValue)
}
np.Metadata[subnetCidrKey] = &pb.MetaValue{MetaValueOneOf: &pb.MetaValue_Cidr{Cidr: cidr}}
// Cache calculated CIDR.
exists[cidr] = struct{}{}
}
}
return nil
}
// fillNodes creates pb.Node slices in desired state, with the new nodes and old nodes
func fillNodes(terraformOutput *outputNodepools, newNodePool *pb.NodePool, oldNodes []*pb.Node) {
// fill slices from terraformOutput maps with names of nodes to ensure an order
var tempNodes []*pb.Node
// get sorted list of keys
sortedNodeNames := getKeysFromMap(terraformOutput.IPs)
for _, nodeName := range sortedNodeNames {
var nodeType pb.NodeType
var private string
if newNodePool.IsControl {
nodeType = pb.NodeType_master
} else {
nodeType = pb.NodeType_worker
}
if len(oldNodes) > 0 {
for _, node := range oldNodes {
//check if node was defined before
if fmt.Sprint(terraformOutput.IPs[nodeName]) == node.Public && nodeName == node.Name {
// carry privateIP to desired state, so it will not get overwritten in Ansibler
private = node.Private
// carry node type since it might be API endpoint, which should not change once set
nodeType = node.NodeType
break
}
}
}
tempNodes = append(tempNodes, &pb.Node{
Name: nodeName,
Public: fmt.Sprint(terraformOutput.IPs[nodeName]),
Private: private,
NodeType: nodeType,
})
}
newNodePool.Nodes = tempNodes
}
// getKeysFromMap returns an array of all keys in a map
func getKeysFromMap(data map[string]interface{}) []string {
var keys []string
for key := range data {
keys = append(keys, key)
}
sort.Strings(keys)
return keys
}
// readIPs reads json output format from terraform and unmarshal it into map[string]map[string]string readable by Go.
func readIPs(data string) (outputNodepools, error) {
var result outputNodepools
// Unmarshal or Decode the JSON to the interface.
err := json.Unmarshal([]byte(data), &result.IPs)
return result, err
}
// getTplFile returns type of the template file.
func getTplFile(clusterType pb.ClusterType) string {
switch clusterType {
case pb.ClusterType_K8s:
return "k8s.tpl"
case pb.ClusterType_LB:
return "lb.tpl"
}
return ""
}
// getUniqueNodeName returns new node name, which is guaranteed to be unique, based on the provided existing names.
func getUniqueNodeName(nodepoolID string, existingNames map[string]struct{}) string {
index := 1
for {
candidate := fmt.Sprintf("%s-%d", nodepoolID, index)
if _, ok := existingNames[candidate]; !ok {
return candidate
}
index++
}
}
// getCIDR function returns CIDR in IPv4 format, with position replaced by value
// The function does not check if it is a valid CIDR/can be used in subnet spec
func getCIDR(baseCIDR string, position int, existing map[string]struct{}) (string, error) {
_, ipNet, err := net.ParseCIDR(baseCIDR)
if err != nil {
return "", fmt.Errorf("cannot parse a CIDR with base %s, position %d", baseCIDR, position)
}
ip := ipNet.IP
ones, _ := ipNet.Mask.Size()
var i int
for {
if i > 255 {
return "", fmt.Errorf("maximum number of IPs assigned")
}
ip[position] = byte(i)
if _, ok := existing[fmt.Sprintf("%s/%d", ip.String(), ones)]; ok {
// CIDR already assigned.
i++
continue
}
// CIDR does not exist yet, return.
return fmt.Sprintf("%s/%d", ip.String(), ones), nil
}
}
// copyCIDRsToMetadata copies CIDRs for subnets in VPCs for every nodepool.
func copyCIDRsToMetadata(data *NodepoolsData) {
if data.Metadata == nil {
data.Metadata = make(map[string]any)
}
for _, np := range data.NodePools {
data.Metadata[fmt.Sprintf(subnetCidrKeyTemplate, np.Name)] = np.NodePool.Metadata[subnetCidrKey].GetCidr()
}
}
// generateProviderTemplates generates only the `provider.tpl` templates so terraform can
// destroy the infra if needed.
func generateProviderTemplates(current, desired *pb.ClusterInfo, clusterID, directory, suffix string) error {
currentNodepools := utils.GroupNodepoolsByProviderNames(current)
desiredNodepools := utils.GroupNodepoolsByProviderNames(desired)
// merge together into a single map instead of creating a new.
for name, np := range desiredNodepools {
// Continue if static node pool provider.
if name.CloudProviderName == pb.StaticNodepoolInfo_STATIC_PROVIDER.String() {
continue
}
if cnp, ok := currentNodepools[name]; !ok {
currentNodepools[name] = np
} else {
// merge them together as different regions could be used.
// (regions are used for generating the providers for various regions)
for _, pool := range np {
if found := utils.GetNodePoolByName(pool.GetName(), cnp); found == nil {
currentNodepools[name] = append(currentNodepools[name], pool)
}
}
}
}
info := desired
if info == nil {
info = current
}
for providerName, nodepools := range currentNodepools {
// Continue if static node pool provider.
if providerName.CloudProviderName == pb.StaticNodepoolInfo_STATIC_PROVIDER.String() {
continue
}
nps := make([]NodePoolInfo, 0, len(nodepools))
for _, np := range nodepools {
if np.GetDynamicNodePool() == nil {
continue
}
nps = append(nps, NodePoolInfo{
Name: np.Name,
Nodes: np.Nodes,
NodePool: np.GetDynamicNodePool(),
})
}
providerSpecName := providerName.SpecName
nodepoolData := NodepoolsData{
NodePools: nps,
ClusterName: info.Name,
ClusterHash: info.Hash,
Metadata: nil, // not needed
Regions: utils.GetRegions(utils.GetDynamicNodePools(nodepools)),
}
// Load TF files of the specific cloud provider
targetDirectory := templateUtils.Templates{Directory: directory}
tplPath := filepath.Join(providerName.CloudProviderName, fmt.Sprintf("provider-%s", suffix))
file, err := templates.CloudProviderTemplates.ReadFile(tplPath)
if err != nil {
return fmt.Errorf("error while reading template file %s : %w", tplPath, err)
}
tpl, err := templateUtils.LoadTemplate(string(file))
if err != nil {
return fmt.Errorf("error while parsing template file %s : %w", tplPath, err)
}
// Parse the templates and create Tf files
if err := targetDirectory.Generate(tpl, fmt.Sprintf("%s-%s-provider.tf", clusterID, providerSpecName), nodepoolData); err != nil {
return fmt.Errorf("error while generating %s file : %w", fmt.Sprintf("%s-%s-provider.tf", clusterID, providerSpecName), err)
}
// Save keys
if err = utils.CreateKeyFile(nps[0].NodePool.Provider.Credentials, directory, providerSpecName); err != nil {
return fmt.Errorf("error creating provider credential key file for provider %s in %s : %w", providerSpecName, directory, err)
}
}
return nil
}