-
Notifications
You must be signed in to change notification settings - Fork 8
/
server.spec.yaml
625 lines (625 loc) · 27.6 KB
/
server.spec.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
openapi: 3.0.3
info:
title: Kubernetes Service API
description: |-
The Kubernetes Service API provides services that allows provisioning and life cycle
management of Kubernetes clusters. The API is logically composed of authentication
services, platform provider specific calls to get a set of resource types that can
be then used by abstract Kubernetes Service resources to create and manage Kubernetes
clusters. Requests must specify the HTML content type
header.
version: 0.2.0
paths:
/api/v1/organizations/{organizationID}/regions/{regionID}/flavors:
description: |-
Kubernetes flavor services.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
- $ref: '#/components/parameters/regionIDParameter'
get:
description: |-
Lists all Kubernetes compatible flavors that the user has access to.
security:
- oauth2Authentication: []
responses:
'200':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/region/main/pkg/openapi/server.spec.yaml#/components/responses/flavorsResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
/api/v1/organizations/{organizationID}/regions/{regionID}/images:
description: |-
Kubernetes image services.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
- $ref: '#/components/parameters/regionIDParameter'
get:
description: |-
Lists all Kubernetes compatible images that the user has access to.
security:
- oauth2Authentication: []
responses:
'200':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/region/main/pkg/openapi/server.spec.yaml#/components/responses/imagesResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
/api/v1/organizations/{organizationID}/clustermanagers:
description: |-
Implements cluster manager management services. Control planes manage the
life cycle of Kubernetes clusters, through provisioning, upgrading, to deletion.
Control planes must reference a versioned application bundle that defines the
software versions of cluster manager components, and forms the basis of automatic
upgrade functionality. Referencing an explicit cluster manager name will
implicitly create the associated project.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
get:
description: |-
Lists cluster managers within the organization.
security:
- oauth2Authentication: []
responses:
'200':
$ref: '#/components/responses/clusterManagersResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'404':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/notFoundResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
/api/v1/organizations/{organizationID}/projects/{projectID}/clustermanagers:
description: |-
Implements cluster manager management services. Control planes manage the
life cycle of Kubernetes clusters, through provisioning, upgrading, to deletion.
Control planes must reference a versioned application bundle that defines the
software versions of cluster manager components, and forms the basis of automatic
upgrade functionality. Referencing an explicit cluster manager name will
implicitly create the associated project.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
- $ref: '#/components/parameters/projectIDParameter'
post:
description: |-
Creates a new cluster manager within the project.
security:
- oauth2Authentication: []
requestBody:
$ref: '#/components/requestBodies/createControlPlaneRequest'
responses:
'202':
$ref: '#/components/responses/clusterManagerResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'409':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/conflictResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
/api/v1/organizations/{organizationID}/projects/{projectID}/clustermanagers/{clusterManagerID}:
description: |-
Implements cluster manager management services. Control planes manage the
life cycle of Kubernetes clusters, through provisioning, upgrading, to deletion.
Control planes must reference a versioned application bundle that defines the
software versions of cluster manager components, and forms the basis of automatic
upgrade functionality. Referencing an explicit cluster manager name will
implicitly create the associated project.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
- $ref: '#/components/parameters/projectIDParameter'
- $ref: '#/components/parameters/clusterManagerIDParameter'
put:
description: |-
Updates a cluster manager within the scoped project.
security:
- oauth2Authentication: []
requestBody:
$ref: '#/components/requestBodies/createControlPlaneRequest'
responses:
'202':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/acceptedResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'404':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/notFoundResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
delete:
description: |-
Deletes a cluster manager from within the scoped project.
This is a cascading operation and will delete all contained clusters.
security:
- oauth2Authentication: []
responses:
'202':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/acceptedResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'404':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/notFoundResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
/api/v1/organizations/{organizationID}/clusters:
description: Cluster services.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
get:
description: |-
List all clusters within the organization.
security:
- oauth2Authentication: []
responses:
'200':
$ref: '#/components/responses/kubernetesClustersResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'404':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/notFoundResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
/api/v1/organizations/{organizationID}/projects/{projectID}/clusters:
description: Cluster services.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
- $ref: '#/components/parameters/projectIDParameter'
post:
description: |-
Creates a new cluster within the selected cluster manager.
security:
- oauth2Authentication: []
requestBody:
$ref: '#/components/requestBodies/createKubernetesClusterRequest'
responses:
'202':
$ref: '#/components/responses/kubernetesClusterResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'409':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/conflictResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
/api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}:
description: Cluster services.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
- $ref: '#/components/parameters/projectIDParameter'
- $ref: '#/components/parameters/clusterIDParameter'
put:
description: |-
Update a cluster within the selected cluster manager.
security:
- oauth2Authentication: []
requestBody:
$ref: '#/components/requestBodies/createKubernetesClusterRequest'
responses:
'202':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/acceptedResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'404':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/notFoundResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
delete:
description: |-
Delete a cluster from within a the selected cluster manager.
security:
- oauth2Authentication: []
responses:
'202':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/acceptedResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'404':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/notFoundResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
/api/v1/organizations/{organizationID}/projects/{projectID}/clusters/{clusterID}/kubeconfig:
description: Cluster services.
parameters:
- $ref: '#/components/parameters/organizationIDParameter'
- $ref: '#/components/parameters/projectIDParameter'
- $ref: '#/components/parameters/clusterIDParameter'
get:
description: |-
Get a cluster's Kubernetes configuration.
security:
- oauth2Authentication: []
responses:
'200':
$ref: '#/components/responses/kubernetesClusterKubeconfigResponse'
'400':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/badRequestResponse'
'401':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/unauthorizedResponse'
'403':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/forbiddenResponse'
'404':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/notFoundResponse'
'500':
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/responses/internalServerErrorResponse'
components:
parameters:
organizationIDParameter:
name: organizationID
in: path
description: |-
The organization name.
required: true
schema:
$ref: '#/components/schemas/kubernetesNameParameter'
projectIDParameter:
name: projectID
in: path
description: |-
The project name.
required: true
schema:
$ref: '#/components/schemas/kubernetesNameParameter'
regionIDParameter:
name: regionID
in: path
description: The region identifier.
required: true
schema:
$ref: '#/components/schemas/kubernetesNameParameter'
clusterManagerIDParameter:
name: clusterManagerID
in: path
description: |-
The cluster manager name, if the cluster manager does not exist, then it may be
implicitly created, for example a cluster is created against a cluster manager
that does not exist. Must be a valid DNS containing only lower case characters,
numbers or hyphens, start and end with a character or number, and be at most
63 characters in length.
required: true
schema:
$ref: '#/components/schemas/kubernetesNameParameter'
clusterIDParameter:
name: clusterID
in: path
description: |-
The cluster name. Must be a valid DNS containing only lower case characters,
numbers or hyphens, start and end with a character or number, and be at most
63 characters in length.
required: true
schema:
$ref: '#/components/schemas/kubernetesNameParameter'
schemas:
kubernetesNameParameter:
description: A Kubernetes name. Must be a valid DNS containing only lower case characters, numbers or hyphens, start and end with a character or number, and be at most 63 characters in length.
type: string
minLength: 1
maxLength: 63
clusterManagerRead:
description: A cluster manager.
type: object
required:
- metadata
properties:
metadata:
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/schemas/projectScopedResourceReadMetadata'
clusterManagerWrite:
description: A cluster manager.
type: object
required:
- metadata
properties:
metadata:
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/schemas/resourceWriteMetadata'
clusterManagers:
description: A list of cluster managers.
type: array
items:
$ref: '#/components/schemas/clusterManagerRead'
kubernetesClusterNetwork:
description: A kubernetes cluster network settings.
type: object
properties:
nodePrefix:
description: Network prefix to provision nodes in. Must be a valid CIDR block.
type: string
servicePrefix:
description: Network prefix to provision services in. Must be a valid CIDR block.
type: string
podPrefix:
description: Network prefix to provision pods in. Must be a valid CIDR block.
type: string
dnsNameservers:
description: A list of DNS name server to use.
type: array
items:
description: A DNS nameserver IPv4 address.
type: string
kubernetesClusterAPI:
description: Kubernetes API settings.
type: object
properties:
subjectAlternativeNames:
description: Set of non-standard X.509 SANs to add to the API certificate.
type: array
minItems: 1
items:
description: An X.509 SAN.
type: string
allowedPrefixes:
description: Set of address prefixes to allow access to the Kubernetes API.
type: array
minItems: 1
items:
description: An IPv4 CIDR address prefix.
type: string
volume:
description: A volume.
type: object
required:
- size
properties:
size:
description: Disk size in GiB.
type: integer
machinePool:
description: A Kubernetes cluster machine.
type: object
properties:
replicas:
description: Number of machines for a statically sized pool or the maximum
for an auto-scaled pool.
type: integer
flavorId:
description: Flavor ID.
type: string
minLength: 1
disk:
$ref: '#/components/schemas/volume'
kubernetesClusterAutoscaling:
description: |-
A Kubernetes cluster workload pool autoscaling configuration. Cluster autoscaling
must also be enabled in the cluster features.
type: object
required:
- minimumReplicas
properties:
minimumReplicas:
description: |-
The minimum number of replicas to allow. Must be less than the maximum.
type: integer
kubernetesClusterWorkloadPool:
description: A Kuberntes cluster workload pool.
type: object
required:
- name
- machine
properties:
name:
description: Workload pool name.
type: string
machine:
$ref: '#/components/schemas/machinePool'
labels:
description: Workload pool key value labels to apply on node creation.
type: object
additionalProperties:
description: A string value.
type: string
autoscaling:
$ref: '#/components/schemas/kubernetesClusterAutoscaling'
kubernetesClusterWorkloadPools:
description: A list of Kubernetes cluster workload pools.
type: array
minItems: 1
items:
$ref: '#/components/schemas/kubernetesClusterWorkloadPool'
kubernetesClusterSpec:
description: Kubernetes cluster creation parameters.
type: object
required:
- regionId
- version
- workloadPools
properties:
regionId:
description: The region to provision the cluster in.
type: string
clusterManagerId:
description: |-
The name of the cluster manager to use, if one is not specified
the system will create one for you.
type: string
version:
description: The Kuebernetes version. This should be derived from
image metadata.
type: string
workloadPools:
$ref: '#/components/schemas/kubernetesClusterWorkloadPools'
kubernetesClusterRead:
description: Kubernetes cluster read.
type: object
required:
- metadata
- spec
properties:
metadata:
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/schemas/projectScopedResourceReadMetadata'
spec:
$ref: '#/components/schemas/kubernetesClusterSpec'
kubernetesClusterWrite:
description: Kubernetes cluster create or update.
type: object
required:
- metadata
- spec
properties:
metadata:
$ref: 'https://raw.githubusercontent.com/unikorn-cloud/core/main/pkg/openapi/common.spec.yaml#/components/schemas/resourceWriteMetadata'
spec:
$ref: '#/components/schemas/kubernetesClusterSpec'
kubernetesClusters:
description: A list of Kubernetes clusters.
type: array
items:
$ref: '#/components/schemas/kubernetesClusterRead'
requestBodies:
createControlPlaneRequest:
description: Control plane request parameters.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/clusterManagerWrite'
example:
metadata:
name: default
createKubernetesClusterRequest:
description: Kubernetes cluster request parameters.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/kubernetesClusterWrite'
example:
metadata:
name: cluster
spec:
regionId: b059b3e6-9ae5-42b7-94b4-f42fb7a6baee
version: v1.27.2
workloadPools:
- autoscaling:
minimumReplicas: 0
machine:
flavorId: c7568e2d-f9ab-453d-9a3a-51375f78426b
replicas: 3
name: default
responses:
clusterManagerResponse:
description: A cluster manager.
content:
application/json:
schema:
$ref: '#/components/schemas/clusterManagerRead'
example:
metadata:
id: c7568e2d-f9ab-453d-9a3a-51375f78426b
name: default
organizationId: d4600d6e-e965-4b44-a808-84fb2fa36702
organizationName: acme-corp
projectId: cae219d7-10e5-4601-8c2c-ee7e066b93ce
projectName: top-secret
creationTime: 2023-07-31T10:45:45Z
provisioningStatus: provisioned
clusterManagersResponse:
description: A list of cluster managers.
content:
application/json:
schema:
$ref: '#/components/schemas/clusterManagers'
example:
- metadata:
id: c7568e2d-f9ab-453d-9a3a-51375f78426b
name: default
organizationId: d4600d6e-e965-4b44-a808-84fb2fa36702
organizationName: acme-corp
projectId: cae219d7-10e5-4601-8c2c-ee7e066b93ce
projectName: top-secret
creationTime: 2023-07-31T10:45:45Z
provisioningStatus: provisioned
kubernetesClusterKubeconfigResponse:
description: A Kubernetes cluster configuration.
content:
application/octet-stream: {}
kubernetesClusterResponse:
description: A Kubernetes cluster.
content:
application/json:
schema:
$ref: '#/components/schemas/kubernetesClusterRead'
example:
metadata:
id: c7568e2d-f9ab-453d-9a3a-51375f78426b
name: cluster
organizationId: d4600d6e-e965-4b44-a808-84fb2fa36702
projectId: cae219d7-10e5-4601-8c2c-ee7e066b93ce
creationTime: 2023-07-31T10:45:45Z
provisioningStatus: provisioned
spec:
regionId: b059b3e6-9ae5-42b7-94b4-f42fb7a6baee
version: v1.27.2
clusterManagerId: b85525fc-40ca-482b-ac07-eca8b01b09c2
workloadPools:
- name: default
machine:
disk:
size: 50
flavorId: c7568e2d-f9ab-453d-9a3a-51375f78426b
replicas: 3
kubernetesClustersResponse:
description: A list of Kubernetes clusters.
content:
application/json:
schema:
$ref: '#/components/schemas/kubernetesClusters'
example:
- metadata:
id: c7568e2d-f9ab-453d-9a3a-51375f78426b
name: cluster
organizationId: d4600d6e-e965-4b44-a808-84fb2fa36702
projectId: cae219d7-10e5-4601-8c2c-ee7e066b93ce
creationTime: 2023-07-31T10:45:45Z
provisioningStatus: provisioned
spec:
regionId: b059b3e6-9ae5-42b7-94b4-f42fb7a6baee
version: v1.27.2
clusterManagerId: b85525fc-40ca-482b-ac07-eca8b01b09c2
workloadPools:
- name: default
machine:
disk:
size: 50
flavorId: c7568e2d-f9ab-453d-9a3a-51375f78426b
replicas: 3
securitySchemes:
oauth2Authentication:
description: Operation requires OAuth2 bearer token authentication.
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://identity.unikorn-cloud.org/oauth2/v2/authorization
tokenUrl: https://identity.unikorn-cloud.org/oauth2/v2/token
scopes: {}