kb-cloud-client-typescript 0.0.0-support-instance-template-ops.20260920.800 → 0.0.0-support-instance-template-ops.20260920.851

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 (35) hide show
  1. package/dist/adminapi/models/component-item-create.d.ts +1 -1
  2. package/dist/adminapi/models/instance-template-create.d.ts +8 -0
  3. package/dist/adminapi/models/instance-template-create.d.ts.map +1 -1
  4. package/dist/adminapi/models/instance-template-overlay-field.d.ts +1 -0
  5. package/dist/adminapi/models/instance-template-overlay-field.d.ts.map +1 -1
  6. package/dist/adminapi/models/instance-template-overlay-field.js +2 -1
  7. package/dist/adminapi/models/instance-template-overlay-field.js.map +1 -1
  8. package/dist/adminapi/models/mode-component-instance-template.d.ts +3 -3
  9. package/dist/adminapi/models/ops-hscale.d.ts +1 -1
  10. package/dist/adminapi/models/ops-vscale.d.ts +1 -1
  11. package/dist/openapi/models/component-item-create.d.ts +1 -1
  12. package/dist/openapi/models/instance-template-create.d.ts +8 -0
  13. package/dist/openapi/models/instance-template-create.d.ts.map +1 -1
  14. package/dist/openapi/models/instance-template-overlay-field.d.ts +1 -0
  15. package/dist/openapi/models/instance-template-overlay-field.d.ts.map +1 -1
  16. package/dist/openapi/models/instance-template-overlay-field.js +2 -1
  17. package/dist/openapi/models/instance-template-overlay-field.js.map +1 -1
  18. package/dist/openapi/models/mode-component-instance-template.d.ts +3 -3
  19. package/dist/openapi/models/ops-hscale.d.ts +1 -1
  20. package/dist/openapi/models/ops-vscale.d.ts +1 -1
  21. package/package.json +1 -1
  22. package/src/adminapi/models/component-item-create.ts +1 -1
  23. package/src/adminapi/models/instance-template-create.ts +6 -0
  24. package/src/adminapi/models/instance-template-overlay-field.ts +2 -1
  25. package/src/adminapi/models/mode-component-instance-template.ts +3 -3
  26. package/src/adminapi/models/ops-hscale.ts +1 -1
  27. package/src/adminapi/models/ops-vscale.ts +1 -1
  28. package/src/adminapi.yaml +18 -12
  29. package/src/openapi/models/component-item-create.ts +1 -1
  30. package/src/openapi/models/instance-template-create.ts +6 -0
  31. package/src/openapi/models/instance-template-overlay-field.ts +2 -1
  32. package/src/openapi/models/mode-component-instance-template.ts +3 -3
  33. package/src/openapi/models/ops-hscale.ts +1 -1
  34. package/src/openapi/models/ops-vscale.ts +1 -1
  35. package/src/openapi.yaml +18 -12
@@ -37,7 +37,7 @@ export interface ComponentItemCreate {
37
37
  */
38
38
  'replicas'?: number | null;
39
39
  /**
40
- * Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations). Node group is cluster-level and inherited by every component and template. Required when the engine option declares instanceTemplate. Names must match instanceTemplate.names exactly. classCode and volumes on the component are copied onto each template; the apiserver does not even-split replicas.
40
+ * Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations, labels). Node group is cluster-level and inherited. Required when the engine option declares instanceTemplate. Request instances replace the Helm chart instances list (or add the field if the chart has none). Names must be in instanceTemplate.names; they need not already exist on the chart. Component replicas must equal the sum of these replica counts.
41
41
  * @type {Array<InstanceTemplateCreate>}
42
42
  * @memberof ComponentItemCreate
43
43
  */
@@ -60,5 +60,13 @@ export interface InstanceTemplateCreate {
60
60
  'annotations'?: {
61
61
  [key: string]: string;
62
62
  };
63
+ /**
64
+ * Labels merged into this template (same-name keys overwritten).
65
+ * @type {{ [key: string]: string; }}
66
+ * @memberof InstanceTemplateCreate
67
+ */
68
+ 'labels'?: {
69
+ [key: string]: string;
70
+ };
63
71
  }
64
72
  //# sourceMappingURL=instance-template-create.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"instance-template-create.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/instance-template-create.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAC9C;;;;OAIG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;CAC9C"}
1
+ {"version":3,"file":"instance-template-create.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/instance-template-create.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAC9C;;;;OAIG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IAC3C;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;CACzC"}
@@ -20,6 +20,7 @@ export declare const InstanceTemplateOverlayField: {
20
20
  readonly availabilityZone: "availabilityZone";
21
21
  readonly env: "env";
22
22
  readonly annotations: "annotations";
23
+ readonly labels: "labels";
23
24
  };
24
25
  export type InstanceTemplateOverlayField = typeof InstanceTemplateOverlayField[keyof typeof InstanceTemplateOverlayField];
25
26
  //# sourceMappingURL=instance-template-overlay-field.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"instance-template-overlay-field.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,4BAA4B;;;;;;CAM/B,CAAC;AAEX,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC"}
1
+ {"version":3,"file":"instance-template-overlay-field.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,4BAA4B;;;;;;;CAO/B,CAAC;AAEX,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC"}
@@ -24,6 +24,7 @@ exports.InstanceTemplateOverlayField = {
24
24
  storageClass: 'storageClass',
25
25
  availabilityZone: 'availabilityZone',
26
26
  env: 'env',
27
- annotations: 'annotations'
27
+ annotations: 'annotations',
28
+ labels: 'labels'
28
29
  };
29
30
  //# sourceMappingURL=instance-template-overlay-field.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"instance-template-overlay-field.js","sourceRoot":"","sources":["../../../src/adminapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,4BAA4B,GAAG;IACxC,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,GAAG,EAAE,KAAK;IACV,WAAW,EAAE,aAAa;CACpB,CAAC"}
1
+ {"version":3,"file":"instance-template-overlay-field.js","sourceRoot":"","sources":["../../../src/adminapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,4BAA4B,GAAG;IACxC,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,GAAG,EAAE,KAAK;IACV,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;CACV,CAAC"}
@@ -13,13 +13,13 @@ import type { InstanceTemplateEnv } from './instance-template-env';
13
13
  import type { InstanceTemplateOp } from './instance-template-op';
14
14
  import type { InstanceTemplateOverlayField } from './instance-template-overlay-field';
15
15
  /**
16
- * Declares instance-template support for this mode component. Create requires instanceTemplates with name and replicas. HScale replica changes require instanceTemplates with name and replicas; shard-count changes use shards; they may be set together with instanceTemplates (KB ops fill both). VScale requires instanceTemplates with name and classCode; only those names are updated. The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations.
16
+ * Declares instance-template support for this mode component. Create requires instanceTemplates for every declared name; component replicas must equal the sum of those replica counts. HScale/vscale: if instanceTemplates names are set, KB ops include per-instance config; if omitted, only the component-level fields are set. The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations.
17
17
  * @export
18
18
  * @interface ModeComponentInstanceTemplate
19
19
  */
20
20
  export interface ModeComponentInstanceTemplate {
21
21
  /**
22
- * Declared instance template names. Request payloads may only use these names. Names must be unique.
22
+ * Allowed instance template names for create and ops payloads. Request names must be in this list. They need not already exist on the Helm-rendered Cluster; create replaces or adds spec.instances.
23
23
  * @type {Set<string>}
24
24
  * @memberof ModeComponentInstanceTemplate
25
25
  */
@@ -31,7 +31,7 @@ export interface ModeComponentInstanceTemplate {
31
31
  */
32
32
  'ops': Array<InstanceTemplateOp>;
33
33
  /**
34
- * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected.
34
+ * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected. Includes classCode, storageClass, availabilityZone, env, annotations, labels.
35
35
  * @type {Set<InstanceTemplateOverlayField>}
36
36
  * @memberof ModeComponentInstanceTemplate
37
37
  */
@@ -36,7 +36,7 @@ export interface OpsHScale {
36
36
  */
37
37
  'replicas'?: number | null;
38
38
  /**
39
- * Target replica count for one or more instance templates. Required for replica hscale when the engine option declares instanceTemplate with hscale. Works on sharding components (HorizontalScaling.componentName is the sharding name). Top-level replicas and shards do not override these counts; KB ops fill replicaChanges/shards and per-template instances together. Names must be unique and declared; unspecified templates are left unchanged.
39
+ * Target replica count for named instance templates. If set, KB ops include scaleIn/scaleOut.instances for those names; if omitted, component-level replicaChanges/shards are used with no Instances. Works on sharding components. Top-level replicas and shards do not override these counts. Names must be unique and declared.
40
40
  * @type {Array<InstanceTemplateReplicas>}
41
41
  * @memberof OpsHScale
42
42
  */
@@ -42,7 +42,7 @@ export interface OpsVScale {
42
42
  */
43
43
  'classCode'?: string;
44
44
  /**
45
- * Per-template classCode assignments. Required when the engine option declares instanceTemplate with vscale. Only these names are updated. Each item sets name and classCode independently. Top-level classCode does not replace these values.
45
+ * Per-template classCode assignments. If set, KB VerticalScaling includes instances[] for those names; if omitted, only component resources are set. Each item sets name and classCode independently. Top-level classCode does not replace these values.
46
46
  * @type {Array<InstanceTemplateVScale>}
47
47
  * @memberof OpsVScale
48
48
  */
@@ -37,7 +37,7 @@ export interface ComponentItemCreate {
37
37
  */
38
38
  'replicas'?: number | null;
39
39
  /**
40
- * Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations). Node group is cluster-level and inherited by every component and template. Required when the engine option declares instanceTemplate. Names must match instanceTemplate.names exactly. classCode and volumes on the component are copied onto each template; the apiserver does not even-split replicas.
40
+ * Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations, labels). Node group is cluster-level and inherited. Required when the engine option declares instanceTemplate. Request instances replace the Helm chart instances list (or add the field if the chart has none). Names must be in instanceTemplate.names; they need not already exist on the chart. Component replicas must equal the sum of these replica counts.
41
41
  * @type {Array<InstanceTemplateCreate>}
42
42
  * @memberof ComponentItemCreate
43
43
  */
@@ -60,5 +60,13 @@ export interface InstanceTemplateCreate {
60
60
  'annotations'?: {
61
61
  [key: string]: string;
62
62
  };
63
+ /**
64
+ * Labels merged into this template (same-name keys overwritten).
65
+ * @type {{ [key: string]: string; }}
66
+ * @memberof InstanceTemplateCreate
67
+ */
68
+ 'labels'?: {
69
+ [key: string]: string;
70
+ };
63
71
  }
64
72
  //# sourceMappingURL=instance-template-create.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"instance-template-create.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/instance-template-create.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAC9C;;;;OAIG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;CAC9C"}
1
+ {"version":3,"file":"instance-template-create.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/instance-template-create.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAC9C;;;;OAIG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IAC3C;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;CACzC"}
@@ -20,6 +20,7 @@ export declare const InstanceTemplateOverlayField: {
20
20
  readonly availabilityZone: "availabilityZone";
21
21
  readonly env: "env";
22
22
  readonly annotations: "annotations";
23
+ readonly labels: "labels";
23
24
  };
24
25
  export type InstanceTemplateOverlayField = typeof InstanceTemplateOverlayField[keyof typeof InstanceTemplateOverlayField];
25
26
  //# sourceMappingURL=instance-template-overlay-field.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"instance-template-overlay-field.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,4BAA4B;;;;;;CAM/B,CAAC;AAEX,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC"}
1
+ {"version":3,"file":"instance-template-overlay-field.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,4BAA4B;;;;;;;CAO/B,CAAC;AAEX,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC"}
@@ -24,6 +24,7 @@ exports.InstanceTemplateOverlayField = {
24
24
  storageClass: 'storageClass',
25
25
  availabilityZone: 'availabilityZone',
26
26
  env: 'env',
27
- annotations: 'annotations'
27
+ annotations: 'annotations',
28
+ labels: 'labels'
28
29
  };
29
30
  //# sourceMappingURL=instance-template-overlay-field.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"instance-template-overlay-field.js","sourceRoot":"","sources":["../../../src/openapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,4BAA4B,GAAG;IACxC,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,GAAG,EAAE,KAAK;IACV,WAAW,EAAE,aAAa;CACpB,CAAC"}
1
+ {"version":3,"file":"instance-template-overlay-field.js","sourceRoot":"","sources":["../../../src/openapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,4BAA4B,GAAG;IACxC,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,GAAG,EAAE,KAAK;IACV,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;CACV,CAAC"}
@@ -13,13 +13,13 @@ import type { InstanceTemplateEnv } from './instance-template-env';
13
13
  import type { InstanceTemplateOp } from './instance-template-op';
14
14
  import type { InstanceTemplateOverlayField } from './instance-template-overlay-field';
15
15
  /**
16
- * Declares instance-template support for this mode component. Create requires instanceTemplates with name and replicas. HScale replica changes require instanceTemplates with name and replicas; shard-count changes use shards; they may be set together with instanceTemplates (KB ops fill both). VScale requires instanceTemplates with name and classCode; only those names are updated. The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations.
16
+ * Declares instance-template support for this mode component. Create requires instanceTemplates for every declared name; component replicas must equal the sum of those replica counts. HScale/vscale: if instanceTemplates names are set, KB ops include per-instance config; if omitted, only the component-level fields are set. The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations.
17
17
  * @export
18
18
  * @interface ModeComponentInstanceTemplate
19
19
  */
20
20
  export interface ModeComponentInstanceTemplate {
21
21
  /**
22
- * Declared instance template names. Request payloads may only use these names. Names must be unique.
22
+ * Allowed instance template names for create and ops payloads. Request names must be in this list. They need not already exist on the Helm-rendered Cluster; create replaces or adds spec.instances.
23
23
  * @type {Set<string>}
24
24
  * @memberof ModeComponentInstanceTemplate
25
25
  */
@@ -31,7 +31,7 @@ export interface ModeComponentInstanceTemplate {
31
31
  */
32
32
  'ops': Array<InstanceTemplateOp>;
33
33
  /**
34
- * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected.
34
+ * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected. Includes classCode, storageClass, availabilityZone, env, annotations, labels.
35
35
  * @type {Set<InstanceTemplateOverlayField>}
36
36
  * @memberof ModeComponentInstanceTemplate
37
37
  */
@@ -36,7 +36,7 @@ export interface OpsHScale {
36
36
  */
37
37
  'replicas'?: number | null;
38
38
  /**
39
- * Target replica count for one or more instance templates. Required for replica hscale when the engine option declares instanceTemplate with hscale. Works on sharding components (HorizontalScaling.componentName is the sharding name). Top-level replicas and shards do not override these counts; KB ops fill replicaChanges/shards and per-template instances together. Names must be unique and declared; unspecified templates are left unchanged.
39
+ * Target replica count for named instance templates. If set, KB ops include scaleIn/scaleOut.instances for those names; if omitted, component-level replicaChanges/shards are used with no Instances. Works on sharding components. Top-level replicas and shards do not override these counts. Names must be unique and declared.
40
40
  * @type {Array<InstanceTemplateReplicas>}
41
41
  * @memberof OpsHScale
42
42
  */
@@ -42,7 +42,7 @@ export interface OpsVScale {
42
42
  */
43
43
  'classCode'?: string;
44
44
  /**
45
- * Per-template classCode assignments. Required when the engine option declares instanceTemplate with vscale. Only these names are updated. Each item sets name and classCode independently. Top-level classCode does not replace these values.
45
+ * Per-template classCode assignments. If set, KB VerticalScaling includes instances[] for those names; if omitted, only component resources are set. Each item sets name and classCode independently. Top-level classCode does not replace these values.
46
46
  * @type {Array<InstanceTemplateVScale>}
47
47
  * @memberof OpsVScale
48
48
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kb-cloud-client-typescript",
3
- "version": "0.0.0-support-instance-template-ops.20260920.800",
3
+ "version": "0.0.0-support-instance-template-ops.20260920.851",
4
4
  "description": "Auto-generated TypeScript SDK for KubeBlocks Cloud API",
5
5
  "private": false,
6
6
  "license": "Apache-2.0",
@@ -48,7 +48,7 @@ export interface ComponentItemCreate {
48
48
  */
49
49
  'replicas'?: number | null;
50
50
  /**
51
- * Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations). Node group is cluster-level and inherited by every component and template. Required when the engine option declares instanceTemplate. Names must match instanceTemplate.names exactly. classCode and volumes on the component are copied onto each template; the apiserver does not even-split replicas.
51
+ * Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations, labels). Node group is cluster-level and inherited. Required when the engine option declares instanceTemplate. Request instances replace the Helm chart instances list (or add the field if the chart has none). Names must be in instanceTemplate.names; they need not already exist on the chart. Component replicas must equal the sum of these replica counts.
52
52
  * @type {Array<InstanceTemplateCreate>}
53
53
  * @memberof ComponentItemCreate
54
54
  */
@@ -65,5 +65,11 @@ export interface InstanceTemplateCreate {
65
65
  * @memberof InstanceTemplateCreate
66
66
  */
67
67
  'annotations'?: { [key: string]: string; };
68
+ /**
69
+ * Labels merged into this template (same-name keys overwritten).
70
+ * @type {{ [key: string]: string; }}
71
+ * @memberof InstanceTemplateCreate
72
+ */
73
+ 'labels'?: { [key: string]: string; };
68
74
  }
69
75
 
@@ -25,7 +25,8 @@ export const InstanceTemplateOverlayField = {
25
25
  storageClass: 'storageClass',
26
26
  availabilityZone: 'availabilityZone',
27
27
  env: 'env',
28
- annotations: 'annotations'
28
+ annotations: 'annotations',
29
+ labels: 'labels'
29
30
  } as const;
30
31
 
31
32
  export type InstanceTemplateOverlayField = typeof InstanceTemplateOverlayField[keyof typeof InstanceTemplateOverlayField];
@@ -24,13 +24,13 @@ import type { InstanceTemplateOp } from './instance-template-op';
24
24
  import type { InstanceTemplateOverlayField } from './instance-template-overlay-field';
25
25
 
26
26
  /**
27
- * Declares instance-template support for this mode component. Create requires instanceTemplates with name and replicas. HScale replica changes require instanceTemplates with name and replicas; shard-count changes use shards; they may be set together with instanceTemplates (KB ops fill both). VScale requires instanceTemplates with name and classCode; only those names are updated. The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations.
27
+ * Declares instance-template support for this mode component. Create requires instanceTemplates for every declared name; component replicas must equal the sum of those replica counts. HScale/vscale: if instanceTemplates names are set, KB ops include per-instance config; if omitted, only the component-level fields are set. The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations.
28
28
  * @export
29
29
  * @interface ModeComponentInstanceTemplate
30
30
  */
31
31
  export interface ModeComponentInstanceTemplate {
32
32
  /**
33
- * Declared instance template names. Request payloads may only use these names. Names must be unique.
33
+ * Allowed instance template names for create and ops payloads. Request names must be in this list. They need not already exist on the Helm-rendered Cluster; create replaces or adds spec.instances.
34
34
  * @type {Set<string>}
35
35
  * @memberof ModeComponentInstanceTemplate
36
36
  */
@@ -42,7 +42,7 @@ export interface ModeComponentInstanceTemplate {
42
42
  */
43
43
  'ops': Array<InstanceTemplateOp>;
44
44
  /**
45
- * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected.
45
+ * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected. Includes classCode, storageClass, availabilityZone, env, annotations, labels.
46
46
  * @type {Set<InstanceTemplateOverlayField>}
47
47
  * @memberof ModeComponentInstanceTemplate
48
48
  */
@@ -45,7 +45,7 @@ export interface OpsHScale {
45
45
  */
46
46
  'replicas'?: number | null;
47
47
  /**
48
- * Target replica count for one or more instance templates. Required for replica hscale when the engine option declares instanceTemplate with hscale. Works on sharding components (HorizontalScaling.componentName is the sharding name). Top-level replicas and shards do not override these counts; KB ops fill replicaChanges/shards and per-template instances together. Names must be unique and declared; unspecified templates are left unchanged.
48
+ * Target replica count for named instance templates. If set, KB ops include scaleIn/scaleOut.instances for those names; if omitted, component-level replicaChanges/shards are used with no Instances. Works on sharding components. Top-level replicas and shards do not override these counts. Names must be unique and declared.
49
49
  * @type {Array<InstanceTemplateReplicas>}
50
50
  * @memberof OpsHScale
51
51
  */
@@ -51,7 +51,7 @@ export interface OpsVScale {
51
51
  */
52
52
  'classCode'?: string;
53
53
  /**
54
- * Per-template classCode assignments. Required when the engine option declares instanceTemplate with vscale. Only these names are updated. Each item sets name and classCode independently. Top-level classCode does not replace these values.
54
+ * Per-template classCode assignments. If set, KB VerticalScaling includes instances[] for those names; if omitted, only component resources are set. Each item sets name and classCode independently. Top-level classCode does not replace these values.
55
55
  * @type {Array<InstanceTemplateVScale>}
56
56
  * @memberof OpsVScale
57
57
  */
package/src/adminapi.yaml CHANGED
@@ -28989,6 +28989,11 @@ components:
28989
28989
  additionalProperties:
28990
28990
  type: string
28991
28991
  description: Annotations merged into this template (same-name keys overwritten).
28992
+ labels:
28993
+ type: object
28994
+ additionalProperties:
28995
+ type: string
28996
+ description: Labels merged into this template (same-name keys overwritten).
28992
28997
  ioQuantity:
28993
28998
  description: IO Quantity describes IOPS and BPS of a volume
28994
28999
  properties:
@@ -29076,7 +29081,7 @@ components:
29076
29081
  instanceTemplates:
29077
29082
  type: array
29078
29083
  minItems: 1
29079
- description: Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations). Node group is cluster-level and inherited by every component and template. Required when the engine option declares instanceTemplate. Names must match instanceTemplate.names exactly. classCode and volumes on the component are copied onto each template; the apiserver does not even-split replicas.
29084
+ description: Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations, labels). Node group is cluster-level and inherited. Required when the engine option declares instanceTemplate. Request instances replace the Helm chart instances list (or add the field if the chart has none). Names must be in instanceTemplate.names; they need not already exist on the chart. Component replicas must equal the sum of these replica counts.
29080
29085
  items:
29081
29086
  $ref: '#/components/schemas/instanceTemplateCreate'
29082
29087
  availabilityZone:
@@ -30487,7 +30492,7 @@ components:
30487
30492
  instanceTemplates:
30488
30493
  type: array
30489
30494
  minItems: 1
30490
- description: Target replica count for one or more instance templates. Required for replica hscale when the engine option declares instanceTemplate with hscale. Works on sharding components (HorizontalScaling.componentName is the sharding name). Top-level replicas and shards do not override these counts; KB ops fill replicaChanges/shards and per-template instances together. Names must be unique and declared; unspecified templates are left unchanged.
30495
+ description: Target replica count for named instance templates. If set, KB ops include scaleIn/scaleOut.instances for those names; if omitted, component-level replicaChanges/shards are used with no Instances. Works on sharding components. Top-level replicas and shards do not override these counts. Names must be unique and declared.
30491
30496
  items:
30492
30497
  $ref: '#/components/schemas/instanceTemplateReplicas'
30493
30498
  onlineInstancesToOffline:
@@ -34555,7 +34560,7 @@ components:
34555
34560
  minItems: 1
34556
34561
  items:
34557
34562
  $ref: '#/components/schemas/instanceTemplateVScale'
34558
- description: Per-template classCode assignments. Required when the engine option declares instanceTemplate with vscale. Only these names are updated. Each item sets name and classCode independently. Top-level classCode does not replace these values.
34563
+ description: Per-template classCode assignments. If set, KB VerticalScaling includes instances[] for those names; if omitted, only component resources are set. Each item sets name and classCode independently. Top-level classCode does not replace these values.
34559
34564
  nullable: true
34560
34565
  schedule:
34561
34566
  $ref: '#/components/schemas/taskSchedule'
@@ -38248,6 +38253,7 @@ components:
38248
38253
  - availabilityZone
38249
38254
  - env
38250
38255
  - annotations
38256
+ - labels
38251
38257
  instanceTemplateEnv:
38252
38258
  type: object
38253
38259
  description: One fillable env var on an instance template, for frontend rendering.
@@ -38293,12 +38299,10 @@ components:
38293
38299
  type: object
38294
38300
  description: |
38295
38301
  Declares instance-template support for this mode component.
38296
- Create requires instanceTemplates with name and replicas.
38297
- HScale replica changes require instanceTemplates with name and replicas;
38298
- shard-count changes use shards; they may be set together with
38299
- instanceTemplates (KB ops fill both).
38300
- VScale requires instanceTemplates with name and classCode;
38301
- only those names are updated.
38302
+ Create requires instanceTemplates for every declared name; component
38303
+ replicas must equal the sum of those replica counts.
38304
+ HScale/vscale: if instanceTemplates names are set, KB ops include
38305
+ per-instance config; if omitted, only the component-level fields are set.
38302
38306
  The platform does not even-split or fill in missing templates.
38303
38307
  Instance online/offline can be set together with instanceTemplates.
38304
38308
  When absent, the component uses component-level operations.
@@ -38313,8 +38317,9 @@ components:
38313
38317
  items:
38314
38318
  type: string
38315
38319
  description: |
38316
- Declared instance template names. Request payloads may only use
38317
- these names. Names must be unique.
38320
+ Allowed instance template names for create and ops payloads.
38321
+ Request names must be in this list. They need not already exist
38322
+ on the Helm-rendered Cluster; create replaces or adds spec.instances.
38318
38323
  ops:
38319
38324
  type: array
38320
38325
  minItems: 1
@@ -38331,7 +38336,8 @@ components:
38331
38336
  description: |
38332
38337
  Overlay fields the frontend should render on each instance template.
38333
38338
  Omitted or empty means only name and replicas. Request fields not
38334
- listed here are rejected.
38339
+ listed here are rejected. Includes classCode, storageClass,
38340
+ availabilityZone, env, annotations, labels.
38335
38341
  env:
38336
38342
  type: array
38337
38343
  description: |
@@ -48,7 +48,7 @@ export interface ComponentItemCreate {
48
48
  */
49
49
  'replicas'?: number | null;
50
50
  /**
51
- * Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations). Node group is cluster-level and inherited by every component and template. Required when the engine option declares instanceTemplate. Names must match instanceTemplate.names exactly. classCode and volumes on the component are copied onto each template; the apiserver does not even-split replicas.
51
+ * Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations, labels). Node group is cluster-level and inherited. Required when the engine option declares instanceTemplate. Request instances replace the Helm chart instances list (or add the field if the chart has none). Names must be in instanceTemplate.names; they need not already exist on the chart. Component replicas must equal the sum of these replica counts.
52
52
  * @type {Array<InstanceTemplateCreate>}
53
53
  * @memberof ComponentItemCreate
54
54
  */
@@ -65,5 +65,11 @@ export interface InstanceTemplateCreate {
65
65
  * @memberof InstanceTemplateCreate
66
66
  */
67
67
  'annotations'?: { [key: string]: string; };
68
+ /**
69
+ * Labels merged into this template (same-name keys overwritten).
70
+ * @type {{ [key: string]: string; }}
71
+ * @memberof InstanceTemplateCreate
72
+ */
73
+ 'labels'?: { [key: string]: string; };
68
74
  }
69
75
 
@@ -25,7 +25,8 @@ export const InstanceTemplateOverlayField = {
25
25
  storageClass: 'storageClass',
26
26
  availabilityZone: 'availabilityZone',
27
27
  env: 'env',
28
- annotations: 'annotations'
28
+ annotations: 'annotations',
29
+ labels: 'labels'
29
30
  } as const;
30
31
 
31
32
  export type InstanceTemplateOverlayField = typeof InstanceTemplateOverlayField[keyof typeof InstanceTemplateOverlayField];
@@ -24,13 +24,13 @@ import type { InstanceTemplateOp } from './instance-template-op';
24
24
  import type { InstanceTemplateOverlayField } from './instance-template-overlay-field';
25
25
 
26
26
  /**
27
- * Declares instance-template support for this mode component. Create requires instanceTemplates with name and replicas. HScale replica changes require instanceTemplates with name and replicas; shard-count changes use shards; they may be set together with instanceTemplates (KB ops fill both). VScale requires instanceTemplates with name and classCode; only those names are updated. The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations.
27
+ * Declares instance-template support for this mode component. Create requires instanceTemplates for every declared name; component replicas must equal the sum of those replica counts. HScale/vscale: if instanceTemplates names are set, KB ops include per-instance config; if omitted, only the component-level fields are set. The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations.
28
28
  * @export
29
29
  * @interface ModeComponentInstanceTemplate
30
30
  */
31
31
  export interface ModeComponentInstanceTemplate {
32
32
  /**
33
- * Declared instance template names. Request payloads may only use these names. Names must be unique.
33
+ * Allowed instance template names for create and ops payloads. Request names must be in this list. They need not already exist on the Helm-rendered Cluster; create replaces or adds spec.instances.
34
34
  * @type {Set<string>}
35
35
  * @memberof ModeComponentInstanceTemplate
36
36
  */
@@ -42,7 +42,7 @@ export interface ModeComponentInstanceTemplate {
42
42
  */
43
43
  'ops': Array<InstanceTemplateOp>;
44
44
  /**
45
- * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected.
45
+ * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected. Includes classCode, storageClass, availabilityZone, env, annotations, labels.
46
46
  * @type {Set<InstanceTemplateOverlayField>}
47
47
  * @memberof ModeComponentInstanceTemplate
48
48
  */
@@ -45,7 +45,7 @@ export interface OpsHScale {
45
45
  */
46
46
  'replicas'?: number | null;
47
47
  /**
48
- * Target replica count for one or more instance templates. Required for replica hscale when the engine option declares instanceTemplate with hscale. Works on sharding components (HorizontalScaling.componentName is the sharding name). Top-level replicas and shards do not override these counts; KB ops fill replicaChanges/shards and per-template instances together. Names must be unique and declared; unspecified templates are left unchanged.
48
+ * Target replica count for named instance templates. If set, KB ops include scaleIn/scaleOut.instances for those names; if omitted, component-level replicaChanges/shards are used with no Instances. Works on sharding components. Top-level replicas and shards do not override these counts. Names must be unique and declared.
49
49
  * @type {Array<InstanceTemplateReplicas>}
50
50
  * @memberof OpsHScale
51
51
  */
@@ -51,7 +51,7 @@ export interface OpsVScale {
51
51
  */
52
52
  'classCode'?: string;
53
53
  /**
54
- * Per-template classCode assignments. Required when the engine option declares instanceTemplate with vscale. Only these names are updated. Each item sets name and classCode independently. Top-level classCode does not replace these values.
54
+ * Per-template classCode assignments. If set, KB VerticalScaling includes instances[] for those names; if omitted, only component resources are set. Each item sets name and classCode independently. Top-level classCode does not replace these values.
55
55
  * @type {Array<InstanceTemplateVScale>}
56
56
  * @memberof OpsVScale
57
57
  */
package/src/openapi.yaml CHANGED
@@ -24651,6 +24651,11 @@ components:
24651
24651
  additionalProperties:
24652
24652
  type: string
24653
24653
  description: Annotations merged into this template (same-name keys overwritten).
24654
+ labels:
24655
+ type: object
24656
+ additionalProperties:
24657
+ type: string
24658
+ description: Labels merged into this template (same-name keys overwritten).
24654
24659
  ioQuantity:
24655
24660
  description: IO Quantity describes IOPS and BPS of a volume
24656
24661
  properties:
@@ -24733,7 +24738,7 @@ components:
24733
24738
  instanceTemplates:
24734
24739
  type: array
24735
24740
  minItems: 1
24736
- description: Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations). Node group is cluster-level and inherited by every component and template. Required when the engine option declares instanceTemplate. Names must match instanceTemplate.names exactly. classCode and volumes on the component are copied onto each template; the apiserver does not even-split replicas.
24741
+ description: Per-template replicas and optional overlays (classCode, storageClass, availabilityZone, env, annotations, labels). Node group is cluster-level and inherited. Required when the engine option declares instanceTemplate. Request instances replace the Helm chart instances list (or add the field if the chart has none). Names must be in instanceTemplate.names; they need not already exist on the chart. Component replicas must equal the sum of these replica counts.
24737
24742
  items:
24738
24743
  $ref: '#/components/schemas/instanceTemplateCreate'
24739
24744
  availabilityZone:
@@ -25677,7 +25682,7 @@ components:
25677
25682
  instanceTemplates:
25678
25683
  type: array
25679
25684
  minItems: 1
25680
- description: Target replica count for one or more instance templates. Required for replica hscale when the engine option declares instanceTemplate with hscale. Works on sharding components (HorizontalScaling.componentName is the sharding name). Top-level replicas and shards do not override these counts; KB ops fill replicaChanges/shards and per-template instances together. Names must be unique and declared; unspecified templates are left unchanged.
25685
+ description: Target replica count for named instance templates. If set, KB ops include scaleIn/scaleOut.instances for those names; if omitted, component-level replicaChanges/shards are used with no Instances. Works on sharding components. Top-level replicas and shards do not override these counts. Names must be unique and declared.
25681
25686
  items:
25682
25687
  $ref: '#/components/schemas/instanceTemplateReplicas'
25683
25688
  onlineInstancesToOffline:
@@ -26663,7 +26668,7 @@ components:
26663
26668
  minItems: 1
26664
26669
  items:
26665
26670
  $ref: '#/components/schemas/instanceTemplateVScale'
26666
- description: Per-template classCode assignments. Required when the engine option declares instanceTemplate with vscale. Only these names are updated. Each item sets name and classCode independently. Top-level classCode does not replace these values.
26671
+ description: Per-template classCode assignments. If set, KB VerticalScaling includes instances[] for those names; if omitted, only component resources are set. Each item sets name and classCode independently. Top-level classCode does not replace these values.
26667
26672
  nullable: true
26668
26673
  schedule:
26669
26674
  $ref: '#/components/schemas/taskSchedule'
@@ -31869,6 +31874,7 @@ components:
31869
31874
  - availabilityZone
31870
31875
  - env
31871
31876
  - annotations
31877
+ - labels
31872
31878
  instanceTemplateEnv:
31873
31879
  type: object
31874
31880
  description: One fillable env var on an instance template, for frontend rendering.
@@ -31914,12 +31920,10 @@ components:
31914
31920
  type: object
31915
31921
  description: |
31916
31922
  Declares instance-template support for this mode component.
31917
- Create requires instanceTemplates with name and replicas.
31918
- HScale replica changes require instanceTemplates with name and replicas;
31919
- shard-count changes use shards; they may be set together with
31920
- instanceTemplates (KB ops fill both).
31921
- VScale requires instanceTemplates with name and classCode;
31922
- only those names are updated.
31923
+ Create requires instanceTemplates for every declared name; component
31924
+ replicas must equal the sum of those replica counts.
31925
+ HScale/vscale: if instanceTemplates names are set, KB ops include
31926
+ per-instance config; if omitted, only the component-level fields are set.
31923
31927
  The platform does not even-split or fill in missing templates.
31924
31928
  Instance online/offline can be set together with instanceTemplates.
31925
31929
  When absent, the component uses component-level operations.
@@ -31934,8 +31938,9 @@ components:
31934
31938
  items:
31935
31939
  type: string
31936
31940
  description: |
31937
- Declared instance template names. Request payloads may only use
31938
- these names. Names must be unique.
31941
+ Allowed instance template names for create and ops payloads.
31942
+ Request names must be in this list. They need not already exist
31943
+ on the Helm-rendered Cluster; create replaces or adds spec.instances.
31939
31944
  ops:
31940
31945
  type: array
31941
31946
  minItems: 1
@@ -31952,7 +31957,8 @@ components:
31952
31957
  description: |
31953
31958
  Overlay fields the frontend should render on each instance template.
31954
31959
  Omitted or empty means only name and replicas. Request fields not
31955
- listed here are rejected.
31960
+ listed here are rejected. Includes classCode, storageClass,
31961
+ availabilityZone, env, annotations, labels.
31956
31962
  env:
31957
31963
  type: array
31958
31964
  description: |