-
Notifications
You must be signed in to change notification settings - Fork 156
/
provider.go
492 lines (416 loc) · 16.7 KB
/
provider.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
/*
Copyright 2020 The Kubermatic Kubernetes Platform contributors.
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 vsphere
import (
"context"
"crypto/x509"
"errors"
"fmt"
"net/url"
"path"
"strings"
"github.com/vmware/govmomi"
"github.com/vmware/govmomi/find"
"github.com/vmware/govmomi/object"
"github.com/vmware/govmomi/session"
"github.com/vmware/govmomi/vapi/tags"
"github.com/vmware/govmomi/vim25"
"github.com/vmware/govmomi/vim25/soap"
kubermaticv1 "k8c.io/kubermatic/v2/pkg/apis/kubermatic/v1"
kuberneteshelper "k8c.io/kubermatic/v2/pkg/kubernetes"
"k8c.io/kubermatic/v2/pkg/provider"
"k8c.io/kubermatic/v2/pkg/resources"
kruntime "k8s.io/apimachinery/pkg/util/runtime"
)
const (
folderCleanupFinalizer = "kubermatic.k8c.io/cleanup-vsphere-folder"
// categoryCleanupFinilizer will instruct the deletion of the default category tag.
tagCategoryCleanupFinilizer = "kubermatic.k8c.io/cleanup-vsphere-tag-category"
defaultCategory = "cluster"
)
// Provider represents the vsphere provider.
type Provider struct {
dc *kubermaticv1.DatacenterSpecVSphere
secretKeySelector provider.SecretKeySelectorValueFunc
caBundle *x509.CertPool
}
// Folder represents a vsphere folder.
type Folder struct {
Path string
}
// NewCloudProvider creates a new vSphere provider.
func NewCloudProvider(dc *kubermaticv1.Datacenter, secretKeyGetter provider.SecretKeySelectorValueFunc, caBundle *x509.CertPool) (*Provider, error) {
if dc.Spec.VSphere == nil {
return nil, errors.New("datacenter is not a vSphere datacenter")
}
return &Provider{
dc: dc.Spec.VSphere,
secretKeySelector: secretKeyGetter,
caBundle: caBundle,
}, nil
}
var _ provider.CloudProvider = &Provider{}
type Session struct {
Client *govmomi.Client
Finder *find.Finder
Datacenter *object.Datacenter
}
// Logout closes the idling vCenter connections.
func (s *Session) Logout(ctx context.Context) {
if err := s.Client.Logout(ctx); err != nil {
kruntime.HandleError(fmt.Errorf("vSphere client failed to logout: %w", err))
}
}
func newSession(ctx context.Context, dc *kubermaticv1.DatacenterSpecVSphere, username, password string, caBundle *x509.CertPool) (*Session, error) {
u, err := url.Parse(fmt.Sprintf("%s/sdk", dc.Endpoint))
if err != nil {
return nil, err
}
// creating the govmoni Client in roundabout way because we need to set the proper CA bundle: reference https://github.com/vmware/govmomi/issues/1200
soapClient := soap.NewClient(u, dc.AllowInsecure)
// set our CA bundle
soapClient.DefaultTransport().TLSClientConfig.RootCAs = caBundle
vim25Client, err := vim25.NewClient(ctx, soapClient)
if err != nil {
return nil, err
}
client := &govmomi.Client{
Client: vim25Client,
SessionManager: session.NewManager(vim25Client),
}
user := url.UserPassword(username, password)
if dc.InfraManagementUser != nil {
user = url.UserPassword(dc.InfraManagementUser.Username, dc.InfraManagementUser.Password)
}
if err = client.Login(ctx, user); err != nil {
return nil, fmt.Errorf("failed to login: %w", err)
}
finder := find.NewFinder(client.Client, true)
datacenter, err := finder.Datacenter(ctx, dc.Datacenter)
if err != nil {
return nil, fmt.Errorf("failed to get vSphere datacenter %q: %w", dc.Datacenter, err)
}
finder.SetDatacenter(datacenter)
return &Session{
Datacenter: datacenter,
Finder: finder,
Client: client,
}, nil
}
// getVMRootPath is a helper func to get the root path for VM's
// We extracted it because we use it in several places.
func getVMRootPath(dc *kubermaticv1.DatacenterSpecVSphere) string {
// Each datacenter root directory for VM's is: ${DATACENTER_NAME}/vm
rootPath := path.Join("/", dc.Datacenter, "vm")
// We offer a different root path though in case people would like to store all Kubermatic VM's below a certain directory
if dc.RootPath != "" {
rootPath = path.Clean(dc.RootPath)
}
return rootPath
}
// InitializeCloudProvider initializes the vsphere cloud provider by setting up vm folders for the cluster.
func (v *Provider) InitializeCloudProvider(ctx context.Context, cluster *kubermaticv1.Cluster, update provider.ClusterUpdater) (*kubermaticv1.Cluster, error) {
username, password, err := GetCredentialsForCluster(cluster.Spec.Cloud, v.secretKeySelector, v.dc)
if err != nil {
return nil, err
}
rootPath := getVMRootPath(v.dc)
if cluster.Spec.Cloud.VSphere.Folder == "" {
session, err := newSession(ctx, v.dc, username, password, v.caBundle)
if err != nil {
return nil, fmt.Errorf("failed to create vCenter session: %w", err)
}
defer session.Logout(ctx)
// If the user did not specify a folder, we create a own folder for this cluster to improve
// the VM management in vCenter
clusterFolder := path.Join(rootPath, cluster.Name)
if err := createVMFolder(ctx, session, clusterFolder); err != nil {
return nil, fmt.Errorf("failed to create the VM folder %q: %w", clusterFolder, err)
}
cluster, err = update(ctx, cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.AddFinalizer(cluster, folderCleanupFinalizer)
cluster.Spec.Cloud.VSphere.Folder = clusterFolder
})
if err != nil {
return nil, err
}
}
if cluster.Spec.Cloud.VSphere.TagCategoryID == "" {
restSession, err := newRESTSession(ctx, v.dc, username, password, v.caBundle)
if err != nil {
return nil, fmt.Errorf("failed to create REST client session: %w", err)
}
defer restSession.Logout(ctx)
// If the user did not specify a tag category, we create an own default for this cluster
categoryID, err := createTagCategory(ctx, restSession, cluster)
if err != nil {
return nil, fmt.Errorf("failed to create tag category: %w", err)
}
cluster, err = update(ctx, cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.AddFinalizer(cluster, tagCategoryCleanupFinilizer)
cluster.Spec.Cloud.VSphere.TagCategoryID = categoryID
})
if err != nil {
return nil, err
}
}
return cluster, nil
}
// TODO: Hey, you! Yes, you! Why don't you implement reconciling for vSphere? Would be really cool :)
// func (v *Provider) ReconcileCluster(cluster *kubermaticv1.Cluster, update provider.ClusterUpdater) (*kubermaticv1.Cluster, error) {
// return cluster, nil
// }
// GetNetworks returns a slice of VSphereNetworks of the datacenter from the passed cloudspec.
func GetNetworks(ctx context.Context, dc *kubermaticv1.DatacenterSpecVSphere, username, password string, caBundle *x509.CertPool) ([]NetworkInfo, error) {
// For the GetNetworks request we use dc.Spec.VSphere.InfraManagementUser
// if set because that is the user which will ultimatively configure
// the networks - But it means users in the UI can see vsphere
// networks without entering credentials
session, err := newSession(ctx, dc, username, password, caBundle)
if err != nil {
return nil, fmt.Errorf("failed to create vCenter session: %w", err)
}
defer session.Logout(ctx)
return getPossibleVMNetworks(ctx, session)
}
// GetVMFolders returns a slice of VSphereFolders of the datacenter from the passed cloudspec.
func GetVMFolders(ctx context.Context, dc *kubermaticv1.DatacenterSpecVSphere, username, password string, caBundle *x509.CertPool) ([]Folder, error) {
session, err := newSession(ctx, dc, username, password, caBundle)
if err != nil {
return nil, fmt.Errorf("failed to create vCenter session: %w", err)
}
defer session.Logout(ctx)
// We simply list all folders & filter out afterwards.
// Filtering here is not possible as vCenter only lists the first level when giving a path.
// vCenter only lists folders recursively if you just specify "*".
folderRefs, err := session.Finder.FolderList(ctx, "*")
if err != nil {
return nil, fmt.Errorf("couldn't retrieve folder list: %w", err)
}
rootPath := getVMRootPath(dc)
var folders []Folder
for _, folderRef := range folderRefs {
// We filter by rootPath. If someone configures it, we should respect it.
if !strings.HasPrefix(folderRef.InventoryPath, rootPath+"/") && folderRef.InventoryPath != rootPath {
continue
}
folder := Folder{Path: folderRef.Common.InventoryPath}
folders = append(folders, folder)
}
return folders, nil
}
// DefaultCloudSpec adds defaults to the cloud spec.
func (v *Provider) DefaultCloudSpec(_ context.Context, spec *kubermaticv1.CloudSpec) error {
if spec.VSphere.TagCategoryID == "" {
spec.VSphere.TagCategoryID = v.dc.DefaultTagCategoryID
}
return nil
}
// ValidateCloudSpec validates whether a vsphere client can be constructed for
// the passed cloudspec and perform some additional checks on datastore config.
func (v *Provider) ValidateCloudSpec(ctx context.Context, spec kubermaticv1.CloudSpec) error {
username, password, err := GetCredentialsForCluster(spec, v.secretKeySelector, v.dc)
if err != nil {
return err
}
if v.dc.DefaultDatastore == "" && spec.VSphere.DatastoreCluster == "" && spec.VSphere.Datastore == "" {
return errors.New("no default datastore provided at datacenter nor datastore/datastore cluster at cluster level")
}
if spec.VSphere.DatastoreCluster != "" && spec.VSphere.Datastore != "" {
return errors.New("either datastore or datastore cluster can be selected")
}
session, err := newSession(ctx, v.dc, username, password, v.caBundle)
if err != nil {
return fmt.Errorf("failed to create vCenter session: %w", err)
}
defer session.Logout(ctx)
if ds := v.dc.DefaultDatastore; ds != "" {
if _, err := session.Finder.Datastore(ctx, ds); err != nil {
return fmt.Errorf("failed to get default datastore provided by datacenter spec %q: %w", ds, err)
}
}
if rp := spec.VSphere.ResourcePool; rp != "" {
if _, err := session.Finder.ResourcePool(ctx, rp); err != nil {
return fmt.Errorf("failed to get resource pool %s: %w", rp, err)
}
}
if dc := spec.VSphere.DatastoreCluster; dc != "" {
if _, err := session.Finder.DatastoreCluster(ctx, spec.VSphere.DatastoreCluster); err != nil {
return fmt.Errorf("failed to get datastore cluster provided by cluster spec %q: %w", dc, err)
}
}
if ds := spec.VSphere.Datastore; ds != "" {
if _, err = session.Finder.Datastore(ctx, ds); err != nil {
return fmt.Errorf("failed to get datastore cluster provided by cluste spec %q: %w", ds, err)
}
}
if tagCategoryID := spec.VSphere.TagCategoryID; tagCategoryID != "" {
restSession, err := newRESTSession(ctx, v.dc, username, password, v.caBundle)
if err != nil {
return fmt.Errorf("failed to create REST client session: %w", err)
}
defer restSession.Logout(ctx)
tagManager := tags.NewManager(restSession.Client)
if _, err := tagManager.GetCategory(ctx, tagCategoryID); err != nil {
return fmt.Errorf("failed to get tag categories %w", err)
}
}
return nil
}
// CleanUpCloudProvider we always check if the folder is there and remove it if yes because we know its absolute path
// This covers cases where the finalizer was not added
// We also remove the finalizer if either the folder is not present or we successfully deleted it.
func (v *Provider) CleanUpCloudProvider(ctx context.Context, cluster *kubermaticv1.Cluster, update provider.ClusterUpdater) (*kubermaticv1.Cluster, error) {
username, password, err := GetCredentialsForCluster(cluster.Spec.Cloud, v.secretKeySelector, v.dc)
if err != nil {
return nil, err
}
session, err := newSession(ctx, v.dc, username, password, v.caBundle)
if err != nil {
return nil, fmt.Errorf("failed to create vCenter session: %w", err)
}
defer session.Logout(ctx)
restSession, err := newRESTSession(ctx, v.dc, username, password, v.caBundle)
if err != nil {
return nil, fmt.Errorf("failed to create REST client session: %w", err)
}
defer restSession.Logout(ctx)
if kuberneteshelper.HasFinalizer(cluster, folderCleanupFinalizer) {
if err := deleteVMFolder(ctx, session, cluster.Spec.Cloud.VSphere.Folder); err != nil {
return nil, err
}
cluster, err = update(ctx, cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.RemoveFinalizer(cluster, folderCleanupFinalizer)
})
if err != nil {
return nil, err
}
}
if kuberneteshelper.HasFinalizer(cluster, tagCategoryCleanupFinilizer) {
if err := deleteTagCategory(ctx, restSession, cluster); err != nil {
return nil, err
}
cluster, err = update(ctx, cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.RemoveFinalizer(cluster, tagCategoryCleanupFinilizer)
})
if err != nil {
return nil, err
}
}
return cluster, nil
}
// ValidateCloudSpecUpdate verifies whether an update of cloud spec is valid and permitted.
func (v *Provider) ValidateCloudSpecUpdate(_ context.Context, oldSpec kubermaticv1.CloudSpec, newSpec kubermaticv1.CloudSpec) error {
if oldSpec.VSphere == nil || newSpec.VSphere == nil {
return errors.New("'vsphere' spec is empty")
}
if oldSpec.VSphere.Folder != "" && oldSpec.VSphere.Folder != newSpec.VSphere.Folder {
return fmt.Errorf("updating vSphere folder is not supported (was %s, updated to %s)", oldSpec.VSphere.Folder, newSpec.VSphere.Folder)
}
return nil
}
// GetDatastoreList returns a slice of Datastore of the datacenter from the passed cloudspec.
func GetDatastoreList(ctx context.Context, dc *kubermaticv1.DatacenterSpecVSphere, username, password string, caBundle *x509.CertPool) ([]*object.Datastore, error) {
session, err := newSession(ctx, dc, username, password, caBundle)
if err != nil {
return nil, fmt.Errorf("failed to create vCenter session: %w", err)
}
defer session.Logout(ctx)
datastoreList, err := session.Finder.DatastoreList(ctx, "*")
if err != nil {
return nil, fmt.Errorf("couldn't retrieve datastore list: %w", err)
}
return datastoreList, nil
}
// Precedence if not infraManagementUser:
// * User from cluster
// * User from Secret
// Precedence if infraManagementUser:
// * User from clusters infraManagementUser
// * User from cluster
// * User form clusters secret infraManagementUser
// * User from clusters secret.
func getUsernameAndPassword(cloud kubermaticv1.CloudSpec, secretKeySelector provider.SecretKeySelectorValueFunc, infraManagementUser bool) (username, password string, err error) {
if infraManagementUser {
username = cloud.VSphere.InfraManagementUser.Username
password = cloud.VSphere.InfraManagementUser.Password
}
if username == "" {
username = cloud.VSphere.Username
}
if password == "" {
password = cloud.VSphere.Password
}
if username != "" && password != "" {
return username, password, nil
}
if cloud.VSphere.CredentialsReference == nil {
return "", "", errors.New("cluster contains no password an and empty credentialsReference")
}
if username == "" && infraManagementUser {
username, err = secretKeySelector(cloud.VSphere.CredentialsReference, resources.VsphereInfraManagementUserUsername)
if err != nil {
return "", "", err
}
}
if username == "" {
username, err = secretKeySelector(cloud.VSphere.CredentialsReference, resources.VsphereUsername)
if err != nil {
return "", "", err
}
}
if password == "" && infraManagementUser {
password, err = secretKeySelector(cloud.VSphere.CredentialsReference, resources.VsphereInfraManagementUserPassword)
if err != nil {
return "", "", err
}
}
if password == "" {
password, err = secretKeySelector(cloud.VSphere.CredentialsReference, resources.VspherePassword)
if err != nil {
return "", "", err
}
}
if username == "" {
return "", "", errors.New("unable to get username")
}
if password == "" {
return "", "", errors.New("unable to get password")
}
return username, password, nil
}
func GetCredentialsForCluster(cloud kubermaticv1.CloudSpec, secretKeySelector provider.SecretKeySelectorValueFunc, dc *kubermaticv1.DatacenterSpecVSphere) (string, string, error) {
var username, password string
var err error
// InfraManagementUser from Datacenter
if dc != nil && dc.InfraManagementUser != nil {
if dc.InfraManagementUser.Username != "" && dc.InfraManagementUser.Password != "" {
return dc.InfraManagementUser.Username, dc.InfraManagementUser.Password, nil
}
}
// InfraManagementUser from Cluster
username, password, err = getUsernameAndPassword(cloud, secretKeySelector, true)
if err != nil {
return "", "", err
}
return username, password, nil
}
func ValidateCredentials(ctx context.Context, dc *kubermaticv1.DatacenterSpecVSphere, username, password string, caBundle *x509.CertPool) error {
session, err := newSession(ctx, dc, username, password, caBundle)
if err != nil {
return err
}
defer session.Logout(ctx)
_, err = session.Finder.DefaultFolder(ctx)
return err
}