-
Notifications
You must be signed in to change notification settings - Fork 7
/
ModelManagerV2.ts
548 lines (473 loc) · 12.2 KB
/
ModelManagerV2.ts
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
/**
Juju ModelManager version 2.
This facade is available on:
Controller-machine-agent
Machine-agent
Unit-agent
Controllers
NOTE: This file was generated using the Juju schema
from Juju 2.9-rc3 at the git SHA cb361902f8.
Do not manually edit this file.
*/
import type { JujuRequest } from "../../../generator/interfaces.js";
import { ConnectionInfo, Transport } from "../../client.js";
import { Facade } from "../../types.js";
import { autoBind } from "../../utils.js";
export interface Entities {
entities: Entity[];
}
export interface Entity {
tag: string;
}
export interface EntityStatus {
data?: AdditionalProperties;
info: string;
since: string;
status: string;
}
export interface Error {
code: string;
info?: AdditionalProperties;
message: string;
}
export interface ErrorResult {
error?: Error;
}
export interface ErrorResults {
results: ErrorResult[];
}
export interface MachineHardware {
arch?: string;
"availability-zone"?: string;
cores?: number;
"cpu-power"?: number;
mem?: number;
"root-disk"?: number;
tags?: string[];
}
export interface MapResult {
error?: Error;
result: AdditionalProperties;
}
export interface MapResults {
results: MapResult[];
}
export interface Model {
name: string;
"owner-tag": string;
type: string;
uuid: string;
}
export interface ModelCreateArgs {
"cloud-tag"?: string;
config?: AdditionalProperties;
credential?: string;
name: string;
"owner-tag": string;
region?: string;
}
export interface ModelDefaultValues {
"cloud-region"?: string;
"cloud-tag"?: string;
config: AdditionalProperties;
}
export interface ModelDefaults {
controller?: AdditionalProperties;
default?: AdditionalProperties;
regions?: RegionDefaults[];
}
export interface ModelDefaultsResult {
config: Record<string, ModelDefaults>;
error?: Error;
}
export interface ModelEntityCount {
count: number;
entity: string;
}
export interface ModelFilesystemInfo {
detachable?: boolean;
id: string;
message?: string;
"provider-id"?: string;
status?: string;
}
export interface ModelInfo {
"agent-version": string;
"cloud-credential-tag"?: string;
"cloud-credential-validity"?: boolean;
"cloud-region"?: string;
"cloud-tag": string;
"controller-uuid": string;
"default-series"?: string;
"is-controller": boolean;
life: string;
machines: ModelMachineInfo[];
migration?: ModelMigrationStatus;
name: string;
"owner-tag": string;
"provider-type"?: string;
sla: ModelSLAInfo;
status?: EntityStatus;
type: string;
users: ModelUserInfo[];
uuid: string;
}
export interface ModelInfoResult {
error?: Error;
result?: ModelInfo;
}
export interface ModelInfoResults {
results: ModelInfoResult[];
}
export interface ModelMachineInfo {
"display-name"?: string;
"ha-primary"?: boolean;
hardware?: MachineHardware;
"has-vote"?: boolean;
id: string;
"instance-id"?: string;
message?: string;
status?: string;
"wants-vote"?: boolean;
}
export interface ModelMigrationStatus {
end?: string;
start: string;
status: string;
}
export interface ModelSLAInfo {
level: string;
owner: string;
}
export interface ModelStatus {
"application-count": number;
error?: Error;
filesystems?: ModelFilesystemInfo[];
"hosted-machine-count": number;
life: string;
machines?: ModelMachineInfo[];
"model-tag": string;
"owner-tag": string;
type: string;
"unit-count": number;
volumes?: ModelVolumeInfo[];
}
export interface ModelStatusResults {
models: ModelStatus[];
}
export interface ModelSummariesRequest {
all?: boolean;
"user-tag": string;
}
export interface ModelSummary {
"agent-version": string;
"cloud-credential-tag"?: string;
"cloud-region"?: string;
"cloud-tag": string;
"controller-uuid": string;
counts: ModelEntityCount[];
"default-series"?: string;
"is-controller": boolean;
"last-connection": string;
life: string;
migration?: ModelMigrationStatus;
name: string;
"owner-tag": string;
"provider-type"?: string;
sla: ModelSLAInfo;
status?: EntityStatus;
type: string;
"user-access": string;
uuid: string;
}
export interface ModelSummaryResult {
error?: Error;
result?: ModelSummary;
}
export interface ModelSummaryResults {
results: ModelSummaryResult[];
}
export interface ModelUnsetKeys {
"cloud-region"?: string;
"cloud-tag"?: string;
keys: string[];
}
export interface ModelUserInfo {
access: string;
"display-name": string;
"last-connection": string;
user: string;
}
export interface ModelVolumeInfo {
detachable?: boolean;
id: string;
message?: string;
"provider-id"?: string;
status?: string;
}
export interface ModifyModelAccess {
access: string;
action: string;
"model-tag": string;
"user-tag": string;
}
export interface ModifyModelAccessRequest {
changes: ModifyModelAccess[];
}
export interface Number {
Build: number;
Major: number;
Minor: number;
Patch: number;
Tag: string;
}
export interface RegionDefaults {
"region-name": string;
value: AdditionalProperties;
}
export interface SetModelDefaults {
config: ModelDefaultValues[];
}
export interface UnsetModelDefaults {
keys: ModelUnsetKeys[];
}
export interface UserModel {
"last-connection": string;
model: Model;
}
export interface UserModelList {
"user-models": UserModel[];
}
export interface ValidateModelUpgradeParam {
"model-tag": string;
}
export interface ValidateModelUpgradeParams {
force: boolean;
model: ValidateModelUpgradeParam[];
}
export interface AdditionalProperties {
[key: string]: any;
}
/**
ModelManagerAPIV2 provides a way to wrap the different calls between
version 2 and version 3 of the model manager API
*/
class ModelManagerV2 implements Facade {
static NAME = "ModelManager";
static VERSION = 2;
NAME = "ModelManager";
VERSION = 2;
_transport: Transport;
_info: ConnectionInfo;
constructor(transport: Transport, info: ConnectionInfo) {
this._transport = transport;
this._info = info;
// Automatically bind all methods to instances.
autoBind(this);
}
/**
CreateModel creates a new model using the account and
model config specified in the args.
*/
createModel(params: ModelCreateArgs): Promise<ModelInfo> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "CreateModel",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
DestroyModels will try to destroy the specified models.
If there is a block on destruction, this method will return an error.
*/
destroyModels(params: Entities): Promise<ErrorResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "DestroyModels",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
DumpModels will export the models into the database agnostic
representation. The user needs to either be a controller admin, or have
admin privileges on the model itself.
*/
dumpModels(params: Entities): Promise<MapResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "DumpModels",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
DumpModelsDB will gather all documents from all model collections
for the specified model. The map result contains a map of collection
names to lists of documents represented as maps.
*/
dumpModelsDB(params: Entities): Promise<MapResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "DumpModelsDB",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
ListModelSummaries returns models that the specified user
has access to in the current server. Controller admins (superuser)
can list models for any user. Other users
can only ask about their own models.
*/
listModelSummaries(
params: ModelSummariesRequest
): Promise<ModelSummaryResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "ListModelSummaries",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
ListModels returns the models that the specified user
has access to in the current server. Controller admins (superuser)
can list models for any user. Other users
can only ask about their own models.
*/
listModels(params: Entity): Promise<UserModelList> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "ListModels",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
ModelDefaults returns the default config values used when creating a new model.
*/
modelDefaults(params: any): Promise<ModelDefaultsResult> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "ModelDefaults",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
ModelInfo returns information about the specified models.
*/
modelInfo(params: Entities): Promise<ModelInfoResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "ModelInfo",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
ModelStatus is a legacy method call to ensure that we preserve
backward compatibility.
TODO (anastasiamac 2017-10-26) This should be made obsolete/removed.
*/
modelStatus(params: Entities): Promise<ModelStatusResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "ModelStatus",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
ModifyModelAccess changes the model access granted to users.
*/
modifyModelAccess(params: ModifyModelAccessRequest): Promise<ErrorResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "ModifyModelAccess",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
SetModelDefaults writes new values for the specified default model settings.
*/
setModelDefaults(params: SetModelDefaults): Promise<ErrorResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "SetModelDefaults",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
UnsetModelDefaults removes the specified default model settings.
*/
unsetModelDefaults(params: UnsetModelDefaults): Promise<ErrorResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "UnsetModelDefaults",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
/**
ValidateModelUpgrades validates if a model is allowed to perform an upgrade.
Examples of why you would want to block a model upgrade, would be situations
like upgrade-series. If performing an upgrade-series we don't know the
current status of the machine, so performing an upgrade-model can lead to
bad unintended errors down the line.
*/
validateModelUpgrades(
params: ValidateModelUpgradeParams
): Promise<ErrorResults> {
return new Promise((resolve, reject) => {
const req: JujuRequest = {
type: "ModelManager",
request: "ValidateModelUpgrades",
version: 2,
params: params,
};
this._transport.write(req, resolve, reject);
});
}
}
export default ModelManagerV2;