kb-cloud-client-typescript 2.4.0-alpha.125 → 2.4.0-alpha.126

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 (75) hide show
  1. package/dist/adminapi/models/component-item-create.d.ts +8 -0
  2. package/dist/adminapi/models/component-item-create.d.ts.map +1 -1
  3. package/dist/adminapi/models/component-item.d.ts +8 -0
  4. package/dist/adminapi/models/component-item.d.ts.map +1 -1
  5. package/dist/adminapi/models/component-option.d.ts +6 -0
  6. package/dist/adminapi/models/component-option.d.ts.map +1 -1
  7. package/dist/adminapi/models/index.d.ts +1 -0
  8. package/dist/adminapi/models/index.d.ts.map +1 -1
  9. package/dist/adminapi/models/index.js +1 -0
  10. package/dist/adminapi/models/index.js.map +1 -1
  11. package/dist/adminapi/models/static-cluster-component.d.ts +43 -0
  12. package/dist/adminapi/models/static-cluster-component.d.ts.map +1 -0
  13. package/dist/adminapi/models/static-cluster-component.js +16 -0
  14. package/dist/adminapi/models/static-cluster-component.js.map +1 -0
  15. package/dist/adminapi/models/static-cluster.d.ts +4 -15
  16. package/dist/adminapi/models/static-cluster.d.ts.map +1 -1
  17. package/dist/adminapi/models/victoria-logs-config.d.ts.map +1 -1
  18. package/dist/internalapi/api.d.ts +1 -0
  19. package/dist/internalapi/api.d.ts.map +1 -1
  20. package/dist/internalapi/api.js +1 -0
  21. package/dist/internalapi/api.js.map +1 -1
  22. package/dist/internalapi/apis/victoria-logs-cluster-api.d.ts +113 -0
  23. package/dist/internalapi/apis/victoria-logs-cluster-api.d.ts.map +1 -0
  24. package/dist/internalapi/apis/victoria-logs-cluster-api.js +135 -0
  25. package/dist/internalapi/apis/victoria-logs-cluster-api.js.map +1 -0
  26. package/dist/internalapi/apis/victoria-metrics-cluster-api.d.ts +11 -2
  27. package/dist/internalapi/apis/victoria-metrics-cluster-api.d.ts.map +1 -1
  28. package/dist/internalapi/apis/victoria-metrics-cluster-api.js +9 -5
  29. package/dist/internalapi/apis/victoria-metrics-cluster-api.js.map +1 -1
  30. package/dist/internalapi/models/component-item.d.ts +8 -0
  31. package/dist/internalapi/models/component-item.d.ts.map +1 -1
  32. package/dist/internalapi/models/index.d.ts +2 -0
  33. package/dist/internalapi/models/index.d.ts.map +1 -1
  34. package/dist/internalapi/models/index.js +2 -0
  35. package/dist/internalapi/models/index.js.map +1 -1
  36. package/dist/internalapi/models/static-cluster-component.d.ts +43 -0
  37. package/dist/internalapi/models/static-cluster-component.d.ts.map +1 -0
  38. package/dist/internalapi/models/static-cluster-component.js +16 -0
  39. package/dist/internalapi/models/static-cluster-component.js.map +1 -0
  40. package/dist/internalapi/models/static-cluster.d.ts +4 -15
  41. package/dist/internalapi/models/static-cluster.d.ts.map +1 -1
  42. package/dist/internalapi/models/victoria-logs-config.d.ts +18 -0
  43. package/dist/internalapi/models/victoria-logs-config.d.ts.map +1 -0
  44. package/dist/internalapi/models/victoria-logs-config.js +16 -0
  45. package/dist/internalapi/models/victoria-logs-config.js.map +1 -0
  46. package/dist/openapi/models/component-item-create.d.ts +8 -0
  47. package/dist/openapi/models/component-item-create.d.ts.map +1 -1
  48. package/dist/openapi/models/component-item.d.ts +8 -0
  49. package/dist/openapi/models/component-item.d.ts.map +1 -1
  50. package/dist/openapi/models/component-option.d.ts +6 -0
  51. package/dist/openapi/models/component-option.d.ts.map +1 -1
  52. package/package.json +1 -1
  53. package/src/adminapi/.openapi-generator/FILES +1 -0
  54. package/src/adminapi/models/component-item-create.ts +6 -0
  55. package/src/adminapi/models/component-item.ts +6 -0
  56. package/src/adminapi/models/component-option.ts +6 -0
  57. package/src/adminapi/models/index.ts +1 -0
  58. package/src/adminapi/models/static-cluster-component.ts +48 -0
  59. package/src/adminapi/models/static-cluster.ts +6 -15
  60. package/src/adminapi/models/victoria-logs-config.ts +3 -0
  61. package/src/adminapi.yaml +43 -10
  62. package/src/internalapi/.openapi-generator/FILES +3 -0
  63. package/src/internalapi/api.ts +1 -0
  64. package/src/internalapi/apis/victoria-logs-cluster-api.ts +183 -0
  65. package/src/internalapi/apis/victoria-metrics-cluster-api.ts +19 -5
  66. package/src/internalapi/models/component-item.ts +6 -0
  67. package/src/internalapi/models/index.ts +2 -0
  68. package/src/internalapi/models/static-cluster-component.ts +48 -0
  69. package/src/internalapi/models/static-cluster.ts +6 -15
  70. package/src/internalapi/models/victoria-logs-config.ts +29 -0
  71. package/src/internalapi.yaml +90 -8
  72. package/src/openapi/models/component-item-create.ts +6 -0
  73. package/src/openapi/models/component-item.ts +6 -0
  74. package/src/openapi/models/component-option.ts +6 -0
  75. package/src/openapi.yaml +14 -0
@@ -425,6 +425,12 @@ paths:
425
425
  required: true
426
426
  schema:
427
427
  type: string
428
+ requestBody:
429
+ description: Optional per-component resources. Omitted components keep installer defaults.
430
+ content:
431
+ application/json:
432
+ schema:
433
+ $ref: '#/components/schemas/staticCluster'
428
434
  responses:
429
435
  '200':
430
436
  description: OK
@@ -432,6 +438,8 @@ paths:
432
438
  application/json:
433
439
  schema:
434
440
  $ref: '#/components/schemas/cluster'
441
+ '400':
442
+ $ref: '#/components/responses/400'
435
443
  '401':
436
444
  $ref: '#/components/responses/401'
437
445
  '404':
@@ -459,6 +467,38 @@ paths:
459
467
  $ref: '#/components/responses/403'
460
468
  tags:
461
469
  - cluster
470
+ /internal/v1/environments/{environmentName}/victoriaLogsCluster:
471
+ post:
472
+ tags:
473
+ - victoriaLogsCluster
474
+ summary: Create VictoriaLogs cluster
475
+ description: Create VictoriaLogs with optional per-component resources and retention. Omitted components keep installer defaults.
476
+ operationId: createVictoriaLogsCluster
477
+ parameters:
478
+ - description: name of the environment
479
+ in: path
480
+ name: environmentName
481
+ required: true
482
+ schema:
483
+ type: string
484
+ requestBody:
485
+ content:
486
+ application/json:
487
+ schema:
488
+ $ref: '#/components/schemas/victoriaLogsConfig'
489
+ responses:
490
+ '200':
491
+ description: OK
492
+ content:
493
+ application/json:
494
+ schema:
495
+ $ref: '#/components/schemas/cluster'
496
+ '400':
497
+ $ref: '#/components/responses/400'
498
+ '401':
499
+ $ref: '#/components/responses/401'
500
+ '404':
501
+ $ref: '#/components/responses/404'
462
502
  /internal/v1/organizations/{orgName}/clusters:
463
503
  get:
464
504
  tags:
@@ -1357,20 +1397,39 @@ components:
1357
1397
  description: the tags for the storage
1358
1398
  additionalProperties:
1359
1399
  type: string
1360
- staticCluster:
1400
+ staticClusterComponent:
1401
+ type: object
1402
+ required:
1403
+ - component
1361
1404
  properties:
1405
+ component:
1406
+ type: string
1407
+ minLength: 1
1408
+ description: Exact component name supported by the selected engine during environment installation. Each component may appear only once.
1362
1409
  replicas:
1363
- title: Replicas
1364
1410
  type: integer
1365
- description: the number of replicas
1366
- storage:
1367
- title: Storage(Gi)
1411
+ format: int64
1412
+ nullable: true
1368
1413
  minimum: 1
1369
- type: number
1370
- description: Storage size, the unit is Gi.
1371
- format: double
1414
+ description: Number of replicas. Omit to keep the installer default.
1372
1415
  classCode:
1373
1416
  type: string
1417
+ description: Resource class for this exact engine, mode and component. Omit to keep the installer default.
1418
+ storage:
1419
+ type: number
1420
+ format: double
1421
+ nullable: true
1422
+ minimum: 1
1423
+ description: Disk capacity in Gi. Only vm-storage, vlstorage and minio accept this field.
1424
+ staticCluster:
1425
+ type: object
1426
+ properties:
1427
+ components:
1428
+ type: array
1429
+ maxItems: 3
1430
+ description: Optional component overrides. Unknown, duplicate or other-engine components are rejected.
1431
+ items:
1432
+ $ref: '#/components/schemas/staticClusterComponent'
1374
1433
  environmentStorage:
1375
1434
  type: object
1376
1435
  description: Storage config
@@ -1581,6 +1640,11 @@ components:
1581
1640
  additionalProperties:
1582
1641
  type: string
1583
1642
  description: User-provided component annotations. Does not include chart defaults or system-generated values.
1643
+ labels:
1644
+ type: object
1645
+ additionalProperties:
1646
+ type: string
1647
+ description: User-provided component labels. Does not include chart defaults or system-generated values.
1584
1648
  nodeGroup:
1585
1649
  type: string
1586
1650
  description: Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
@@ -2045,6 +2109,24 @@ components:
2045
2109
  description: the tags for the storage
2046
2110
  additionalProperties:
2047
2111
  type: string
2112
+ victoriaLogsConfig:
2113
+ type: object
2114
+ allOf:
2115
+ - $ref: '#/components/schemas/staticCluster'
2116
+ - type: object
2117
+ properties:
2118
+ retentionPeriod:
2119
+ type: string
2120
+ x-nullable: false
2121
+ default: 100y
2122
+ description: Environment installation log retention, explicitly overriding the addon default. Defaults to 100y when omitted. Accepts a number with s (seconds), h (hours), d (days), w (weeks), M (months), or y (years); a bare number means months. Must be between 1d and 100y. Disk usage retention limits still apply.
2123
+ retentionMaxDiskUsagePercent:
2124
+ type: integer
2125
+ nullable: true
2126
+ default: 80
2127
+ minimum: 1
2128
+ maximum: 100
2129
+ description: Maximum disk usage percentage before VictoriaLogs deletes older log partitions. Defaults to 80 when omitted. Applies independently of retentionPeriod.
2048
2130
  environmentType:
2049
2131
  type: string
2050
2132
  description: Type of this environment
@@ -35,6 +35,12 @@ export interface ComponentItemCreate {
35
35
  * @memberof ComponentItemCreate
36
36
  */
37
37
  'annotations'?: { [key: string]: string; };
38
+ /**
39
+ * User-provided component labels, merged over chart defaults. Key prefixes before / matching kubeblocks.io, kubernetes.io, k8s.io or any of their subdomains are reserved. Keys and values must satisfy Kubernetes label syntax. Omitted or empty preserves defaults; empty string values are literal values, not deletions.
40
+ * @type {{ [key: string]: string; }}
41
+ * @memberof ComponentItemCreate
42
+ */
43
+ 'labels'?: { [key: string]: string; };
38
44
  /**
39
45
  * Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
40
46
  * @type {string}
@@ -35,6 +35,12 @@ export interface ComponentItem {
35
35
  * @memberof ComponentItem
36
36
  */
37
37
  'annotations'?: { [key: string]: string; };
38
+ /**
39
+ * User-provided component labels. Does not include chart defaults or system-generated values.
40
+ * @type {{ [key: string]: string; }}
41
+ * @memberof ComponentItem
42
+ */
43
+ 'labels'?: { [key: string]: string; };
38
44
  /**
39
45
  * Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
40
46
  * @type {string}
@@ -86,6 +86,12 @@ export interface ComponentOption {
86
86
  * @memberof ComponentOption
87
87
  */
88
88
  'customAnnotations'?: boolean;
89
+ /**
90
+ * Whether to show the component labels editor during cluster creation. Omitted or false hides the editor. This is a UI visibility hint and does not restrict the cluster creation API. Applies to this component in every engine mode, including sharding templates, on KubeBlocks 0.9 and 1.0.
91
+ * @type {boolean}
92
+ * @memberof ComponentOption
93
+ */
94
+ 'customLabels'?: boolean;
89
95
  /**
90
96
  * whether the component supports custom secret
91
97
  * @type {boolean}
package/src/openapi.yaml CHANGED
@@ -29020,6 +29020,11 @@ components:
29020
29020
  additionalProperties:
29021
29021
  type: string
29022
29022
  description: User-provided component annotations, merged over chart defaults. Platform-managed keys cannot be overridden. Omitted or empty preserves defaults; empty string values are literal values, not deletions.
29023
+ labels:
29024
+ type: object
29025
+ additionalProperties:
29026
+ type: string
29027
+ description: User-provided component labels, merged over chart defaults. Key prefixes before / matching kubeblocks.io, kubernetes.io, k8s.io or any of their subdomains are reserved. Keys and values must satisfy Kubernetes label syntax. Omitted or empty preserves defaults; empty string values are literal values, not deletions.
29023
29028
  nodeGroup:
29024
29029
  type: string
29025
29030
  description: Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
@@ -29357,6 +29362,11 @@ components:
29357
29362
  additionalProperties:
29358
29363
  type: string
29359
29364
  description: User-provided component annotations. Does not include chart defaults or system-generated values.
29365
+ labels:
29366
+ type: object
29367
+ additionalProperties:
29368
+ type: string
29369
+ description: User-provided component labels. Does not include chart defaults or system-generated values.
29360
29370
  nodeGroup:
29361
29371
  type: string
29362
29372
  description: Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
@@ -37230,6 +37240,10 @@ components:
37230
37240
  type: boolean
37231
37241
  description: Whether to show the component annotations editor during cluster creation. Omitted or false hides the editor. This is a UI visibility hint and does not restrict the cluster creation API. Applies to this component in every engine mode, including sharding templates, on KubeBlocks 0.9 and 1.0.
37232
37242
  x-nullable: false
37243
+ customLabels:
37244
+ type: boolean
37245
+ description: Whether to show the component labels editor during cluster creation. Omitted or false hides the editor. This is a UI visibility hint and does not restrict the cluster creation API. Applies to this component in every engine mode, including sharding templates, on KubeBlocks 0.9 and 1.0.
37246
+ x-nullable: false
37233
37247
  customSecret:
37234
37248
  type: boolean
37235
37249
  description: whether the component supports custom secret