15min
Node
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 Node:
GraphQL
|
type k8sCronJob { id: String context: String apiVersion: String kind: String metadata { id: String annotations: { id: String! key: String value: String } clusterName: String creationTimestamp: String deletionGracePeriodSeconds: Int deletionTimestamp: String finalizers: [String] generateName: String generation: Int labels: { id: String! key: String value: String } ownerReferences: { id: String! apiVersion: String blockOwnerDeletion: Boolean controller: Boolean kind: String name: String } name: String namespace: String resourceVersion: String selfLink: String } spec { providerID: String unschedulable: Boolean configSource { configMap { id: String kubeletConfigKey: String name: String namespace: String resourceVersion: String } } taints { id: String! effect: String key: String timeAdded: String value: String } externalID: String podCIDR: String podCIDRs: [String] } status { addresses { id: String1 address: String type: String } daemonEndpoints { kubeletEndpoint { port: Int } } conditions { id: String! lastHeartbeatTime: String lastTransitionTime: String message: String reason: String status: String type: String } config { error: String active { configMap { id: String kubeletConfigKey: String name: String namespace: String resourceVersion: String } } assigned { configMap { id: String kubeletConfigKey: String name: String namespace: String resourceVersion: String } } lastKnownGood { configMap { id: String kubeletConfigKey: String name: String namespace: String resourceVersion: String } } } images { id: String! names: [String] sizeBytes: Int } nodeInfo { architecture: String bootID: String containerRuntimeVersion: String kernelVersion: String kubeProxyVersion: String kubeletVersion: String machineID: String operatingSystem: String osImage: String systemUUID: String } phase volumesAttached { id: String! devicePath: String name: String } volumesInUse: [String] } namespace { id: String # other namespace fields } }
Filtering
Get data for a single node that you know the id for:
GraphQL
|
query { getk8sNode(id: "12345") { id # Other fields and connections here... } }
Get data for all of the nodes in a certain k8s Context:
GraphQL
|
query { queryk8sNode(filter: { context: { eq: "my-context-name" } }) { id # Other fields and connections here... } }
Get data for all of the nodes NOT in a certain k8s Context:
GraphQL
|
query { queryk8sNode(filter: { not: { context: { eq: "my-context-name" } } }) { id # Other fields and connections here... } }
Advanced Filtering
Get data for all of the nodes that have a namespace:
GraphQL
|
query { queryk8sNode(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: # context # apiVersion # kind # metadata # spec # status
Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the nodes that have a namespace AND status OR that do not have a spec. Note that you can use has, and, not, or completely independently of each other:
GraphQL
|
query { queryk8sNode( filter: { has: namespace and: { has: status } or: { not: { has: spec } } } ) { 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 { queryk8sNode( 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 { queryk8sNode(order: { desc: apiVersion }) { apiVersion # Other fields and connections here... } } # Note that in addition to "apiVersion" you can filter # Using "asc" or "desc" based on any of the following attributes: # id # kind # context
Only select and return the first two nodes that are found:
GraphQL
|
query { queryk8sNode(first: 2, order: { desc: apiVersion }) { apiVersion # Other fields and connections here... } }
Only select and return the first two nodes that are found, but offset by one so nodes two & three are returned:
GraphQL
|
query { queryk8sNode(first: 2, order: { desc: apiVersion }, offset: 1) { apiVersion # Other fields and connections here... } }
Aggregation
Count the number of nodes across all scanned K8s contexts:
GraphQL
|
query { aggregatek8sNode { 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
Count the number of nodes in a single context. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query { aggregatek8sNode(filter: { context: { eq: "my-context-name" } }) { count # Other fields and connections here... } }
Kitchen Sink
Putting it all together; get all data for all nodes across all k8s contexts in a single query. For the purposes of this example we will only get direct children of the service but if you want to it's easy to go from say, node -> namespace -> service ...etc:
GraphQL
|
query { queryk8sCronJob { id context apiVersion kind metadata { id annotations { id key value } clusterName creationTimestamp deletionGracePeriodSeconds deletionTimestamp finalizers generateName generation labels{ id key value } ownerReferences { id apiVersion blockOwnerDeletion controller kind name } name namespace resourceVersion selfLink } spec { concurrencyPolicy failedJobsHistoryLimit jobTemplate { metadata { id annotations { id key value } clusterName creationTimestamp deletionGracePeriodSeconds deletionTimestamp finalizers generateName generation labels{ id key value } ownerReferences { id apiVersion blockOwnerDeletion controller kind name } name namespace resourceVersion selfLink } spec { activeDeadlineSeconds backoffLimit completionMode completions manualSelector parallelism selector { matchExpressions { id key operator values } matchLabels { id key value } } suspend template { metadata { id annotations { id key value } clusterName creationTimestamp deletionGracePeriodSeconds deletionTimestamp finalizers generateName generation labels{ id key value } ownerReferences { id apiVersion blockOwnerDeletion controller kind name } name namespace resourceVersion selfLink } spec { activeDeadlineSeconds affinity { nodeAffinity { requiredDuringSchedulingIgnoredDuringExecution { nodeSelectorTerms { id matchExpressions { id key operator values } matchFields { id key operator values } } } preferredDuringSchedulingIgnoredDuringExecution { id weight preference { id labelSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaceSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaces topologyKey } podAffinityTerm { id labelSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaceSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaces topologyKey } } } podAffinity { requiredDuringSchedulingIgnoredDuringExecution { id labelSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaceSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaces topologyKey } preferredDuringSchedulingIgnoredDuringExecution { id weight preference { id labelSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaceSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaces topologyKey } podAffinityTerm { id labelSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaceSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaces topologyKey } } } podAntiAffinity { requiredDuringSchedulingIgnoredDuringExecution { id labelSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaceSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaces topologyKey } preferredDuringSchedulingIgnoredDuringExecution { id weight preference { id labelSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaceSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaces topologyKey } podAffinityTerm { id labelSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaceSelector { matchExpressions { id key operator values } matchLabels { id key value } } namespaces topologyKey } } } } automountServiceAccountToken dnsPolicy enableServiceLinks hostIpc hostNetwork hostPid hostname nodeName preemptionPolicy priority priorityClassName restartPolicy runtimeClassName schedulerName serviceAccount serviceAccountName setHostnameAsFqdn shareProcessNamespace subdomain terminationGracePeriodSeconds } } ttlSecondsAfterFinished } } schedule startingDeadlineSeconds successfulJobsHistoryLimit suspend } status { lastScheduleTime lastSuccessfulTime active { id apiVersion fieldPath kind name namespace resourceVersion } } namespace { id # other namespace fields } } }
