kb-cloud-client-typescript 2.3.0-alpha.155 → 2.3.0-alpha.156

package/src/adminapi.yaml

@@ -9929,6 +9929,37 @@ paths:
           $ref: '#/components/responses/404'
       tags:
         - environment
+  /admin/v1/environments/{environmentName}/koordinatorReservations/summary:
+    get:
+      description: Get Koordinator Reservation summary for the cluster creation page.
+      summary: Get Koordinator Reservation summary
+      operationId: getKoordinatorReservationSummary
+      parameters:
+        - description: name of the environment
+          in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/koordinatorReservationSummary'
+          description: Koordinator Reservation summary.
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+      tags:
+        - environment
   /admin/v1/environments/{environmentName}/nodes/{nodeName}/cordon:
     patch:
       description: cordon the specified Environment node
@@ -23810,6 +23841,11 @@ components:
         * `HardAntiAffinity` - Strictly enforce pod anti-affinity across nodes. Pods will not be scheduled when the anti-affinity constraints cannot be satisfied.
         * `SoftAntiAffinity` - Prefer to spread pods across nodes using anti-affinity, but allow scheduling on the same node when constraints cannot be fully satisfied.
         * `Disabled` - Do not apply pod anti-affinity constraints on nodes.
+    koordinatorReservationResourceClass:
+      type: string
+      enum:
+        - database
+        - business
     clusterCreate:
       required:
         - engine
@@ -23909,6 +23945,14 @@ components:
         schedulingPolicy:
           description: Scheduling policy for this cluster.
           $ref: '#/components/schemas/schedulingPolicyType'
+        schedulerName:
+          title: Scheduler Name
+          type: string
+          nullable: true
+          description: Scheduler used by this cluster. If omitted, KBE uses the environment default. When koordinatorEnabled is true for the target environment, the environment default is the globally configured Koordinator scheduler.
+        reservationResourceClass:
+          nullable: true
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
       description: KubeBlocks cluster information
     componentItem:
       type: object
@@ -24136,6 +24180,14 @@ components:
         schedulingPolicy:
           description: Scheduling policy for this cluster.
           $ref: '#/components/schemas/schedulingPolicyType'
+        schedulerName:
+          title: Scheduler Name
+          type: string
+          nullable: true
+          description: Effective scheduler used when the cluster was created.
+        reservationResourceClass:
+          nullable: true
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
       description: KubeBlocks cluster details
     clusterBatchUpdateData:
       type: object
@@ -28270,6 +28322,58 @@ components:
       required:
         - usage
       type: object
+    koordinatorReservationResources:
+      type: object
+      additionalProperties: false
+      description: Resource requests supported by KBE for Koordinator Reservations. Values are Kubernetes quantities and responses use Kubernetes canonical quantity strings.
+      properties:
+        cpu:
+          type: string
+        memory:
+          type: string
+    koordinatorReservationAllocatePolicy:
+      type: string
+      enum:
+        - Restricted
+        - Aligned
+    koordinatorReservationStatus:
+      type: object
+      properties:
+        phase:
+          type: string
+        nodeName:
+          type: string
+        allocatable:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        allocated:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        available:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+    koordinatorNodeReservation:
+      type: object
+      required:
+        - resourceClass
+        - resources
+      properties:
+        resourceClass:
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
+        reservationName:
+          type: string
+          readOnly: true
+        resources:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        ttl:
+          type: string
+          default: 24h
+          description: Kubernetes duration string. Koordinator defaults omitted ttl to 24h.
+        allocateOnce:
+          type: boolean
+        preAllocation:
+          type: boolean
+        allocatePolicy:
+          $ref: '#/components/schemas/koordinatorReservationAllocatePolicy'
+        status:
+          $ref: '#/components/schemas/koordinatorReservationStatus'
     nodeStatus:
       type: string
       description: Status of the node
@@ -28328,6 +28432,10 @@ components:
         managed:
           description: Whether the node is managed (has data-plane or control-plane label)
           type: boolean
+        koordinatorReservations:
+          type: array
+          items:
+            $ref: '#/components/schemas/koordinatorNodeReservation'
         status:
           $ref: '#/components/schemas/nodeStatus'
           description: Node status
@@ -29004,7 +29112,6 @@ components:
       type: object
       description: Storage config for environment
       required:
-        - log
         - backup
         - storages
       properties:
@@ -29013,15 +29120,6 @@ components:
           description: these storages will be created
           items:
             $ref: '#/components/schemas/environmentStorage'
-        log:
-          type: object
-          description: the storage config for log
-          required:
-            - storageName
-          properties:
-            storageName:
-              type: string
-              description: the name of storage
         backup:
           type: object
           description: the storage config for backup
@@ -29262,6 +29360,10 @@ components:
           description: whether to enable calculate the cluster SLA for the environment
           type: boolean
           default: false
+        koordinatorEnabled:
+          description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+          type: boolean
+          default: false
     environmentList:
       description: EnvironmentList is a list of Environments
       properties:
@@ -29341,6 +29443,10 @@ components:
           description: whether to enable calculate the cluster SLA for the environment
           type: boolean
           default: false
+        koordinatorEnabled:
+          description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+          type: boolean
+          default: false
     preflight:
       title: Preflight results
       description: The result of preflight check
@@ -29469,6 +29575,10 @@ components:
           description: whether to enable calculate the cluster SLA for the environment
           type: boolean
           default: false
+        koordinatorEnabled:
+          description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+          type: boolean
+          default: false
         clusterSchedulingPolicy:
           $ref: '#/components/schemas/clusterSchedulingPolicy'
     environmentStateEvent:
@@ -29794,6 +29904,50 @@ components:
       required:
         - items
       type: object
+    schedulerOption:
+      type: object
+      properties:
+        name:
+          type: string
+        displayName:
+          type: string
+        default:
+          type: boolean
+    koordinatorReservationSummaryItem:
+      type: object
+      properties:
+        resourceClass:
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
+        nodeCount:
+          type: integer
+          format: int64
+        total:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        allocated:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        available:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+    koordinatorReservationSummary:
+      type: object
+      required:
+        - enabled
+        - schedulerOptions
+        - items
+      properties:
+        enabled:
+          type: boolean
+        schedulerName:
+          type: string
+        defaultSchedulerName:
+          type: string
+        schedulerOptions:
+          type: array
+          items:
+            $ref: '#/components/schemas/schedulerOption'
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/koordinatorReservationSummaryItem'
     listBody:
       description: Represents a list of JSON bodies.
       items:

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

@@ -59,6 +59,7 @@ models/image-registry.ts
 models/index.ts
 models/init-option-item.ts
 models/io-quantity.ts
+models/koordinator-reservation-resource-class.ts
 models/localized-description.ts
 models/network-mode.ts
 models/outage-record.ts

package/src/internalapi/models/cluster.ts

@@ -39,6 +39,9 @@ import type { ComponentItem } from './component-item';
 import type { InitOptionItem } from './init-option-item';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { NetworkMode } from './network-mode';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -314,6 +317,18 @@ export interface Cluster {
      * @memberof Cluster
      */
     'schedulingPolicy'?: SchedulingPolicyType;
+    /**
+     * Effective scheduler used when the cluster was created.
+     * @type {string}
+     * @memberof Cluster
+     */
+    'schedulerName'?: string | null;
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof Cluster
+     */
+    'reservationResourceClass'?: KoordinatorReservationResourceClass;
 }
 
 

package/src/internalapi/models/index.ts

@@ -34,6 +34,7 @@ export * from './http-body';
 export * from './image-registry';
 export * from './init-option-item';
 export * from './io-quantity';
+export * from './koordinator-reservation-resource-class';
 export * from './localized-description';
 export * from './network-mode';
 export * from './outage-record';

package/src/internalapi/models/koordinator-reservation-resource-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const KoordinatorReservationResourceClass = {
+    database: 'database',
+    business: 'business'
+} as const;
+
+export type KoordinatorReservationResourceClass = typeof KoordinatorReservationResourceClass[keyof typeof KoordinatorReservationResourceClass];
+
+
+

package/src/internalapi.yaml

@@ -1518,6 +1518,11 @@ components:
         * `HardAntiAffinity` - Strictly enforce pod anti-affinity across nodes. Pods will not be scheduled when the anti-affinity constraints cannot be satisfied.
         * `SoftAntiAffinity` - Prefer to spread pods across nodes using anti-affinity, but allow scheduling on the same node when constraints cannot be fully satisfied.
         * `Disabled` - Do not apply pod anti-affinity constraints on nodes.
+    koordinatorReservationResourceClass:
+      type: string
+      enum:
+        - database
+        - business
     cluster:
       required:
         - engine
@@ -1695,6 +1700,14 @@ components:
         schedulingPolicy:
           description: Scheduling policy for this cluster.
           $ref: '#/components/schemas/schedulingPolicyType'
+        schedulerName:
+          title: Scheduler Name
+          type: string
+          nullable: true
+          description: Effective scheduler used when the cluster was created.
+        reservationResourceClass:
+          nullable: true
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
       description: KubeBlocks cluster details
     storage:
       type: object

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

@@ -513,6 +513,11 @@ models/ip-whitelist-list.ts
 models/ip-whitelist.ts
 models/key-list.ts
 models/key.ts
+models/koordinator-node-reservation.ts
+models/koordinator-reservation-allocate-policy.ts
+models/koordinator-reservation-resource-class.ts
+models/koordinator-reservation-resources.ts
+models/koordinator-reservation-status.ts
 models/kubeblocks-endpoint.ts
 models/license-option.ts
 models/license.ts

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

@@ -39,6 +39,9 @@ import type { ComponentItemCreate } from './component-item-create';
 import type { InitOptionItem } from './init-option-item';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { NetworkMode } from './network-mode';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -212,6 +215,18 @@ export interface ClusterCreate {
      * @memberof ClusterCreate
      */
     'schedulingPolicy'?: SchedulingPolicyType;
+    /**
+     * Scheduler used by this cluster. If omitted, KBE uses the environment default. When koordinatorEnabled is true for the target environment, the environment default is the globally configured Koordinator scheduler.
+     * @type {string}
+     * @memberof ClusterCreate
+     */
+    'schedulerName'?: string | null;
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof ClusterCreate
+     */
+    'reservationResourceClass'?: KoordinatorReservationResourceClass;
 }
 
 

package/src/openapi/models/cluster.ts

@@ -39,6 +39,9 @@ import type { ComponentItem } from './component-item';
 import type { InitOptionItem } from './init-option-item';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { NetworkMode } from './network-mode';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -314,6 +317,18 @@ export interface Cluster {
      * @memberof Cluster
      */
     'schedulingPolicy'?: SchedulingPolicyType;
+    /**
+     * Effective scheduler used when the cluster was created.
+     * @type {string}
+     * @memberof Cluster
+     */
+    'schedulerName'?: string | null;
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof Cluster
+     */
+    'reservationResourceClass'?: KoordinatorReservationResourceClass;
 }
 
 

package/src/openapi/models/index.ts

@@ -426,6 +426,11 @@ export * from './ip-whitelist';
 export * from './ip-whitelist-list';
 export * from './key';
 export * from './key-list';
+export * from './koordinator-node-reservation';
+export * from './koordinator-reservation-allocate-policy';
+export * from './koordinator-reservation-resource-class';
+export * from './koordinator-reservation-resources';
+export * from './koordinator-reservation-status';
 export * from './kubeblocks-endpoint';
 export * from './license';
 export * from './license-option';

package/src/openapi/models/koordinator-node-reservation.ts

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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 { KoordinatorReservationAllocatePolicy } from './koordinator-reservation-allocate-policy';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationResources } from './koordinator-reservation-resources';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationStatus } from './koordinator-reservation-status';
+
+/**
+ * 
+ * @export
+ * @interface KoordinatorNodeReservation
+ */
+export interface KoordinatorNodeReservation {
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof KoordinatorNodeReservation
+     */
+    'resourceClass': KoordinatorReservationResourceClass;
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorNodeReservation
+     */
+    'reservationName'?: string;
+    /**
+     * 
+     * @type {KoordinatorReservationResources}
+     * @memberof KoordinatorNodeReservation
+     */
+    'resources': KoordinatorReservationResources;
+    /**
+     * Kubernetes duration string. Koordinator defaults omitted ttl to 24h.
+     * @type {string}
+     * @memberof KoordinatorNodeReservation
+     */
+    'ttl'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof KoordinatorNodeReservation
+     */
+    'allocateOnce'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof KoordinatorNodeReservation
+     */
+    'preAllocation'?: boolean;
+    /**
+     * 
+     * @type {KoordinatorReservationAllocatePolicy}
+     * @memberof KoordinatorNodeReservation
+     */
+    'allocatePolicy'?: KoordinatorReservationAllocatePolicy;
+    /**
+     * 
+     * @type {KoordinatorReservationStatus}
+     * @memberof KoordinatorNodeReservation
+     */
+    'status'?: KoordinatorReservationStatus;
+}
+
+
+

package/src/openapi/models/koordinator-reservation-allocate-policy.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const KoordinatorReservationAllocatePolicy = {
+    Restricted: 'Restricted',
+    Aligned: 'Aligned'
+} as const;
+
+export type KoordinatorReservationAllocatePolicy = typeof KoordinatorReservationAllocatePolicy[keyof typeof KoordinatorReservationAllocatePolicy];
+
+
+

package/src/openapi/models/koordinator-reservation-resource-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const KoordinatorReservationResourceClass = {
+    database: 'database',
+    business: 'business'
+} as const;
+
+export type KoordinatorReservationResourceClass = typeof KoordinatorReservationResourceClass[keyof typeof KoordinatorReservationResourceClass];
+
+
+

package/src/openapi/models/koordinator-reservation-resources.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * Resource requests supported by KBE for Koordinator Reservations. Values are Kubernetes quantities and responses use Kubernetes canonical quantity strings.
+ * @export
+ * @interface KoordinatorReservationResources
+ */
+export interface KoordinatorReservationResources {
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorReservationResources
+     */
+    'cpu'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorReservationResources
+     */
+    'memory'?: string;
+}
+