Note: if you are running CloudGraph locally you can view the interactive, automatically generated documentation in either GraphQL Playground or Altair by clicking the docs button on the right-hand side of the screen. After reading the below information we highly suggest you use one of these tools to test your queries as they will autocomplete fields for you and let you know if your queries are valid before you even submit them.
Overview
You can currently query the following attributes and connections on a k8s storage class:
GraphQL
|
typek8sStorageClass{id:Stringcontext:StringapiVersion:Stringkind:Stringmetadata{id:Stringannotations:{id:String!key:Stringvalue:String}clusterName:StringcreationTimestamp:StringdeletionGracePeriodSeconds:IntdeletionTimestamp:Stringfinalizers:[String]generateName:Stringgeneration:Intlabels:{id:String!key:Stringvalue:String}ownerReferences:{id:String!apiVersion:StringblockOwnerDeletion:Booleancontroller:Booleankind:Stringname:String}name:Stringnamespace:StringresourceVersion:StringselfLink:String}allowVolumeExpansion:BooleanallowedTopologies{id:StringmatchLabelExpressions{id:Stringkey:Stringvalues:[String]}}mountOptions:[String]provisioner:Stringparameters{id:Stringkey:Stringvalue:String}reclaimPolicy:StringvolumeBindingMode:Stringnamespace{id# Other namespace fields}}
Filtering
Get data for a single storage class that you know the id for:
GraphQL
|
query{getk8sStorageClass(id:"12345"){id# Other fields and connections here...}}
Get data for all of the storage classes in a certain k8s Context:
GraphQL
|
query{queryk8sStorageClass(filter:{context:{eq:"my-context-name"}}){id# Other fields and connections here...}}
Get data for all of the storage classes NOT in a certain k8s Context:
GraphQL
|
query{queryk8sStorageClass(filter:{not:{context:{eq:"my-context-name"}}}){id# Other fields and connections here...}}
Advanced Filtering
Get data for all of the storage classes that have a namespace:
GraphQL
|
query{queryk8sStorageClass(filter:{has:namespace}){id# Other fields and connections here...}}# Note that in addition to "namespace" you can filter# Using "has" based on any of the following attributes:# apiVersion# kind# metadata# allowVolumeExpansion# allowedTopologies# mountOptions# provisioner# parameters# reclaimPolicy# volumeBindingMode
Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the storage classes that have a namespace AND mountOptions OR that do not have parameters. Note that you can use has, and, not, or completely independently of each other:
GraphQL
|
query{queryk8sStorageClass(filter:{has:namespaceand:{has:mountOptions}or:{not:{has:parameters}}}){id# Other fields and connections here...}}
You may also filter using a regex when filtering on a string field like, context if you want to look for a value that matches say, some-value (case insensitive):
GraphQL
|
query{queryk8sStorageClass(filter:{context:{regexp:"/.*some-value*./i"}}){id# Other fields and connections here...}}
Ordering
You can order the results you get back either asc or desc depending on your preference:
GraphQL
|
query{queryk8sStorageClass(order:{desc:context}){context# Other fields and connections here...}}# Note that in addition to "type" you can filter# Using "asc" or "desc" based on any of the following attributes:# id# kind# apiVersion# allowVolumeExpansion# provisioner# reclaimPolicy# volumeBindingMode
Only select and return the first two storage classes that are found:
GraphQL
|
query{queryk8sStorageClass(first:2,order:{desc:context}){id# Other fields and connections here...}}
Only select and return the first two storage classes that are found, but offset by one so storage classes two & three are returned:
GraphQL
|
query{queryk8sStorageClass(first:2,order:{desc:context},offset:1){id# Other fields and connections here...}}
Aggregation
Count the number of storage classes across all scanned K8s contexts:
GraphQL
|
query{aggregatek8sStorageClass{count# Other fields and connections here...}}# Note that in addition to "count" you can request the# Following min and max values based on attributes of your Namespaces:# idMin# idMax# contextMin# contextMax# kindMin# kindMax# apiVersionMin# apiVersionMax# allowVolumeExpansionMin# allowedVolumeExpansionMax# provisionerMin# provisionerMax# reclaimPolicyMin# reclaimPolicyMax# volumeBindingModeMin# volumeBindingModeMax
Count the number of storage classes in a single context. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query{aggregatek8sStorageClass(filter:{context:{eq:"my-context-name"}}){count# Other fields and connections here...}}
Kitchen Sink
Putting it all together; get all data for all storage classes across all k8s contexts in a single query. For the purposes of this example we will only get direct children of the storage class but if you want to it's easy to go from say, storageClass -> namespace -> job ...etc:
GraphQL
|
query{queryk8sStorageClass{idcontextapiVersionkindmetadata{idannotations{idkeyvalue}clusterNamecreationTimestampdeletionGracePeriodSecondsdeletionTimestampfinalizersgenerateNamegenerationlabels{idkeyvalue}ownerReferences{idapiVersionblockOwnerDeletioncontrollerkindname}namenamespaceresourceVersionselfLink}allowVolumeExpansionallowedTopologies{idmatchLabelExpressions{idkeyvalues}}mountOptionsprovisionerparameters{idkeyvalue}reclaimPolicyvolumeBindingModenamespace{idcontextapiVersionkindmetadata{idannotations{idkeyvalue}clusterNamecreationTimestampdeletionGracePeriodSecondsdeletionTimestampfinalizersgenerateNamegenerationlabels{idkeyvalue}ownerReferences{idapiVersionblockOwnerDeletioncontrollerkindname}namenamespaceresourceVersionselfLink}spec{finalizers}status{phaseconditions{idlastHeartbeatTimelastTransitionTimemessagereasonstatustype}}networkPolicies{id# any networkPolicy properties}nodes{id# any node properties}pods{id# any pod properties}deployments{id# any deployment properties}ingresses{id# any ingress properties}secrets{id# any secret properties}services{id# any service properties}serviceAccounts{id# any serviceAccount properties}storageClasses{id# any storageClass properties}persistentVolumes{id# any persistentVolume properties}persistentVolumeClaims{id# any persistentVolumeCalim properties}roles{id# any role properties}jobs{id# any job properties}cronJobs{id# any cronJob properties}}}}