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
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* Copyright (C) 2017 Huawei Technologies Co., Ltd. All rights reserved.
* ================================================================================
* Modifications Copyright (c) 2019 Samsung
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.so.openstack.utils;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.woorea.openstack.base.client.OpenStackConnectException;
import com.woorea.openstack.base.client.OpenStackRequest;
import com.woorea.openstack.base.client.OpenStackResponseException;
import com.woorea.openstack.heat.Heat;
import com.woorea.openstack.heat.model.CreateStackParam;
import com.woorea.openstack.heat.model.Resources;
import com.woorea.openstack.heat.model.Stack;
import com.woorea.openstack.heat.model.Stack.Output;
import com.woorea.openstack.heat.model.Stacks;
import com.woorea.openstack.keystone.Keystone;
import com.woorea.openstack.keystone.model.Access;
import com.woorea.openstack.keystone.model.Authentication;
import com.woorea.openstack.keystone.utils.KeystoneUtils;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.onap.so.adapters.vdu.CloudInfo;
import org.onap.so.adapters.vdu.PluginAction;
import org.onap.so.adapters.vdu.VduArtifact;
import org.onap.so.adapters.vdu.VduArtifact.ArtifactType;
import org.onap.so.adapters.vdu.VduException;
import org.onap.so.adapters.vdu.VduInstance;
import org.onap.so.adapters.vdu.VduModelInfo;
import org.onap.so.adapters.vdu.VduPlugin;
import org.onap.so.adapters.vdu.VduStateType;
import org.onap.so.adapters.vdu.VduStatus;
import org.onap.so.cloud.CloudConfig;
import org.onap.so.cloud.authentication.AuthenticationMethodFactory;
import org.onap.so.cloud.authentication.KeystoneAuthHolder;
import org.onap.so.cloud.authentication.KeystoneV3Authentication;
import org.onap.so.cloud.authentication.ServiceEndpointNotFoundException;
import org.onap.so.db.catalog.beans.CloudIdentity;
import org.onap.so.db.catalog.beans.CloudSite;
import org.onap.so.db.catalog.beans.HeatTemplate;
import org.onap.so.db.catalog.beans.HeatTemplateParam;
import org.onap.so.db.catalog.beans.ServerType;
import org.onap.so.logger.ErrorCode;
import org.onap.so.logger.MessageEnum;
import org.onap.so.openstack.beans.HeatStatus;
import org.onap.so.openstack.beans.StackInfo;
import org.onap.so.openstack.exceptions.MsoAdapterException;
import org.onap.so.openstack.exceptions.MsoCloudSiteNotFound;
import org.onap.so.openstack.exceptions.MsoException;
import org.onap.so.openstack.exceptions.MsoIOException;
import org.onap.so.openstack.exceptions.MsoOpenstackException;
import org.onap.so.openstack.exceptions.MsoStackAlreadyExists;
import org.onap.so.openstack.exceptions.MsoTenantNotFound;
import org.onap.so.openstack.mappers.StackInfoMapper;
import org.onap.so.utils.CryptoUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Primary;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
@Primary
@Component
public class MsoHeatUtils extends MsoCommonUtils implements VduPlugin{
private static final String TOKEN_AUTH = "TokenAuth";
private static final String QUERY_ALL_STACKS = "QueryAllStacks";
private static final String DELETE_STACK = "DeleteStack";
protected static final String HEAT_ERROR = "HeatError";
protected static final String CREATE_STACK = "CreateStack";
// Fetch cloud configuration each time (may be cached in CloudConfig class)
@Autowired
protected CloudConfig cloudConfig;
@Autowired
private Environment environment;
@Autowired
private AuthenticationMethodFactory authenticationMethodFactory;
@Autowired
private MsoTenantUtilsFactory tenantUtilsFactory;
@Autowired
private KeystoneV3Authentication keystoneV3Authentication;
private static final Logger logger = LoggerFactory.getLogger(MsoHeatUtils.class);
// Properties names and variables (with default values)
protected String createPollIntervalProp = "org.onap.so.adapters.po.pollInterval";
private String deletePollIntervalProp = "org.onap.so.adapters.po.pollInterval";
private String deletePollTimeoutProp = "org.onap.so.adapters.po.pollTimeout";
protected static final String createPollIntervalDefault = "15";
private static final String deletePollIntervalDefault = "15";
private static final ObjectMapper JSON_MAPPER = new ObjectMapper();
/**
* keep this old method signature here to maintain backwards compatibility. keep others as well.
* this method does not include environment, files, or heatFiles
*/
public StackInfo createStack (String cloudSiteId,
String cloudOwner,
String tenantId,
String stackName,
String heatTemplate,
Map <String, ?> stackInputs,
boolean pollForCompletion,
int timeoutMinutes) throws MsoException {
// Just call the new method with the environment & files variable set to null
return this.createStack (cloudSiteId,
cloudOwner,
tenantId,
stackName,
null,
heatTemplate,
stackInputs,
pollForCompletion,
timeoutMinutes,
null,
null,
null,
true);
}
// This method has environment, but not files or heatFiles
public StackInfo createStack (String cloudSiteId,
String cloudOwner,
String tenantId,
String stackName,
String heatTemplate,
Map <String, ?> stackInputs,
boolean pollForCompletion,
int timeoutMinutes,
String environment) throws MsoException {
// Just call the new method with the files/heatFiles variables set to null
return this.createStack (cloudSiteId,
cloudOwner,
tenantId,
stackName,
null,
heatTemplate,
stackInputs,
pollForCompletion,
timeoutMinutes,
environment,
null,
null,
true);
}
// This method has environment and files, but not heatFiles.
public StackInfo createStack (String cloudSiteId,
String cloudOwner,
String tenantId,
String stackName,
String heatTemplate,
Map <String, ?> stackInputs,
boolean pollForCompletion,
int timeoutMinutes,
String environment,
Map <String, Object> files) throws MsoException {
return this.createStack (cloudSiteId,
cloudOwner,
tenantId,
stackName,
null,
heatTemplate,
stackInputs,
pollForCompletion,
timeoutMinutes,
environment,
files,
null,
true);
}
// This method has environment, files, heatfiles
public StackInfo createStack (String cloudSiteId,
String cloudOwner,
String tenantId,
String stackName,
String heatTemplate,
Map <String, ?> stackInputs,
boolean pollForCompletion,
int timeoutMinutes,
String environment,
Map <String, Object> files,
Map <String, Object> heatFiles) throws MsoException {
return this.createStack (cloudSiteId,
cloudOwner,
tenantId,
stackName,
null,
heatTemplate,
stackInputs,
pollForCompletion,
timeoutMinutes,
environment,
files,
heatFiles,
true);
}
/**
* Create a new Stack in the specified cloud location and tenant. The Heat template
* and parameter map are passed in as arguments, along with the cloud access credentials.
* It is expected that parameters have been validated and contain at minimum the required
* parameters for the given template with no extra (undefined) parameters..
*
* The Stack name supplied by the caller must be unique in the scope of this tenant.
* However, it should also be globally unique, as it will be the identifier for the
* resource going forward in Inventory. This latter is managed by the higher levels
* invoking this function.
*
* The caller may choose to let this function poll Openstack for completion of the
* stack creation, or may handle polling itself via separate calls to query the status.
* In either case, a StackInfo object will be returned containing the current status.
* When polling is enabled, a status of CREATED is expected. When not polling, a
* status of BUILDING is expected.
*
* An error will be thrown if the requested Stack already exists in the specified
* Tenant and Cloud.
*
* For 1510 - add "environment", "files" (nested templates), and "heatFiles" (get_files) as
* parameters for createStack. If environment is non-null, it will be added to the stack.
* The nested templates and get_file entries both end up being added to the "files" on the
* stack. We must combine them before we add them to the stack if they're both non-null.
*
* @param cloudSiteId The cloud (may be a region) in which to create the stack.
* @param cloudOwner the cloud owner of the cloud site in which to create the stack
* @param tenantId The Openstack ID of the tenant in which to create the Stack
* @param stackName The name of the stack to create
* @param vduModelInfo contains information about the vdu model (added for plugin adapter)
* @param heatTemplate The Heat template
* @param stackInputs A map of key/value inputs
* @param pollForCompletion Indicator that polling should be handled in Java vs. in the client
* @param environment An optional yaml-format string to specify environmental parameters
* @param files a Map<String, Object> that lists the child template IDs (file is the string, object is an int of
* Template id)
* @param heatFiles a Map<String, Object> that lists the get_file entries (fileName, fileBody)
* @param backout Donot delete stack on create Failure - defaulted to True
* @return A StackInfo object
* @throws MsoOpenstackException Thrown if the Openstack API call returns an exception.
*/
@SuppressWarnings("unchecked")
public StackInfo createStack (String cloudSiteId,
String cloudOwner,
String tenantId,
String stackName,
VduModelInfo vduModel,
String heatTemplate,
Map <String, ?> stackInputs,
boolean pollForCompletion,
int timeoutMinutes,
String environment,
Map <String, Object> files,
Map <String, Object> heatFiles,
boolean backout) throws MsoException {
// Take out the multicloud inputs, if present.
for (String key : MsoMulticloudUtils.MULTICLOUD_INPUTS) {
if (stackInputs.containsKey(key)) {
stackInputs.remove(key);
if (stackInputs.isEmpty()) {
break;
}
}
}
CreateStackParam stack = createStackParam(stackName, heatTemplate, stackInputs, timeoutMinutes, environment, files, heatFiles);
// Obtain the cloud site information where we will create the stack
CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId).orElseThrow(
() -> new MsoCloudSiteNotFound(cloudSiteId));
logger.debug("Found: {}", cloudSite);
// Get a Heat client. They are cached between calls (keyed by tenantId:cloudId)
// This could throw MsoTenantNotFound or MsoOpenstackException (both propagated)
Heat heatClient = getHeatClient (cloudSite, tenantId);
logger.debug("Found: {}", heatClient);
logger.debug ("Ready to Create Stack ({}) with input params: {}", heatTemplate, stackInputs);
Stack heatStack = null;
try {
OpenStackRequest <Stack> request = heatClient.getStacks ().create (stack);
CloudIdentity cloudIdentity = cloudSite.getIdentityService();
request.header ("X-Auth-User", cloudIdentity.getMsoId ());
request.header ("X-Auth-Key", CryptoUtils.decryptCloudConfigPassword(cloudIdentity.getMsoPass ()));
heatStack = executeAndRecordOpenstackRequest (request);
} catch (OpenStackResponseException e) {
if (e.getStatus () == 409) {
MsoStackAlreadyExists me = new MsoStackAlreadyExists (stackName, tenantId, cloudSiteId);
me.addContext (CREATE_STACK);
throw me;
} else {
logger.debug("ERROR STATUS = {},\n{}\n{}", e.getStatus(), e.getMessage(), e.getLocalizedMessage());
throw heatExceptionToMsoException (e, CREATE_STACK);
}
} catch (OpenStackConnectException e) {
throw heatExceptionToMsoException (e, CREATE_STACK);
} catch (RuntimeException e) {
throw runtimeExceptionToMsoException (e, CREATE_STACK);
}
// Subsequent access by the canonical name "<stack name>/<stack-id>".
// Otherwise, simple query by name returns a 302 redirect.
// NOTE: This is specific to the v1 Orchestration API.
String canonicalName = stackName + "/" + heatStack.getId ();
if (pollForCompletion) {
heatStack = pollStackForCompletion(cloudSiteId, tenantId, stackName, timeoutMinutes, backout, heatClient,
heatStack, canonicalName);
} else {
// Get initial status, since it will have been null after the create.
heatStack = queryHeatStack (heatClient, canonicalName);
logger.debug (heatStack.getStackStatus ());
}
return new StackInfoMapper(heatStack).map();
}
private Stack pollStackForCompletion(String cloudSiteId, String tenantId, String stackName, int timeoutMinutes,
boolean backout, Heat heatClient, Stack heatStack, String canonicalName)
throws MsoException, MsoOpenstackException {
int createPollInterval = Integer.parseInt(this.environment.getProperty(createPollIntervalProp, createPollIntervalDefault));
int pollTimeout = (timeoutMinutes * 60) + createPollInterval;
int deletePollInterval = createPollInterval;
int deletePollTimeout = pollTimeout;
boolean createTimedOut = false;
StringBuilder stackErrorStatusReason = new StringBuilder("");
logger.debug("createPollInterval={}, pollTimeout={}", createPollInterval, pollTimeout);
while (true) {
try {
heatStack = queryHeatStack (heatClient, canonicalName);
logger.debug("{} ({})", heatStack.getStackStatus(), canonicalName);
try {
logger.debug("Current stack {}", this.getOutputsAsStringBuilder(heatStack).toString());
} catch (Exception e) {
logger.debug("an error occurred trying to print out the current outputs of the stack", e);
}
if ("CREATE_IN_PROGRESS".equals (heatStack.getStackStatus ())) {
if (pollTimeout <= 0) {
logger.error("{} Cloud site: {} Tenant: {} Stack: {} Stack status: {} {} Create stack timeout",
MessageEnum.RA_CREATE_STACK_TIMEOUT, cloudSiteId, tenantId, stackName,
heatStack.getStackStatus(), ErrorCode.AvailabilityError.getValue());
createTimedOut = true;
break;
}
sleep(createPollInterval * 1000L);
pollTimeout -= createPollInterval;
logger.debug("pollTimeout remaining: {}", pollTimeout);
} else {
stackErrorStatusReason.append("Stack error (" + heatStack.getStackStatus() + "): " + heatStack.getStackStatusReason());
break;
}
} catch (MsoException me) {
// Cannot query the stack status. Something is wrong.
// Try to roll back the stack
if (!backout)
{
logger.warn("{} Exception in Create Stack, stack deletion suppressed {}",
MessageEnum.RA_CREATE_STACK_ERR, ErrorCode.BusinessProcesssError.getValue());
}
else
{
try {
logger.debug(
"Create Stack error - unable to query for stack status - attempting to delete stack: {}"
+ " - This will likely fail and/or we won't be able to query to see if delete worked",
canonicalName);
OpenStackRequest <Void> request = heatClient.getStacks ().deleteByName (canonicalName);
executeAndRecordOpenstackRequest (request);
boolean deleted = false;
while (!deleted) {
try {
heatStack = queryHeatStack(heatClient, canonicalName);
if (heatStack != null) {
logger.debug(heatStack.getStackStatus());
if ("DELETE_IN_PROGRESS".equals(heatStack.getStackStatus())) {
if (deletePollTimeout <= 0) {
logger.error(
"{} Cloud site: {} Tenant: {} Stack: {} Stack status: {} {} Rollback: DELETE stack timeout",
MessageEnum.RA_CREATE_STACK_TIMEOUT, cloudSiteId, tenantId, stackName,
heatStack.getStackStatus(), ErrorCode.AvailabilityError.getValue());
break;
} else {
sleep(deletePollInterval * 1000L);
deletePollTimeout -= deletePollInterval;
}
} else if ("DELETE_COMPLETE".equals(heatStack.getStackStatus())){
logger.debug("DELETE_COMPLETE for {}", canonicalName);
deleted = true;
continue;
} else {
//got a status other than DELETE_IN_PROGRESS or DELETE_COMPLETE - so break and evaluate
break;
}
} else {
// assume if we can't find it - it's deleted
logger.debug("heatStack returned null - assume the stack {} has been deleted", canonicalName);
deleted = true;
continue;
}
} catch (Exception e3) {
// Just log this one. We will report the original exception.
logger.error("{} Create Stack: Nested exception rolling back stack: {} ",
MessageEnum.RA_CREATE_STACK_ERR, ErrorCode.BusinessProcesssError.getValue(), e3);
}
}
} catch (Exception e2) {
// Just log this one. We will report the original exception.
logger.error("{} Create Stack: Nested exception rolling back stack: {} ",
MessageEnum.RA_CREATE_STACK_ERR, ErrorCode.BusinessProcesssError.getValue(), e2);
}
}
// Propagate the original exception from Stack Query.
me.addContext (CREATE_STACK);
throw me;
}
}
if (!"CREATE_COMPLETE".equals (heatStack.getStackStatus ())) {
logger.error("{} Create Stack error: Polling complete with non-success status: {}, {} {} ",
MessageEnum.RA_CREATE_STACK_ERR, heatStack.getStackStatus(), heatStack.getStackStatusReason(),
ErrorCode.BusinessProcesssError.getValue());
// Rollback the stack creation, since it is in an indeterminate state.
if (!backout)
{
logger.warn(
"{} Create Stack errored, stack deletion suppressed {} Create Stack error, stack deletion suppressed",
MessageEnum.RA_CREATE_STACK_ERR, ErrorCode.BusinessProcesssError.getValue());
}
else
{
try {
logger.debug("Create Stack errored - attempting to DELETE stack: {}", canonicalName);
logger.debug("deletePollInterval={}, deletePollTimeout={}", deletePollInterval, deletePollTimeout);
OpenStackRequest <Void> request = heatClient.getStacks ().deleteByName (canonicalName);
executeAndRecordOpenstackRequest (request);
boolean deleted = false;
while (!deleted) {
try {
heatStack = queryHeatStack(heatClient, canonicalName);
if (heatStack != null) {
logger.debug("{} ({})", heatStack.getStackStatus(), canonicalName);
if ("DELETE_IN_PROGRESS".equals(heatStack.getStackStatus())) {
if (deletePollTimeout <= 0) {
logger.error(
"{} Cloud site: {} Tenant: {} Stack: {} Stack status: {} {} Rollback: DELETE stack timeout",
MessageEnum.RA_CREATE_STACK_TIMEOUT, cloudSiteId, tenantId, stackName,
heatStack.getStackStatus(), ErrorCode.AvailabilityError.getValue());
break;
} else {
sleep(deletePollInterval * 1000L);
deletePollTimeout -= deletePollInterval;
logger.debug("deletePollTimeout remaining: {}", deletePollTimeout);
}
} else if ("DELETE_COMPLETE".equals(heatStack.getStackStatus())){
logger.debug("DELETE_COMPLETE for {}", canonicalName);
deleted = true;
continue;
} else if ("DELETE_FAILED".equals(heatStack.getStackStatus())) {
// Warn about this (?) - but still throw the original exception
logger.warn(
"{} Create Stack errored, stack deletion FAILED {} Create Stack error, stack deletion FAILED",
MessageEnum.RA_CREATE_STACK_ERR, ErrorCode.BusinessProcesssError.getValue());
logger.debug("Stack deletion FAILED on a rollback of a create - {}, status={}, reason={}",
canonicalName, heatStack.getStackStatus(), heatStack.getStackStatusReason());
break;
} else {
//got a status other than DELETE_IN_PROGRESS or DELETE_COMPLETE - so break and evaluate
break;
}
} else {
// assume if we can't find it - it's deleted
logger.debug("heatStack returned null - assume the stack {} has been deleted", canonicalName);
deleted = true;
continue;
}
} catch (MsoException me2) {
// We got an exception on the delete - don't throw this exception - throw the original - just log.
logger.debug("Exception thrown trying to delete {} on a create->rollback: {} ", canonicalName,
me2.getContextMessage(), me2);
logger.warn("{} Create Stack errored, then stack deletion FAILED - exception thrown {} {}",
MessageEnum.RA_CREATE_STACK_ERR, ErrorCode.BusinessProcesssError.getValue(),
me2.getContextMessage());
}
} // end while !deleted
StringBuilder errorContextMessage;
if (createTimedOut) {
errorContextMessage = new StringBuilder("Stack Creation Timeout");
} else {
errorContextMessage = stackErrorStatusReason;
}
if (deleted) {
errorContextMessage.append(" - stack successfully deleted");
} else {
errorContextMessage.append(" - encountered an error trying to delete the stack");
}
} catch (Exception e2) {
// shouldn't happen - but handle
logger.error("{} Create Stack: Nested exception rolling back stack: {} ", MessageEnum.RA_CREATE_STACK_ERR,
ErrorCode.BusinessProcesssError.getValue(), e2);
}
}
MsoOpenstackException me = new MsoOpenstackException(0, "", stackErrorStatusReason.toString());
me.addContext(CREATE_STACK);
throw me;
}
return heatStack;
}
/**
* Query for a single stack (by Name) in a tenant. This call will always return a
* StackInfo object. If the stack does not exist, an "empty" StackInfo will be
* returned - containing only the stack name and a status of NOTFOUND.
*
* @param tenantId The Openstack ID of the tenant in which to query
* @param cloudSiteId The cloud identifier (may be a region) in which to query
* @param cloudOwner the cloud owner of the cloud site in which to query
* @param stackName The name of the stack to query (may be simple or canonical)
* @return A StackInfo object
* @throws MsoOpenstackException Thrown if the Openstack API call returns an exception.
*/
public StackInfo queryStack (String cloudSiteId, String cloudOwner, String tenantId, String stackName) throws MsoException {
logger.debug ("Query HEAT stack: {} in tenant {}", stackName, tenantId);
// Obtain the cloud site information where we will create the stack
CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId).orElseThrow(
() -> new MsoCloudSiteNotFound(cloudSiteId));
logger.debug("Found: {}", cloudSite.toString());
// Get a Heat client. They are cached between calls (keyed by tenantId:cloudId)
Heat heatClient = null;
try {
heatClient = getHeatClient (cloudSite, tenantId);
if (heatClient != null) {
logger.debug("Found: {}", heatClient.toString());
}
} catch (MsoTenantNotFound e) {
// Tenant doesn't exist, so stack doesn't either
logger.debug ("Tenant with id " + tenantId + "not found.", e);
return new StackInfo (stackName, HeatStatus.NOTFOUND);
} catch (MsoException me) {
// Got an Openstack error. Propagate it
logger.error("{} {} Openstack Exception on Token request: ", MessageEnum.RA_CONNECTION_EXCEPTION,
ErrorCode.AvailabilityError.getValue(), me);
me.addContext ("QueryStack");
throw me;
}
// Query the Stack.
// An MsoException will propagate transparently to the caller.
Stack heatStack = queryHeatStack (heatClient, stackName);
if (heatStack == null) {
// Stack does not exist. Return a StackInfo with status NOTFOUND
return new StackInfo (stackName, HeatStatus.NOTFOUND);
}
return new StackInfoMapper(heatStack).map();
}
/**
* Delete a stack (by Name/ID) in a tenant. If the stack is not found, it will be
* considered a successful deletion. The return value is a StackInfo object which
* contains the current stack status.
*
* The client may choose to let the adapter poll Openstack for completion of the
* stack deletion, or may handle polling itself via separate query calls. In either
* case, a StackInfo object will be returned. When polling is enabled, a final
* status of NOTFOUND is expected. When not polling, a status of DELETING is expected.
*
* There is no rollback from a successful stack deletion. A deletion failure will
* also result in an undefined stack state - the components may or may not have been
* all or partially deleted, so the resulting stack must be considered invalid.
*
* @param tenantId The Openstack ID of the tenant in which to perform the delete
* @param cloudOwner the cloud owner of the cloud site in which to delete the stack
* @param cloudSiteId The cloud identifier (may be a region) from which to delete the stack.
* @param stackName The name/id of the stack to delete. May be simple or canonical
* @param pollForCompletion Indicator that polling should be handled in Java vs. in the client
* @return A StackInfo object
* @throws MsoOpenstackException Thrown if the Openstack API call returns an exception.
* @throws MsoCloudSiteNotFound
*/
public StackInfo deleteStack (String tenantId,
String cloudOwner,
String cloudSiteId,
String stackName,
boolean pollForCompletion) throws MsoException {
// Obtain the cloud site information where we will create the stack
CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId).orElseThrow(
() -> new MsoCloudSiteNotFound(cloudSiteId));
logger.debug("Found: {}", cloudSite.toString());
// Get a Heat client. They are cached between calls (keyed by tenantId:cloudId)
Heat heatClient = null;
try {
heatClient = getHeatClient (cloudSite, tenantId);
if (heatClient != null) {
logger.debug("Found: {}", heatClient.toString());
}
} catch (MsoTenantNotFound e) {
// Tenant doesn't exist, so stack doesn't either
logger.debug ("Tenant with id " + tenantId + "not found.", e);
return new StackInfo (stackName, HeatStatus.NOTFOUND);
} catch (MsoException me) {
// Got an Openstack error. Propagate it
logger.error("{} {} Openstack Exception on Token request: ", MessageEnum.RA_CONNECTION_EXCEPTION,
ErrorCode.AvailabilityError.getValue(), me);
me.addContext (DELETE_STACK);
throw me;
}
// OK if stack not found, perform a query first
Stack heatStack = queryHeatStack (heatClient, stackName);
if (heatStack == null || "DELETE_COMPLETE".equals (heatStack.getStackStatus ())) {
// Not found. Return a StackInfo with status NOTFOUND
return new StackInfo (stackName, HeatStatus.NOTFOUND);
}
// Delete the stack.
// Use canonical name "<stack name>/<stack-id>" to delete.
// Otherwise, deletion by name returns a 302 redirect.
// NOTE: This is specific to the v1 Orchestration API.
String canonicalName = heatStack.getStackName () + "/" + heatStack.getId ();
try {
OpenStackRequest <Void> request = null;
if(null != heatClient) {
request = heatClient.getStacks ().deleteByName (canonicalName);
}
else {
logger.debug ("Heat Client is NULL" );
}
executeAndRecordOpenstackRequest (request);
} catch (OpenStackResponseException e) {
if (e.getStatus () == 404) {
// Not found. We are OK with this. Return a StackInfo with status NOTFOUND
return new StackInfo (stackName, HeatStatus.NOTFOUND);
} else {
// Convert the OpenStackResponseException to an MsoOpenstackException
throw heatExceptionToMsoException (e, DELETE_STACK);
}
} catch (OpenStackConnectException e) {
// Error connecting to Openstack instance. Convert to an MsoException
throw heatExceptionToMsoException (e, DELETE_STACK);
} catch (RuntimeException e) {
// Catch-all
throw runtimeExceptionToMsoException (e, DELETE_STACK);
}
// Requery the stack for current status.
// It will probably still exist with "DELETE_IN_PROGRESS" status.
heatStack = queryHeatStack (heatClient, canonicalName);
if (pollForCompletion) {
// Set a timeout on polling
int pollInterval = Integer.parseInt(this.environment.getProperty(deletePollIntervalProp, "" + deletePollIntervalDefault));
int pollTimeout = Integer.parseInt(this.environment.getProperty(deletePollTimeoutProp, "" + deletePollIntervalDefault));
// When querying by canonical name, Openstack returns DELETE_COMPLETE status
// instead of "404" (which would result from query by stack name).
while (heatStack != null && !"DELETE_COMPLETE".equals (heatStack.getStackStatus ())) {
logger.debug ("Stack status: {}", heatStack.getStackStatus ());
if ("DELETE_FAILED".equals (heatStack.getStackStatus ())) {
// Throw a 'special case' of MsoOpenstackException to report the Heat status
String error = "Stack delete error (" + heatStack.getStackStatus ()
+ "): "
+ heatStack.getStackStatusReason ();
MsoOpenstackException me = new MsoOpenstackException (0, "", error);
me.addContext (DELETE_STACK);
// Alarm this condition, stack deletion failed
throw me;
}
if (pollTimeout <= 0) {
logger.error("{} Cloud site: {} Tenant: {} Stack: {} Stack status: {} {} Delete Stack Timeout",
MessageEnum.RA_DELETE_STACK_TIMEOUT, cloudSiteId, tenantId, stackName,
heatStack.getStackStatus(), ErrorCode.AvailabilityError.getValue());
// Throw a 'special case' of MsoOpenstackException to report the Heat status
MsoOpenstackException me = new MsoOpenstackException (0, "", "Stack Deletion Timeout");
me.addContext (DELETE_STACK);
// Alarm this condition, stack deletion failed
throw me;
}
sleep(pollInterval * 1000L);
pollTimeout -= pollInterval;
logger.debug("pollTimeout remaining: {}", pollTimeout);
heatStack = queryHeatStack (heatClient, canonicalName);
}
// The stack is gone when this point is reached
return new StackInfo (stackName, HeatStatus.NOTFOUND);
}
// Return the current status (if not polling, the delete may still be in progress)
StackInfo stackInfo = new StackInfoMapper(heatStack).map();
stackInfo.setName (stackName);
return stackInfo;
}
/**
* Query for all stacks in a tenant site. This call will return a List of StackInfo
* objects, one for each deployed stack.
*
* Note that this is limited to a single site. To ensure that a tenant is truly
* empty would require looping across all tenant endpoints.
*
* @param tenantId The Openstack ID of the tenant to query
* @param cloudSiteId The cloud identifier (may be a region) in which to query.
* @return A List of StackInfo objects
* @throws MsoOpenstackException Thrown if the Openstack API call returns an exception.
* @throws MsoCloudSiteNotFound
*/
public List <StackInfo> queryAllStacks (String tenantId, String cloudSiteId) throws MsoException {
// Obtain the cloud site information where we will create the stack
CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId).orElseThrow(
() -> new MsoCloudSiteNotFound(cloudSiteId));
// Get a Heat client. They are cached between calls (keyed by tenantId:cloudId)
Heat heatClient = getHeatClient (cloudSite, tenantId);
try {
OpenStackRequest <Stacks> request = heatClient.getStacks ().list ();
Stacks stacks = executeAndRecordOpenstackRequest (request);
List <StackInfo> stackList = new ArrayList <> ();
// Not sure if returns an empty list or null if no stacks exist
if (stacks != null) {
for (Stack stack : stacks) {
stackList.add (new StackInfoMapper(stack).map());
}
}
return stackList;
} catch (OpenStackResponseException e) {
if (e.getStatus () == 404) {
// Not sure if this can happen, but return an empty list
logger.debug ("queryAllStacks - stack not found: ");
return new ArrayList <> ();
} else {
// Convert the OpenStackResponseException to an MsoOpenstackException
throw heatExceptionToMsoException (e, QUERY_ALL_STACKS);
}
} catch (OpenStackConnectException e) {
// Error connecting to Openstack instance. Convert to an MsoException
throw heatExceptionToMsoException (e, QUERY_ALL_STACKS);
} catch (RuntimeException e) {
// Catch-all
throw runtimeExceptionToMsoException (e, QUERY_ALL_STACKS);
}
}
/**
* Validate parameters to be passed to Heat template. This method performs
* three functions:
* 1. Apply default values to parameters which have them defined
* 2. Report any required parameters that are missing. This will generate an
* exception in the caller, since stack create/update operations would fail.
* 3. Report and remove any extraneous parameters. This will allow clients to
* pass supersets of parameters and not get errors.
*
* These functions depend on the HeatTemplate definition from the MSO Catalog DB,
* along with the input parameter Map. The output is an updated parameter map.
* If the parameters are invalid for the template, an IllegalArgumentException
* is thrown.
*/
public Map <String, Object> validateStackParams (Map <String, Object> inputParams,
HeatTemplate heatTemplate) {
// Check that required parameters have been supplied for this template type
StringBuilder missingParams = null;
List <String> paramList = new ArrayList <> ();
// TODO: Enhance DB to support defaults for Heat Template parameters
for (HeatTemplateParam parm : heatTemplate.getParameters ()) {
if (parm.isRequired () && !inputParams.containsKey (parm.getParamName ())) {
if (missingParams == null) {
missingParams = new StringBuilder(parm.getParamName());
} else {
missingParams.append("," + parm.getParamName());
}
}
paramList.add (parm.getParamName ());
}
if (missingParams != null) {
// Problem - missing one or more required parameters
String error = "Missing Required inputs for HEAT Template: " + missingParams;
logger.error("{} for HEAT Template {} Missing Required inputs for HEAT Template: {}",
MessageEnum.RA_MISSING_PARAM, ErrorCode.SchemaError.getValue(), missingParams);
throw new IllegalArgumentException (error);
}
// Remove any extraneous parameters (don't throw an error)
Map <String, Object> updatedParams = new HashMap <> ();
List <String> extraParams = new ArrayList <> ();
for (Entry<String, Object> entry : inputParams.entrySet()) {
if (!paramList.contains(entry.getKey())) {
// This is not a valid parameter for this template
extraParams.add(entry.getKey());
} else {
updatedParams.put(entry.getKey(), entry.getValue());
}
}
if (!extraParams.isEmpty ()) {
logger.warn("{} Heat Stack ({}) extra input params received: {} {}", MessageEnum.RA_GENERAL_WARNING,
heatTemplate.getTemplateName(), extraParams, ErrorCode.DataError.getValue());
}
return updatedParams;
}
// ---------------------------------------------------------------
// PRIVATE FUNCTIONS FOR USE WITHIN THIS CLASS
/**
* Get a Heat client for the Openstack Identity service.
* This requires a 'member'-level userId + password, which will be retrieved from
* properties based on the specified cloud Id. The tenant in which to operate
* must also be provided.
* <p>
* On successful authentication, the Heat object will be cached for the
* tenantID + cloudId so that it can be reused without reauthenticating with
* Openstack every time.
*
* @return an authenticated Heat object
*/
public Heat getHeatClient (CloudSite cloudSite, String tenantId) throws MsoException {
String cloudId = cloudSite.getId();
// For DCP/LCP, the region should be the cloudId.
String region = cloudSite.getRegionId ();
// Obtain an MSO token for the tenant
CloudIdentity cloudIdentity = cloudSite.getIdentityService();
logger.debug("Found: {}", cloudIdentity.toString());
MsoTenantUtils tenantUtils = tenantUtilsFactory.getTenantUtilsByServerType(cloudIdentity.getIdentityServerType());
String keystoneUrl = tenantUtils.getKeystoneUrl(cloudId, cloudIdentity);
logger.debug("keystoneUrl={}", keystoneUrl);
String heatUrl = null;
String tokenId = null;
Calendar expiration = null;
try {
if (ServerType.KEYSTONE.equals(cloudIdentity.getIdentityServerType())) {
Keystone keystoneTenantClient = new Keystone (keystoneUrl);
Access access = null;
Authentication credentials = authenticationMethodFactory.getAuthenticationFor(cloudIdentity);
OpenStackRequest <Access> request = keystoneTenantClient.tokens ()
.authenticate (credentials).withTenantId (tenantId);
access = executeAndRecordOpenstackRequest (request);
try {
// Isolate trying to printout the region IDs
try {
logger.debug("access={}", access.toString());
for (Access.Service service : access.getServiceCatalog()) {
List<Access.Service.Endpoint> endpoints = service.getEndpoints();
for (Access.Service.Endpoint endpoint : endpoints) {
logger.debug("AIC returned region={}", endpoint.getRegion());
}
}
} catch (Exception e) {
logger.debug("Encountered an error trying to printout Access object returned from AIC. {}",
e.getMessage(), e);
}
heatUrl = KeystoneUtils.findEndpointURL (access.getServiceCatalog (), "orchestration", region, "public");
logger.debug("heatUrl={}, region={}", heatUrl, region);
} catch (RuntimeException e) {
// This comes back for not found (probably an incorrect region ID)
String error = "AIC did not match an orchestration service for: region=" + region + ",cloud=" + cloudIdentity.getIdentityUrl();
throw new MsoAdapterException (error, e);
}
tokenId = access.getToken ().getId ();
expiration = access.getToken ().getExpires ();
} else if (ServerType.KEYSTONE_V3.equals(cloudIdentity.getIdentityServerType())) {
try {
KeystoneAuthHolder holder = keystoneV3Authentication.getToken(cloudSite, tenantId, "orchestration");
tokenId = holder.getId();
expiration = holder.getexpiration();
heatUrl = holder.getServiceUrl();
} catch (ServiceEndpointNotFoundException e) {
// This comes back for not found (probably an incorrect region ID)
String error = "cloud did not match an orchestration service for: region=" + region + ",cloud=" + cloudIdentity.getIdentityUrl();
throw new MsoAdapterException (error, e);
}
}
} catch (OpenStackResponseException e) {
if (e.getStatus () == 401) {
// Authentication error.
String error = "Authentication Failure: tenant=" + tenantId + ",cloud=" + cloudIdentity.getId ();
throw new MsoAdapterException (error);
} else {
throw keystoneErrorToMsoException (e, TOKEN_AUTH);
}
} catch (OpenStackConnectException e) {
// Connection to Openstack failed
MsoIOException me = new MsoIOException (e.getMessage (), e);
me.addContext (TOKEN_AUTH);
throw me;
} catch (RuntimeException e) {
// Catch-all
throw runtimeExceptionToMsoException (e, TOKEN_AUTH);
}
Heat heatClient = new Heat (heatUrl);
heatClient.token (tokenId);
return heatClient;
}
/*
* Query for a Heat Stack. This function is needed in several places, so
* a common method is useful. This method takes an authenticated Heat Client
* (which internally identifies the cloud & tenant to search), and returns
* a Stack object if found, Null if not found, or an MsoOpenstackException
* if the Openstack API call fails.
*
* The stack name may be a simple name or a canonical name ("{name}/{id}").
* When simple name is used, Openstack always returns a 302 redirect which
* results in a 2nd request (to the canonical name). Note that query by
* canonical name for a deleted stack returns a Stack object with status
* "DELETE_COMPLETE" while query by simple name for a deleted stack returns
* HTTP 404.
*
* @param heatClient an authenticated Heat client
*
* @param stackName the stack name to query
*
* @return a Stack object that describes the current stack or null if the
* requested stack doesn't exist.
*
* @throws MsoOpenstackException Thrown if the Openstack API call returns an exception
*/
protected Stack queryHeatStack (Heat heatClient, String stackName) throws MsoException {
if (stackName == null) {
return null;
}
try {
OpenStackRequest <Stack> request = heatClient.getStacks ().byName (stackName);
return executeAndRecordOpenstackRequest (request);
} catch (OpenStackResponseException e) {
logger.error("Error in Query Stack", e);
if (e.getStatus () == 404) {
logger.debug ("queryHeatStack - stack not found: {}", stackName);
return null;
} else {
// Convert the OpenStackResponseException to an MsoOpenstackException
throw heatExceptionToMsoException (e, "QueryStack");
}
} catch (OpenStackConnectException e) {
// Connection to Openstack failed
throw heatExceptionToMsoException (e, "QueryAllStack");
}
}
public Map<String, Object> queryStackForOutputs(String cloudSiteId, String cloudOwner,
String tenantId, String stackName) throws MsoException {
logger.debug("MsoHeatUtils.queryStackForOutputs)");
StackInfo heatStack = this.queryStack(cloudSiteId, cloudOwner, tenantId, stackName);
if (heatStack == null || heatStack.getStatus() == HeatStatus.NOTFOUND) {
return null;
}
return heatStack.getOutputs();
}
public void copyStringOutputsToInputs(Map<String, Object> inputs,
Map<String, Object> otherStackOutputs, boolean overWrite) {
if (inputs == null || otherStackOutputs == null)
return;
for (String key : otherStackOutputs.keySet()) {
if (!inputs.containsKey(key)) {
Object obj = otherStackOutputs.get(key);
if (obj instanceof String) {
inputs.put(key, (String) otherStackOutputs.get(key));
} else if (obj instanceof JsonNode ){
// This is a bit of mess - but I think it's the least impacting
// let's convert it BACK to a string - then it will get converted back later
try {
String str = this.convertNode((JsonNode) obj);
inputs.put(key, str);
} catch (Exception e) {
logger.debug("DANGER WILL ROBINSON: unable to convert value for JsonNode {} ", key, e);
//effect here is this value will not have been copied to the inputs - and therefore will error out downstream
}
} else if (obj instanceof java.util.LinkedHashMap) {
logger.debug("LinkedHashMap - this is showing up as a LinkedHashMap instead of JsonNode");
try {
String str = JSON_MAPPER.writeValueAsString(obj);
inputs.put(key, str);
} catch (Exception e) {
logger.debug("DANGER WILL ROBINSON: unable to convert value for LinkedHashMap {} ", key, e);
}
} else if (obj instanceof Integer) {
try {
String str = "" + obj;
inputs.put(key, str);
} catch (Exception e) {
logger.debug("DANGER WILL ROBINSON: unable to convert value for Integer {} ", key, e);
}
} else {
try {
String str = obj.toString();
inputs.put(key, str);
} catch (Exception e) {
logger.debug("DANGER WILL ROBINSON: unable to convert value for Other {} ({}) ", key, e.getMessage(), e);
//effect here is this value will not have been copied to the inputs - and therefore will error out downstream
}
}
}
}
return;
}
public StringBuilder requestToStringBuilder(CreateStackParam stack) {
StringBuilder sb = new StringBuilder();
sb.append("Stack:\n");
sb.append("\tStackName: " + stack.getStackName());
sb.append("\tTemplateUrl: " + stack.getTemplateUrl());
sb.append("\tTemplate: " + stack.getTemplate());
sb.append("\tEnvironment: " + stack.getEnvironment());
sb.append("\tTimeout: " + stack.getTimeoutMinutes());
sb.append("\tParameters:\n");
Map<String, Object> params = stack.getParameters();
if (params == null || params.size() < 1) {
sb.append("\nNONE");
} else {
for (String key : params.keySet()) {
if (params.get(key) instanceof String) {
sb.append("\n").append(key).append("=").append((String) params.get(key));
} else if (params.get(key) instanceof JsonNode) {
String jsonStringOut = this.convertNode((JsonNode)params.get(key));
sb.append("\n").append(key).append("=").append(jsonStringOut);
} else if (params.get(key) instanceof Integer) {
String integerOut = "" + params.get(key);
sb.append("\n").append(key).append("=").append(integerOut);
} else {
try {
String str = params.get(key).toString();
sb.append("\n").append(key).append("=").append(str);
} catch (Exception e) {
logger.debug("Exception :", e);
}
}
}
}
return sb;
}
private String convertNode(final JsonNode node) {
try {
final Object obj = JSON_MAPPER.treeToValue(node, Object.class);
final String json = JSON_MAPPER.writeValueAsString(obj);
return json;
} catch (Exception e) {
logger.debug("Error converting json to string {} ", e.getMessage(), e);
}
return "[Error converting json to string]";
}
protected StringBuilder getOutputsAsStringBuilder(Stack heatStack) {
// This should only be used as a utility to print out the stack outputs
// to the log
StringBuilder sb = new StringBuilder("");
if (heatStack == null) {
sb.append("(heatStack is null)");
return sb;
}
List<Output> outputList = heatStack.getOutputs();
if (outputList == null || outputList.isEmpty()) {
sb.append("(outputs is empty)");
return sb;
}
Map<String, Object> outputs = new HashMap<>();
for (Output outputItem : outputList) {
outputs.put(outputItem.getOutputKey(), outputItem.getOutputValue());
}
int counter = 0;
sb.append("OUTPUTS:\n");
for (String key : outputs.keySet()) {
sb.append("outputs[").append(counter++).append("]: ").append(key).append("=");
Object obj = outputs.get(key);
if (obj instanceof String) {
sb.append((String) obj).append(" (a string)");
} else if (obj instanceof JsonNode) {
sb.append(this.convertNode((JsonNode) obj)).append(" (a JsonNode)");
} else if (obj instanceof java.util.LinkedHashMap) {
try {
String str = JSON_MAPPER.writeValueAsString(obj);
sb.append(str).append(" (a java.util.LinkedHashMap)");
} catch (Exception e) {
logger.debug("Exception :", e);
sb.append("(a LinkedHashMap value that would not convert nicely)");
}
} else if (obj instanceof Integer) {
String str = "";
try {
str = obj.toString() + " (an Integer)\n";
} catch (Exception e) {
logger.debug("Exception :", e);
str = "(an Integer unable to call .toString() on)";
}
sb.append(str);
} else if (obj instanceof ArrayList) {
String str = "";
try {
str = obj.toString() + " (an ArrayList)";
} catch (Exception e) {
logger.debug("Exception :", e);
str = "(an ArrayList unable to call .toString() on?)";
}
sb.append(str);
} else if (obj instanceof Boolean) {
String str = "";
try {
str = obj.toString() + " (a Boolean)";
} catch (Exception e) {
logger.debug("Exception :", e);
str = "(an Boolean unable to call .toString() on?)";
}
sb.append(str);
}
else {
String str = "";
try {
str = obj.toString() + " (unknown Object type)";
} catch (Exception e) {
logger.debug("Exception :", e);
str = "(a value unable to call .toString() on?)";
}
sb.append(str);
}
sb.append("\n");
}
sb.append("[END]");
return sb;
}
public void copyBaseOutputsToInputs(Map<String, Object> inputs,
Map<String, Object> otherStackOutputs, List<String> paramNames, Map<String, String> aliases) {
if (inputs == null || otherStackOutputs == null)
return;
for (String key : otherStackOutputs.keySet()) {
if (paramNames != null) {
if (!paramNames.contains(key) && !aliases.containsKey(key)) {
logger.debug("\tParameter {} is NOT defined to be in the template - do not copy to inputs", key);
continue;
}
if (aliases.containsKey(key)) {
logger.debug("Found an alias! Will move {} to {}", key, aliases.get(key));
Object obj = otherStackOutputs.get(key);
key = aliases.get(key);
otherStackOutputs.put(key, obj);
}
}
if (!inputs.containsKey(key)) {
Object obj = otherStackOutputs.get(key);
logger.debug("\t**Adding {} to inputs (.toString()={}", key, obj.toString());
if (obj instanceof String) {
logger.debug("\t\t**A String");
inputs.put(key, obj);
} else if (obj instanceof Integer) {
logger.debug("\t\t**An Integer");
inputs.put(key, obj);
} else if (obj instanceof JsonNode) {
logger.debug("\t\t**A JsonNode");
inputs.put(key, obj);
} else if (obj instanceof Boolean) {
logger.debug("\t\t**A Boolean");
inputs.put(key, obj);
} else if (obj instanceof java.util.LinkedHashMap) {
logger.debug("\t\t**A java.util.LinkedHashMap **");
inputs.put(key, obj);
} else if (obj instanceof java.util.ArrayList) {
logger.debug("\t\t**An ArrayList");
inputs.put(key, obj);
} else {
logger.debug("\t\t**UNKNOWN OBJECT TYPE");
inputs.put(key, obj);
}
} else {
logger.debug("key={} is already in the inputs - will not overwrite", key);
}
}
return;
}
public List<String> convertCdlToArrayList(String cdl) {
String cdl2 = cdl.trim();
String cdl3;
if (cdl2.startsWith("[") && cdl2.endsWith("]")) {
cdl3 = cdl2.substring(1, cdl2.lastIndexOf("]"));
} else {
cdl3 = cdl2;
}
return new ArrayList<>(Arrays.asList(cdl3.split(",")));
}
/**
* New with 1707 - this method will convert all the String *values* of the inputs
* to their "actual" object type (based on the param type: in the db - which comes from the template):
* (heat variable type) -> java Object type
* string -> String
* number -> Integer
* json -> marshal object to json
* comma_delimited_list -> ArrayList
* boolean -> Boolean
* if any of the conversions should fail, we will default to adding it to the inputs
* as a string - see if Openstack can handle it.
* Also, will remove any params that are extra.
* Any aliases will be converted to their appropriate name (anyone use this feature?)
* @param inputs - the Map<String, String> of the inputs received on the request
* @param template the HeatTemplate object - this is so we can also verify if the param is valid for this template
* @return HashMap<String, Object> of the inputs, cleaned and converted
*/
public Map<String, Object> convertInputMap(Map<String, Object> inputs, HeatTemplate template) {
HashMap<String, Object> newInputs = new HashMap<>();
HashMap<String, HeatTemplateParam> params = new HashMap<>();
HashMap<String, HeatTemplateParam> paramAliases = new HashMap<>();
if (inputs == null) {
logger.debug("convertInputMap - inputs is null - nothing to do here");
return new HashMap<>();
}
logger.debug("convertInputMap in MsoHeatUtils called, with {} inputs, and template {}", inputs.size(),
template.getArtifactUuid());
try {
logger.debug(template.toString());
Set<HeatTemplateParam> paramSet = template.getParameters();
logger.debug("paramSet has {} entries", paramSet.size());
} catch (Exception e) {
logger.debug("Exception occurred in convertInputMap {} :", e.getMessage(), e);
}
for (HeatTemplateParam htp : template.getParameters()) {
logger.debug("Adding {}", htp.getParamName());
params.put(htp.getParamName(), htp);
if (htp.getParamAlias() != null && !"".equals(htp.getParamAlias())) {
logger.debug("\tFound ALIAS {} -> {}", htp.getParamName(), htp.getParamAlias());
paramAliases.put(htp.getParamAlias(), htp);
}
}
logger.debug("Now iterate through the inputs...");
for (String key : inputs.keySet()) {
logger.debug("key={}", key);
boolean alias = false;
String realName = null;
if (!params.containsKey(key)) {
logger.debug("{} is not a parameter in the template! - check for an alias", key);
// add check here for an alias
if (!paramAliases.containsKey(key)) {
logger.debug("The parameter {} is in the inputs, but it's not a parameter for this template - omit", key);
continue;
} else {
alias = true;
realName = paramAliases.get(key).getParamName();
logger.debug("FOUND AN ALIAS! Will use {} in lieu of give key/alias {}", realName, key);
}
}
String type = params.get(key).getParamType();
if (type == null || "".equals(type)) {
logger.debug("**PARAM_TYPE is null/empty for {}, will default to string", key);
type = "string";
}
logger.debug("Parameter: {} is of type {}", key, type);
if ("string".equalsIgnoreCase(type)) {
// Easiest!
String str = inputs.get(key) != null ? inputs.get(key).toString() : null;
if (alias)
newInputs.put(realName, str);
else
newInputs.put(key, str);
} else if ("number".equalsIgnoreCase(type)) {
String integerString = inputs.get(key) != null ? inputs.get(key).toString() : null;
Integer anInteger = null;
try {
anInteger = Integer.parseInt(integerString);
} catch (Exception e) {
logger.debug("Unable to convert {} to an integer!!", integerString, e);
anInteger = null;
}
if (anInteger != null) {
if (alias)
newInputs.put(realName, anInteger);
else
newInputs.put(key, anInteger);
}
else {
if (alias)
newInputs.put(realName, integerString);
else
newInputs.put(key, integerString);
}
} else if ("json".equalsIgnoreCase(type)) {
Object jsonObj = inputs.get(key);
Object json;
try {
if (jsonObj instanceof String) {
json = JSON_MAPPER.readTree(jsonObj.toString());
} else {
//will already marshal to json without intervention
json = jsonObj;
}
} catch (IOException e) {
logger.error("failed to map to json, directly converting to string instead", e);
json = jsonObj.toString();
}
if (alias)
newInputs.put(realName, json);
else
newInputs.put(key, json);
} else if ("comma_delimited_list".equalsIgnoreCase(type)) {
String commaSeparated = inputs.get(key) != null ? inputs.get(key).toString() : null;
try {
List<String> anArrayList = this.convertCdlToArrayList(commaSeparated);
if (alias)
newInputs.put(realName, anArrayList);
else
newInputs.put(key, anArrayList);
} catch (Exception e) {
logger.debug("Unable to convert {} to an ArrayList!!", commaSeparated, e);
if (alias)
newInputs.put(realName, commaSeparated);
else
newInputs.put(key, commaSeparated);
}
} else if ("boolean".equalsIgnoreCase(type)) {
String booleanString = inputs.get(key) != null ? inputs.get(key).toString() : null;
Boolean aBool = Boolean.valueOf(booleanString);
if (alias)
newInputs.put(realName, aBool);
else
newInputs.put(key, aBool);
} else {
// it's null or something undefined - just add it back as a String
String str = inputs.get(key).toString();
if (alias)
newInputs.put(realName, str);
else
newInputs.put(key, str);
}
}
return newInputs;
}
/*
* This helpful method added for Valet
*/
public String getCloudSiteKeystoneUrl(String cloudSiteId) throws MsoCloudSiteNotFound {
String keystone_url = null;
try {
CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId).orElseThrow(() -> new MsoCloudSiteNotFound(cloudSiteId));
CloudIdentity cloudIdentity = cloudSite.getIdentityService();
keystone_url = cloudIdentity.getIdentityUrl();
} catch (Exception e) {
throw new MsoCloudSiteNotFound(cloudSiteId);
}
if (keystone_url == null || keystone_url.isEmpty()) {
throw new MsoCloudSiteNotFound(cloudSiteId);
}
return keystone_url;
}
/*
* Create a string suitable for being dumped to a debug log that creates a
* pseudo-JSON request dumping what's being sent to Openstack API in the create or update request
*/
private String printStackRequest(String tenantId,
Map<String, Object> heatFiles,
Map<String, Object> nestedTemplates,
String environment,
Map<String, Object> inputs,
String vfModuleName,
String template,
int timeoutMinutes,
boolean backout,
String cloudSiteId) {
StringBuilder sb = new StringBuilder();
sb.append("CREATE STACK REQUEST (formatted for readability)\n");
sb.append("tenant=" + tenantId + ", cloud=" + cloudSiteId);
sb.append("{\n");
sb.append(" \"stack_name\": \"" + vfModuleName + "\",\n");
sb.append(" \"disable_rollback\": " + backout + ",\n");
sb.append(" \"timeout_mins\": " + timeoutMinutes + ",\n");
sb.append(" \"template\": {\n");
sb.append(template);
sb.append(" },\n");
sb.append(" \"environment\": {\n");
if (environment == null)
sb.append("<none>");
else
sb.append(environment);
sb.append(" },\n");
sb.append(" \"files\": {\n");
int filesCounter = 0;
if (heatFiles != null) {
for (String key : heatFiles.keySet()) {
filesCounter++;
if (filesCounter > 1) {
sb.append(",\n");
}
sb.append(" \"" + key + "\": {\n");
sb.append(heatFiles.get(key).toString() + "\n }");
}
}
if (nestedTemplates != null) {
for (String key : nestedTemplates.keySet()) {
filesCounter++;
if (filesCounter > 1) {
sb.append(",\n");
}
sb.append(" \"" + key + "\": {\n");
sb.append(nestedTemplates.get(key).toString() + "\n }");
}
}
sb.append("\n },\n");
sb.append(" \"parameters\": {\n");
int paramCounter = 0;
for (String name : inputs.keySet()) {
paramCounter++;
if (paramCounter > 1) {
sb.append(",\n");
}
Object o = inputs.get(name);
if (o instanceof java.lang.String) {
sb.append(" \"" + name + "\": \"" + inputs.get(name).toString() + "\"");
} else if (o instanceof Integer) {
sb.append(" \"" + name + "\": " + inputs.get(name).toString() );
} else if (o instanceof ArrayList) {
sb.append(" \"" + name + "\": " + inputs.get(name).toString() );
} else if (o instanceof Boolean) {
sb.append(" \"" + name + "\": " + inputs.get(name).toString() );
} else {
sb.append(" \"" + name + "\": " + "\"(there was an issue trying to dump this value...)\"" );
}
}
sb.append("\n }\n}\n");
return sb.toString();
}
/*******************************************************************************
*
* Methods (and associated utilities) to implement the VduPlugin interface
*
*******************************************************************************/
/**
* VduPlugin interface for instantiate function.
*
* Translate the VduPlugin parameters to the corresponding 'createStack' parameters,
* and then invoke the existing function.
*/
@Override
public VduInstance instantiateVdu (
CloudInfo cloudInfo,
String instanceName,
Map<String,Object> inputs,
VduModelInfo vduModel,
boolean rollbackOnFailure)
throws VduException
{
String cloudSiteId = cloudInfo.getCloudSiteId();
String cloudOwner = cloudInfo.getCloudOwner();
String tenantId = cloudInfo.getTenantId();
// Translate the VDU ModelInformation structure to that which is needed for
// creating the Heat stack. Loop through the artifacts, looking specifically
// for MAIN_TEMPLATE and ENVIRONMENT. Any other artifact will
// be attached as a FILE.
String heatTemplate = null;
Map<String,Object> nestedTemplates = new HashMap<>();
Map<String,Object> files = new HashMap<>();
String heatEnvironment = null;
for (VduArtifact vduArtifact: vduModel.getArtifacts()) {
if (vduArtifact.getType() == ArtifactType.MAIN_TEMPLATE) {
heatTemplate = new String(vduArtifact.getContent());
}
else if (vduArtifact.getType() == ArtifactType.NESTED_TEMPLATE) {
nestedTemplates.put(vduArtifact.getName(), new String(vduArtifact.getContent()));
}
else if (vduArtifact.getType() == ArtifactType.ENVIRONMENT) {
heatEnvironment = new String(vduArtifact.getContent());
}
}
try {
StackInfo stackInfo = createStack (cloudSiteId,
cloudOwner,
tenantId,
instanceName,
vduModel,
heatTemplate,
inputs,
true, // poll for completion
vduModel.getTimeoutMinutes(),
heatEnvironment,
nestedTemplates,
files,
rollbackOnFailure);
// Populate a vduInstance from the StackInfo
return stackInfoToVduInstance(stackInfo);
}
catch (Exception e) {
throw new VduException ("MsoHeatUtils (instantiateVDU): createStack Exception", e);
}
}
/**
* VduPlugin interface for query function.
*/
@Override
public VduInstance queryVdu (CloudInfo cloudInfo, String instanceId)
throws VduException
{
String cloudSiteId = cloudInfo.getCloudSiteId();
String cloudOwner = cloudInfo.getCloudOwner();
String tenantId = cloudInfo.getTenantId();
try {
// Query the Cloudify Deployment object and populate a VduInstance
StackInfo stackInfo = queryStack (cloudSiteId, cloudOwner, tenantId, instanceId);
return stackInfoToVduInstance(stackInfo);
}
catch (Exception e) {
throw new VduException ("MsoHeatUtile (queryVdu): queryStack Exception ", e);
}
}
/**
* VduPlugin interface for delete function.
*/
@Override
public VduInstance deleteVdu (CloudInfo cloudInfo, String instanceId, int timeoutMinutes)
throws VduException
{
String cloudSiteId = cloudInfo.getCloudSiteId();
String cloudOwner = cloudInfo.getCloudOwner();
String tenantId = cloudInfo.getTenantId();
try {
// Delete the Heat stack
StackInfo stackInfo = deleteStack (tenantId, cloudOwner, cloudSiteId, instanceId, true);
// Populate a VduInstance based on the deleted Cloudify Deployment object
VduInstance vduInstance = stackInfoToVduInstance(stackInfo);
// Override return state to DELETED (HeatUtils sets to NOTFOUND)
vduInstance.getStatus().setState(VduStateType.DELETED);
return vduInstance;
}
catch (Exception e) {
throw new VduException ("Delete VDU Exception", e);
}
}
/**
* VduPlugin interface for update function.
*
* Update is currently not supported in the MsoHeatUtils implementation of VduPlugin.
* Just return a VduException.
*
*/
@Override
public VduInstance updateVdu (
CloudInfo cloudInfo,
String instanceId,
Map<String,Object> inputs,
VduModelInfo vduModel,
boolean rollbackOnFailure)
throws VduException
{
throw new VduException ("MsoHeatUtils: updateVdu interface not supported");
}
/*
* Convert the local DeploymentInfo object (Cloudify-specific) to a generic VduInstance object
*/
protected VduInstance stackInfoToVduInstance (StackInfo stackInfo)
{
VduInstance vduInstance = new VduInstance();
// The full canonical name as the instance UUID
vduInstance.setVduInstanceId(stackInfo.getCanonicalName());
vduInstance.setVduInstanceName(stackInfo.getName());
// Copy inputs and outputs
vduInstance.setInputs(stackInfo.getParameters());
vduInstance.setOutputs(stackInfo.getOutputs());
// Translate the status elements
vduInstance.setStatus(stackStatusToVduStatus (stackInfo));
return vduInstance;
}
private VduStatus stackStatusToVduStatus (StackInfo stackInfo)
{
VduStatus vduStatus = new VduStatus();
// Map the status fields to more generic VduStatus.
// There are lots of HeatStatus values, so this is a bit long...
HeatStatus heatStatus = stackInfo.getStatus();
String statusMessage = stackInfo.getStatusMessage();
if (heatStatus == HeatStatus.INIT || heatStatus == HeatStatus.BUILDING) {
vduStatus.setState(VduStateType.INSTANTIATING);
vduStatus.setLastAction((new PluginAction ("create", "in_progress", statusMessage)));
}
else if (heatStatus == HeatStatus.NOTFOUND) {
vduStatus.setState(VduStateType.NOTFOUND);
}
else if (heatStatus == HeatStatus.CREATED) {
vduStatus.setState(VduStateType.INSTANTIATED);
vduStatus.setLastAction((new PluginAction ("create", "complete", statusMessage)));
}
else if (heatStatus == HeatStatus.UPDATED) {
vduStatus.setState(VduStateType.INSTANTIATED);
vduStatus.setLastAction((new PluginAction ("update", "complete", statusMessage)));
}
else if (heatStatus == HeatStatus.UPDATING) {
vduStatus.setState(VduStateType.UPDATING);
vduStatus.setLastAction((new PluginAction ("update", "in_progress", statusMessage)));
}
else if (heatStatus == HeatStatus.DELETING) {
vduStatus.setState(VduStateType.DELETING);
vduStatus.setLastAction((new PluginAction ("delete", "in_progress", statusMessage)));
}
else if (heatStatus == HeatStatus.FAILED) {
vduStatus.setState(VduStateType.FAILED);
vduStatus.setErrorMessage(stackInfo.getStatusMessage());
} else {
vduStatus.setState(VduStateType.UNKNOWN);
}
return vduStatus;
}
public Resources queryStackResources(String cloudSiteId, String tenantId, String stackName, int nestedDepth) throws MsoException {
CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId)
.orElseThrow(() -> new MsoCloudSiteNotFound(cloudSiteId));
Heat heatClient = getHeatClient(cloudSite, tenantId);
OpenStackRequest<Resources> request = heatClient.getResources().listResources(stackName).queryParam("nested_depth", nestedDepth);
return executeAndRecordOpenstackRequest(request);
}
public <R> R executeHeatClientRequest(String url, String cloudSiteId, String tenantId, Class<R> returnType) throws MsoException {
CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId)
.orElseThrow(() -> new MsoCloudSiteNotFound(cloudSiteId));
Heat heatClient = getHeatClient(cloudSite, tenantId);
OpenStackRequest<R> request = heatClient.get(url, returnType);
return executeAndRecordOpenstackRequest(request);
}
protected void sleep(long time) {
try {
Thread.sleep(time);
} catch (InterruptedException e) {
logger.debug ("Thread interrupted while sleeping", e);
Thread.currentThread().interrupt();
}
}
}
|