kb-cloud-client-typescript 2.4.0-alpha.66 → 2.4.0-alpha.67

package/src/adminapi/models/instance-template-env.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { LocalizedDescription } from './localized-description';
+
+/**
+ * One fillable env var on an instance template, for frontend rendering.
+ * @export
+ * @interface InstanceTemplateEnv
+ */
+export interface InstanceTemplateEnv {
+    /**
+     * Env var name written to the instance template.
+     * @type {string}
+     * @memberof InstanceTemplateEnv
+     */
+    'name': string;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof InstanceTemplateEnv
+     */
+    'label'?: LocalizedDescription;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof InstanceTemplateEnv
+     */
+    'description'?: LocalizedDescription;
+    /**
+     * If true, the frontend should treat this env as required. Create does not re-check.
+     * @type {boolean}
+     * @memberof InstanceTemplateEnv
+     */
+    'required'?: boolean;
+    /**
+     * Default value shown by the frontend.
+     * @type {string}
+     * @memberof InstanceTemplateEnv
+     */
+    'default'?: string;
+}
+

package/src/adminapi/models/instance-template-op.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Operation that can be declared on instanceTemplate.ops.
+ * @export
+ * @enum {string}
+ */
+
+export const InstanceTemplateOp = {
+    hscale: 'hscale',
+    vscale: 'vscale'
+} as const;
+
+export type InstanceTemplateOp = typeof InstanceTemplateOp[keyof typeof InstanceTemplateOp];
+
+
+

package/src/adminapi/models/instance-template-replicas.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * HScale assignment for one instance template. name and replicas only.
+ * @export
+ * @interface InstanceTemplateReplicas
+ */
+export interface InstanceTemplateReplicas {
+    /**
+     * Instance template name on the live Cluster spec.
+     * @type {string}
+     * @memberof InstanceTemplateReplicas
+     */
+    'name': string;
+    /**
+     * Target replica count for this instance template.
+     * @type {number}
+     * @memberof InstanceTemplateReplicas
+     */
+    'replicas': number;
+}
+

package/src/adminapi/models/mode-component-instance-template.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateAttribute } from './instance-template-attribute';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateEnv } from './instance-template-env';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateOp } from './instance-template-op';
+
+/**
+ * Frontend catalog of instance templates for this mode component. names, ops, attributes, and env are for UI rendering. Create validates the request against chart-rendered Cluster instances, not this catalog. HScale does not re-check this catalog; it builds the OpsRequest from the request and the live Cluster. HScale instanceTemplates still requires top-level replicas. ops lists hscale and vscale for the UI (vscale is reserved; class stays component-level). Only HScale processes instance templates. VolumeExpansion, VScale, Upgrade, Restart, and other operations silently ignore instance templates and keep their component-level behavior. Template-level volumeexpansion is not implemented. The platform does not even-split or fill in missing templates. When absent, the frontend should use component-level operations. 
+ * @export
+ * @interface ModeComponentInstanceTemplate
+ */
+export interface ModeComponentInstanceTemplate {
+    /**
+     * Instance template names the frontend should render. Create and hscale check names against the chart or live Cluster, not this list. 
+     * @type {Set<string>}
+     * @memberof ModeComponentInstanceTemplate
+     */
+    'names': Set<string>;
+    /**
+     * Operations the frontend should offer per template: hscale, vscale. Not re-checked when creating a cluster or building an hscale OpsRequest. Only hscale currently acts per template; vscale is reserved. VolumeExpansion, VScale, Upgrade, and Restart ignore instance templates and keep their component-level behavior. 
+     * @type {Array<InstanceTemplateOp>}
+     * @memberof ModeComponentInstanceTemplate
+     */
+    'ops': Array<InstanceTemplateOp>;
+    /**
+     * Heterogeneous attributes the frontend should render on each instance template at create. Omitted or empty means only name and replicas. Create overlays the request onto the chart and does not re-check this list. 
+     * @type {Set<InstanceTemplateAttribute>}
+     * @memberof ModeComponentInstanceTemplate
+     */
+    'attributes'?: Set<InstanceTemplateAttribute>;
+    /**
+     * Env vars the frontend may render when attributes includes env. Create does not re-check this list. 
+     * @type {Array<InstanceTemplateEnv>}
+     * @memberof ModeComponentInstanceTemplate
+     */
+    'env'?: Array<InstanceTemplateEnv>;
+}
+

package/src/adminapi/models/mode-component.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ModeComponentInstanceTemplate } from './mode-component-instance-template';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ModeReadonlyEndpoint } from './mode-readonly-endpoint';
@@ -41,6 +44,12 @@ export interface ModeComponent {
      * @memberof ModeComponent
      */
     'hideOnCreate': boolean;
+    /**
+     * 
+     * @type {ModeComponentInstanceTemplate}
+     * @memberof ModeComponent
+     */
+    'instanceTemplate'?: ModeComponentInstanceTemplate;
     /**
      * the name of the serviceRef defined in mode\'s serviceRefs. If set, it means a serviceRef can be used to replace this component. 
      * @type {string}

package/src/adminapi/models/ops-hscale.ts

@@ -13,12 +13,15 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateReplicas } from './instance-template-replicas';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { TaskSchedule } from './task-schedule';
 
 /**
- * OpsHScale is the payload to horizontally scale a KubeBlocks cluster. It requires specifying either the number of replicas or the number of shards.
+ * OpsHScale is the payload to horizontally scale a KubeBlocks cluster. Specify replicas or shards. instanceTemplates is an optional overlay and requires top-level replicas.
  * @export
  * @interface OpsHScale
  */
@@ -41,6 +44,12 @@ export interface OpsHScale {
      * @memberof OpsHScale
      */
     'replicas'?: number | null;
+    /**
+     * Target replica count for named instance templates. Requires top-level replicas. Mapped onto the live Cluster spec to build scaleIn/scaleOut.instances. Required for replica scaling when the live component has instance templates. Names must exactly match all live instance templates, without missing, extra, or duplicate names; order does not matter. Top-level replicas must equal the sum of all requested template replica counts. Shard-count scaling does not check templates and cannot include this list.
+     * @type {Array<InstanceTemplateReplicas>}
+     * @memberof OpsHScale
+     */
+    'instanceTemplates'?: Array<InstanceTemplateReplicas>;
     /**
      * List of online instance names to be switched to offline during scaling in.
      * @type {Array<string>}

package/src/adminapi/models/ops-vscale.ts

@@ -42,7 +42,7 @@ export interface OpsVScale {
      */
     'memory'?: string;
     /**
-     * class code of the cluster
+     * Class code for component-level vertical scaling.
      * @type {string}
      * @memberof OpsVScale
      */

package/src/adminapi/models/vip-pool-create.ts

@@ -26,5 +26,11 @@ export interface VipPoolCreate {
      * @memberof VipPoolCreate
      */
     'addresses': string;
+    /**
+     * Name of the VIP Pool. It is what a cluster selects the pool by, so it is not restricted by Kubernetes resource naming rules. The MetalLB IPAddressPool resource name stays the generated kb-<id>.
+     * @type {string}
+     * @memberof VipPoolCreate
+     */
+    'poolName': string;
 }
 

package/src/adminapi/models/vip-pool-update.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * VIP Pool update
+ * @export
+ * @interface VipPoolUpdate
+ */
+export interface VipPoolUpdate {
+    /**
+     * IP Addresses
+     * @type {string}
+     * @memberof VipPoolUpdate
+     */
+    'addresses': string;
+}
+

package/src/adminapi/models/vip-pool.ts

@@ -32,6 +32,18 @@ export interface VipPool {
      * @memberof VipPool
      */
     'id'?: string;
+    /**
+     * Name of VIP Pool. It is the MetalLB IPAddressPool resource name, generated as kb-<id>.
+     * @type {string}
+     * @memberof VipPool
+     */
+    'name'?: string;
+    /**
+     * User facing name of the VIP Pool, used to select the pool when creating a cluster. It falls back to the IPAddressPool resource name.
+     * @type {string}
+     * @memberof VipPool
+     */
+    'poolName'?: string;
     /**
      * Total number of IP addresses
      * @type {number}

package/src/adminapi.yaml

@@ -11407,6 +11407,44 @@ paths:
           $ref: '#/components/responses/404'
       tags:
         - vipPool
+    put:
+      operationId: updateVIPPool
+      summary: Update environment VIP Pool
+      parameters:
+        - description: name of the environment
+          in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+        - description: id of the VIP Pool
+          in: path
+          name: poolID
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/vipPoolUpdate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/vipPool'
+          description: A successful response.
+        '400':
+          $ref: '#/components/responses/400'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - vipPool
+      x-codegen-request-body-name: body
   /admin/v1/environments/{environmentName}/storageClasses:
     get:
       description: Provides a summary of storage class statistics.
@@ -30107,6 +30145,48 @@ components:
       enum:
         - DoNotTerminate
         - Delete
+    instanceTemplateCreate:
+      type: object
+      additionalProperties: false
+      description: |
+        Create assignment for one instance template. name and replicas are required. env, annotations, and labels are optional overlays onto the chart-rendered instance. The request must include every chart-rendered instance template exactly once.
+      required:
+        - name
+        - replicas
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Instance template name; must match a chart-rendered instance.
+        replicas:
+          type: integer
+          minimum: 0
+          description: Replica count for this instance template.
+        env:
+          type: array
+          description: Simple env vars (name and value only) merged into this template. valueFrom is not supported; overlaying a name clears any chart valueFrom.
+          items:
+            type: object
+            required:
+              - name
+              - value
+            properties:
+              name:
+                type: string
+              value:
+                type: string
+                minLength: 1
+                description: Plain string value only. valueFrom is not supported.
+        annotations:
+          type: object
+          additionalProperties:
+            type: string
+          description: Annotation map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
+        labels:
+          type: object
+          additionalProperties:
+            type: string
+          description: Label map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
     ioQuantity:
       description: IO Quantity describes IOPS and BPS of a volume
       properties:
@@ -30190,7 +30270,13 @@ components:
           title: Replicas
           type: integer
           x-nullable: true
-          description: Omit to use the cluster chart default. Set zero to disable the component when its resource constraints allow zero replicas.
+          description: Omit to use the cluster chart default. Set zero to disable the component when its resource constraints allow zero replicas. If the rendered component has instance templates, this must equal the sum of all template replica counts in the complete instanceTemplates list.
+        instanceTemplates:
+          type: array
+          minItems: 1
+          description: Per-template replicas and optional overlays (env, annotations, labels). Required when the chart renders instance templates. Names must exactly match all chart-rendered instances, without missing, extra, or duplicate names; order does not matter. Component replicas must equal the sum of all requested instance template replica counts.
+          items:
+            $ref: '#/components/schemas/instanceTemplateCreate'
         skipResourceConstraints:
           type: boolean
           description: Whether to skip resource constraint validation when creating cluster
@@ -30484,6 +30570,10 @@ components:
         networkMode:
           description: Specify the network mode for intra-cluster communication
           $ref: '#/components/schemas/networkMode'
+        vipPoolName:
+          title: VIP Pool Name
+          description: Name of the VIP Pool (VIP Pool poolName) used as the MetalLB address pool for LoadBalancer services. Only effective when networkMode is LoadBalancer.
+          type: string
         serviceRefs:
           type: array
           items:
@@ -31561,8 +31651,23 @@ components:
           x-nullable: true
       required:
         - type
+    instanceTemplateReplicas:
+      type: object
+      description: HScale assignment for one instance template. name and replicas only.
+      required:
+        - name
+        - replicas
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Instance template name on the live Cluster spec.
+        replicas:
+          type: integer
+          minimum: 0
+          description: Target replica count for this instance template.
     opsHScale:
-      description: OpsHScale is the payload to horizontally scale a KubeBlocks cluster. It requires specifying either the number of replicas or the number of shards.
+      description: OpsHScale is the payload to horizontally scale a KubeBlocks cluster. Specify replicas or shards. instanceTemplates is an optional overlay and requires top-level replicas.
       required:
         - component
       properties:
@@ -31578,6 +31683,12 @@ components:
           description: number of replicas
           type: integer
           nullable: true
+        instanceTemplates:
+          type: array
+          minItems: 1
+          description: Target replica count for named instance templates. Requires top-level replicas. Mapped onto the live Cluster spec to build scaleIn/scaleOut.instances. Required for replica scaling when the live component has instance templates. Names must exactly match all live instance templates, without missing, extra, or duplicate names; order does not matter. Top-level replicas must equal the sum of all requested template replica counts. Shard-count scaling does not check templates and cannot include this list.
+          items:
+            $ref: '#/components/schemas/instanceTemplateReplicas'
         onlineInstancesToOffline:
           type: array
           items:
@@ -35620,7 +35731,7 @@ components:
           description: memory size
           type: string
         classCode:
-          description: class code of the cluster
+          description: Class code for component-level vertical scaling.
           type: string
         schedule:
           $ref: '#/components/schemas/taskSchedule'
@@ -37226,6 +37337,14 @@ components:
           description: ID of VIP Pool
           title: ID
           type: string
+        name:
+          description: Name of VIP Pool. It is the MetalLB IPAddressPool resource name, generated as kb-<id>.
+          title: Name
+          type: string
+        poolName:
+          description: User facing name of the VIP Pool, used to select the pool when creating a cluster. It falls back to the IPAddressPool resource name.
+          title: Pool Name
+          type: string
         total:
           description: Total number of IP addresses
           format: int64
@@ -37262,6 +37381,21 @@ components:
       type: object
     vipPoolCreate:
       description: VIP Pool create
+      properties:
+        addresses:
+          description: IP Addresses
+          title: IP Addresses
+          type: string
+        poolName:
+          description: Name of the VIP Pool. It is what a cluster selects the pool by, so it is not restricted by Kubernetes resource naming rules. The MetalLB IPAddressPool resource name stays the generated kb-<id>.
+          title: Pool Name
+          type: string
+      required:
+        - addresses
+        - poolName
+      type: object
+    vipPoolUpdate:
+      description: VIP Pool update
       properties:
         addresses:
           description: IP Addresses
@@ -39298,6 +39432,39 @@ components:
       enum:
         - '0.9'
         - '1.0'
+    instanceTemplateOp:
+      type: string
+      description: Operation that can be declared on instanceTemplate.ops.
+      enum:
+        - hscale
+        - vscale
+    instanceTemplateAttribute:
+      type: string
+      description: Heterogeneous attribute the frontend may render on an instance template at create.
+      enum:
+        - env
+        - annotations
+        - labels
+    instanceTemplateEnv:
+      type: object
+      description: One fillable env var on an instance template, for frontend rendering.
+      required:
+        - name
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Env var name written to the instance template.
+        label:
+          $ref: '#/components/schemas/localizedDescription'
+        description:
+          $ref: '#/components/schemas/localizedDescription'
+        required:
+          type: boolean
+          description: If true, the frontend should treat this env as required. Create does not re-check.
+        default:
+          type: string
+          description: Default value shown by the frontend.
     modeReadonlyEndpoint:
       type: object
       required:
@@ -39319,6 +39486,64 @@ components:
           type: boolean
         hideOnCreate:
           type: boolean
+        instanceTemplate:
+          type: object
+          description: |
+            Frontend catalog of instance templates for this mode component.
+            names, ops, attributes, and env are for UI rendering. Create
+            validates the request against chart-rendered Cluster instances,
+            not this catalog. HScale does not re-check this catalog; it
+            builds the OpsRequest from the request and the live Cluster.
+            HScale instanceTemplates still requires top-level replicas.
+            ops lists hscale and vscale for the UI (vscale is reserved;
+            class stays component-level). Only HScale processes instance templates.
+            VolumeExpansion, VScale, Upgrade, Restart, and other operations silently
+            ignore instance templates and keep their component-level behavior.
+            Template-level volumeexpansion is not implemented.
+            The platform does not even-split or fill in missing templates.
+            When absent, the frontend should use component-level operations.
+          required:
+            - names
+            - ops
+          properties:
+            names:
+              type: array
+              minItems: 1
+              uniqueItems: true
+              items:
+                type: string
+              description: |
+                Instance template names the frontend should render.
+                Create and hscale check names against the chart or live Cluster,
+                not this list.
+            ops:
+              type: array
+              minItems: 1
+              items:
+                $ref: '#/components/schemas/instanceTemplateOp'
+              description: |
+                Operations the frontend should offer per template: hscale, vscale.
+                Not re-checked when creating a cluster or building an hscale OpsRequest.
+                Only hscale currently acts per template; vscale is reserved.
+                VolumeExpansion, VScale, Upgrade, and Restart ignore instance templates
+                and keep their component-level behavior.
+            attributes:
+              type: array
+              uniqueItems: true
+              items:
+                $ref: '#/components/schemas/instanceTemplateAttribute'
+              description: |
+                Heterogeneous attributes the frontend should render on each
+                instance template at create. Omitted or empty means only name
+                and replicas. Create overlays the request onto the chart and
+                does not re-check this list.
+            env:
+              type: array
+              description: |
+                Env vars the frontend may render when attributes includes env.
+                Create does not re-check this list.
+              items:
+                $ref: '#/components/schemas/instanceTemplateEnv'
         serviceRef:
           type: string
           description: |

package/src/openapi/.openapi-generator/FILES

@@ -604,6 +604,12 @@ models/instance-metrics-list.ts
 models/instance-metrics.ts
 models/instance-status.ts
 models/instance-storage-item.ts
+models/instance-template-attribute.ts
+models/instance-template-create-env-inner.ts
+models/instance-template-create.ts
+models/instance-template-env.ts
+models/instance-template-op.ts
+models/instance-template-replicas.ts
 models/instance.ts
 models/integer-option.ts
 models/international-desc.ts
@@ -666,6 +672,7 @@ models/milvus-role-list.ts
 models/milvus-role-request.ts
 models/milvus-role.ts
 models/mode-compatible-kubeblocks-version.ts
+models/mode-component-instance-template.ts
 models/mode-component.ts
 models/mode-object-storage-additional-helm-value-path.ts
 models/mode-object-storage-service-ref.ts

package/src/openapi/models/cluster-create.ts

@@ -191,6 +191,12 @@ export interface ClusterCreate {
      * @memberof ClusterCreate
      */
     'networkMode'?: NetworkMode;
+    /**
+     * Name of the VIP Pool (VIP Pool poolName) used as the MetalLB address pool for LoadBalancer services. Only effective when networkMode is LoadBalancer.
+     * @type {string}
+     * @memberof ClusterCreate
+     */
+    'vipPoolName'?: string;
     /**
      * 
      * @type {Array<ServiceRef>}

package/src/openapi/models/component-item-create.ts

@@ -19,6 +19,9 @@ import type { ComponentNetwork } from './component-network';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentVolumeItem } from './component-volume-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateCreate } from './instance-template-create';
 
 /**
  * ComponentItem is the information of a component
@@ -39,11 +42,17 @@ export interface ComponentItemCreate {
      */
     'compNum'?: number;
     /**
-     * Omit to use the cluster chart default. Set zero to disable the component when its resource constraints allow zero replicas.
+     * Omit to use the cluster chart default. Set zero to disable the component when its resource constraints allow zero replicas. If the rendered component has instance templates, this must equal the sum of all template replica counts in the complete instanceTemplates list.
      * @type {number}
      * @memberof ComponentItemCreate
      */
     'replicas'?: number | null;
+    /**
+     * Per-template replicas and optional overlays (env, annotations, labels). Required when the chart renders instance templates. Names must exactly match all chart-rendered instances, without missing, extra, or duplicate names; order does not matter. Component replicas must equal the sum of all requested instance template replica counts.
+     * @type {Array<InstanceTemplateCreate>}
+     * @memberof ComponentItemCreate
+     */
+    'instanceTemplates'?: Array<InstanceTemplateCreate>;
     /**
      * Whether to skip resource constraint validation when creating cluster
      * @type {boolean}