-
Notifications
You must be signed in to change notification settings - Fork 179
Expand file tree
/
Copy pathschema.py
More file actions
3485 lines (3254 loc) · 114 KB
/
Copy pathschema.py
File metadata and controls
3485 lines (3254 loc) · 114 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
# ruff: noqa: E402
from __future__ import annotations
import asyncio
import logging
import time
import uuid
from collections.abc import Awaitable, Callable, Mapping, Sequence
from typing import TYPE_CHECKING, Any, cast
import attrs
import graphene
import graphene_federation
import sqlalchemy as sa
from graphene.types.inputobjecttype import set_input_object_type_default_value
from graphql import GraphQLError, OperationType, Undefined
from graphql.type import GraphQLField, get_named_type, is_leaf_type
from opentelemetry import trace
from opentelemetry.trace import StatusCode
from sqlalchemy.orm import selectinload
from ai.backend.common.clients.valkey_client.valkey_image.client import ValkeyImageClient
from ai.backend.common.clients.valkey_client.valkey_live.client import ValkeyLiveClient
from ai.backend.common.clients.valkey_client.valkey_schedule.client import ValkeyScheduleClient
from ai.backend.common.clients.valkey_client.valkey_stat.client import ValkeyStatClient
from ai.backend.common.exception import (
BackendAIError,
ErrorCode,
PermissionDeniedError,
)
from ai.backend.common.identifier.project import ProjectID
from ai.backend.common.metrics.metric import GraphQLMetricObserver
from ai.backend.logging.utils import BraceStyleAdapter
from ai.backend.manager.config.provider import ManagerConfigProvider
from ai.backend.manager.plugin.network import NetworkPluginContext
from ai.backend.manager.service.base import ServicesContext
from ai.backend.manager.services.processors import Processors
from .audit_log import (
AuditLogConnection,
AuditLogNode,
AuditLogSchema,
)
from .container_registry import (
ContainerRegistryConnection,
ContainerRegistryNode,
ContainerRegistryScopeField,
CreateContainerRegistryNode,
DeleteContainerRegistryNode,
ModifyContainerRegistryNode,
)
from .container_registry_v2 import (
CreateContainerRegistryNodeV2,
DeleteContainerRegistryNodeV2,
ModifyContainerRegistryNodeV2,
)
from .service_config import (
AvailableServiceConnection,
AvailableServiceNode,
ModifyServiceConfigNode,
ServiceConfigConnection,
ServiceConfigNode,
)
set_input_object_type_default_value(Undefined)
from ai.backend.common.types import QuotaScopeID, SessionId
from ai.backend.manager.defs import DEFAULT_IMAGE_ARCH
from ai.backend.manager.models.rbac import ContainerRegistryScope
from ai.backend.manager.models.session import SessionRow
from .container_registry import (
ContainerRegistry,
CreateContainerRegistry,
DeleteContainerRegistry,
ModifyContainerRegistry,
)
from .gql_relay import (
AsyncListConnectionField,
AsyncNode,
ConnectionResolverResult,
GlobalIDField,
ResolvedGlobalID,
)
if TYPE_CHECKING:
from ai.backend.common.bgtask.bgtask import BackgroundTaskManager
from ai.backend.common.etcd import AsyncEtcd
from ai.backend.common.types import (
AccessKey,
AgentId,
SlotName,
SlotTypes,
)
from ai.backend.manager.clients.storage_proxy.session_manager import StorageSessionManager
from ai.backend.manager.data.manager_status.types import ManagerStatus
from ai.backend.manager.idle import IdleCheckerHost
from ai.backend.manager.models.utils import ExtendedAsyncSAEngine
from ai.backend.manager.registry import AgentRegistry
from ai.backend.manager.repositories.agent.repository import AgentRepository
from ai.backend.manager.repositories.scheduler.repository import SchedulerRepository
from ai.backend.manager.repositories.user.repository import UserRepository
from ai.backend.common.data.user.types import UserRole
from ai.backend.manager.data.group.types import ProjectType
from ai.backend.manager.data.image.types import ImageStatus
from ai.backend.manager.data.permission.permission_defs import (
AgentPermission,
ComputeSessionPermission,
DomainPermission,
ImagePermission,
ProjectPermission,
)
from ai.backend.manager.data.permission.permission_defs import (
VFolderPermission as VFolderRBACPermission,
)
from ai.backend.manager.data.session.types import SessionStatus
from ai.backend.manager.data.user.types import UserStatus
from ai.backend.manager.errors.api import InvalidAPIParameters
from ai.backend.manager.errors.auth import InsufficientPrivilege
from ai.backend.manager.errors.common import ObjectNotFound
from ai.backend.manager.errors.image import ImageNotFound
from ai.backend.manager.errors.kernel import TooManyKernelsFound
from ai.backend.manager.models.image.row import (
ImageLoadFilter,
PublicImageLoadFilter,
)
from ai.backend.manager.models.rbac import ProjectScope, ScopeType, SystemScope
from ai.backend.manager.models.scaling_group.row import (
ScalingGroupRow,
and_names,
query_allowed_sgroups,
)
from ai.backend.manager.models.vfolder import ensure_quota_scope_accessible_by_user
from .acl import PredefinedAtomicPermission
from .agent import (
Agent,
AgentConnection,
AgentList,
AgentNode,
AgentSummary,
AgentSummaryList,
ModifyAgent,
RescanGPUAllocMaps,
)
from .base import DataLoaderManager, PaginatedConnectionField, privileged_query, scoped_query
from .container_registry import (
CreateContainerRegistryQuota,
DeleteContainerRegistryQuota,
UpdateContainerRegistryQuota,
)
from .domain import (
CreateDomain,
CreateDomainNode,
DeleteDomain,
Domain,
DomainConnection,
DomainNode,
DomainPermissionValueField,
ModifyDomain,
ModifyDomainNode,
PurgeDomain,
)
from .endpoint import (
CreateEndpointAutoScalingRuleNode,
DeleteEndpointAutoScalingRuleNode,
Endpoint,
EndpointAutoScalingRuleConnection,
EndpointAutoScalingRuleNode,
EndpointList,
EndpointToken,
EndpointTokenList,
ModifyEndpoint,
ModifyEndpointAutoScalingRuleNode,
)
from .fields import AgentPermissionField, ScopeField
from .group import (
CreateGroup,
DeleteGroup,
Group,
GroupConnection,
GroupNode,
GroupPermissionField,
ModifyGroup,
PurgeGroup,
)
from .image import (
AliasImage,
ClearImageCustomResourceLimit,
ClearImages,
DealiasImage,
ForgetImage,
ForgetImageById,
Image,
ImageConnection,
ImageNode,
ImagePermissionValueField,
ImageStatusType,
ModifyImage,
PreloadImage,
PurgeImageById,
PurgeImages,
RescanImages,
UnloadImage,
UntagImageFromRegistry,
)
from .kernel import (
ComputeContainer,
ComputeContainerList,
LegacyComputeSession,
LegacyComputeSessionList,
)
from .keypair import CreateKeyPair, DeleteKeyPair, KeyPair, KeyPairList, ModifyKeyPair
from .metric.base import ContainerUtilizationMetricMetadata
from .metric.user import UserUtilizationMetric, UserUtilizationMetricQueryInput
from .network import CreateNetwork, DeleteNetwork, ModifyNetwork, NetworkConnection, NetworkNode
from .pending_queue import SessionPendingQueueConnection
from .resource_policy import (
CreateKeyPairResourcePolicy,
CreateProjectResourcePolicy,
CreateUserResourcePolicy,
DeleteKeyPairResourcePolicy,
DeleteProjectResourcePolicy,
DeleteUserResourcePolicy,
KeyPairResourcePolicy,
ModifyKeyPairResourcePolicy,
ModifyProjectResourcePolicy,
ModifyUserResourcePolicy,
ProjectResourcePolicy,
UserResourcePolicy,
)
from .resource_preset import (
CreateResourcePreset,
DeleteResourcePreset,
ModifyResourcePreset,
ResourcePreset,
)
from .routing import Routing, RoutingList
from .scaling_group import (
AssociateScalingGroupsWithDomain,
AssociateScalingGroupsWithKeyPair,
AssociateScalingGroupsWithUserGroup,
AssociateScalingGroupWithDomain,
AssociateScalingGroupWithKeyPair,
AssociateScalingGroupWithUserGroup,
CreateScalingGroup,
DeleteScalingGroup,
DisassociateAllScalingGroupsWithDomain,
DisassociateAllScalingGroupsWithGroup,
DisassociateScalingGroupsWithDomain,
DisassociateScalingGroupsWithKeyPair,
DisassociateScalingGroupsWithUserGroup,
DisassociateScalingGroupWithDomain,
DisassociateScalingGroupWithKeyPair,
DisassociateScalingGroupWithUserGroup,
ModifyScalingGroup,
ScalingGroup,
)
from .session import (
CheckAndTransitStatus,
ComputeSession,
ComputeSessionConnection,
ComputeSessionList,
ComputeSessionNode,
ModifyComputeSession,
SessionPermissionValueField,
TotalResourceSlot,
)
from .storage import StorageVolume, StorageVolumeList
from .user import (
CreateUser,
DeleteUser,
ModifyUser,
PurgeUser,
User,
UserConnection,
UserList,
UserNode,
)
from .vfolder import (
ModelCard,
ModelCardConnection,
QuotaScope,
SetQuotaScope,
UnsetQuotaScope,
VFolderPermissionValueField,
VirtualFolder,
VirtualFolderConnection,
VirtualFolderList,
VirtualFolderNode,
VirtualFolderPermission,
VirtualFolderPermissionList,
)
from .viewer import Viewer
log = BraceStyleAdapter(logging.getLogger(__spec__.name))
def _is_legacy_mutation(mutation_cls: Any) -> bool:
"""
Checks whether the GraphQL mutation is in the legacy format with the fields `ok` and `msg`.
"""
fields = mutation_cls._meta.fields
return {"ok", "msg"}.issubset(fields)
@attrs.define(auto_attribs=True, slots=True)
class GraphQueryContext:
schema: graphene.Schema
dataloader_manager: DataLoaderManager[Any, Any, Any]
config_provider: ManagerConfigProvider
etcd: AsyncEtcd
user: Mapping[str, Any] # TODO: express using typed dict
access_key: str
db: ExtendedAsyncSAEngine
network_plugin_ctx: NetworkPluginContext
services_ctx: ServicesContext
valkey_stat: ValkeyStatClient
valkey_live: ValkeyLiveClient
valkey_image: ValkeyImageClient
valkey_schedule: ValkeyScheduleClient # TODO: Remove this client from here
manager_status: ManagerStatus
known_slot_types: Mapping[SlotName, SlotTypes]
background_task_manager: BackgroundTaskManager
storage_manager: StorageSessionManager
registry: AgentRegistry
idle_checker_host: IdleCheckerHost
metric_observer: GraphQLMetricObserver
processors: Processors
scheduler_repository: SchedulerRepository
user_repository: UserRepository
agent_repository: AgentRepository
class Mutation(graphene.ObjectType): # type: ignore[misc]
"""
All available GraphQL mutations.
Type name changed from 'Mutations' to 'Mutation' in 25.13.0
"""
# super-admin only
modify_agent = ModifyAgent.Field()
# super-admin only
create_domain = CreateDomain.Field()
modify_domain = ModifyDomain.Field()
delete_domain = DeleteDomain.Field()
purge_domain = PurgeDomain.Field()
create_domain_node = CreateDomainNode.Field(description="Added in 24.12.0.")
modify_domain_node = ModifyDomainNode.Field(description="Added in 24.12.0.")
# admin only
create_group = CreateGroup.Field()
modify_group = ModifyGroup.Field()
delete_group = DeleteGroup.Field()
purge_group = PurgeGroup.Field()
# super-admin only
create_user = CreateUser.Field()
modify_user = ModifyUser.Field()
delete_user = DeleteUser.Field()
purge_user = PurgeUser.Field()
rescan_gpu_alloc_maps = RescanGPUAllocMaps.Field(description="Added in 25.4.0.")
# admin only
create_keypair = CreateKeyPair.Field()
modify_keypair = ModifyKeyPair.Field()
delete_keypair = DeleteKeyPair.Field()
# admin only
rescan_images = RescanImages.Field()
preload_image = PreloadImage.Field()
unload_image = UnloadImage.Field()
modify_image = ModifyImage.Field()
clear_image_custom_resource_limit = ClearImageCustomResourceLimit.Field(
description="Added in 25.6.0"
)
forget_image_by_id = ForgetImageById.Field(description="Added in 24.03.0")
forget_image = ForgetImage.Field(
deprecation_reason="Deprecated since 25.4.0. Use `forget_image_by_id` instead."
)
purge_image_by_id = PurgeImageById.Field(description="Added in 25.4.0")
untag_image_from_registry = UntagImageFromRegistry.Field(description="Added in 24.03.1")
alias_image = AliasImage.Field()
dealias_image = DealiasImage.Field()
clear_images = ClearImages.Field()
purge_images = PurgeImages.Field(description="Added in 25.4.0")
# super-admin only
modify_compute_session = ModifyComputeSession.Field()
# super-admin only
create_keypair_resource_policy = CreateKeyPairResourcePolicy.Field()
modify_keypair_resource_policy = ModifyKeyPairResourcePolicy.Field()
delete_keypair_resource_policy = DeleteKeyPairResourcePolicy.Field()
# super-admin only
create_user_resource_policy = CreateUserResourcePolicy.Field()
modify_user_resource_policy = ModifyUserResourcePolicy.Field()
delete_user_resource_policy = DeleteUserResourcePolicy.Field()
# super-admin only
create_project_resource_policy = CreateProjectResourcePolicy.Field()
modify_project_resource_policy = ModifyProjectResourcePolicy.Field()
delete_project_resource_policy = DeleteProjectResourcePolicy.Field()
# super-admin only
create_resource_preset = CreateResourcePreset.Field()
modify_resource_preset = ModifyResourcePreset.Field()
delete_resource_preset = DeleteResourcePreset.Field()
# super-admin only
modify_service_config = ModifyServiceConfigNode.Field()
# super-admin only
create_scaling_group = CreateScalingGroup.Field()
modify_scaling_group = ModifyScalingGroup.Field()
delete_scaling_group = DeleteScalingGroup.Field()
associate_scaling_group_with_domain = AssociateScalingGroupWithDomain.Field()
associate_scaling_groups_with_domain = AssociateScalingGroupsWithDomain.Field(
description="Added in 24.03.9"
)
associate_scaling_group_with_user_group = AssociateScalingGroupWithUserGroup.Field()
associate_scaling_groups_with_user_group = AssociateScalingGroupsWithUserGroup.Field(
description="Added in 24.03.9"
)
associate_scaling_group_with_keypair = AssociateScalingGroupWithKeyPair.Field()
associate_scaling_groups_with_keypair = AssociateScalingGroupsWithKeyPair.Field(
description="Added in 24.03.9"
)
disassociate_scaling_group_with_domain = DisassociateScalingGroupWithDomain.Field()
disassociate_scaling_groups_with_domain = DisassociateScalingGroupsWithDomain.Field(
description="Added in 24.03.9"
)
disassociate_scaling_group_with_user_group = DisassociateScalingGroupWithUserGroup.Field()
disassociate_scaling_groups_with_user_group = DisassociateScalingGroupsWithUserGroup.Field(
description="Added in 24.03.9"
)
disassociate_scaling_group_with_keypair = DisassociateScalingGroupWithKeyPair.Field()
disassociate_scaling_groups_with_keypair = DisassociateScalingGroupsWithKeyPair.Field(
description="Added in 24.03.9"
)
disassociate_all_scaling_groups_with_domain = DisassociateAllScalingGroupsWithDomain.Field()
disassociate_all_scaling_groups_with_group = DisassociateAllScalingGroupsWithGroup.Field()
set_quota_scope = SetQuotaScope.Field()
unset_quota_scope = UnsetQuotaScope.Field()
create_container_registry_node = CreateContainerRegistryNode.Field(
description="Added in 24.09.0.",
deprecation_reason="Deprecated since 25.3.0. use `create_container_registry_node_v2` instead.",
)
modify_container_registry_node = ModifyContainerRegistryNode.Field(
description="Added in 24.09.0.",
deprecation_reason="Deprecated since 25.3.0. use `modify_container_registry_node_v2` instead.",
)
delete_container_registry_node = DeleteContainerRegistryNode.Field(
description="Added in 24.09.0.",
deprecation_reason="Deprecated since 25.3.0. use `delete_container_registry_node_v2` instead.",
)
create_container_registry_node_v2 = CreateContainerRegistryNodeV2.Field(
description="Added in 25.3.0.",
)
modify_container_registry_node_v2 = ModifyContainerRegistryNodeV2.Field(
description="Added in 25.3.0.",
)
delete_container_registry_node_v2 = DeleteContainerRegistryNodeV2.Field(
description="Added in 25.3.0.",
)
create_endpoint_auto_scaling_rule_node = CreateEndpointAutoScalingRuleNode.Field(
description="Added in 25.1.0."
)
modify_endpoint_auto_scaling_rule_node = ModifyEndpointAutoScalingRuleNode.Field(
description="Added in 25.1.0."
)
delete_endpoint_auto_scaling_rule_node = DeleteEndpointAutoScalingRuleNode.Field(
description="Added in 25.1.0."
)
create_container_registry_quota = CreateContainerRegistryQuota.Field(
description="Added in 25.3.0."
)
update_container_registry_quota = UpdateContainerRegistryQuota.Field(
description="Added in 25.3.0."
)
delete_container_registry_quota = DeleteContainerRegistryQuota.Field(
description="Added in 25.3.0."
)
# Legacy mutations
create_container_registry = CreateContainerRegistry.Field(
deprecation_reason="Deprecated since 24.09.0. use `create_container_registry_node_v2` instead."
)
modify_container_registry = ModifyContainerRegistry.Field(
deprecation_reason="Deprecated since 24.09.0. use `modify_container_registry_node_v2` instead."
)
delete_container_registry = DeleteContainerRegistry.Field(
deprecation_reason="Deprecated since 24.09.0. use `delete_container_registry_node_v2` instead."
)
modify_endpoint = ModifyEndpoint.Field()
check_and_transit_session_status = CheckAndTransitStatus.Field(description="Added in 24.09.0.")
create_network = CreateNetwork.Field()
modify_network = ModifyNetwork.Field()
delete_network = DeleteNetwork.Field()
class Query(graphene.ObjectType): # type: ignore[misc]
"""
All available GraphQL queries.
Type name changed from 'Queries' to 'Query' in 25.14.0
"""
# Relay node(id:) runtime resolution is migrated to the Strawberry (v2) subgraph via
# federation ``@override`` (see ``api/gql/node_field.py``). This field stays declared so the
# v1 graphene schema contract is unchanged; at runtime the supergraph resolves ``node`` in the
# Strawberry subgraph.
node = AsyncNode.Field()
# super-admin only
audit_log_schema = graphene.Field(
AuditLogSchema,
description="Added in 25.6.0.",
)
audit_log_nodes = PaginatedConnectionField(
AuditLogConnection,
description="Added in 25.6.0.",
filter=graphene.String(
description="Specifies the criteria used to narrow down the query results based on certain conditions."
),
order=graphene.String(description="Specifies the sorting order of the query result."),
offset=graphene.Int(
description="Specifies how many items to skip before beginning to return result."
),
before=graphene.String(
description="If this value is provided, the query will be limited to that value."
),
after=graphene.String(
description="Queries the `last` number of results from the query result from last."
),
first=graphene.Int(
description="Queries the `first` number of results from the query result from first."
),
last=graphene.Int(
description="If the given value is provided, the query will start from that value."
),
)
# super-admin only
agent = graphene.Field(
Agent,
agent_id=graphene.String(required=True),
)
# super-admin only
agent_list = graphene.Field(
AgentList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
# filters
scaling_group=graphene.String(),
status=graphene.String(),
)
# super-admin only
agents = graphene.List( # legacy non-paginated list
Agent,
scaling_group=graphene.String(),
status=graphene.String(),
)
agent_summary = graphene.Field(
AgentSummary,
agent_id=graphene.String(required=True),
)
agent_summary_list = graphene.Field(
AgentSummaryList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
# filters
scaling_group=graphene.String(),
status=graphene.String(),
)
domain_node = graphene.Field(
DomainNode,
description="Added in 24.12.0.",
id=GlobalIDField(required=True),
permission=DomainPermissionValueField(
required=False,
default_value=DomainPermission.READ_ATTRIBUTE,
),
)
domain_nodes = PaginatedConnectionField(
DomainConnection,
description="Added in 24.12.0.",
filter=graphene.String(),
order=graphene.String(),
permission=DomainPermissionValueField(
required=False,
default_value=DomainPermission.READ_ATTRIBUTE,
),
)
agent_nodes = PaginatedConnectionField(
AgentConnection,
description="Added in 24.12.0.",
scope=ScopeField(
description="Added in 24.12.0. Default is `system`.",
),
permission=AgentPermissionField(
default_value=AgentPermission.CREATE_COMPUTE_SESSION,
description=f"Added in 24.12.0. Default is {AgentPermission.CREATE_COMPUTE_SESSION.value}.",
),
)
domain = graphene.Field(
Domain,
name=graphene.String(),
)
# super-admin only
domains = graphene.List(
Domain,
is_active=graphene.Boolean(),
)
group_node = graphene.Field(
GroupNode, id=graphene.String(required=True), description="Added in 24.03.0."
)
group_nodes = PaginatedConnectionField(
GroupConnection,
description="Added in 24.03.0.",
filter=graphene.String(description="Added in 24.09.0."),
order=graphene.String(description="Added in 24.09.0."),
scope=ScopeField(
description="Added in 25.3.0. Default is `system`.",
),
container_registry_scope=ContainerRegistryScopeField(description="Added in 25.3.0."),
permission=GroupPermissionField(
default_value=ProjectPermission.READ_ATTRIBUTE,
description=f"Added in 25.3.0. Default is {ProjectPermission.READ_ATTRIBUTE.value}.",
),
)
group = graphene.Field(
Group,
id=graphene.UUID(required=True),
domain_name=graphene.String(),
type=graphene.List(
graphene.String,
default_value=[ProjectType.GENERAL.name],
description=("Added in 24.03.0."),
),
)
# Within a single domain, this will always return nothing or a single item,
# but if queried across all domains by superadmins, it may return multiple results
# because the group name is unique only inside each domain.
groups_by_name = graphene.List(
Group,
name=graphene.String(required=True),
domain_name=graphene.String(),
)
groups = graphene.List(
Group,
domain_name=graphene.String(),
is_active=graphene.Boolean(),
type=graphene.List(
graphene.String,
default_value=[ProjectType.GENERAL.name],
description=(
f"Added in 24.03.0. Available values: {', '.join([p.name for p in ProjectType])}"
),
),
)
image = graphene.Field(
Image,
id=graphene.String(description="Added in 24.03.1"),
reference=graphene.String(),
architecture=graphene.String(
default_value=None,
description="Changed to nullable in 26.1. If not provided, defaults to the Manager's architecture.",
),
)
images = graphene.List(
Image,
is_installed=graphene.Boolean(
description="Added in 19.09.0. If it is specified, fetch images installed on at least one agent."
),
is_operation=graphene.Boolean(
deprecation_reason="Deprecated since 24.03.4. This field is ignored if `load_filters` is specified and is not null."
),
filter_by_statuses=graphene.List(
ImageStatusType,
default_value=[ImageStatus.ALIVE],
description="Added in 25.4.0.",
),
load_filters=graphene.List(
graphene.String,
default_value=None,
description=f"Added in 24.03.8. Allowed values are: [{', '.join([f.value for f in PublicImageLoadFilter])}]. When superuser queries with `customized` option set the resolver will return every customized images (including those not owned by callee). To resolve images owned by user only call `customized_images`.",
),
image_filters=graphene.List(
graphene.String,
default_value=None,
deprecation_reason="Deprecated since 24.03.8. Use `load_filters` instead.",
description=f"Added in 24.03.4. Allowed values are: [{', '.join([f.value for f in PublicImageLoadFilter])}]. When superuser queries with `customized` option set the resolver will return every customized images (including those not owned by caller). To list the owned images only call `customized_images`.",
),
)
customized_images = graphene.List(ImageNode, description="Added in 24.03.1")
image_node = graphene.Field(
ImageNode,
description="Added in 25.3.0.",
id=GlobalIDField(required=True),
scope_id=ScopeField(),
permission=ImagePermissionValueField(
default_value=ImagePermission.READ_ATTRIBUTE,
description=f"Default is {ImagePermission.READ_ATTRIBUTE.value}.",
),
)
image_nodes = PaginatedConnectionField(
ImageConnection,
description="Added in 25.3.0.",
scope_id=ScopeField(required=True),
permission=ImagePermissionValueField(
default_value=ImagePermission.READ_ATTRIBUTE,
description=f"Default is {ImagePermission.READ_ATTRIBUTE.value}.",
),
filter_by_statuses=graphene.List(
ImageStatusType,
default_value=[ImageStatus.ALIVE],
description="Added in 25.4.0.",
),
)
viewer = graphene.Field(
Viewer, description="Added in 25.14.2. Returns information about the current user."
)
user = graphene.Field(
User,
domain_name=graphene.String(),
email=graphene.String(),
)
user_from_uuid = graphene.Field(
User,
domain_name=graphene.String(),
user_id=graphene.ID(),
)
users = graphene.List( # legacy non-paginated list
User,
domain_name=graphene.String(),
group_id=graphene.UUID(),
is_active=graphene.Boolean(),
status=graphene.String(),
)
user_list = graphene.Field(
UserList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
# intrinsic filters
domain_name=graphene.String(),
group_id=graphene.UUID(),
is_active=graphene.Boolean(),
status=graphene.String(),
)
user_node = graphene.Field(
UserNode, id=graphene.String(required=True), description="Added in 24.03.0."
)
user_nodes = PaginatedConnectionField(UserConnection, description="Added in 24.03.0.")
keypair = graphene.Field(
KeyPair,
domain_name=graphene.String(),
access_key=graphene.String(),
)
keypairs = graphene.List( # legacy non-paginated list
KeyPair,
domain_name=graphene.String(),
email=graphene.String(),
is_active=graphene.Boolean(),
)
keypair_list = graphene.Field(
KeyPairList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
# intrinsic filters
domain_name=graphene.String(),
email=graphene.String(),
is_active=graphene.Boolean(),
)
# NOTE: maybe add keypairs_from_user_id?
keypair_resource_policy = graphene.Field(
KeyPairResourcePolicy,
name=graphene.String(),
)
user_resource_policy = graphene.Field(
UserResourcePolicy,
name=graphene.String(),
)
project_resource_policy = graphene.Field(
ProjectResourcePolicy,
name=graphene.String(required=True),
)
keypair_resource_policies = graphene.List(KeyPairResourcePolicy)
user_resource_policies = graphene.List(UserResourcePolicy)
project_resource_policies = graphene.List(ProjectResourcePolicy)
resource_preset = graphene.Field(
ResourcePreset,
name=graphene.String(),
)
resource_preset_by_id = graphene.Field(
ResourcePreset,
description="Added in 25.4.0.",
id=graphene.UUID(),
)
resource_presets = graphene.List(
ResourcePreset,
filter=graphene.String(
description="Added in 25.4.0.",
),
order=graphene.String(
description="Added in 25.4.0.",
),
)
# super-admin only
scaling_group = graphene.Field(
ScalingGroup,
name=graphene.String(),
)
# super-admin only
scaling_groups = graphene.List(
ScalingGroup,
name=graphene.String(),
is_active=graphene.Boolean(),
)
accessible_scaling_groups = graphene.List(
ScalingGroup,
description=(
"Added in 25.5.0. This query is available for all users. "
"It returns the resource groups(=scaling groups) that the user has access to. "
"Only name, is_active, own_session_occupied_resource_slots and accelerator_quantum_size fields are returned."
),
project_id=graphene.UUID(required=True),
)
# super-admin only
scaling_groups_for_domain = graphene.List(
ScalingGroup,
domain=graphene.String(required=True),
is_active=graphene.Boolean(),
)
# super-admin only
scaling_groups_for_user_group = graphene.List(
ScalingGroup,
user_group=graphene.String(required=True),
is_active=graphene.Boolean(),
)
# super-admin only
scaling_groups_for_keypair = graphene.List(
ScalingGroup,
access_key=graphene.String(required=True),
is_active=graphene.Boolean(),
)
# super-admin only
storage_volume = graphene.Field(
StorageVolume,
id=graphene.String(),
)
# super-admin only
storage_volume_list = graphene.Field(
StorageVolumeList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
)
vfolder = graphene.Field(
VirtualFolder,
id=graphene.String(),
)
vfolder_node = graphene.Field(
VirtualFolderNode, id=graphene.String(required=True), description="Added in 24.03.4."
)
vfolder_nodes = PaginatedConnectionField(
VirtualFolderConnection,
description="Added in 24.03.4.",
scope_id=ScopeField(description="Added in 24.12.0."),
project_id=graphene.UUID(
required=False,
description="Added in 24.09.0.",
deprecation_reason="Deprecated since 24.12.0. use `scope_id` instead.",
),
permission=VFolderPermissionValueField(description="Added in 24.09.0."),
)
vfolder_list = graphene.Field( # legacy non-paginated list
VirtualFolderList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
# intrinsic filters
domain_name=graphene.String(),
group_id=graphene.UUID(),
access_key=graphene.String(), # must be empty for user requests
)
# super-admin only
vfolder_permission_list = graphene.Field(
VirtualFolderPermissionList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
)
vfolder_own_list = graphene.Field(
VirtualFolderList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
# intrinsic filters
domain_name=graphene.String(),
access_key=graphene.String(), # must be empty for user requests
)
vfolder_invited_list = graphene.Field(
VirtualFolderList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
# intrinsic filters
domain_name=graphene.String(),
access_key=graphene.String(), # must be empty for user requests
)
vfolder_project_list = graphene.Field(
VirtualFolderList,
limit=graphene.Int(required=True),
offset=graphene.Int(required=True),
filter=graphene.String(),
order=graphene.String(),
# intrinsic filters
domain_name=graphene.String(),
access_key=graphene.String(), # must be empty for user requests
)
vfolders = graphene.List( # legacy non-paginated list
VirtualFolder,
domain_name=graphene.String(),
group_id=graphene.String(),
access_key=graphene.String(), # must be empty for user requests
)
compute_session_node = graphene.Field(
ComputeSessionNode,
description="Added in 24.09.0.",
id=GlobalIDField(required=True),