@openshift-migration-advisor/planner-sdk 0.13.3-391ade47acd8 → 0.13.3-4f3d8bb515ec

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.
Files changed (49) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/README.md +7 -2
  3. package/dist/apis/SizingApi.d.ts +61 -0
  4. package/dist/apis/SizingApi.js +74 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/esm/apis/SizingApi.d.ts +61 -0
  8. package/dist/esm/apis/SizingApi.js +70 -0
  9. package/dist/esm/apis/index.d.ts +1 -0
  10. package/dist/esm/apis/index.js +1 -0
  11. package/dist/esm/models/ClusterRequirementsRequest.d.ts +6 -23
  12. package/dist/esm/models/ClusterRequirementsRequest.js +6 -21
  13. package/dist/esm/models/CpuOverCommitRatio.d.ts +27 -0
  14. package/dist/esm/models/CpuOverCommitRatio.js +45 -0
  15. package/dist/esm/models/MemoryOverCommitRatio.d.ts +26 -0
  16. package/dist/esm/models/MemoryOverCommitRatio.js +44 -0
  17. package/dist/esm/models/StandaloneClusterRequirementsRequest.d.ts +114 -0
  18. package/dist/esm/models/StandaloneClusterRequirementsRequest.js +88 -0
  19. package/dist/esm/models/StandaloneClusterRequirementsResponse.d.ts +40 -0
  20. package/dist/esm/models/StandaloneClusterRequirementsResponse.js +49 -0
  21. package/dist/esm/models/index.d.ts +4 -0
  22. package/dist/esm/models/index.js +4 -0
  23. package/dist/models/ClusterRequirementsRequest.d.ts +6 -23
  24. package/dist/models/ClusterRequirementsRequest.js +7 -22
  25. package/dist/models/CpuOverCommitRatio.d.ts +27 -0
  26. package/dist/models/CpuOverCommitRatio.js +53 -0
  27. package/dist/models/MemoryOverCommitRatio.d.ts +26 -0
  28. package/dist/models/MemoryOverCommitRatio.js +52 -0
  29. package/dist/models/StandaloneClusterRequirementsRequest.d.ts +114 -0
  30. package/dist/models/StandaloneClusterRequirementsRequest.js +96 -0
  31. package/dist/models/StandaloneClusterRequirementsResponse.d.ts +40 -0
  32. package/dist/models/StandaloneClusterRequirementsResponse.js +56 -0
  33. package/dist/models/index.d.ts +4 -0
  34. package/dist/models/index.js +4 -0
  35. package/docs/ClusterRequirementsRequest.md +2 -2
  36. package/docs/CpuOverCommitRatio.md +33 -0
  37. package/docs/MemoryOverCommitRatio.md +33 -0
  38. package/docs/SizingApi.md +80 -0
  39. package/docs/StandaloneClusterRequirementsRequest.md +59 -0
  40. package/docs/StandaloneClusterRequirementsResponse.md +37 -0
  41. package/package.json +1 -1
  42. package/src/apis/SizingApi.ts +114 -0
  43. package/src/apis/index.ts +1 -0
  44. package/src/models/ClusterRequirementsRequest.ts +23 -29
  45. package/src/models/CpuOverCommitRatio.ts +55 -0
  46. package/src/models/MemoryOverCommitRatio.ts +54 -0
  47. package/src/models/StandaloneClusterRequirementsRequest.ts +194 -0
  48. package/src/models/StandaloneClusterRequirementsResponse.ts +90 -0
  49. package/src/models/index.ts +4 -0
@@ -0,0 +1,114 @@
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
+ import type { CpuOverCommitRatio } from './CpuOverCommitRatio.js';
13
+ import type { MemoryOverCommitRatio } from './MemoryOverCommitRatio.js';
14
+ /**
15
+ * Request payload for calculating cluster requirements with inline inventory data (no assessment required)
16
+ * @export
17
+ * @interface StandaloneClusterRequirementsRequest
18
+ */
19
+ export interface StandaloneClusterRequirementsRequest {
20
+ /**
21
+ * Total number of VMs to size for
22
+ * @type {number}
23
+ * @memberof StandaloneClusterRequirementsRequest
24
+ */
25
+ totalVMs: number;
26
+ /**
27
+ * Total CPU cores across all VMs
28
+ * @type {number}
29
+ * @memberof StandaloneClusterRequirementsRequest
30
+ */
31
+ totalCPU: number;
32
+ /**
33
+ * Total memory (GB) across all VMs
34
+ * @type {number}
35
+ * @memberof StandaloneClusterRequirementsRequest
36
+ */
37
+ totalMemory: number;
38
+ /**
39
+ * CPU over-commit ratio (e.g., "1:4")
40
+ * @type {CpuOverCommitRatio}
41
+ * @memberof StandaloneClusterRequirementsRequest
42
+ */
43
+ cpuOverCommitRatio: CpuOverCommitRatio;
44
+ /**
45
+ * Memory over-commit ratio (e.g., "1:2")
46
+ * @type {MemoryOverCommitRatio}
47
+ * @memberof StandaloneClusterRequirementsRequest
48
+ */
49
+ memoryOverCommitRatio: MemoryOverCommitRatio;
50
+ /**
51
+ * CPU cores per worker node
52
+ * @type {number}
53
+ * @memberof StandaloneClusterRequirementsRequest
54
+ */
55
+ workerNodeCPU: number;
56
+ /**
57
+ * Memory (GB) per worker node
58
+ * @type {number}
59
+ * @memberof StandaloneClusterRequirementsRequest
60
+ */
61
+ workerNodeMemory: number;
62
+ /**
63
+ * Number of CPU threads per worker node (for SMT calculation). If not provided, assumes no SMT (threads = cores). Must be >= workerNodeCPU
64
+ * @type {number}
65
+ * @memberof StandaloneClusterRequirementsRequest
66
+ */
67
+ workerNodeThreads?: number;
68
+ /**
69
+ * Allow workload scheduling on control plane nodes (default: false)
70
+ * @type {boolean}
71
+ * @memberof StandaloneClusterRequirementsRequest
72
+ */
73
+ controlPlaneSchedulable?: boolean;
74
+ /**
75
+ * CPU cores per control plane node (default: 6)
76
+ * @type {number}
77
+ * @memberof StandaloneClusterRequirementsRequest
78
+ */
79
+ controlPlaneCPU?: number;
80
+ /**
81
+ * Memory in GB per control plane node (default: 16)
82
+ * @type {number}
83
+ * @memberof StandaloneClusterRequirementsRequest
84
+ */
85
+ controlPlaneMemory?: number;
86
+ /**
87
+ * Number of control plane nodes: 1 or 3 (default: 3)
88
+ * @type {StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum}
89
+ * @memberof StandaloneClusterRequirementsRequest
90
+ */
91
+ controlPlaneNodeCount?: StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum;
92
+ /**
93
+ * If true, control plane is hosted externally. Incompatible with control plane fields (default: false)
94
+ * @type {boolean}
95
+ * @memberof StandaloneClusterRequirementsRequest
96
+ */
97
+ hostedControlPlane?: boolean;
98
+ }
99
+ /**
100
+ * @export
101
+ */
102
+ export declare const StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum: {
103
+ readonly NUMBER_1: 1;
104
+ readonly NUMBER_3: 3;
105
+ };
106
+ export type StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum = typeof StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum[keyof typeof StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum];
107
+ /**
108
+ * Check if a given object implements the StandaloneClusterRequirementsRequest interface.
109
+ */
110
+ export declare function instanceOfStandaloneClusterRequirementsRequest(value: object): value is StandaloneClusterRequirementsRequest;
111
+ export declare function StandaloneClusterRequirementsRequestFromJSON(json: any): StandaloneClusterRequirementsRequest;
112
+ export declare function StandaloneClusterRequirementsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): StandaloneClusterRequirementsRequest;
113
+ export declare function StandaloneClusterRequirementsRequestToJSON(json: any): StandaloneClusterRequirementsRequest;
114
+ export declare function StandaloneClusterRequirementsRequestToJSONTyped(value?: StandaloneClusterRequirementsRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,96 @@
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.StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum = void 0;
17
+ exports.instanceOfStandaloneClusterRequirementsRequest = instanceOfStandaloneClusterRequirementsRequest;
18
+ exports.StandaloneClusterRequirementsRequestFromJSON = StandaloneClusterRequirementsRequestFromJSON;
19
+ exports.StandaloneClusterRequirementsRequestFromJSONTyped = StandaloneClusterRequirementsRequestFromJSONTyped;
20
+ exports.StandaloneClusterRequirementsRequestToJSON = StandaloneClusterRequirementsRequestToJSON;
21
+ exports.StandaloneClusterRequirementsRequestToJSONTyped = StandaloneClusterRequirementsRequestToJSONTyped;
22
+ const CpuOverCommitRatio_js_1 = require("./CpuOverCommitRatio.js");
23
+ const MemoryOverCommitRatio_js_1 = require("./MemoryOverCommitRatio.js");
24
+ /**
25
+ * @export
26
+ */
27
+ exports.StandaloneClusterRequirementsRequestControlPlaneNodeCountEnum = {
28
+ NUMBER_1: 1,
29
+ NUMBER_3: 3
30
+ };
31
+ /**
32
+ * Check if a given object implements the StandaloneClusterRequirementsRequest interface.
33
+ */
34
+ function instanceOfStandaloneClusterRequirementsRequest(value) {
35
+ if (!('totalVMs' in value) || value['totalVMs'] === undefined)
36
+ return false;
37
+ if (!('totalCPU' in value) || value['totalCPU'] === undefined)
38
+ return false;
39
+ if (!('totalMemory' in value) || value['totalMemory'] === undefined)
40
+ return false;
41
+ if (!('cpuOverCommitRatio' in value) || value['cpuOverCommitRatio'] === undefined)
42
+ return false;
43
+ if (!('memoryOverCommitRatio' in value) || value['memoryOverCommitRatio'] === undefined)
44
+ return false;
45
+ if (!('workerNodeCPU' in value) || value['workerNodeCPU'] === undefined)
46
+ return false;
47
+ if (!('workerNodeMemory' in value) || value['workerNodeMemory'] === undefined)
48
+ return false;
49
+ return true;
50
+ }
51
+ function StandaloneClusterRequirementsRequestFromJSON(json) {
52
+ return StandaloneClusterRequirementsRequestFromJSONTyped(json, false);
53
+ }
54
+ function StandaloneClusterRequirementsRequestFromJSONTyped(json, ignoreDiscriminator) {
55
+ if (json == null) {
56
+ return json;
57
+ }
58
+ return {
59
+ 'totalVMs': json['totalVMs'],
60
+ 'totalCPU': json['totalCPU'],
61
+ 'totalMemory': json['totalMemory'],
62
+ 'cpuOverCommitRatio': (0, CpuOverCommitRatio_js_1.CpuOverCommitRatioFromJSON)(json['cpuOverCommitRatio']),
63
+ 'memoryOverCommitRatio': (0, MemoryOverCommitRatio_js_1.MemoryOverCommitRatioFromJSON)(json['memoryOverCommitRatio']),
64
+ 'workerNodeCPU': json['workerNodeCPU'],
65
+ 'workerNodeMemory': json['workerNodeMemory'],
66
+ 'workerNodeThreads': json['workerNodeThreads'] == null ? undefined : json['workerNodeThreads'],
67
+ 'controlPlaneSchedulable': json['controlPlaneSchedulable'] == null ? undefined : json['controlPlaneSchedulable'],
68
+ 'controlPlaneCPU': json['controlPlaneCPU'] == null ? undefined : json['controlPlaneCPU'],
69
+ 'controlPlaneMemory': json['controlPlaneMemory'] == null ? undefined : json['controlPlaneMemory'],
70
+ 'controlPlaneNodeCount': json['controlPlaneNodeCount'] == null ? undefined : json['controlPlaneNodeCount'],
71
+ 'hostedControlPlane': json['hostedControlPlane'] == null ? undefined : json['hostedControlPlane'],
72
+ };
73
+ }
74
+ function StandaloneClusterRequirementsRequestToJSON(json) {
75
+ return StandaloneClusterRequirementsRequestToJSONTyped(json, false);
76
+ }
77
+ function StandaloneClusterRequirementsRequestToJSONTyped(value, ignoreDiscriminator = false) {
78
+ if (value == null) {
79
+ return value;
80
+ }
81
+ return {
82
+ 'totalVMs': value['totalVMs'],
83
+ 'totalCPU': value['totalCPU'],
84
+ 'totalMemory': value['totalMemory'],
85
+ 'cpuOverCommitRatio': (0, CpuOverCommitRatio_js_1.CpuOverCommitRatioToJSON)(value['cpuOverCommitRatio']),
86
+ 'memoryOverCommitRatio': (0, MemoryOverCommitRatio_js_1.MemoryOverCommitRatioToJSON)(value['memoryOverCommitRatio']),
87
+ 'workerNodeCPU': value['workerNodeCPU'],
88
+ 'workerNodeMemory': value['workerNodeMemory'],
89
+ 'workerNodeThreads': value['workerNodeThreads'],
90
+ 'controlPlaneSchedulable': value['controlPlaneSchedulable'],
91
+ 'controlPlaneCPU': value['controlPlaneCPU'],
92
+ 'controlPlaneMemory': value['controlPlaneMemory'],
93
+ 'controlPlaneNodeCount': value['controlPlaneNodeCount'],
94
+ 'hostedControlPlane': value['hostedControlPlane'],
95
+ };
96
+ }
@@ -0,0 +1,40 @@
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
+ import type { SizingResourceConsumption } from './SizingResourceConsumption.js';
13
+ import type { ClusterSizing } from './ClusterSizing.js';
14
+ /**
15
+ * Sizing results; omits inventoryTotals (already in the request).
16
+ * @export
17
+ * @interface StandaloneClusterRequirementsResponse
18
+ */
19
+ export interface StandaloneClusterRequirementsResponse {
20
+ /**
21
+ *
22
+ * @type {ClusterSizing}
23
+ * @memberof StandaloneClusterRequirementsResponse
24
+ */
25
+ clusterSizing: ClusterSizing;
26
+ /**
27
+ *
28
+ * @type {SizingResourceConsumption}
29
+ * @memberof StandaloneClusterRequirementsResponse
30
+ */
31
+ resourceConsumption: SizingResourceConsumption;
32
+ }
33
+ /**
34
+ * Check if a given object implements the StandaloneClusterRequirementsResponse interface.
35
+ */
36
+ export declare function instanceOfStandaloneClusterRequirementsResponse(value: object): value is StandaloneClusterRequirementsResponse;
37
+ export declare function StandaloneClusterRequirementsResponseFromJSON(json: any): StandaloneClusterRequirementsResponse;
38
+ export declare function StandaloneClusterRequirementsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): StandaloneClusterRequirementsResponse;
39
+ export declare function StandaloneClusterRequirementsResponseToJSON(json: any): StandaloneClusterRequirementsResponse;
40
+ export declare function StandaloneClusterRequirementsResponseToJSONTyped(value?: StandaloneClusterRequirementsResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,56 @@
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.instanceOfStandaloneClusterRequirementsResponse = instanceOfStandaloneClusterRequirementsResponse;
17
+ exports.StandaloneClusterRequirementsResponseFromJSON = StandaloneClusterRequirementsResponseFromJSON;
18
+ exports.StandaloneClusterRequirementsResponseFromJSONTyped = StandaloneClusterRequirementsResponseFromJSONTyped;
19
+ exports.StandaloneClusterRequirementsResponseToJSON = StandaloneClusterRequirementsResponseToJSON;
20
+ exports.StandaloneClusterRequirementsResponseToJSONTyped = StandaloneClusterRequirementsResponseToJSONTyped;
21
+ const SizingResourceConsumption_js_1 = require("./SizingResourceConsumption.js");
22
+ const ClusterSizing_js_1 = require("./ClusterSizing.js");
23
+ /**
24
+ * Check if a given object implements the StandaloneClusterRequirementsResponse interface.
25
+ */
26
+ function instanceOfStandaloneClusterRequirementsResponse(value) {
27
+ if (!('clusterSizing' in value) || value['clusterSizing'] === undefined)
28
+ return false;
29
+ if (!('resourceConsumption' in value) || value['resourceConsumption'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ function StandaloneClusterRequirementsResponseFromJSON(json) {
34
+ return StandaloneClusterRequirementsResponseFromJSONTyped(json, false);
35
+ }
36
+ function StandaloneClusterRequirementsResponseFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'clusterSizing': (0, ClusterSizing_js_1.ClusterSizingFromJSON)(json['clusterSizing']),
42
+ 'resourceConsumption': (0, SizingResourceConsumption_js_1.SizingResourceConsumptionFromJSON)(json['resourceConsumption']),
43
+ };
44
+ }
45
+ function StandaloneClusterRequirementsResponseToJSON(json) {
46
+ return StandaloneClusterRequirementsResponseToJSONTyped(json, false);
47
+ }
48
+ function StandaloneClusterRequirementsResponseToJSONTyped(value, ignoreDiscriminator = false) {
49
+ if (value == null) {
50
+ return value;
51
+ }
52
+ return {
53
+ 'clusterSizing': (0, ClusterSizing_js_1.ClusterSizingToJSON)(value['clusterSizing']),
54
+ 'resourceConsumption': (0, SizingResourceConsumption_js_1.SizingResourceConsumptionToJSON)(value['resourceConsumption']),
55
+ };
56
+ }
@@ -12,6 +12,7 @@ export * from './ClusterSizing.js';
12
12
  export * from './ComplexityDiskScoreEntry.js';
13
13
  export * from './ComplexityOSNameEntry.js';
14
14
  export * from './ComplexityOSScoreEntry.js';
15
+ export * from './CpuOverCommitRatio.js';
15
16
  export * from './Customer.js';
16
17
  export * from './Datastore.js';
17
18
  export * from './DiskSizeTierSummary.js';
@@ -36,6 +37,7 @@ export * from './Label.js';
36
37
  export * from './Member.js';
37
38
  export * from './MemberCreate.js';
38
39
  export * from './MemberUpdate.js';
40
+ export * from './MemoryOverCommitRatio.js';
39
41
  export * from './MigrationComplexityRequest.js';
40
42
  export * from './MigrationComplexityResponse.js';
41
43
  export * from './MigrationEstimationByComplexityResponse.js';
@@ -62,6 +64,8 @@ export * from './Source.js';
62
64
  export * from './SourceCreate.js';
63
65
  export * from './SourceInfra.js';
64
66
  export * from './SourceUpdate.js';
67
+ export * from './StandaloneClusterRequirementsRequest.js';
68
+ export * from './StandaloneClusterRequirementsResponse.js';
65
69
  export * from './Status.js';
66
70
  export * from './UpdateInventory.js';
67
71
  export * from './VCenter.js';
@@ -30,6 +30,7 @@ __exportStar(require("./ClusterSizing.js"), exports);
30
30
  __exportStar(require("./ComplexityDiskScoreEntry.js"), exports);
31
31
  __exportStar(require("./ComplexityOSNameEntry.js"), exports);
32
32
  __exportStar(require("./ComplexityOSScoreEntry.js"), exports);
33
+ __exportStar(require("./CpuOverCommitRatio.js"), exports);
33
34
  __exportStar(require("./Customer.js"), exports);
34
35
  __exportStar(require("./Datastore.js"), exports);
35
36
  __exportStar(require("./DiskSizeTierSummary.js"), exports);
@@ -54,6 +55,7 @@ __exportStar(require("./Label.js"), exports);
54
55
  __exportStar(require("./Member.js"), exports);
55
56
  __exportStar(require("./MemberCreate.js"), exports);
56
57
  __exportStar(require("./MemberUpdate.js"), exports);
58
+ __exportStar(require("./MemoryOverCommitRatio.js"), exports);
57
59
  __exportStar(require("./MigrationComplexityRequest.js"), exports);
58
60
  __exportStar(require("./MigrationComplexityResponse.js"), exports);
59
61
  __exportStar(require("./MigrationEstimationByComplexityResponse.js"), exports);
@@ -80,6 +82,8 @@ __exportStar(require("./Source.js"), exports);
80
82
  __exportStar(require("./SourceCreate.js"), exports);
81
83
  __exportStar(require("./SourceInfra.js"), exports);
82
84
  __exportStar(require("./SourceUpdate.js"), exports);
85
+ __exportStar(require("./StandaloneClusterRequirementsRequest.js"), exports);
86
+ __exportStar(require("./StandaloneClusterRequirementsResponse.js"), exports);
83
87
  __exportStar(require("./Status.js"), exports);
84
88
  __exportStar(require("./UpdateInventory.js"), exports);
85
89
  __exportStar(require("./VCenter.js"), exports);
@@ -8,8 +8,8 @@ Request payload for calculating cluster requirements
8
8
  Name | Type
9
9
  ------------ | -------------
10
10
  `clusterId` | string
11
- `cpuOverCommitRatio` | string
12
- `memoryOverCommitRatio` | string
11
+ `cpuOverCommitRatio` | [CpuOverCommitRatio](CpuOverCommitRatio.md)
12
+ `memoryOverCommitRatio` | [MemoryOverCommitRatio](MemoryOverCommitRatio.md)
13
13
  `workerNodeCPU` | number
14
14
  `workerNodeMemory` | number
15
15
  `workerNodeThreads` | number
@@ -0,0 +1,33 @@
1
+
2
+ # CpuOverCommitRatio
3
+
4
+ CPU over-commit ratio
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { CpuOverCommitRatio } from '@openshift-migration-advisor/planner-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ } satisfies CpuOverCommitRatio
19
+
20
+ console.log(example)
21
+
22
+ // Convert the instance to a JSON string
23
+ const exampleJSON: string = JSON.stringify(example)
24
+ console.log(exampleJSON)
25
+
26
+ // Parse the JSON string back to an object
27
+ const exampleParsed = JSON.parse(exampleJSON) as CpuOverCommitRatio
28
+ console.log(exampleParsed)
29
+ ```
30
+
31
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
32
+
33
+
@@ -0,0 +1,33 @@
1
+
2
+ # MemoryOverCommitRatio
3
+
4
+ Memory over-commit ratio
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { MemoryOverCommitRatio } from '@openshift-migration-advisor/planner-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ } satisfies MemoryOverCommitRatio
19
+
20
+ console.log(example)
21
+
22
+ // Convert the instance to a JSON string
23
+ const exampleJSON: string = JSON.stringify(example)
24
+ console.log(exampleJSON)
25
+
26
+ // Parse the JSON string back to an object
27
+ const exampleParsed = JSON.parse(exampleJSON) as MemoryOverCommitRatio
28
+ console.log(exampleParsed)
29
+ ```
30
+
31
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
32
+
33
+
@@ -0,0 +1,80 @@
1
+ # SizingApi
2
+
3
+ All URIs are relative to *https://raw.githubusercontent.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**calculateClusterRequirements**](SizingApi.md#calculateclusterrequirements) | **POST** /api/v1/cluster-requirements | |
8
+
9
+
10
+
11
+ ## calculateClusterRequirements
12
+
13
+ > StandaloneClusterRequirementsResponse calculateClusterRequirements(standaloneClusterRequirementsRequest)
14
+
15
+
16
+
17
+ Calculate cluster requirements for hypothetical workload with inline inventory data (no assessment required)
18
+
19
+ ### Example
20
+
21
+ ```ts
22
+ import {
23
+ Configuration,
24
+ SizingApi,
25
+ } from '@openshift-migration-advisor/planner-sdk';
26
+ import type { CalculateClusterRequirementsRequest } from '@openshift-migration-advisor/planner-sdk';
27
+
28
+ async function example() {
29
+ console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
30
+ const api = new SizingApi();
31
+
32
+ const body = {
33
+ // StandaloneClusterRequirementsRequest
34
+ standaloneClusterRequirementsRequest: {"totalVMs":100,"totalCPU":400,"totalMemory":800,"cpuOverCommitRatio":"1:4","memoryOverCommitRatio":"1:2","workerNodeCPU":16,"workerNodeMemory":64},
35
+ } satisfies CalculateClusterRequirementsRequest;
36
+
37
+ try {
38
+ const data = await api.calculateClusterRequirements(body);
39
+ console.log(data);
40
+ } catch (error) {
41
+ console.error(error);
42
+ }
43
+ }
44
+
45
+ // Run the test
46
+ example().catch(console.error);
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+
52
+ | Name | Type | Description | Notes |
53
+ |------------- | ------------- | ------------- | -------------|
54
+ | **standaloneClusterRequirementsRequest** | [StandaloneClusterRequirementsRequest](StandaloneClusterRequirementsRequest.md) | | |
55
+
56
+ ### Return type
57
+
58
+ [**StandaloneClusterRequirementsResponse**](StandaloneClusterRequirementsResponse.md)
59
+
60
+ ### Authorization
61
+
62
+ No authorization required
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: `application/json`
67
+ - **Accept**: `application/json`
68
+
69
+
70
+ ### HTTP response details
71
+ | Status code | Description | Response headers |
72
+ |-------------|-------------|------------------|
73
+ | **200** | Cluster requirements calculation successful | - |
74
+ | **400** | Bad Request | - |
75
+ | **401** | Unauthorized | - |
76
+ | **500** | Internal error | - |
77
+ | **503** | Service Unavailable | - |
78
+
79
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
80
+
@@ -0,0 +1,59 @@
1
+
2
+ # StandaloneClusterRequirementsRequest
3
+
4
+ Request payload for calculating cluster requirements with inline inventory data (no assessment required)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `totalVMs` | number
11
+ `totalCPU` | number
12
+ `totalMemory` | number
13
+ `cpuOverCommitRatio` | [CpuOverCommitRatio](CpuOverCommitRatio.md)
14
+ `memoryOverCommitRatio` | [MemoryOverCommitRatio](MemoryOverCommitRatio.md)
15
+ `workerNodeCPU` | number
16
+ `workerNodeMemory` | number
17
+ `workerNodeThreads` | number
18
+ `controlPlaneSchedulable` | boolean
19
+ `controlPlaneCPU` | number
20
+ `controlPlaneMemory` | number
21
+ `controlPlaneNodeCount` | number
22
+ `hostedControlPlane` | boolean
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import type { StandaloneClusterRequirementsRequest } from '@openshift-migration-advisor/planner-sdk'
28
+
29
+ // TODO: Update the object below with actual values
30
+ const example = {
31
+ "totalVMs": null,
32
+ "totalCPU": null,
33
+ "totalMemory": null,
34
+ "cpuOverCommitRatio": null,
35
+ "memoryOverCommitRatio": null,
36
+ "workerNodeCPU": null,
37
+ "workerNodeMemory": null,
38
+ "workerNodeThreads": null,
39
+ "controlPlaneSchedulable": null,
40
+ "controlPlaneCPU": null,
41
+ "controlPlaneMemory": null,
42
+ "controlPlaneNodeCount": null,
43
+ "hostedControlPlane": null,
44
+ } satisfies StandaloneClusterRequirementsRequest
45
+
46
+ console.log(example)
47
+
48
+ // Convert the instance to a JSON string
49
+ const exampleJSON: string = JSON.stringify(example)
50
+ console.log(exampleJSON)
51
+
52
+ // Parse the JSON string back to an object
53
+ const exampleParsed = JSON.parse(exampleJSON) as StandaloneClusterRequirementsRequest
54
+ console.log(exampleParsed)
55
+ ```
56
+
57
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
58
+
59
+
@@ -0,0 +1,37 @@
1
+
2
+ # StandaloneClusterRequirementsResponse
3
+
4
+ Sizing results; omits inventoryTotals (already in the request).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `clusterSizing` | [ClusterSizing](ClusterSizing.md)
11
+ `resourceConsumption` | [SizingResourceConsumption](SizingResourceConsumption.md)
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { StandaloneClusterRequirementsResponse } from '@openshift-migration-advisor/planner-sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "clusterSizing": null,
21
+ "resourceConsumption": null,
22
+ } satisfies StandaloneClusterRequirementsResponse
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 StandaloneClusterRequirementsResponse
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openshift-migration-advisor/planner-sdk",
3
- "version": "0.13.3-391ade47acd8",
3
+ "version": "0.13.3-4f3d8bb515ec",
4
4
  "description": "OpenAPI client for @openshift-migration-advisor/planner-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {