forked from juju/juju
-
Notifications
You must be signed in to change notification settings - Fork 0
/
modelmanager.go
627 lines (589 loc) · 19.1 KB
/
modelmanager.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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
// Copyright 2015 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package modelmanager
import (
"time"
"github.com/juju/errors"
"github.com/juju/loggo"
"github.com/juju/names/v4"
"gopkg.in/yaml.v2"
"github.com/DavinZhang/juju/api/base"
"github.com/DavinZhang/juju/api/common"
"github.com/DavinZhang/juju/apiserver/params"
"github.com/DavinZhang/juju/core/instance"
"github.com/DavinZhang/juju/core/model"
"github.com/DavinZhang/juju/core/permission"
"github.com/DavinZhang/juju/environs/config"
"github.com/DavinZhang/juju/rpc"
)
var logger = loggo.GetLogger("juju.api.modelmanager")
// Client provides methods that the Juju client command uses to interact
// with models stored in the Juju Server.
type Client struct {
base.ClientFacade
facade base.FacadeCaller
*common.ModelStatusAPI
}
// NewClient creates a new `Client` based on an existing authenticated API
// connection.
func NewClient(st base.APICallCloser) *Client {
frontend, backend := base.NewClientFacade(st, "ModelManager")
return &Client{
ClientFacade: frontend,
facade: backend,
ModelStatusAPI: common.NewModelStatusAPI(backend),
}
}
// CreateModel creates a new model using the model config,
// cloud region and credential specified in the args.
func (c *Client) CreateModel(
name, owner, cloud, cloudRegion string,
cloudCredential names.CloudCredentialTag,
config map[string]interface{},
) (base.ModelInfo, error) {
var result base.ModelInfo
if !names.IsValidUser(owner) {
return result, errors.Errorf("invalid owner name %q", owner)
}
var cloudTag string
if cloud != "" {
if !names.IsValidCloud(cloud) {
return result, errors.Errorf("invalid cloud name %q", cloud)
}
cloudTag = names.NewCloudTag(cloud).String()
}
var cloudCredentialTag string
if cloudCredential != (names.CloudCredentialTag{}) {
cloudCredentialTag = cloudCredential.String()
}
createArgs := params.ModelCreateArgs{
Name: name,
OwnerTag: names.NewUserTag(owner).String(),
Config: config,
CloudTag: cloudTag,
CloudRegion: cloudRegion,
CloudCredentialTag: cloudCredentialTag,
}
var modelInfo params.ModelInfo
err := c.facade.FacadeCall("CreateModel", createArgs, &modelInfo)
if err != nil {
// We don't want the message to contain the "(already exists)" suffix.
if rpcErr, ok := errors.Cause(err).(*rpc.RequestError); ok {
return result, errors.New(rpcErr.Message)
}
return result, errors.Trace(err)
}
return convertParamsModelInfo(modelInfo)
}
func convertParamsModelInfo(modelInfo params.ModelInfo) (base.ModelInfo, error) {
cloud, err := names.ParseCloudTag(modelInfo.CloudTag)
if err != nil {
return base.ModelInfo{}, err
}
var credential string
if modelInfo.CloudCredentialTag != "" {
credTag, err := names.ParseCloudCredentialTag(modelInfo.CloudCredentialTag)
if err != nil {
return base.ModelInfo{}, err
}
credential = credTag.Id()
}
ownerTag, err := names.ParseUserTag(modelInfo.OwnerTag)
if err != nil {
return base.ModelInfo{}, err
}
result := base.ModelInfo{
Name: modelInfo.Name,
UUID: modelInfo.UUID,
ControllerUUID: modelInfo.ControllerUUID,
IsController: modelInfo.IsController,
ProviderType: modelInfo.ProviderType,
DefaultSeries: modelInfo.DefaultSeries,
Cloud: cloud.Id(),
CloudRegion: modelInfo.CloudRegion,
CloudCredential: credential,
Owner: ownerTag.Id(),
Life: modelInfo.Life,
AgentVersion: modelInfo.AgentVersion,
}
modelType := modelInfo.Type
if modelType == "" {
modelType = model.IAAS.String()
}
result.Type = model.ModelType(modelType)
result.Status = base.Status{
Status: modelInfo.Status.Status,
Info: modelInfo.Status.Info,
Data: make(map[string]interface{}),
Since: modelInfo.Status.Since,
}
for k, v := range modelInfo.Status.Data {
result.Status.Data[k] = v
}
result.Users = make([]base.UserInfo, len(modelInfo.Users))
for i, u := range modelInfo.Users {
result.Users[i] = base.UserInfo{
UserName: u.UserName,
DisplayName: u.DisplayName,
Access: string(u.Access),
LastConnection: u.LastConnection,
}
}
result.Machines = make([]base.Machine, len(modelInfo.Machines))
for i, m := range modelInfo.Machines {
machine := base.Machine{
Id: m.Id,
InstanceId: m.InstanceId,
DisplayName: m.DisplayName,
HasVote: m.HasVote,
WantsVote: m.WantsVote,
Status: m.Status,
HAPrimary: m.HAPrimary,
}
if m.Hardware != nil {
machine.Hardware = &instance.HardwareCharacteristics{
Arch: m.Hardware.Arch,
Mem: m.Hardware.Mem,
RootDisk: m.Hardware.RootDisk,
CpuCores: m.Hardware.Cores,
CpuPower: m.Hardware.CpuPower,
Tags: m.Hardware.Tags,
AvailabilityZone: m.Hardware.AvailabilityZone,
}
}
result.Machines[i] = machine
}
return result, nil
}
// ListModels returns the models that the specified user
// has access to in the current server. Only that controller owner
// can list models for any user (at this stage). Other users
// can only ask about their own models.
func (c *Client) ListModels(user string) ([]base.UserModel, error) {
var models params.UserModelList
if !names.IsValidUser(user) {
return nil, errors.Errorf("invalid user name %q", user)
}
entity := params.Entity{names.NewUserTag(user).String()}
err := c.facade.FacadeCall("ListModels", entity, &models)
if err != nil {
return nil, errors.Trace(err)
}
result := make([]base.UserModel, len(models.UserModels))
for i, usermodel := range models.UserModels {
owner, err := names.ParseUserTag(usermodel.OwnerTag)
if err != nil {
return nil, errors.Annotatef(err, "OwnerTag %q at position %d", usermodel.OwnerTag, i)
}
modelType := model.ModelType(usermodel.Type)
if modelType == "" {
modelType = model.IAAS
}
result[i] = base.UserModel{
Name: usermodel.Name,
UUID: usermodel.UUID,
Type: modelType,
Owner: owner.Id(),
LastConnection: usermodel.LastConnection,
}
}
return result, nil
}
func (c *Client) ListModelSummaries(user string, all bool) ([]base.UserModelSummary, error) {
var out params.ModelSummaryResults
if !names.IsValidUser(user) {
return nil, errors.Errorf("invalid user name %q", user)
}
in := params.ModelSummariesRequest{UserTag: names.NewUserTag(user).String(), All: all}
err := c.facade.FacadeCall("ListModelSummaries", in, &out)
if err != nil {
return nil, errors.Trace(err)
}
summaries := make([]base.UserModelSummary, len(out.Results))
for i, r := range out.Results {
if r.Error != nil {
// cope with typed error
summaries[i] = base.UserModelSummary{Error: errors.Trace(r.Error)}
continue
}
summary := r.Result
modelType := model.ModelType(summary.Type)
if modelType == "" {
modelType = model.IAAS
}
summaries[i] = base.UserModelSummary{
Name: summary.Name,
UUID: summary.UUID,
Type: modelType,
ControllerUUID: summary.ControllerUUID,
IsController: summary.IsController,
ProviderType: summary.ProviderType,
DefaultSeries: summary.DefaultSeries,
CloudRegion: summary.CloudRegion,
Life: summary.Life,
ModelUserAccess: string(summary.UserAccess),
UserLastConnection: summary.UserLastConnection,
Counts: make([]base.EntityCount, len(summary.Counts)),
AgentVersion: summary.AgentVersion,
}
for pos, count := range summary.Counts {
summaries[i].Counts[pos] = base.EntityCount{string(count.Entity), count.Count}
}
summaries[i].Status = base.Status{
Status: summary.Status.Status,
Info: summary.Status.Info,
Data: make(map[string]interface{}),
Since: summary.Status.Since,
}
for k, v := range summary.Status.Data {
summaries[i].Status.Data[k] = v
}
if owner, err := names.ParseUserTag(summary.OwnerTag); err != nil {
summaries[i].Error = errors.Annotatef(err, "while parsing model owner tag")
continue
} else {
summaries[i].Owner = owner.Id()
}
if cloud, err := names.ParseCloudTag(summary.CloudTag); err != nil {
summaries[i].Error = errors.Annotatef(err, "while parsing model cloud tag")
continue
} else {
summaries[i].Cloud = cloud.Id()
}
if summary.CloudCredentialTag != "" {
if credTag, err := names.ParseCloudCredentialTag(summary.CloudCredentialTag); err != nil {
summaries[i].Error = errors.Annotatef(err, "while parsing model cloud credential tag")
continue
} else {
summaries[i].CloudCredential = credTag.Id()
}
}
if summary.Migration != nil {
summaries[i].Migration = &base.MigrationSummary{
Status: summary.Migration.Status,
StartTime: summary.Migration.Start,
EndTime: summary.Migration.End,
}
}
if summary.SLA != nil {
summaries[i].SLA = &base.SLASummary{
Level: summary.SLA.Level,
Owner: summary.SLA.Owner,
}
}
}
return summaries, nil
}
func (c *Client) ModelInfo(tags []names.ModelTag) ([]params.ModelInfoResult, error) {
entities := params.Entities{
Entities: make([]params.Entity, len(tags)),
}
for i, tag := range tags {
entities.Entities[i].Tag = tag.String()
}
var results params.ModelInfoResults
err := c.facade.FacadeCall("ModelInfo", entities, &results)
if err != nil {
return nil, errors.Trace(err)
}
if len(results.Results) != len(tags) {
return nil, errors.Errorf("expected %d result(s), got %d", len(tags), len(results.Results))
}
for i := range results.Results {
if results.Results[i].Error != nil {
continue
}
if results.Results[i].Result.Type == "" {
results.Results[i].Result.Type = model.IAAS.String()
}
}
return results.Results, nil
}
// DumpModel returns the serialized database agnostic model representation.
func (c *Client) DumpModel(model names.ModelTag, simplified bool) (map[string]interface{}, error) {
if bestVer := c.BestAPIVersion(); bestVer < 3 {
logger.Debugf("calling older dump model on v%d", bestVer)
if simplified {
logger.Warningf("simplified dump-model not available, server too old")
}
return c.dumpModelV2(model)
}
var results params.StringResults
entities := params.DumpModelRequest{
Entities: []params.Entity{{Tag: model.String()}},
Simplified: simplified,
}
err := c.facade.FacadeCall("DumpModels", entities, &results)
if err != nil {
return nil, errors.Trace(err)
}
if count := len(results.Results); count != 1 {
return nil, errors.Errorf("unexpected result count: %d", count)
}
result := results.Results[0]
if result.Error != nil {
return nil, result.Error
}
// Parse back into a map.
var asMap map[string]interface{}
err = yaml.Unmarshal([]byte(result.Result), &asMap)
if err != nil {
return nil, errors.Trace(err)
}
return asMap, nil
}
func (c *Client) dumpModelV2(model names.ModelTag) (map[string]interface{}, error) {
var results params.MapResults
entities := params.Entities{
Entities: []params.Entity{{Tag: model.String()}},
}
err := c.facade.FacadeCall("DumpModels", entities, &results)
if err != nil {
return nil, errors.Trace(err)
}
if count := len(results.Results); count != 1 {
return nil, errors.Errorf("unexpected result count: %d", count)
}
result := results.Results[0]
if result.Error != nil {
return nil, result.Error
}
return result.Result, nil
}
// DumpModelDB returns all relevant mongo documents for the model.
func (c *Client) DumpModelDB(model names.ModelTag) (map[string]interface{}, error) {
var results params.MapResults
entities := params.Entities{
Entities: []params.Entity{{Tag: model.String()}},
}
err := c.facade.FacadeCall("DumpModelsDB", entities, &results)
if err != nil {
return nil, errors.Trace(err)
}
if count := len(results.Results); count != 1 {
return nil, errors.Errorf("unexpected result count: %d", count)
}
result := results.Results[0]
if result.Error != nil {
return nil, result.Error
}
return result.Result, nil
}
// DestroyModel puts the specified model into a "dying" state, which will
// cause the model's resources to be cleaned up, after which the model will
// be removed.
func (c *Client) DestroyModel(tag names.ModelTag, destroyStorage, force *bool, maxWait *time.Duration, timeout time.Duration) error {
var args interface{}
if c.BestAPIVersion() < 4 {
if destroyStorage == nil || !*destroyStorage {
return errors.New("this Juju controller requires destroyStorage to be true")
}
args = params.Entities{Entities: []params.Entity{{Tag: tag.String()}}}
} else {
arg := params.DestroyModelParams{
ModelTag: tag.String(),
DestroyStorage: destroyStorage,
}
if c.BestAPIVersion() > 6 {
arg.Force = force
arg.MaxWait = maxWait
arg.Timeout = &timeout
}
args = params.DestroyModelsParams{Models: []params.DestroyModelParams{arg}}
}
var results params.ErrorResults
if err := c.facade.FacadeCall("DestroyModels", args, &results); err != nil {
return errors.Trace(err)
}
if n := len(results.Results); n != 1 {
return errors.Errorf("expected 1 result, got %d", n)
}
if err := results.Results[0].Error; err != nil {
return errors.Trace(err)
}
return nil
}
// GrantModel grants a user access to the specified models.
func (c *Client) GrantModel(user, access string, modelUUIDs ...string) error {
return c.modifyModelUser(params.GrantModelAccess, user, access, modelUUIDs)
}
// RevokeModel revokes a user's access to the specified models.
func (c *Client) RevokeModel(user, access string, modelUUIDs ...string) error {
return c.modifyModelUser(params.RevokeModelAccess, user, access, modelUUIDs)
}
func (c *Client) modifyModelUser(action params.ModelAction, user, access string, modelUUIDs []string) error {
var args params.ModifyModelAccessRequest
if !names.IsValidUser(user) {
return errors.Errorf("invalid username: %q", user)
}
userTag := names.NewUserTag(user)
modelAccess := permission.Access(access)
if err := permission.ValidateModelAccess(modelAccess); err != nil {
return errors.Trace(err)
}
for _, m := range modelUUIDs {
if !names.IsValidModel(m) {
return errors.Errorf("invalid model: %q", m)
}
modelTag := names.NewModelTag(m)
args.Changes = append(args.Changes, params.ModifyModelAccess{
UserTag: userTag.String(),
Action: action,
Access: params.UserAccessPermission(modelAccess),
ModelTag: modelTag.String(),
})
}
var result params.ErrorResults
err := c.facade.FacadeCall("ModifyModelAccess", args, &result)
if err != nil {
return errors.Trace(err)
}
if len(result.Results) != len(args.Changes) {
return errors.Errorf("expected %d results, got %d", len(args.Changes), len(result.Results))
}
for i, r := range result.Results {
if r.Error != nil && r.Error.Code == params.CodeAlreadyExists {
logger.Warningf("model %q is already shared with %q", modelUUIDs[i], userTag.Id())
result.Results[i].Error = nil
}
}
return result.Combine()
}
// ModelDefaults returns the default values for various sources used when
// creating a new model on the specified cloud.
func (c *Client) ModelDefaults(cloud string) (config.ModelDefaultAttributes, error) {
if c.BestAPIVersion() < 6 {
if cloud != "" {
return nil, errors.Errorf("model defaults for cloud %s not supported for this version of Juju", cloud)
}
return c.legacyModelDefaults()
}
results := params.ModelDefaultsResults{}
args := params.Entities{
Entities: []params.Entity{{Tag: names.NewCloudTag(cloud).String()}},
}
err := c.facade.FacadeCall("ModelDefaultsForClouds", args, &results)
if err != nil {
return nil, errors.Trace(err)
}
if len(results.Results) != 1 {
return nil, errors.Errorf("expected one result, got %d", len(results.Results))
}
result := results.Results[0]
if result.Error != nil {
return nil, errors.Trace(result.Error)
}
values := make(config.ModelDefaultAttributes)
for name, val := range result.Config {
setting := config.AttributeDefaultValues{
Default: val.Default,
Controller: val.Controller,
}
for _, region := range val.Regions {
setting.Regions = append(setting.Regions, config.RegionDefaultValue{
Name: region.RegionName,
Value: region.Value})
}
values[name] = setting
}
return values, nil
}
func (c *Client) legacyModelDefaults() (config.ModelDefaultAttributes, error) {
result := params.ModelDefaultsResult{}
err := c.facade.FacadeCall("ModelDefaults", nil, &result)
if err != nil {
return nil, errors.Trace(err)
}
values := make(config.ModelDefaultAttributes)
for name, val := range result.Config {
setting := config.AttributeDefaultValues{
Default: val.Default,
Controller: val.Controller,
}
for _, region := range val.Regions {
setting.Regions = append(setting.Regions, config.RegionDefaultValue{
Name: region.RegionName,
Value: region.Value})
}
values[name] = setting
}
return values, nil
}
// SetModelDefaults updates the specified default model config values.
func (c *Client) SetModelDefaults(cloud, region string, config map[string]interface{}) error {
var cloudTag string
if cloud != "" {
cloudTag = names.NewCloudTag(cloud).String()
}
args := params.SetModelDefaults{
Config: []params.ModelDefaultValues{{
Config: config,
CloudTag: cloudTag,
CloudRegion: region,
}},
}
var result params.ErrorResults
err := c.facade.FacadeCall("SetModelDefaults", args, &result)
if err != nil {
return err
}
return result.OneError()
}
// UnsetModelDefaults removes the specified default model config values.
func (c *Client) UnsetModelDefaults(cloud, region string, keys ...string) error {
var cloudTag string
if cloud != "" {
cloudTag = names.NewCloudTag(cloud).String()
}
args := params.UnsetModelDefaults{
Keys: []params.ModelUnsetKeys{{
Keys: keys,
CloudTag: cloudTag,
CloudRegion: region,
}},
}
var result params.ErrorResults
err := c.facade.FacadeCall("UnsetModelDefaults", args, &result)
if err != nil {
return err
}
return result.OneError()
}
// ChangeModelCredential replaces cloud credential for a given model with the provided one.
func (c *Client) ChangeModelCredential(model names.ModelTag, credential names.CloudCredentialTag) error {
if bestVer := c.BestAPIVersion(); bestVer < 5 {
return errors.NotImplementedf("ChangeModelCredential in version %v", bestVer)
}
var out params.ErrorResults
in := params.ChangeModelCredentialsParams{
Models: []params.ChangeModelCredentialParams{
{ModelTag: model.String(), CloudCredentialTag: credential.String()},
},
}
err := c.facade.FacadeCall("ChangeModelCredential", in, &out)
if err != nil {
return errors.Trace(err)
}
return out.OneError()
}
// ValidateModelUpgrade checks to see if it's possible to upgrade a model,
// before actually attempting to do the real model-upgrade.
func (c *Client) ValidateModelUpgrade(model names.ModelTag, force bool) error {
if bestVer := c.BestAPIVersion(); bestVer < 9 {
return errors.NotImplementedf("ValidateModelUpgrade in version %v", bestVer)
}
args := params.ValidateModelUpgradeParams{
Models: []params.ValidateModelUpgradeParam{{
ModelTag: model.String(),
}},
Force: force,
}
var results params.ErrorResults
if err := c.facade.FacadeCall("ValidateModelUpgrades", args, &results); err != nil {
return errors.Trace(err)
}
if num := len(results.Results); num != 1 {
return errors.Errorf("expected one result, got %d", num)
}
return results.OneError()
}