@openshift-migration-advisor/planner-sdk 0.13.7 → 0.14.0-e72c0cc421c6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +4 -0
- package/README.md +4 -2
- package/dist/esm/models/ClusterRequirementsRequest.d.ts +6 -0
- package/dist/esm/models/ClusterRequirementsRequest.js +2 -0
- package/dist/esm/models/ClusterRequirementsResponse.d.ts +20 -0
- package/dist/esm/models/ClusterRequirementsResponse.js +8 -0
- package/dist/esm/models/ClusterRequirementsStoredInput.d.ts +7 -0
- package/dist/esm/models/ClusterRequirementsStoredInput.js +4 -1
- package/dist/esm/models/ClusterSizing.d.ts +18 -0
- package/dist/esm/models/ClusterSizing.js +6 -0
- package/dist/esm/models/CpuOverCommitRatio.d.ts +1 -0
- package/dist/esm/models/CpuOverCommitRatio.js +2 -1
- package/dist/esm/models/OptimizationStatus.d.ts +48 -0
- package/dist/esm/models/OptimizationStatus.js +56 -0
- package/dist/esm/models/Savings.d.ts +44 -0
- package/dist/esm/models/Savings.js +51 -0
- package/dist/esm/models/Source.d.ts +14 -0
- package/dist/esm/models/Source.js +9 -0
- package/dist/esm/models/StandaloneClusterRequirementsRequest.d.ts +6 -0
- package/dist/esm/models/StandaloneClusterRequirementsRequest.js +2 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/ClusterRequirementsRequest.d.ts +6 -0
- package/dist/models/ClusterRequirementsRequest.js +2 -0
- package/dist/models/ClusterRequirementsResponse.d.ts +20 -0
- package/dist/models/ClusterRequirementsResponse.js +8 -0
- package/dist/models/ClusterRequirementsStoredInput.d.ts +7 -0
- package/dist/models/ClusterRequirementsStoredInput.js +4 -1
- package/dist/models/ClusterSizing.d.ts +18 -0
- package/dist/models/ClusterSizing.js +6 -0
- package/dist/models/CpuOverCommitRatio.d.ts +1 -0
- package/dist/models/CpuOverCommitRatio.js +2 -1
- package/dist/models/OptimizationStatus.d.ts +48 -0
- package/dist/models/OptimizationStatus.js +64 -0
- package/dist/models/Savings.d.ts +44 -0
- package/dist/models/Savings.js +58 -0
- package/dist/models/Source.d.ts +14 -0
- package/dist/models/Source.js +10 -0
- package/dist/models/StandaloneClusterRequirementsRequest.d.ts +6 -0
- package/dist/models/StandaloneClusterRequirementsRequest.js +2 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/ClusterRequirementsRequest.md +2 -0
- package/docs/ClusterRequirementsResponse.md +6 -0
- package/docs/ClusterRequirementsStoredInput.md +2 -0
- package/docs/ClusterSizing.md +6 -0
- package/docs/OptimizationStatus.md +37 -0
- package/docs/Savings.md +39 -0
- package/docs/Source.md +2 -0
- package/docs/StandaloneClusterRequirementsRequest.md +2 -0
- package/package.json +1 -1
- package/src/models/ClusterRequirementsRequest.ts +8 -0
- package/src/models/ClusterRequirementsResponse.ts +38 -0
- package/src/models/ClusterRequirementsStoredInput.ts +10 -1
- package/src/models/ClusterSizing.ts +24 -0
- package/src/models/CpuOverCommitRatio.ts +2 -1
- package/src/models/OptimizationStatus.ts +88 -0
- package/src/models/Savings.ts +84 -0
- package/src/models/Source.ts +19 -0
- package/src/models/StandaloneClusterRequirementsRequest.ts +8 -0
- package/src/models/index.ts +2 -0
|
@@ -18,9 +18,11 @@ exports.ClusterRequirementsResponseFromJSON = ClusterRequirementsResponseFromJSO
|
|
|
18
18
|
exports.ClusterRequirementsResponseFromJSONTyped = ClusterRequirementsResponseFromJSONTyped;
|
|
19
19
|
exports.ClusterRequirementsResponseToJSON = ClusterRequirementsResponseToJSON;
|
|
20
20
|
exports.ClusterRequirementsResponseToJSONTyped = ClusterRequirementsResponseToJSONTyped;
|
|
21
|
+
const Savings_js_1 = require("./Savings.js");
|
|
21
22
|
const SizingResourceConsumption_js_1 = require("./SizingResourceConsumption.js");
|
|
22
23
|
const InventoryTotals_js_1 = require("./InventoryTotals.js");
|
|
23
24
|
const ClusterSizing_js_1 = require("./ClusterSizing.js");
|
|
25
|
+
const OptimizationStatus_js_1 = require("./OptimizationStatus.js");
|
|
24
26
|
/**
|
|
25
27
|
* Check if a given object implements the ClusterRequirementsResponse interface.
|
|
26
28
|
*/
|
|
@@ -42,6 +44,9 @@ function ClusterRequirementsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
42
44
|
}
|
|
43
45
|
return {
|
|
44
46
|
'clusterSizing': (0, ClusterSizing_js_1.ClusterSizingFromJSON)(json['clusterSizing']),
|
|
47
|
+
'optimizedSizing': json['optimizedSizing'] == null ? undefined : (0, ClusterSizing_js_1.ClusterSizingFromJSON)(json['optimizedSizing']),
|
|
48
|
+
'savings': json['savings'] == null ? undefined : (0, Savings_js_1.SavingsFromJSON)(json['savings']),
|
|
49
|
+
'optimizationStatus': json['optimizationStatus'] == null ? undefined : (0, OptimizationStatus_js_1.OptimizationStatusFromJSON)(json['optimizationStatus']),
|
|
45
50
|
'resourceConsumption': (0, SizingResourceConsumption_js_1.SizingResourceConsumptionFromJSON)(json['resourceConsumption']),
|
|
46
51
|
'inventoryTotals': (0, InventoryTotals_js_1.InventoryTotalsFromJSON)(json['inventoryTotals']),
|
|
47
52
|
};
|
|
@@ -55,6 +60,9 @@ function ClusterRequirementsResponseToJSONTyped(value, ignoreDiscriminator = fal
|
|
|
55
60
|
}
|
|
56
61
|
return {
|
|
57
62
|
'clusterSizing': (0, ClusterSizing_js_1.ClusterSizingToJSON)(value['clusterSizing']),
|
|
63
|
+
'optimizedSizing': (0, ClusterSizing_js_1.ClusterSizingToJSON)(value['optimizedSizing']),
|
|
64
|
+
'savings': (0, Savings_js_1.SavingsToJSON)(value['savings']),
|
|
65
|
+
'optimizationStatus': (0, OptimizationStatus_js_1.OptimizationStatusToJSON)(value['optimizationStatus']),
|
|
58
66
|
'resourceConsumption': (0, SizingResourceConsumption_js_1.SizingResourceConsumptionToJSON)(value['resourceConsumption']),
|
|
59
67
|
'inventoryTotals': (0, InventoryTotals_js_1.InventoryTotalsToJSON)(value['inventoryTotals']),
|
|
60
68
|
};
|
|
@@ -81,6 +81,12 @@ export interface ClusterRequirementsStoredInput {
|
|
|
81
81
|
* @memberof ClusterRequirementsStoredInput
|
|
82
82
|
*/
|
|
83
83
|
hostedControlPlane?: boolean;
|
|
84
|
+
/**
|
|
85
|
+
* If true, creates a 3-node compact cluster with no dedicated workers
|
|
86
|
+
* @type {boolean}
|
|
87
|
+
* @memberof ClusterRequirementsStoredInput
|
|
88
|
+
*/
|
|
89
|
+
compactMode?: boolean;
|
|
84
90
|
}
|
|
85
91
|
/**
|
|
86
92
|
* @export
|
|
@@ -90,6 +96,7 @@ export declare const ClusterRequirementsStoredInputCpuOverCommitRatioEnum: {
|
|
|
90
96
|
readonly _12: "1:2";
|
|
91
97
|
readonly _14: "1:4";
|
|
92
98
|
readonly _16: "1:6";
|
|
99
|
+
readonly _18: "1:8";
|
|
93
100
|
};
|
|
94
101
|
export type ClusterRequirementsStoredInputCpuOverCommitRatioEnum = typeof ClusterRequirementsStoredInputCpuOverCommitRatioEnum[keyof typeof ClusterRequirementsStoredInputCpuOverCommitRatioEnum];
|
|
95
102
|
/**
|
|
@@ -26,7 +26,8 @@ exports.ClusterRequirementsStoredInputCpuOverCommitRatioEnum = {
|
|
|
26
26
|
_11: '1:1',
|
|
27
27
|
_12: '1:2',
|
|
28
28
|
_14: '1:4',
|
|
29
|
-
_16: '1:6'
|
|
29
|
+
_16: '1:6',
|
|
30
|
+
_18: '1:8'
|
|
30
31
|
};
|
|
31
32
|
/**
|
|
32
33
|
* @export
|
|
@@ -70,6 +71,7 @@ function ClusterRequirementsStoredInputFromJSONTyped(json, ignoreDiscriminator)
|
|
|
70
71
|
'controlPlaneMemory': json['controlPlaneMemory'] == null ? undefined : json['controlPlaneMemory'],
|
|
71
72
|
'controlPlaneNodeCount': json['controlPlaneNodeCount'] == null ? undefined : json['controlPlaneNodeCount'],
|
|
72
73
|
'hostedControlPlane': json['hostedControlPlane'] == null ? undefined : json['hostedControlPlane'],
|
|
74
|
+
'compactMode': json['compactMode'] == null ? undefined : json['compactMode'],
|
|
73
75
|
};
|
|
74
76
|
}
|
|
75
77
|
function ClusterRequirementsStoredInputToJSON(json) {
|
|
@@ -91,5 +93,6 @@ function ClusterRequirementsStoredInputToJSONTyped(value, ignoreDiscriminator =
|
|
|
91
93
|
'controlPlaneMemory': value['controlPlaneMemory'],
|
|
92
94
|
'controlPlaneNodeCount': value['controlPlaneNodeCount'],
|
|
93
95
|
'hostedControlPlane': value['hostedControlPlane'],
|
|
96
|
+
'compactMode': value['compactMode'],
|
|
94
97
|
};
|
|
95
98
|
}
|
|
@@ -51,6 +51,24 @@ export interface ClusterSizing {
|
|
|
51
51
|
* @memberof ClusterSizing
|
|
52
52
|
*/
|
|
53
53
|
totalMemory: number;
|
|
54
|
+
/**
|
|
55
|
+
* CPU utilization maximum percentage (only in optimized_sizing)
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof ClusterSizing
|
|
58
|
+
*/
|
|
59
|
+
cpuUtilizationMax?: number;
|
|
60
|
+
/**
|
|
61
|
+
* Memory utilization maximum percentage (only in optimized_sizing)
|
|
62
|
+
* @type {number}
|
|
63
|
+
* @memberof ClusterSizing
|
|
64
|
+
*/
|
|
65
|
+
memoryUtilizationMax?: number;
|
|
66
|
+
/**
|
|
67
|
+
* Data coverage confidence 0-100 (only in optimized_sizing)
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof ClusterSizing
|
|
70
|
+
*/
|
|
71
|
+
confidence?: number;
|
|
54
72
|
}
|
|
55
73
|
/**
|
|
56
74
|
* Check if a given object implements the ClusterSizing interface.
|
|
@@ -50,6 +50,9 @@ function ClusterSizingFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
50
50
|
'failoverNodes': json['failoverNodes'],
|
|
51
51
|
'totalCPU': json['totalCPU'],
|
|
52
52
|
'totalMemory': json['totalMemory'],
|
|
53
|
+
'cpuUtilizationMax': json['cpuUtilizationMax'] == null ? undefined : json['cpuUtilizationMax'],
|
|
54
|
+
'memoryUtilizationMax': json['memoryUtilizationMax'] == null ? undefined : json['memoryUtilizationMax'],
|
|
55
|
+
'confidence': json['confidence'] == null ? undefined : json['confidence'],
|
|
53
56
|
};
|
|
54
57
|
}
|
|
55
58
|
function ClusterSizingToJSON(json) {
|
|
@@ -66,5 +69,8 @@ function ClusterSizingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
66
69
|
'failoverNodes': value['failoverNodes'],
|
|
67
70
|
'totalCPU': value['totalCPU'],
|
|
68
71
|
'totalMemory': value['totalMemory'],
|
|
72
|
+
'cpuUtilizationMax': value['cpuUtilizationMax'],
|
|
73
|
+
'memoryUtilizationMax': value['memoryUtilizationMax'],
|
|
74
|
+
'confidence': value['confidence'],
|
|
69
75
|
};
|
|
70
76
|
}
|
|
@@ -18,6 +18,7 @@ export declare const CpuOverCommitRatio: {
|
|
|
18
18
|
readonly CpuOneToTwo: "1:2";
|
|
19
19
|
readonly CpuOneToFour: "1:4";
|
|
20
20
|
readonly CpuOneToSix: "1:6";
|
|
21
|
+
readonly CpuOneToEight: "1:8";
|
|
21
22
|
};
|
|
22
23
|
export type CpuOverCommitRatio = typeof CpuOverCommitRatio[keyof typeof CpuOverCommitRatio];
|
|
23
24
|
export declare function instanceOfCpuOverCommitRatio(value: any): boolean;
|
|
@@ -27,7 +27,8 @@ exports.CpuOverCommitRatio = {
|
|
|
27
27
|
CpuOneToOne: '1:1',
|
|
28
28
|
CpuOneToTwo: '1:2',
|
|
29
29
|
CpuOneToFour: '1:4',
|
|
30
|
-
CpuOneToSix: '1:6'
|
|
30
|
+
CpuOneToSix: '1:6',
|
|
31
|
+
CpuOneToEight: '1:8'
|
|
31
32
|
};
|
|
32
33
|
function instanceOfCpuOverCommitRatio(value) {
|
|
33
34
|
for (const key in exports.CpuOverCommitRatio) {
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenShift Migration Advisor API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1alpha1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Status of utilization-based optimization attempt
|
|
14
|
+
* @export
|
|
15
|
+
* @interface OptimizationStatus
|
|
16
|
+
*/
|
|
17
|
+
export interface OptimizationStatus {
|
|
18
|
+
/**
|
|
19
|
+
* Whether optimization was attempted based on available utilization data
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof OptimizationStatus
|
|
22
|
+
*/
|
|
23
|
+
attempted: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Reason for optimization result
|
|
26
|
+
* @type {OptimizationStatusReasonEnum}
|
|
27
|
+
* @memberof OptimizationStatus
|
|
28
|
+
*/
|
|
29
|
+
reason: OptimizationStatusReasonEnum;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* @export
|
|
33
|
+
*/
|
|
34
|
+
export declare const OptimizationStatusReasonEnum: {
|
|
35
|
+
readonly NoUtilizationData: "no_utilization_data";
|
|
36
|
+
readonly LowConfidence: "low_confidence";
|
|
37
|
+
readonly CalculationError: "calculation_error";
|
|
38
|
+
readonly Success: "success";
|
|
39
|
+
};
|
|
40
|
+
export type OptimizationStatusReasonEnum = typeof OptimizationStatusReasonEnum[keyof typeof OptimizationStatusReasonEnum];
|
|
41
|
+
/**
|
|
42
|
+
* Check if a given object implements the OptimizationStatus interface.
|
|
43
|
+
*/
|
|
44
|
+
export declare function instanceOfOptimizationStatus(value: object): value is OptimizationStatus;
|
|
45
|
+
export declare function OptimizationStatusFromJSON(json: any): OptimizationStatus;
|
|
46
|
+
export declare function OptimizationStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): OptimizationStatus;
|
|
47
|
+
export declare function OptimizationStatusToJSON(json: any): OptimizationStatus;
|
|
48
|
+
export declare function OptimizationStatusToJSONTyped(value?: OptimizationStatus | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* OpenShift Migration Advisor API
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v1alpha1
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.OptimizationStatusReasonEnum = void 0;
|
|
17
|
+
exports.instanceOfOptimizationStatus = instanceOfOptimizationStatus;
|
|
18
|
+
exports.OptimizationStatusFromJSON = OptimizationStatusFromJSON;
|
|
19
|
+
exports.OptimizationStatusFromJSONTyped = OptimizationStatusFromJSONTyped;
|
|
20
|
+
exports.OptimizationStatusToJSON = OptimizationStatusToJSON;
|
|
21
|
+
exports.OptimizationStatusToJSONTyped = OptimizationStatusToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.OptimizationStatusReasonEnum = {
|
|
26
|
+
NoUtilizationData: 'no_utilization_data',
|
|
27
|
+
LowConfidence: 'low_confidence',
|
|
28
|
+
CalculationError: 'calculation_error',
|
|
29
|
+
Success: 'success'
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the OptimizationStatus interface.
|
|
33
|
+
*/
|
|
34
|
+
function instanceOfOptimizationStatus(value) {
|
|
35
|
+
if (!('attempted' in value) || value['attempted'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('reason' in value) || value['reason'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
function OptimizationStatusFromJSON(json) {
|
|
42
|
+
return OptimizationStatusFromJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function OptimizationStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
45
|
+
if (json == null) {
|
|
46
|
+
return json;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'attempted': json['attempted'],
|
|
50
|
+
'reason': json['reason'],
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
function OptimizationStatusToJSON(json) {
|
|
54
|
+
return OptimizationStatusToJSONTyped(json, false);
|
|
55
|
+
}
|
|
56
|
+
function OptimizationStatusToJSONTyped(value, ignoreDiscriminator = false) {
|
|
57
|
+
if (value == null) {
|
|
58
|
+
return value;
|
|
59
|
+
}
|
|
60
|
+
return {
|
|
61
|
+
'attempted': value['attempted'],
|
|
62
|
+
'reason': value['reason'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenShift Migration Advisor API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1alpha1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Infrastructure savings comparison
|
|
14
|
+
* @export
|
|
15
|
+
* @interface Savings
|
|
16
|
+
*/
|
|
17
|
+
export interface Savings {
|
|
18
|
+
/**
|
|
19
|
+
* Number of nodes saved compared to baseline
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof Savings
|
|
22
|
+
*/
|
|
23
|
+
nodesSaved: number;
|
|
24
|
+
/**
|
|
25
|
+
* Percentage reduction in nodes
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof Savings
|
|
28
|
+
*/
|
|
29
|
+
percentageReduction: number;
|
|
30
|
+
/**
|
|
31
|
+
* Human-readable description of savings source
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof Savings
|
|
34
|
+
*/
|
|
35
|
+
description: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the Savings interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfSavings(value: object): value is Savings;
|
|
41
|
+
export declare function SavingsFromJSON(json: any): Savings;
|
|
42
|
+
export declare function SavingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Savings;
|
|
43
|
+
export declare function SavingsToJSON(json: any): Savings;
|
|
44
|
+
export declare function SavingsToJSONTyped(value?: Savings | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* OpenShift Migration Advisor API
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v1alpha1
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfSavings = instanceOfSavings;
|
|
17
|
+
exports.SavingsFromJSON = SavingsFromJSON;
|
|
18
|
+
exports.SavingsFromJSONTyped = SavingsFromJSONTyped;
|
|
19
|
+
exports.SavingsToJSON = SavingsToJSON;
|
|
20
|
+
exports.SavingsToJSONTyped = SavingsToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the Savings interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfSavings(value) {
|
|
25
|
+
if (!('nodesSaved' in value) || value['nodesSaved'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('percentageReduction' in value) || value['percentageReduction'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('description' in value) || value['description'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
function SavingsFromJSON(json) {
|
|
34
|
+
return SavingsFromJSONTyped(json, false);
|
|
35
|
+
}
|
|
36
|
+
function SavingsFromJSONTyped(json, ignoreDiscriminator) {
|
|
37
|
+
if (json == null) {
|
|
38
|
+
return json;
|
|
39
|
+
}
|
|
40
|
+
return {
|
|
41
|
+
'nodesSaved': json['nodesSaved'],
|
|
42
|
+
'percentageReduction': json['percentageReduction'],
|
|
43
|
+
'description': json['description'],
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
function SavingsToJSON(json) {
|
|
47
|
+
return SavingsToJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
function SavingsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
50
|
+
if (value == null) {
|
|
51
|
+
return value;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
'nodesSaved': value['nodesSaved'],
|
|
55
|
+
'percentageReduction': value['percentageReduction'],
|
|
56
|
+
'description': value['description'],
|
|
57
|
+
};
|
|
58
|
+
}
|
package/dist/models/Source.d.ts
CHANGED
|
@@ -85,7 +85,21 @@ export interface Source {
|
|
|
85
85
|
* @memberof Source
|
|
86
86
|
*/
|
|
87
87
|
agentVersionWarning?: string | null;
|
|
88
|
+
/**
|
|
89
|
+
* Indicates whether the inventory was updated automatically by an agent or manually by a user
|
|
90
|
+
* @type {SourceUpdateTypeEnum}
|
|
91
|
+
* @memberof Source
|
|
92
|
+
*/
|
|
93
|
+
updateType?: SourceUpdateTypeEnum;
|
|
88
94
|
}
|
|
95
|
+
/**
|
|
96
|
+
* @export
|
|
97
|
+
*/
|
|
98
|
+
export declare const SourceUpdateTypeEnum: {
|
|
99
|
+
readonly Auto: "auto";
|
|
100
|
+
readonly Manual: "manual";
|
|
101
|
+
};
|
|
102
|
+
export type SourceUpdateTypeEnum = typeof SourceUpdateTypeEnum[keyof typeof SourceUpdateTypeEnum];
|
|
89
103
|
/**
|
|
90
104
|
* Check if a given object implements the Source interface.
|
|
91
105
|
*/
|
package/dist/models/Source.js
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SourceUpdateTypeEnum = void 0;
|
|
16
17
|
exports.instanceOfSource = instanceOfSource;
|
|
17
18
|
exports.SourceFromJSON = SourceFromJSON;
|
|
18
19
|
exports.SourceFromJSONTyped = SourceFromJSONTyped;
|
|
@@ -22,6 +23,13 @@ const SourceInfra_js_1 = require("./SourceInfra.js");
|
|
|
22
23
|
const Agent_js_1 = require("./Agent.js");
|
|
23
24
|
const Label_js_1 = require("./Label.js");
|
|
24
25
|
const Inventory_js_1 = require("./Inventory.js");
|
|
26
|
+
/**
|
|
27
|
+
* @export
|
|
28
|
+
*/
|
|
29
|
+
exports.SourceUpdateTypeEnum = {
|
|
30
|
+
Auto: 'auto',
|
|
31
|
+
Manual: 'manual'
|
|
32
|
+
};
|
|
25
33
|
/**
|
|
26
34
|
* Check if a given object implements the Source interface.
|
|
27
35
|
*/
|
|
@@ -57,6 +65,7 @@ function SourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
57
65
|
'infra': json['infra'] == null ? undefined : (0, SourceInfra_js_1.SourceInfraFromJSON)(json['infra']),
|
|
58
66
|
'agentVersion': json['agentVersion'] == null ? undefined : json['agentVersion'],
|
|
59
67
|
'agentVersionWarning': json['agentVersionWarning'] == null ? undefined : json['agentVersionWarning'],
|
|
68
|
+
'updateType': json['updateType'] == null ? undefined : json['updateType'],
|
|
60
69
|
};
|
|
61
70
|
}
|
|
62
71
|
function SourceToJSON(json) {
|
|
@@ -78,5 +87,6 @@ function SourceToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
78
87
|
'infra': (0, SourceInfra_js_1.SourceInfraToJSON)(value['infra']),
|
|
79
88
|
'agentVersion': value['agentVersion'],
|
|
80
89
|
'agentVersionWarning': value['agentVersionWarning'],
|
|
90
|
+
'updateType': value['updateType'],
|
|
81
91
|
};
|
|
82
92
|
}
|
|
@@ -95,6 +95,12 @@ export interface StandaloneClusterRequirementsRequest {
|
|
|
95
95
|
* @memberof StandaloneClusterRequirementsRequest
|
|
96
96
|
*/
|
|
97
97
|
hostedControlPlane?: boolean;
|
|
98
|
+
/**
|
|
99
|
+
* If true, creates a 3-node compact cluster with no dedicated workers. Requires controlPlaneNodeCount=3 and controlPlaneSchedulable=true. Incompatible with hostedControlPlane=true
|
|
100
|
+
* @type {boolean}
|
|
101
|
+
* @memberof StandaloneClusterRequirementsRequest
|
|
102
|
+
*/
|
|
103
|
+
compactMode?: boolean;
|
|
98
104
|
}
|
|
99
105
|
/**
|
|
100
106
|
* @export
|
|
@@ -69,6 +69,7 @@ function StandaloneClusterRequirementsRequestFromJSONTyped(json, ignoreDiscrimin
|
|
|
69
69
|
'controlPlaneMemory': json['controlPlaneMemory'] == null ? undefined : json['controlPlaneMemory'],
|
|
70
70
|
'controlPlaneNodeCount': json['controlPlaneNodeCount'] == null ? undefined : json['controlPlaneNodeCount'],
|
|
71
71
|
'hostedControlPlane': json['hostedControlPlane'] == null ? undefined : json['hostedControlPlane'],
|
|
72
|
+
'compactMode': json['compactMode'] == null ? undefined : json['compactMode'],
|
|
72
73
|
};
|
|
73
74
|
}
|
|
74
75
|
function StandaloneClusterRequirementsRequestToJSON(json) {
|
|
@@ -92,5 +93,6 @@ function StandaloneClusterRequirementsRequestToJSONTyped(value, ignoreDiscrimina
|
|
|
92
93
|
'controlPlaneMemory': value['controlPlaneMemory'],
|
|
93
94
|
'controlPlaneNodeCount': value['controlPlaneNodeCount'],
|
|
94
95
|
'hostedControlPlane': value['hostedControlPlane'],
|
|
96
|
+
'compactMode': value['compactMode'],
|
|
95
97
|
};
|
|
96
98
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -47,6 +47,7 @@ export * from './MigrationEstimationResponse.js';
|
|
|
47
47
|
export * from './MigrationIssue.js';
|
|
48
48
|
export * from './ModelError.js';
|
|
49
49
|
export * from './Network.js';
|
|
50
|
+
export * from './OptimizationStatus.js';
|
|
50
51
|
export * from './OsDiskEstimationEntry.js';
|
|
51
52
|
export * from './OsInfo.js';
|
|
52
53
|
export * from './PartnerRequest.js';
|
|
@@ -55,6 +56,7 @@ export * from './PartnerRequestStatus.js';
|
|
|
55
56
|
export * from './PartnerRequestUpdate.js';
|
|
56
57
|
export * from './PartnerSummary.js';
|
|
57
58
|
export * from './PresignedUrl.js';
|
|
59
|
+
export * from './Savings.js';
|
|
58
60
|
export * from './SchemaEstimationResult.js';
|
|
59
61
|
export * from './SharingSubject.js';
|
|
60
62
|
export * from './SizingOverCommitRatio.js';
|
package/dist/models/index.js
CHANGED
|
@@ -65,6 +65,7 @@ __exportStar(require("./MigrationEstimationResponse.js"), exports);
|
|
|
65
65
|
__exportStar(require("./MigrationIssue.js"), exports);
|
|
66
66
|
__exportStar(require("./ModelError.js"), exports);
|
|
67
67
|
__exportStar(require("./Network.js"), exports);
|
|
68
|
+
__exportStar(require("./OptimizationStatus.js"), exports);
|
|
68
69
|
__exportStar(require("./OsDiskEstimationEntry.js"), exports);
|
|
69
70
|
__exportStar(require("./OsInfo.js"), exports);
|
|
70
71
|
__exportStar(require("./PartnerRequest.js"), exports);
|
|
@@ -73,6 +74,7 @@ __exportStar(require("./PartnerRequestStatus.js"), exports);
|
|
|
73
74
|
__exportStar(require("./PartnerRequestUpdate.js"), exports);
|
|
74
75
|
__exportStar(require("./PartnerSummary.js"), exports);
|
|
75
76
|
__exportStar(require("./PresignedUrl.js"), exports);
|
|
77
|
+
__exportStar(require("./Savings.js"), exports);
|
|
76
78
|
__exportStar(require("./SchemaEstimationResult.js"), exports);
|
|
77
79
|
__exportStar(require("./SharingSubject.js"), exports);
|
|
78
80
|
__exportStar(require("./SizingOverCommitRatio.js"), exports);
|
|
@@ -18,6 +18,7 @@ Name | Type
|
|
|
18
18
|
`controlPlaneMemory` | number
|
|
19
19
|
`controlPlaneNodeCount` | number
|
|
20
20
|
`hostedControlPlane` | boolean
|
|
21
|
+
`compactMode` | boolean
|
|
21
22
|
|
|
22
23
|
## Example
|
|
23
24
|
|
|
@@ -37,6 +38,7 @@ const example = {
|
|
|
37
38
|
"controlPlaneMemory": null,
|
|
38
39
|
"controlPlaneNodeCount": null,
|
|
39
40
|
"hostedControlPlane": null,
|
|
41
|
+
"compactMode": null,
|
|
40
42
|
} satisfies ClusterRequirementsRequest
|
|
41
43
|
|
|
42
44
|
console.log(example)
|
|
@@ -8,6 +8,9 @@ Cluster requirements calculation results
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`clusterSizing` | [ClusterSizing](ClusterSizing.md)
|
|
11
|
+
`optimizedSizing` | [ClusterSizing](ClusterSizing.md)
|
|
12
|
+
`savings` | [Savings](Savings.md)
|
|
13
|
+
`optimizationStatus` | [OptimizationStatus](OptimizationStatus.md)
|
|
11
14
|
`resourceConsumption` | [SizingResourceConsumption](SizingResourceConsumption.md)
|
|
12
15
|
`inventoryTotals` | [InventoryTotals](InventoryTotals.md)
|
|
13
16
|
|
|
@@ -19,6 +22,9 @@ import type { ClusterRequirementsResponse } from '@openshift-migration-advisor/p
|
|
|
19
22
|
// TODO: Update the object below with actual values
|
|
20
23
|
const example = {
|
|
21
24
|
"clusterSizing": null,
|
|
25
|
+
"optimizedSizing": null,
|
|
26
|
+
"savings": null,
|
|
27
|
+
"optimizationStatus": null,
|
|
22
28
|
"resourceConsumption": null,
|
|
23
29
|
"inventoryTotals": null,
|
|
24
30
|
} satisfies ClusterRequirementsResponse
|
|
@@ -18,6 +18,7 @@ Name | Type
|
|
|
18
18
|
`controlPlaneMemory` | number
|
|
19
19
|
`controlPlaneNodeCount` | number
|
|
20
20
|
`hostedControlPlane` | boolean
|
|
21
|
+
`compactMode` | boolean
|
|
21
22
|
|
|
22
23
|
## Example
|
|
23
24
|
|
|
@@ -37,6 +38,7 @@ const example = {
|
|
|
37
38
|
"controlPlaneMemory": null,
|
|
38
39
|
"controlPlaneNodeCount": null,
|
|
39
40
|
"hostedControlPlane": null,
|
|
41
|
+
"compactMode": null,
|
|
40
42
|
} satisfies ClusterRequirementsStoredInput
|
|
41
43
|
|
|
42
44
|
console.log(example)
|
package/docs/ClusterSizing.md
CHANGED
|
@@ -13,6 +13,9 @@ Name | Type
|
|
|
13
13
|
`failoverNodes` | number
|
|
14
14
|
`totalCPU` | number
|
|
15
15
|
`totalMemory` | number
|
|
16
|
+
`cpuUtilizationMax` | number
|
|
17
|
+
`memoryUtilizationMax` | number
|
|
18
|
+
`confidence` | number
|
|
16
19
|
|
|
17
20
|
## Example
|
|
18
21
|
|
|
@@ -27,6 +30,9 @@ const example = {
|
|
|
27
30
|
"failoverNodes": null,
|
|
28
31
|
"totalCPU": null,
|
|
29
32
|
"totalMemory": null,
|
|
33
|
+
"cpuUtilizationMax": null,
|
|
34
|
+
"memoryUtilizationMax": null,
|
|
35
|
+
"confidence": null,
|
|
30
36
|
} satisfies ClusterSizing
|
|
31
37
|
|
|
32
38
|
console.log(example)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# OptimizationStatus
|
|
3
|
+
|
|
4
|
+
Status of utilization-based optimization attempt
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`attempted` | boolean
|
|
11
|
+
`reason` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { OptimizationStatus } from '@openshift-migration-advisor/planner-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"attempted": null,
|
|
21
|
+
"reason": null,
|
|
22
|
+
} satisfies OptimizationStatus
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as OptimizationStatus
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|
package/docs/Savings.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# Savings
|
|
3
|
+
|
|
4
|
+
Infrastructure savings comparison
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`nodesSaved` | number
|
|
11
|
+
`percentageReduction` | number
|
|
12
|
+
`description` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { Savings } from '@openshift-migration-advisor/planner-sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"nodesSaved": null,
|
|
22
|
+
"percentageReduction": null,
|
|
23
|
+
"description": null,
|
|
24
|
+
} satisfies Savings
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as Savings
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
package/docs/Source.md
CHANGED
|
@@ -17,6 +17,7 @@ Name | Type
|
|
|
17
17
|
`infra` | [SourceInfra](SourceInfra.md)
|
|
18
18
|
`agentVersion` | string
|
|
19
19
|
`agentVersionWarning` | string
|
|
20
|
+
`updateType` | string
|
|
20
21
|
|
|
21
22
|
## Example
|
|
22
23
|
|
|
@@ -36,6 +37,7 @@ const example = {
|
|
|
36
37
|
"infra": null,
|
|
37
38
|
"agentVersion": null,
|
|
38
39
|
"agentVersionWarning": null,
|
|
40
|
+
"updateType": null,
|
|
39
41
|
} satisfies Source
|
|
40
42
|
|
|
41
43
|
console.log(example)
|
|
@@ -20,6 +20,7 @@ Name | Type
|
|
|
20
20
|
`controlPlaneMemory` | number
|
|
21
21
|
`controlPlaneNodeCount` | number
|
|
22
22
|
`hostedControlPlane` | boolean
|
|
23
|
+
`compactMode` | boolean
|
|
23
24
|
|
|
24
25
|
## Example
|
|
25
26
|
|
|
@@ -41,6 +42,7 @@ const example = {
|
|
|
41
42
|
"controlPlaneMemory": null,
|
|
42
43
|
"controlPlaneNodeCount": null,
|
|
43
44
|
"hostedControlPlane": null,
|
|
45
|
+
"compactMode": null,
|
|
44
46
|
} satisfies StandaloneClusterRequirementsRequest
|
|
45
47
|
|
|
46
48
|
console.log(example)
|