-
Notifications
You must be signed in to change notification settings - Fork 33
/
instance.go
347 lines (308 loc) · 14.5 KB
/
instance.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
/*
Copyright 2023 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package cloud
import (
"fmt"
"strings"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
"github.com/apache/cloudstack-go/v2/cloudstack"
"github.com/hashicorp/go-multierror"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
"k8s.io/utils/pointer"
infrav1 "sigs.k8s.io/cluster-api-provider-cloudstack/api/v1beta2"
)
type VMIface interface {
GetOrCreateVMInstance(*infrav1.CloudStackMachine, *clusterv1.Machine, *infrav1.CloudStackCluster, *infrav1.CloudStackFailureDomain, *infrav1.CloudStackAffinityGroup, string) error
ResolveVMInstanceDetails(*infrav1.CloudStackMachine) error
DestroyVMInstance(*infrav1.CloudStackMachine) error
}
// Set infrastructure spec and status from the CloudStack API's virtual machine metrics type.
func setMachineDataFromVMMetrics(vmResponse *cloudstack.VirtualMachinesMetric, csMachine *infrav1.CloudStackMachine) {
csMachine.Spec.ProviderID = pointer.String(fmt.Sprintf("cloudstack:///%s", vmResponse.Id))
// InstanceID is later used as required parameter to destroy VM.
csMachine.Spec.InstanceID = pointer.String(vmResponse.Id)
csMachine.Status.Addresses = []corev1.NodeAddress{{Type: corev1.NodeInternalIP, Address: vmResponse.Ipaddress}}
newInstanceState := vmResponse.State
if newInstanceState != csMachine.Status.InstanceState || (newInstanceState != "" && csMachine.Status.InstanceStateLastUpdated.IsZero()) {
csMachine.Status.InstanceState = newInstanceState
csMachine.Status.InstanceStateLastUpdated = metav1.Now()
}
}
// ResolveVMInstanceDetails Retrieves VM instance details by csMachine.Spec.InstanceID or csMachine.Name, and
// sets infrastructure machine spec and status if VM instance is found.
func (c *client) ResolveVMInstanceDetails(csMachine *infrav1.CloudStackMachine) error {
// Attempt to fetch by ID.
if csMachine.Spec.InstanceID != nil {
vmResp, count, err := c.cs.VirtualMachine.GetVirtualMachinesMetricByID(*csMachine.Spec.InstanceID)
if err != nil && !strings.Contains(strings.ToLower(err.Error()), "no match found") {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return err
} else if count > 1 {
return fmt.Errorf("found more than one VM Instance with ID %s", *csMachine.Spec.InstanceID)
} else if err == nil {
setMachineDataFromVMMetrics(vmResp, csMachine)
return nil
}
}
// Attempt fetch by name.
if csMachine.Name != "" {
vmResp, count, err := c.cs.VirtualMachine.GetVirtualMachinesMetricByName(csMachine.Name) // add opts usage
if err != nil && !strings.Contains(strings.ToLower(err.Error()), "no match") {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return err
} else if count > 1 {
return fmt.Errorf("found more than one VM Instance with name %s", csMachine.Name)
} else if err == nil {
setMachineDataFromVMMetrics(vmResp, csMachine)
return nil
}
}
return errors.New("no match found")
}
func (c *client) ResolveServiceOffering(csMachine *infrav1.CloudStackMachine, zoneID string) (offeringID string, retErr error) {
if len(csMachine.Spec.Offering.ID) > 0 {
csOffering, count, err := c.cs.ServiceOffering.GetServiceOfferingByID(csMachine.Spec.Offering.ID)
if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return "", multierror.Append(retErr, errors.Wrapf(
err, "could not get Service Offering by ID %s", csMachine.Spec.Offering.ID))
} else if count != 1 {
return "", multierror.Append(retErr, errors.Errorf(
"expected 1 Service Offering with UUID %s, but got %d", csMachine.Spec.Offering.ID, count))
}
if len(csMachine.Spec.Offering.Name) > 0 && csMachine.Spec.Offering.Name != csOffering.Name {
return "", multierror.Append(retErr, errors.Errorf(
"offering name %s does not match name %s returned using UUID %s", csMachine.Spec.Offering.Name, csOffering.Name, csMachine.Spec.Offering.ID))
}
return csMachine.Spec.Offering.ID, nil
}
offeringID, count, err := c.cs.ServiceOffering.GetServiceOfferingID(csMachine.Spec.Offering.Name, cloudstack.WithZone(zoneID))
if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return "", multierror.Append(retErr, errors.Wrapf(
err, "could not get Service Offering ID from %s in zone %s", csMachine.Spec.Offering.Name, zoneID))
} else if count != 1 {
return "", multierror.Append(retErr, errors.Errorf(
"expected 1 Service Offering with name %s in zone %s, but got %d", csMachine.Spec.Offering.Name, zoneID, count))
}
return offeringID, nil
}
func (c *client) ResolveTemplate(
csCluster *infrav1.CloudStackCluster,
csMachine *infrav1.CloudStackMachine,
zoneID string,
) (templateID string, retErr error) {
if len(csMachine.Spec.Template.ID) > 0 {
csTemplate, count, err := c.cs.Template.GetTemplateByID(csMachine.Spec.Template.ID, "executable")
if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return "", multierror.Append(retErr, errors.Wrapf(
err, "could not get Template by ID %s", csMachine.Spec.Template.ID))
} else if count != 1 {
return "", multierror.Append(retErr, errors.Errorf(
"expected 1 Template with UUID %s, but got %d", csMachine.Spec.Template.ID, count))
}
if len(csMachine.Spec.Template.Name) > 0 && csMachine.Spec.Template.Name != csTemplate.Name {
return "", multierror.Append(retErr, errors.Errorf(
"template name %s does not match name %s returned using UUID %s", csMachine.Spec.Template.Name, csTemplate.Name, csMachine.Spec.Template.ID))
}
return csMachine.Spec.Template.ID, nil
}
templateID, count, err := c.cs.Template.GetTemplateID(csMachine.Spec.Template.Name, "executable", zoneID)
if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return "", multierror.Append(retErr, errors.Wrapf(
err, "could not get Template ID from %s", csMachine.Spec.Template.Name))
} else if count != 1 {
return "", multierror.Append(retErr, errors.Errorf(
"expected 1 Template with name %s, but got %d", csMachine.Spec.Template.Name, count))
}
return templateID, nil
}
// ResolveDiskOffering Retrieves diskOffering by using disk offering ID if ID is provided and confirm returned
// disk offering name matches name provided in spec.
// If disk offering ID is not provided, the disk offering name is used to retrieve disk offering ID.
func (c *client) ResolveDiskOffering(csMachine *infrav1.CloudStackMachine, zoneID string) (diskOfferingID string, retErr error) {
diskOfferingID = csMachine.Spec.DiskOffering.ID
if len(csMachine.Spec.DiskOffering.Name) > 0 {
diskID, count, err := c.cs.DiskOffering.GetDiskOfferingID(csMachine.Spec.DiskOffering.Name, cloudstack.WithZone(zoneID))
if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return "", multierror.Append(retErr, errors.Wrapf(
err, "could not get DiskOffering ID from %s", csMachine.Spec.DiskOffering.Name))
} else if count != 1 {
return "", multierror.Append(retErr, errors.Errorf(
"expected 1 DiskOffering with name %s in zone %s, but got %d", csMachine.Spec.DiskOffering.Name, zoneID, count))
} else if len(csMachine.Spec.DiskOffering.ID) > 0 && diskID != csMachine.Spec.DiskOffering.ID {
return "", multierror.Append(retErr, errors.Errorf(
"diskOffering ID %s does not match ID %s returned using name %s in zone %s",
csMachine.Spec.DiskOffering.ID, diskID, csMachine.Spec.DiskOffering.Name, zoneID))
} else if len(diskID) == 0 {
return "", multierror.Append(retErr, errors.Errorf(
"empty diskOffering ID %s returned using name %s in zone %s",
diskID, csMachine.Spec.DiskOffering.Name, zoneID))
}
diskOfferingID = diskID
}
if len(diskOfferingID) == 0 {
return "", nil
}
return verifyDiskoffering(csMachine, c, diskOfferingID, retErr)
}
func verifyDiskoffering(csMachine *infrav1.CloudStackMachine, c *client, diskOfferingID string, retErr error) (string, error) {
csDiskOffering, count, err := c.cs.DiskOffering.GetDiskOfferingByID(diskOfferingID)
if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return "", multierror.Append(retErr, errors.Wrapf(
err, "could not get DiskOffering by ID %s", diskOfferingID))
} else if count != 1 {
return "", multierror.Append(retErr, errors.Errorf(
"expected 1 DiskOffering with UUID %s, but got %d", diskOfferingID, count))
}
if csDiskOffering.Iscustomized && csMachine.Spec.DiskOffering.CustomSize == 0 {
return "", multierror.Append(retErr, errors.Errorf(
"diskOffering with UUID %s is customized, disk size can not be 0 GB",
diskOfferingID))
}
if !csDiskOffering.Iscustomized && csMachine.Spec.DiskOffering.CustomSize > 0 {
return "", multierror.Append(retErr, errors.Errorf(
"diskOffering with UUID %s is not customized, disk size can not be specified",
diskOfferingID))
}
return diskOfferingID, nil
}
// GetOrCreateVMInstance CreateVMInstance will fetch or create a VM instance, and
// sets the infrastructure machine spec and status accordingly.
func (c *client) GetOrCreateVMInstance(
csMachine *infrav1.CloudStackMachine,
capiMachine *clusterv1.Machine,
csCluster *infrav1.CloudStackCluster,
fd *infrav1.CloudStackFailureDomain,
affinity *infrav1.CloudStackAffinityGroup,
userData string) error {
// Check if VM instance already exists.
if err := c.ResolveVMInstanceDetails(csMachine); err == nil ||
!strings.Contains(strings.ToLower(err.Error()), "no match") {
return err
}
offeringID, err := c.ResolveServiceOffering(csMachine, fd.Spec.Zone.ID)
if err != nil {
return err
}
templateID, err := c.ResolveTemplate(csCluster, csMachine, fd.Spec.Zone.ID)
if err != nil {
return err
}
diskOfferingID, err := c.ResolveDiskOffering(csMachine, fd.Spec.Zone.ID)
if err != nil {
return err
}
// Create VM instance.
p := c.cs.VirtualMachine.NewDeployVirtualMachineParams(offeringID, templateID, fd.Spec.Zone.ID)
p.SetNetworkids([]string{fd.Spec.Zone.Network.ID})
setIfNotEmpty(csMachine.Name, p.SetName)
setIfNotEmpty(capiMachine.Name, p.SetDisplayname)
setIfNotEmpty(diskOfferingID, p.SetDiskofferingid)
setIntIfPositive(csMachine.Spec.DiskOffering.CustomSize, p.SetSize)
setIfNotEmpty(csMachine.Spec.SSHKey, p.SetKeypair)
compressedAndEncodedUserData, err := CompressAndEncodeString(userData)
if err != nil {
return err
}
setIfNotEmpty(compressedAndEncodedUserData, p.SetUserdata)
if len(csMachine.Spec.AffinityGroupIDs) > 0 {
p.SetAffinitygroupids(csMachine.Spec.AffinityGroupIDs)
} else if strings.ToLower(csMachine.Spec.Affinity) != "no" && csMachine.Spec.Affinity != "" {
p.SetAffinitygroupids([]string{affinity.Spec.ID})
if err != nil {
return err
}
}
if csMachine.Spec.Details != nil {
p.SetDetails(csMachine.Spec.Details)
}
deployVMResp, err := c.cs.VirtualMachine.DeployVirtualMachine(p)
if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
// Just because an error was returned doesn't mean a (failed) VM wasn't created and will need to be dealt with.
// Regretfully the deployVMResp may be nil, so we need to get the VM ID with a separate query, so we
// can return it to the caller, so they can clean it up.
listVirtualMachineParams := c.cs.VirtualMachine.NewListVirtualMachinesParams()
listVirtualMachineParams.SetTemplateid(templateID)
listVirtualMachineParams.SetZoneid(fd.Spec.Zone.ID)
listVirtualMachineParams.SetNetworkid(fd.Spec.Zone.Network.ID)
listVirtualMachineParams.SetName(csMachine.Name)
listVirtualMachinesResponse, err2 := c.cs.VirtualMachine.ListVirtualMachines(listVirtualMachineParams)
if err2 != nil || listVirtualMachinesResponse.Count <= 0 {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err2)
return err
}
csMachine.Spec.InstanceID = pointer.String(listVirtualMachinesResponse.VirtualMachines[0].Id)
csMachine.Status.InstanceState = listVirtualMachinesResponse.VirtualMachines[0].State
} else {
csMachine.Spec.InstanceID = pointer.String(deployVMResp.Id)
csMachine.Status.Status = pointer.String(metav1.StatusSuccess)
}
// Resolve uses a VM metrics request response to fill cloudstack machine status.
// The deployment response is insufficient.
return c.ResolveVMInstanceDetails(csMachine)
}
// DestroyVMInstance Destroys a VM instance. Assumes machine has been fetched prior and has an instance ID.
func (c *client) DestroyVMInstance(csMachine *infrav1.CloudStackMachine) error {
// Attempt deletion regardless of machine state.
p := c.csAsync.VirtualMachine.NewDestroyVirtualMachineParams(*csMachine.Spec.InstanceID)
volIDs, err := c.listVMInstanceDatadiskVolumeIDs(*csMachine.Spec.InstanceID)
if err != nil {
return err
}
p.SetExpunge(true)
setArrayIfNotEmpty(volIDs, p.SetVolumeids)
if _, err := c.csAsync.VirtualMachine.DestroyVirtualMachine(p); err != nil &&
strings.Contains(strings.ToLower(err.Error()), "unable to find uuid for id") {
// VM doesn't exist. Success...
return nil
} else if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return err
}
if err := c.ResolveVMInstanceDetails(csMachine); err == nil && (csMachine.Status.InstanceState == "Expunging" ||
csMachine.Status.InstanceState == "Expunged") {
// VM is stopped and getting expunged. So the desired state is getting satisfied. Let's move on.
return nil
} else if err != nil {
if strings.Contains(strings.ToLower(err.Error()), "no match found") {
// VM doesn't exist. So the desired state is in effect. Our work is done here.
return nil
}
return err
}
return errors.New("VM deletion in progress")
}
func (c *client) listVMInstanceDatadiskVolumeIDs(instanceID string) ([]string, error) {
p := c.cs.Volume.NewListVolumesParams()
p.SetVirtualmachineid(instanceID)
// VM root volumes are destroyed automatically, no need to explicitly include
p.SetType("DATADISK")
listVOLResp, err := c.csAsync.Volume.ListVolumes(p)
if err != nil {
c.customMetrics.EvaluateErrorAndIncrementAcsReconciliationErrorCounter(err)
return nil, err
}
var ret []string
for _, vol := range listVOLResp.Volumes {
ret = append(ret, vol.Id)
}
return ret, nil
}