-
Notifications
You must be signed in to change notification settings - Fork 26
Expand file tree
/
Copy pathspec.yaml
More file actions
15763 lines (15527 loc) · 577 KB
/
spec.yaml
File metadata and controls
15763 lines (15527 loc) · 577 KB
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
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# SPDX-FileCopyrightText: Copyright (c) 2021-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: LicenseRef-NvidiaProprietary
#
# NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
# property and proprietary rights in and to this material, related
# documentation and any modifications thereto. Any use, reproduction,
# disclosure or distribution of this material and related documentation
# without an express license agreement from NVIDIA CORPORATION or
# its affiliates is strictly prohibited.
openapi: 3.1.0
info:
title: Carbide REST API
version: 1.0.2
summary: Carbide REST API is the centralize RESTful gateway to access Carbide service
description: 'Carbide REST API allows users to create and manage resources e.g. VPC, Subnets, Instances across all Carbide Sites.'
license:
name: Copyright Nvidia Inc.
url: 'https://www.nvidia.com/en-us/about-nvidia/legal-info/'
contact:
name: Carbide Dev Team
email: carbide-dev@exchange.nvidia.com
servers:
- url: 'https://carbide-rest-api.carbide.svc.cluster.local'
description: Kubernetes Cluster
tags:
- name: Service Account
description: 'When API service is configured in Service Account mode, API users can act as both Provider and Tenant'
- name: Infrastructure Provider
description: |-
Infrastructure Provider issues a unique identifier for a Provider and contains information about their Org
Deprecation history:
- `name` attribute was deprecated and was removed on August 17th, 2023 0:00 UTC. Please use `orgDisplayName` instead.
- `POST /org/:orgName/carbide/infrastructure-provider` endpoint was deprecated and was removed on August 17th, 2023 0:00 UTC. Infrastructure Providers are automatically created when retrieved by a Provider Admin.
- `PATCH /org/:orgName/carbide/infrastructure-provider/current` endpoint was deprecated and was removed on August 17th, 2023 0:00 UTC. Infrastructure Provider details are populated from Org information and cannot be updated by user.
- name: Tenant
description: |-
Tenant issues a unique identifier for a Tenant and contains information about their Org
Deprecation history:
- `name` attribute was deprecated and was removed on August 17th, 2023. Please use `orgDisplayName` instead.
- `enableSSHAccess` attribute was deprecated and was removed on August 17th, 2023 0:00 UTC. Please use 'isSerialConsoleSSHKeysEnabled' attribute of Site instead.
- `POST /org/:orgName/carbide/tenant` endpoint was deprecated and was removed on August 17th, 2023 0:00 UTC. Tenants are automatically created when retrieved by a Tenant Admin.
- `PATCH /org/:orgName/carbide/tenant/current` endpoint was deprecated and was removed on August 17th, 2023 0:00 UTC. Tenant details are populated from Org information and cannot be updated by user.
- name: Tenant Account
description: Tenant Account connects a Carbide Tenant with a Carbide Infrastructure Provider. It represent/contains any information pertaining to their relationship.
- name: Site
description: Site operations
- name: Allocation
description: Allocation operations
- name: VPC
description: VPC operations
- name: VPC Prefix
description: |-
VPC Prefixes are networking constructs that connect a set of Carbide baremetal machines.
They are defined by a prefix and prefix length and can be a slice or the whole part of an IP Block allocated to a Tenant.
- name: Subnet
description: |-
Subnets are networking constructs that connect a set of Carbide baremetal machines.
They are defined by a prefix and prefix length and can be a slice or the whole part of an IP Block allocated to a Tenant.
Deprecation history:
- `ipBlockSize` was deprecated in favor of `prefixLength` and was removed on April 15th, 2023 0:00 UTC. Please use `prefixLength` instead.
- name: Expected Machine
description: |-
Expected Machine operations allow Infrastructure Providers to pre-register machines that are expected to be discovered at a site.
Expected Machines contain BMC credentials and hardware identifiers to help with automated machine provisioning and management.
- name: SKU
description: |-
SKU (Stock Keeping Unit) operations allow Infrastructure Providers to retrieve hardware configurations discovered at their sites.
SKUs are automatically derived from machine hardware characteristics and used to group similar machines. SKUs are read-only and managed by the system.
- name: InfiniBand Partition
description: Partitions provide networking support for high-performance computing that features very high throughput and very low latency.
- name: NVLink Logical Partition
description: NVLink Logical Partitions provide networking support for high-performance computing that features very high throughput and very low latency for GPU to GPU communication.
- name: Operating System
description: Operating System operations
- name: Instance Type
description: |-
Instance Types allow grouping two or more Machines into a pool which can be specified when creating an Instance.
Deprecation history:
- `includeMachineAssociation` was deprecated in favor of `includeMachineAssignment` and was removed on July 26th, 2023 0:00 UTC. Please use `includeMachineAssignment` instead.
- `displayName` attribute was deprecated and removed on October 30, 2024 0:00 UTC. Please update your usage accordingly.
- name: Instance
description: |-
Instance is a Machine provisioned with an Operating System for a Tenant and attached to one of more Subnets
Deprecation history:
- `sshUrl` Was deprecated in favor of `serialConsoleUrl` and was removed on April 25th, 2023 0:00 UTC. Please use `serialConsoleUrl` instead.
- `instanceSubnets` was deprecated in favor of `interfaces` and was removed on May 10th, 2023 0:00 UTC. Please use `interfaces` instead.
- `sshkeygroups` was deprecated in favor of `sshKeyGroups` and was removed on September 4th, 2025 0:00 UTC. Please use `sshKeyGroups` instead.
- `allocationId` was deprecated, and removed on September 6th, 2025 0:00 UTC.
- name: Machine
description: Machine operations
- name: Machine Capability
description: Machine Capability operations
- name: Network Security Group
description: Network Security Group operations
- name: IP Block
description: |-
IP Block is a set of IP addresses defined by a prefix and prefix length.
It can be used by the Provider to describe the overlay network of a particular Site. Providers can also use Allocations to delegate portions of these blocks to Tenant.
Historic deprecations:
- `blockSize` was deprecated in favor of `prefixLength` and was removed on April 15th, 2023 0:00 UTC. Please use `prefixLength` instead.
- name: DPU Extension Service
description: DPU Extension Service allows users to run custom services in the DPUs of their Instance
- name: SSH Key Group
description: SSH Key Groups allow binding several SSH Keys together so they can be applied to Sites or other entities as a unit
- name: SSH Key
description: SSH Key allows access to Carbide Serial Console
- name: User
description: User operations
- name: Audit
description: Audit operations
- name: Metadata
description: Metadata described various system level attributes of the API server
- name: Deprecations
description: |-
Endpoints that have deprecations will be grouped here. Following deprecations are in effect or slated to be effective in future:
Infrastructure Provider:
- `name` attribute was deprecated and was removed on August 17th, 2023 0:00 UTC. Please use `orgDisplayName` instead.
- `POST /org/:orgName/carbide/infrastructure-provider` endpoint was deprecated and was removed on August 17th, 2023 0:00 UTC. Infrastructure Providers are automatically created when retrieved by a Provider Admin.
- `PATCH /org/:orgName/carbide/infrastructure-provider/current` endpoint was deprecated and was removed on August 17th, 2023 0:00 UTC. Infrastructure Provider details are populated from Org information and cannot be updated by user.
Tenant:
- `name` attribute was deprecated and was removed on August 17th, 2023. Please use `orgDisplayName` instead.
- `enableSSHAccess` attribute was deprecated and was removed on August 17th, 2023 0:00 UTC. Please use 'isSerialConsoleSSHKeysEnabled' attribute of Site instead.
- `POST /org/:orgName/carbide/tenant` endpoint was deprecated and was removed on August 17th, 2023 0:00 UTC. Tenants are automatically created when retrieved by a Tenant Admin.
- `PATCH /org/:orgName/carbide/tenant/current` endpoint was deprecated and was removed on August 17th, 2023 0:00 UTC. Tenant details are populated from Org information and cannot be updated by user.
Instance Type:
- `includeMachineAssociation` was deprecated in favor of `includeMachineAssignment` and was removed on July 26th, 2023 0:00 UTC. Please use `includeMachineAssignment` instead.
- `displayName` attribute was deprecated and removed on October 30, 2024 0:00 UTC. Please update your usage accordingly.
Instance:
- `sshUrl` Was deprecated in favor of `serialConsoleUrl` and was removed on April 25th, 2023 0:00 UTC. Please use `serialConsoleUrl` instead.
- `instanceSubnets` was deprecated in favor of `interfaces` and was removed on May 10th, 2023 0:00 UTC. Please use `interfaces` instead.
- `sshkeygroups` was deprecated in favor of `sshKeyGroups` and was removed on September 4th, 2025 0:00 UTC. Please use `sshKeyGroups` instead.
- `allocationId`was deprecated, and removed on September 6th, 2025 0:00 UTC.
IP Block:
- `blockSize` was deprecated in favor of `prefixLength` and was removed on April 15th, 2023 0:00 UTC. Please use `prefixLength` instead.
Subnet:
- `ipBlockSize` was deprecated in favor of `prefixLength` and was removed on April 15th, 2023 0:00 UTC. Please use `prefixLength` instead.
paths:
'/v2/org/{org}/carbide/service-account/current':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
get:
summary: Retrieve Service Account status for current org
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccount'
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-current-service-account
description: |-
Retrieve Service Account status for current org
API service must be configured for Service Account access at the time of deployment. It cannot be enabled or disabled via API.
parameters: []
tags:
- Service Account
'/v2/org/{org}/carbide/infrastructure-provider/current':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
get:
summary: Retrieve Infrastructure Provider for current Org
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InfrastructureProvider'
examples:
example-1:
value:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
org: rf43bbtnb9c5
orgDisplayName: Dell Corporation
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-current-infrastructure-provider
description: |-
Retrieve Infrastructure Provider entity for current Org.
User must have `FORGE_PROVIDER_ADMIN` authorization role.
parameters: []
tags:
- Infrastructure Provider
'/v2/org/{org}/carbide/infrastructure-provider/current/stats':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
get:
summary: Retrieve Stats for current Infrastructure Provider
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InfrastructureProviderStats'
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-current-infrastructure-provider-stats
description: |-
Retrieve stats for current Infrastructure Provider.
User must have `FORGE_PROVIDER_ADMIN` authorization role.
parameters: []
tags:
- Infrastructure Provider
'/v2/org/{org}/carbide/tenant/current':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
get:
summary: Retrieve Tenant for current Org
tags:
- Tenant
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
examples:
example-1:
value:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
org: qygdmg8oqik8
orgDisplayName: Echo Corporation
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
capabilities:
targetedInstanceCreation: false
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-current-tenant
description: |-
Retrieve Tenant entity for current Org.
User must have `FORGE_TENANT_ADMIN` authorization role.
parameters: []
'/v2/org/{org}/carbide/tenant/current/stats':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
get:
summary: Retrieve Stats for current Tenant
tags:
- Tenant
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantStats'
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-current-tenant-stats
description: |-
Retrieve stats for current Tenant.
User must have `FORGE_TENANT_ADMIN` authorization role.
parameters: []
'/v2/org/{org}/carbide/tenant/account':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
get:
summary: Retrieve all Tenant Accounts
tags:
- Tenant Account
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TenantAccount'
examples:
example-1:
value:
- id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
infrastructureProviderId: e94bcfda-f6cb-42e4-80ec-516811e5abbf
infrastructureProviderOrg: xskkpgqpeakn
tenantId: f97df110-f4de-492e-8849-4a6af68026b0
tenantOrg: rf43bbtnb9c5
tenantContact:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
email: janed@nvidia.com
firstName: Jane
lastName: Doe
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
allocationCount: 0
status: Pending
statusHistory:
- status: Pending
message: 'Request received, pending processing'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
headers:
X-Pagination:
schema:
type: string
example: '{"pageNumber":1,"pageSize":20,"total":30,"orderBy": "CREATED_DESC"}'
description: Pagination result in JSON format
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-all-tenant-account
description: |-
Retrieve all Tenant Accounts.
Either `infrastructureProviderId` or `tenantId` query param must be specified.
If `infrastructureProviderId` query param is provided, then org must have an Infrastructure Provider entity and its ID should match the query param value. User must have `FORGE_PROVIDER_ADMIN` role.
If `tenantId` query param is provided, then org must have a Tenant entity and its ID should match the query param value. User must have `FORGE_TENANT_ADMIN` role.
parameters:
- schema:
type: string
format: uuid
in: query
name: infrastructureProviderId
description: Filter TenantAccounts by Infrastructure Provider ID
- schema:
type: string
format: uuid
in: query
name: tenantId
description: Filter TenantAccounts by Tenant ID
- schema:
type: string
enum:
- InfrastructureProvider
- Tenant
in: query
name: includeRelation
description: Related entity to expand
- schema:
type: integer
example: 1
default: 1
minimum: 1
in: query
name: pageNumber
description: Page number for pagination query
- schema:
type: integer
minimum: 1
maximum: 100
example: 20
in: query
name: pageSize
description: Page size for pagination query
- schema:
type: string
enum:
- STATUS_ASC
- STATUS_DESC
- CREATED_ASC
- CREATED_DESC
- UPDATED_ASC
- UPDATED_DESC
- ACCOUNT_NUMBER_ASC
- ACCOUNT_NUMBER_DESC
- TENANT_ORG_NAME_ASC
- TENANT_ORG_NAME_DESC
- TENANT_ORG_DISPLAY_NAME_ASC
- TENANT_ORG_DISPLAY_NAME_DESC
- TENANT_CONTACT_EMAIL_ASC
- TENANT_CONTACT_EMAIL_DESC
- TENANT_CONTACT_FULL_NAME_ASC
- TENANT_CONTACT_FULL_NAME_DESC
in: query
name: orderBy
description: Ordering for pagination query
post:
summary: Create Tenant Account
operationId: create-tenant-account
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TenantAccount'
examples:
example-1:
value:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
infrastructureProviderId: e94bcfda-f6cb-42e4-80ec-516811e5abbf
infrastructureProviderOrg: xskkpgqpeakn
tenantId: null
tenantOrg: rf43bbtnb9c5
tenantContact:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
email: janed@nvidia.com
firstName: Jane
lastName: Doe
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
allocationCount: 0
status: Pending
statusHistory:
- status: Pending
message: 'Request received, pending processing'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
'400':
$ref: '#/components/responses/ValidationError'
'403':
$ref: '#/components/responses/ForbiddenError'
description: |-
Create a Tenant Account.
Org must have an Infrastructure Provider entity and its ID must Infrastructure Provider ID in request data. User must have `FORGE_PROVIDER_ADMIN` authorization role
Infrastructure Provider can create a Tenant Account by specifying the Tenant's UUID or Tenant's org name. This will set the status of the Tenant Account to "Invited". Then the Tenant can view this account information and are able to confirm/accept the account by updating the Tenant Account.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantAccountCreateRequest'
examples:
example-1:
value:
infrastructureProviderId: e94bcfda-f6cb-42e4-80ec-516811e5abbf
tenantOrg: rf43bbtnb9c5
tags:
- Tenant Account
'/v2/org/{org}/carbide/tenant/account/{accountId}':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
- schema:
type: string
format: uuid
name: accountId
in: path
required: true
description: ID of the Tenant Account
get:
summary: Retrieve Tenant Account
tags:
- Tenant Account
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantAccount'
examples:
example-1:
value:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
infrastructureProviderId: e94bcfda-f6cb-42e4-80ec-516811e5abbf
infrastructureProviderOrg: xskkpgqpeakn
tenantId: f97df110-f4de-492e-8849-4a6af68026b0
tenantOrg: rf43bbtnb9c5
tenantContact:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
email: janed@nvidia.com
firstName: Jane
lastName: Doe
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
allocationCount: 2
status: Ready
statusHistory:
- status: Ready
message: 'Account ready, Tenant accepted invite'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
- status: Invited
message: 'Request received, pending Tenant acceptance'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-tenant-account
description: |-
Retrieve a Tenant Account by ID
Either `infrastructureProviderId` or `tenantId` query param must be specified.
If `infrastructureProviderId` query param is provided, then org must have an Infrastructure Provider entity and its ID should match the query param value. User must have `FORGE_PROVIDER_ADMIN` role.
If `tenantId` query param is provided, then org must have a Tenant entity and its ID should match the query param value. User must have `FORGE_TENANT_ADMIN` role.
parameters:
- schema:
type: string
format: uuid
in: query
name: infrastructureProviderId
description: Filter Tenant Accounts by Infrastructure Provider ID
- schema:
type: string
format: uuid
in: query
name: tenantId
description: Filter Tenant Accounts by Tenant ID
- schema:
type: string
enum:
- InfrastructureProvider
- Tenant
in: query
name: includeRelation
description: Related entity to expand
patch:
summary: Update Tenant Account
operationId: update-tenant-account
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantAccount'
examples:
example-1:
value:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
infrastructureProviderId: e94bcfda-f6cb-42e4-80ec-516811e5abbf
infrastructureProviderOrg: xskkpgqpeakn
tenantId: f97df110-f4de-492e-8849-4a6af68026b0
tenantOrg: rf43bbtnb9c5
tenantContact:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
email: janed@nvidia.com
firstName: Jane
lastName: Doe
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
allocationCount: 0
status: Ready
statusHistory:
- status: Ready
message: 'Account ready, Tenant accepted invite'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
- status: Invited
message: 'Request received, pending Tenant acceptance'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
'400':
$ref: '#/components/responses/ValidationError'
'403':
$ref: '#/components/responses/ForbiddenError'
tags:
- Tenant Account
description: |-
Update a Tenant Account.
Can be used to accept an invitation sent by InfraStructure provider.
Org must have a tenant entity whose ID matches the `tenantId` of the Tenant Account object. User must have `FORGE_TENANT_ADMIN` role. Can only update a TenantAccount that has `Invited` status.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantAccountUpdateRequest'
examples:
example-1:
value: {}
description: 'No params needed, an empty request body will suffice.'
delete:
summary: Delete Tenant Account
operationId: delete-tenant-account
responses:
'202':
description: Accepted
'403':
$ref: '#/components/responses/ForbiddenError'
description: |-
Delete a Tenant Account by ID.
Org must have an Infrastructure Provider entity, specified Tenant Account must be created by said Provider. Requesting user must have `FORGE_PROVIDER_ADMIN` role.
Tenant cannot delete a Tenant Account.
tags:
- Tenant Account
'/v2/org/{org}/carbide/site':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
get:
summary: Retrieve all Sites
tags:
- Site
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Site'
headers:
X-Pagination:
schema:
type: string
example: '{"pageNumber":1,"pageSize":20,"total":30,"orderBy": "CREATED_DESC"}'
description: Pagination result in JSON format
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-all-site
description: |-
Retrieve all Sites for org.
User must have `FORGE_PROVIDER_ADMIN` or `FORGE_TENANT_ADMIN` role. `infrastructureProviderId` or `tenantId` query param may be required for older API versions.
parameters:
- schema:
type: string
format: uuid
in: query
name: infrastructureProviderId
description: Filter Sites by Infrastructure Provider ID
- schema:
type: string
format: uuid
in: query
name: tenantId
description: Filter Sites by Tenant ID
- schema:
type: string
in: query
name: status
description: Filter Sites by Status. Can be specified multiple times to filter on more than one status
- schema:
type: boolean
in: query
name: isNativeNetworkingEnabled
description: Filter Sites by native networking enabled flag. Requires Provider Admin role.
- schema:
type: boolean
in: query
name: isNetworkSecurityGroupEnabled
description: Filter Sites by network security group enabled flag. Requires Provider Admin role.
- schema:
type: boolean
in: query
name: includeMachineStats
description: Include a breakdown of Machine counts by life-cycle status and health. Requires Provider Admin role.
- schema:
type: string
in: query
name: query
description: 'Search for matches across all Sites. Input will be matched against name, description, location, contact, and status fields'
- schema:
type: string
enum:
- InfrastructureProvider
in: query
name: includeRelation
description: Related entity to expand
- schema:
type: integer
example: 1
default: 1
minimum: 1
in: query
name: pageNumber
description: Page number for pagination query
- schema:
type: integer
minimum: 1
maximum: 100
example: 20
in: query
name: pageSize
description: Page size for pagination query
- schema:
type: string
enum:
- NAME_ASC
- NAME_DESC
- STATUS_ASC
- STATUS_DESC
- CREATED_ASC
- CREATED_DESC
- UPDATED_ASC
- UPDATED_DESC
- DESCRIPTION_ASC
- DESCRIPTION_DESC
- LOCATION_ASC
- LOCATION_DESC
- CONTACT_ASC
- CONTACT_DESC
in: query
name: orderBy
description: Ordering for pagination query
post:
summary: Create Site
operationId: create-site
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
'400':
$ref: '#/components/responses/ValidationError'
'403':
$ref: '#/components/responses/ForbiddenError'
description: |-
Create a Site for the org.
Org must have an Infrastructure Provider entity. User must have `FORGE_PROVIDER_ADMIN` authorization role.
Tenant cannot create a Site.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SiteCreateRequest'
examples:
example-1:
value:
name: San Jose Central 4
description: Datacenter serving San Jose central region
location:
city: San Jose
state: CA
country: USA
contact:
email: johndoe@nvidia.com
tags:
- Site
'/v2/org/{org}/carbide/site/{siteId}':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
- schema:
type: string
format: uuid
name: siteId
in: path
required: true
description: ID of the Site
get:
summary: Retrieve Site
tags:
- Site
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-site
description: |-
Retrieve a specific Site by ID.
User must have `FORGE_PROVIDER_ADMIN` or `FORGE_TENANT_ADMIN` role.
parameters: []
patch:
summary: Update Site
operationId: update-site
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Site'
tags:
- Site
description: |-
Update a specific Site
Org must have an Infrastructure Provider entity. User must have `FORGE_PROVIDER_ADMIN` or `FORGE_TENANT_ADMIN` authorization role.
Infrastructure Provider updating the Site must be the owner of the Site.
Tenant updating the Site must have access to the Site and can only update Tenant specific attributes.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SiteUpdateRequest'
examples:
example-1:
value:
name: San Jose Central No.4
description: Datacenter 4 serving central San Jose
renewRegistrationToken: true
serialConsoleHostname: sol.carbide.acme.com
isSerialConsoleEnabled: true
serialConsoleIdleTimeout: 120
serialConsoleMaxSessionLength: 1800
location:
city: San Jose
state: CA
country: USA
contact:
email: johndoe@nvidia.com
example-2:
value:
isSerialConsoleSSHKeysEnabled: true
contact:
email: janedoe@nvidia.com
delete:
summary: Delete Site
operationId: delete-site
responses:
'202':
description: Deletion request was accepted
tags:
- Site
description: |-
Delete a specific Site
Org must have an Infrastructure Provider entity. User must have `FORGE_PROVIDER_ADMIN` authorization role.
Site can only be deleted if all Allocations have been deleted.
parameters:
- schema:
type: boolean
in: query
name: purgeMachines
description: Scrub all Machine data associated with this Site to re-pair
'/v2/org/{org}/carbide/site/{siteId}/status-history':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
- schema:
type: string
format: uuid
name: siteId
in: path
required: true
description: ID of the Site
get:
summary: Retrieve Site status history
tags:
- Site
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StatusDetail'
examples:
Example 1:
value:
- status: Pending
message: 'Request received, pending processing'
created: '2019-08-24T14:15:22Z'
updated: '2019-08-24T14:15:22Z'
headers:
X-Pagination:
schema:
type: string
description: Pagination result in JSON format
'403':
$ref: '#/components/responses/ForbiddenError'
operationId: get-site-status-history
description: |-
Retrieve a specific Site status history
Either `infrastructureProviderId` or `tenantId` query param must be specified.
If `infrastructureProviderId` query param is provided, then org must have an Infrastructure Provider entity and its ID should match the query param value. User must have `FORGE_PROVIDER_ADMIN` role. The Infrastructure Provider must own the Site.
If `tenantId` query param is provided, then org must have a Tenant entity and its ID should match the query param value. User must have `FORGE_TENANT_ADMIN` role. The Tenant must have an allocation with the Site.
parameters:
- schema:
type: integer
in: query
name: pageNumber
description: Page number for pagination query
- schema:
type: integer
in: query
name: pageSize
description: Page size for pagination query
- schema:
type: string
in: query
name: orderBy
description: Ordering for pagination query
'/v2/org/{org}/carbide/allocation':
parameters:
- schema:
type: string
name: org
in: path
required: true
description: Name of the Org
get:
summary: Retrieve all Allocations
tags:
- Allocation
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Allocation'
examples:
example-1:
value:
- id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
name: Echo Studios
description: Echo Studios resource allocation in SJC4
infrastructureProviderId: e94bcfda-f6cb-42e4-80ec-516811e5abbf