-
Notifications
You must be signed in to change notification settings - Fork 7
/
twinDeploymentHandler.ts
533 lines (495 loc) · 21.5 KB
/
twinDeploymentHandler.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
import { Contract, ExtrinsicResult } from "@threefold/tfchain_client";
import { RMB } from "../clients";
import { TFClient } from "../clients/tf-grid/client";
import { GridClientConfig } from "../config";
import { events } from "../helpers/events";
import { validateObject } from "../helpers/validator";
import { DeploymentFactory, Nodes } from "../primitives/index";
import { Workload, WorkloadTypes } from "../zos/workload";
import { Operations, TwinDeployment } from "./models";
class TwinDeploymentHandler {
tfclient: TFClient;
rmb: RMB;
deploymentFactory: DeploymentFactory;
original_deployments = [];
nodes: Nodes;
constructor(public config: GridClientConfig) {
this.tfclient = new TFClient(config.substrateURL, config.mnemonic, config.storeSecret, config.keypairType);
this.deploymentFactory = new DeploymentFactory(this.config);
this.rmb = new RMB(config.rmbClient);
this.nodes = new Nodes(this.config.graphqlURL, this.config.proxyURL, this.config.rmbClient);
}
async createNameContract(name: string) {
const id = await this.tfclient.contracts.getContractIdByName({ name });
if (id) {
const c = await this.tfclient.contracts.get({ id });
if (c && c.twinId !== this.config.twinId) {
throw Error(`Name contract with name ${name} is already reserved`);
}
}
try {
return await this.tfclient.contracts.createName({ name });
} catch (e) {
throw Error(`Failed to create name contract ${name} due to ${e}`);
}
}
async deleteNameContract(name: string) {
const c = await this.tfclient.contracts.getContractIdByName({ name });
if (!c) {
events.emit("logs", `Couldn't find a name contract with name ${name} to delete`);
} else {
events.emit("logs", `Deleting name contract with name: ${name} and id: ${c}`);
return await this.tfclient.contracts.cancel({ id: c });
}
}
async sendToNode(twinDeployment: TwinDeployment) {
try {
await twinDeployment.deployment.sign(this.config.twinId, this.config.mnemonic, this.tfclient.keypairType);
const payload = JSON.stringify(twinDeployment.deployment);
const node_twin_id = await this.nodes.getNodeTwinId(twinDeployment.nodeId);
await this.rmb.request([node_twin_id], `zos.deployment.${twinDeployment.operation}`, payload);
} catch (e) {
throw Error(`Failed to ${twinDeployment.operation} the deployment on node ${twinDeployment.nodeId} due to ${e}`);
}
}
async getDeployment(contract_id: number) {
const node_id = await this.nodes.getNodeIdFromContractId(contract_id, this.config.mnemonic);
const node_twin_id = await this.nodes.getNodeTwinId(node_id);
const payload = JSON.stringify({ contract_id: contract_id });
return await this.rmb.request([node_twin_id], "zos.deployment.get", payload);
}
checkWorkload(workload: Workload, targetWorkload: Workload, nodeId: number): boolean {
let state = false;
if (workload.result.state === "error") {
throw Error(
`Failed to deploy ${workload.type} with name ${workload.name} on node ${nodeId} due to: ${workload.result.message}`,
);
} else if (workload.result.state === "ok") {
state = true;
}
if (workload.version === targetWorkload.version) {
return state;
}
return false;
}
async waitForDeployment(twinDeployment: TwinDeployment, timeout = this.config.deploymentTimeoutMinutes) {
const contract_id = twinDeployment.deployment.contract_id;
const node_id = await this.nodes.getNodeIdFromContractId(contract_id, this.config.mnemonic);
const now = new Date().getTime();
while (new Date().getTime() < now + timeout * 1000 * 60) {
const deployment = await this.getDeployment(contract_id);
if (deployment.workloads.length !== twinDeployment.deployment.workloads.length) {
await new Promise(f => setTimeout(f, 2000));
continue;
}
let readyWorkloads = 0;
for (const workload of deployment.workloads) {
for (const w of twinDeployment.deployment.workloads) {
if (w.name === workload.name) {
if (this.checkWorkload(workload, w, node_id)) {
readyWorkloads += 1;
}
break;
}
}
}
if (readyWorkloads === twinDeployment.deployment.workloads.length) {
return;
}
await new Promise(f => setTimeout(f, 2000));
}
throw Error(`Deployment with contract_id: ${contract_id} failed to be ready after ${timeout} minutes`);
}
async waitForDeployments(twinDeployments: TwinDeployment[], timeout = this.config.deploymentTimeoutMinutes) {
const promises = twinDeployments.map(t => {
if ([Operations.deploy, Operations.update].includes(t.operation)) {
events.emit("logs", `Waiting for deployment with contract_id: ${t.deployment.contract_id} to be ready`);
return this.waitForDeployment(t, timeout);
}
});
return Promise.all(promises);
}
async saveNetworks(twinDeployments: TwinDeployment[]) {
for (const twinDeployment of twinDeployments) {
if (twinDeployment.network) {
if (twinDeployment.operation === Operations.delete) {
await twinDeployment.network.save();
continue;
}
// deploy or update operations
await twinDeployment.network.save(twinDeployment.deployment.contract_id, twinDeployment.nodeId);
}
}
}
deployMerge(twinDeployments: TwinDeployment[]): TwinDeployment[] {
const deploymentMap = {};
const deployments = [];
for (const twinDeployment of twinDeployments) {
if (twinDeployment.operation !== Operations.deploy) {
continue;
}
const network_workloads = twinDeployment.deployment.workloads.filter(
workload => workload.type === WorkloadTypes.network,
);
if (network_workloads.length > 0 || twinDeployment.publicIps > 0) {
deployments.push(twinDeployment);
continue;
}
if (Object.keys(deploymentMap).includes(twinDeployment.nodeId.toString())) {
deploymentMap[twinDeployment.nodeId].deployment.workloads = deploymentMap[
twinDeployment.nodeId
].deployment.workloads.concat(twinDeployment.deployment.workloads);
} else {
deploymentMap[twinDeployment.nodeId] = twinDeployment;
}
}
for (const key of Object.keys(deploymentMap)) {
deployments.push(deploymentMap[key]);
}
return deployments;
}
_updateToLatest(twinDeployments: TwinDeployment[]): TwinDeployment {
// all deployment pass should be with the same contract id to merge them to one deployment with all updates
if (twinDeployments.length === 0) {
return;
} else if (twinDeployments.length === 1) {
twinDeployments[0].deployment.version += 1;
return twinDeployments[0];
}
const workloadMap = {};
let publicIps = 0;
let network = null;
for (const twinDeployment of twinDeployments) {
for (const workload of twinDeployment.deployment.workloads) {
if (Object.keys(workloadMap).includes(workload.name)) {
workloadMap[workload.name].push(workload);
} else {
workloadMap[workload.name] = [workload];
}
}
publicIps += twinDeployment.publicIps;
if (!network && twinDeployment.network) {
network = twinDeployment.network;
}
}
const workloads = [];
for (const name of Object.keys(workloadMap)) {
let w = workloadMap[name][0];
if (workloadMap[name].length < twinDeployments.length && w.version <= twinDeployments[0].deployment.version) {
continue;
}
for (const workload of workloadMap[name]) {
if (w.version < workload.version) {
w = workload;
}
}
workloads.push(w);
}
const d = twinDeployments[0];
d.deployment.workloads = workloads;
d.publicIps = publicIps;
d.network = network;
d.deployment.version += 1;
return d;
}
async updateMerge(twinDeployments: TwinDeployment[]): Promise<TwinDeployment[]> {
const deploymentMap = {};
for (const twinDeployment of twinDeployments) {
if (twinDeployment.operation !== Operations.update) {
continue;
}
if (Object.keys(deploymentMap).includes(String(twinDeployment.deployment.contract_id))) {
deploymentMap[twinDeployment.deployment.contract_id].push(twinDeployment);
} else {
deploymentMap[twinDeployment.deployment.contract_id] = [twinDeployment];
}
const contract_id = twinDeployment.deployment.contract_id;
if (contract_id) {
const contract = await this.tfclient.contracts.get({ id: contract_id });
const node_id = contract["contractType"]["nodeContract"]["nodeId"];
deploymentMap[contract_id][0].nodeId = node_id;
}
}
const deployments = [];
for (const key of Object.keys(deploymentMap)) {
deployments.push(this._updateToLatest(deploymentMap[key]));
}
return deployments;
}
mergeDelete(twinDeployments: TwinDeployment[]): TwinDeployment[] {
const finalDeployments: TwinDeployment[] = [];
const contractsList: number[] = [];
for (const twinDeployment of twinDeployments) {
if (!contractsList.includes(twinDeployment.deployment.contract_id)) {
contractsList.push(twinDeployment.deployment.contract_id);
finalDeployments.push(twinDeployment);
}
}
return finalDeployments;
}
async merge(twinDeployments: TwinDeployment[]): Promise<TwinDeployment[]> {
let deployments = [];
deployments = deployments.concat(this.deployMerge(twinDeployments));
const deletedDeployments = twinDeployments.filter(d => d.operation === Operations.delete);
const deletedContracts = [];
for (const d of deletedDeployments) {
deletedContracts.push(d.deployment.contract_id);
}
const updatedDeployment = this.updateMerge(twinDeployments);
deployments = deployments.concat(
(await updatedDeployment).filter(d => !deletedContracts.includes(d.deployment.contract_id)),
);
deployments = deployments.concat(this.mergeDelete(deletedDeployments));
return deployments;
}
async checkNodesCapacity(twinDeployments: TwinDeployment[]) {
for (const twinDeployment of twinDeployments) {
let workloads: Workload[] = [];
if (twinDeployment.operation == Operations.deploy) {
workloads = twinDeployment.deployment.workloads;
}
if (twinDeployment.operation == Operations.update) {
const deployment_version = twinDeployment.deployment.version;
workloads = twinDeployment.deployment.workloads.filter(workload => workload.version == deployment_version);
}
let hru = 0;
let sru = 0;
let mru = 0;
const rootfsDisks: number[] = [];
const ssdDisks: number[] = [];
const hddDisks: number[] = [];
for (const workload of workloads) {
if (workload.type == WorkloadTypes.zmachine) {
rootfsDisks.push(workload.data["size"]);
sru += workload.data["size"];
}
if (workload.type == WorkloadTypes.zmount) {
ssdDisks.push(workload.data["size"]);
sru += workload.data["size"];
}
if (workload.type == WorkloadTypes.zdb) {
hddDisks.push(workload.data["size"]);
hru += workload.data["size"];
}
if (workload.type == WorkloadTypes.zmachine) {
mru += workload.data["compute_capacity"].memory;
}
}
if (
workloads.length !== 0 &&
!(await this.nodes.nodeHasResources(+twinDeployment.nodeId, {
hru: hru / 1024 ** 3,
sru: sru / 1024 ** 3,
mru: mru / 1024 ** 3,
}))
) {
throw Error(`Node ${twinDeployment.nodeId} doesn't have enough resources: sru=${sru}, mru=${mru}`);
}
if (workloads.length && (rootfsDisks.length || ssdDisks.length || hddDisks.length)) {
await this.nodes.verifyNodeStoragePoolCapacity(ssdDisks, hddDisks, rootfsDisks, +twinDeployment.nodeId);
}
}
}
async validate(twinDeployments: TwinDeployment[]) {
for (const twinDeployment of twinDeployments) {
await validateObject(twinDeployment.deployment);
}
}
async getDeploymentFromFactory(contract_id: number) {
const deployment = await this.getDeployment(contract_id);
return await this.deploymentFactory.fromObj(deployment);
}
async rollback(contracts) {
// cancel all created contracts and leave the updated ones.
events.emit("logs", "Rolling back deployments");
const extrinsics: ExtrinsicResult<number | Contract>[] = [];
for (const c of contracts.created) {
if (c.state !== "Deleted") {
events.emit("logs", `Deleting contract id ${c.contractId}`);
const extrinsic = await this.tfclient.contracts.cancel({ id: c.contractId });
extrinsics.push(extrinsic);
}
}
const deploymentsToUpdate: TwinDeployment[] = [];
for (const c of contracts.updated) {
const updated_contract_id = c.contractId;
const updated_deployement = await this.getDeploymentFromFactory(updated_contract_id);
const original_deployment = this.original_deployments.pop();
let update_deployment_res;
if (original_deployment)
update_deployment_res = await this.deploymentFactory.UpdateDeployment(updated_deployement, original_deployment);
if (update_deployment_res) {
update_deployment_res.version += 1;
update_deployment_res.sign(this.config.twinId, this.config.mnemonic, this.tfclient.keypairType);
const old_contract = await this.tfclient.contracts.get({ id: update_deployment_res.contract_id });
const extrinsic = await this.tfclient.contracts.updateNode({
id: update_deployment_res.contract_id,
hash: update_deployment_res.challenge_hash(),
data: old_contract.contractType.nodeContract.deploymentData,
});
extrinsics.push(extrinsic);
deploymentsToUpdate.push(
new TwinDeployment(
update_deployment_res,
Operations.update,
0,
old_contract.contractType.nodeContract.nodeId,
),
);
}
}
await this.tfclient.applyAllExtrinsics(extrinsics);
for (const d of deploymentsToUpdate) {
await this.sendToNode(d);
}
}
async PrepareExtrinsic(twinDeployment: TwinDeployment, contracts) {
const nodeExtrinsics: ExtrinsicResult<Contract>[] = [];
const nameExtrinsics: ExtrinsicResult<Contract>[] = [];
const deletedExtrinsics: ExtrinsicResult<number>[] = [];
if (twinDeployment.operation === Operations.deploy) {
events.emit("logs", `Deploying on node_id: ${twinDeployment.nodeId}`);
for (const workload of twinDeployment.deployment.workloads) {
// check if the deployment need name contract
if (workload.type === WorkloadTypes.gatewaynameproxy) {
events.emit("logs", `Check the name contract for the workload with name: ${workload.name}`);
const extrinsic = await this.createNameContract(workload.data["name"]);
nameExtrinsics.push(extrinsic);
}
}
const extrinsic = await this.tfclient.contracts.createNode({
hash: twinDeployment.deployment.challenge_hash(),
data: twinDeployment.deployment.metadata,
nodeId: twinDeployment.nodeId,
numberOfPublicIps: twinDeployment.publicIps,
solutionProviderId: twinDeployment.solutionProviderId,
});
nodeExtrinsics.push(extrinsic);
} else if (twinDeployment.operation === Operations.update) {
for (const workload of twinDeployment.deployment.workloads) {
// check if the deployment need name contract
if (workload.type === WorkloadTypes.gatewaynameproxy) {
events.emit("logs", `Check the name contract for the workload with name: ${workload.name}`);
const extrinsic = await this.createNameContract(workload.data["name"]);
nameExtrinsics.push(extrinsic);
}
}
const old_contract = await this.tfclient.contracts.get({ id: twinDeployment.deployment.contract_id });
const extrinsic = await this.tfclient.contracts.updateNode({
id: twinDeployment.deployment.contract_id,
data: old_contract.contractType.nodeContract.deploymentData,
hash: twinDeployment.deployment.challenge_hash(),
});
nodeExtrinsics.push(extrinsic);
contracts.updated.push(old_contract);
} else if (twinDeployment.operation === Operations.delete) {
events.emit("logs", `Deleting deployment with contract_id: ${twinDeployment.deployment.contract_id}`);
for (const workload of twinDeployment.deployment.workloads) {
// check if the deployment needs to delete a name contract
if (workload.type === WorkloadTypes.gatewaynameproxy) {
events.emit("logs", `Check the name contract for the workload with name: ${workload.name}`);
const extrinsic = await this.deleteNameContract(workload.data["name"]);
if (extrinsic) deletedExtrinsics.push(extrinsic);
}
}
const extrinsic = await this.tfclient.contracts.cancel({ id: twinDeployment.deployment.contract_id });
deletedExtrinsics.push(extrinsic);
}
return { nodeExtrinsics, nameExtrinsics, deletedExtrinsics };
}
async handle(twinDeployments: TwinDeployment[]) {
events.emit("logs", "Merging workloads");
twinDeployments = await this.merge(twinDeployments);
await this.validate(twinDeployments);
await this.checkNodesCapacity(twinDeployments);
const contracts = { created: [], updated: [], deleted: [] };
const resultContracts = { created: [], updated: [], deleted: [] };
let nodeExtrinsics: ExtrinsicResult<Contract>[] = [];
let nameExtrinsics: ExtrinsicResult<Contract>[] = [];
let deletedExtrinsics: ExtrinsicResult<number>[] = [];
//TODO: check if it can be done to save the deployment here instead of doing this in the module.
for (const twinDeployment of twinDeployments) {
for (const workload of twinDeployment.deployment.workloads) {
if (!twinDeployment.network) {
break;
}
if (workload.type === WorkloadTypes.network) {
events.emit("logs", `Updating network workload with name: ${workload.name}`);
workload["data"] = twinDeployment.network.updateNetwork(workload.data);
}
}
const extrinsics = await this.PrepareExtrinsic(twinDeployment, contracts);
nodeExtrinsics = nodeExtrinsics.concat(extrinsics.nodeExtrinsics);
nameExtrinsics = nameExtrinsics.concat(extrinsics.nameExtrinsics);
deletedExtrinsics = deletedExtrinsics.concat(extrinsics.deletedExtrinsics);
}
const extrinsicResults: Contract[] = await this.tfclient.applyAllExtrinsics<Contract>([
...nodeExtrinsics,
...nameExtrinsics,
]);
for (const contract of extrinsicResults) {
const updatedContract = contracts.updated.filter(c => c["contractId"] === contract.contractId);
if (updatedContract.length === 0) contracts.created.push(contract);
}
try {
for (const twinDeployment of twinDeployments) {
if (twinDeployment.operation === Operations.deploy) {
events.emit("logs", `Sending deployment to node_id: ${twinDeployment.nodeId}`);
for (const contract of extrinsicResults) {
if (twinDeployment.deployment.challenge_hash() === contract.contractType.nodeContract.deploymentHash) {
twinDeployment.deployment.contract_id = contract.contractId;
if (
!(
twinDeployment.deployment.workloads.length === 1 &&
twinDeployment.deployment.workloads[0].type === WorkloadTypes.network
)
)
resultContracts.created.push(contract);
break;
}
}
await this.sendToNode(twinDeployment);
events.emit(
"logs",
`A deployment has been created on node_id: ${twinDeployment.nodeId} with contract_id: ${twinDeployment.deployment.contract_id}`,
);
} else if (twinDeployment.operation === Operations.update) {
const old_contract_id = twinDeployment.deployment.contract_id;
if (old_contract_id) {
this.original_deployments.push(await this.getDeploymentFromFactory(old_contract_id));
}
events.emit("logs", `Updating deployment with contract_id: ${twinDeployment.deployment.contract_id}`);
for (const contract of extrinsicResults) {
if (twinDeployment.deployment.challenge_hash() === contract.contractType.nodeContract.deploymentHash) {
twinDeployment.nodeId = contract.contractType.nodeContract.nodeId;
if (
!(
twinDeployment.deployment.workloads.length === 1 &&
twinDeployment.deployment.workloads[0].type === WorkloadTypes.network
)
)
resultContracts.updated.push(contract);
break;
}
}
await this.sendToNode(twinDeployment);
events.emit("logs", `Deployment has been updated with contract_id: ${twinDeployment.deployment.contract_id}`);
}
}
const deletedResult = await this.tfclient.applyAllExtrinsics<number>(deletedExtrinsics);
if (deletedExtrinsics.length > 0) {
for (const id of deletedResult) {
resultContracts.deleted.push({ contractId: id });
events.emit("logs", `Deployment has been deleted with contract_id: ${id}`);
}
}
await this.waitForDeployments(twinDeployments);
await this.saveNetworks(twinDeployments);
} catch (e) {
await this.rollback(contracts);
throw Error(e);
}
return resultContracts;
}
}
export { TwinDeploymentHandler };