16min

Service

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 Service:

GraphQL
|

Filtering

Get data for a single service that you know the id for:

GraphQL
|

Get data for all of the services in a certain k8s Context:

GraphQL
|

Get data for all of the services NOT in a certain k8s Context:

GraphQL
|



Advanced Filtering

Get data for all of the services that have a namespace:

GraphQL
|

Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the services 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
|

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
|

Ordering

You can order the results you get back either asc or desc depending on your preference:

GraphQL
|

Only select and return the first two services that are found:

GraphQL
|

Only select and return the first two services that are found, but offset by one so services two & three are returned:

GraphQL
|

Aggregation

Count the number of services across all scanned K8s contexts:

GraphQL
|

Count the number of services in a single context. Note that you can apply all of the same filters that are listed above to aggregate queries:

GraphQL
|

Kitchen Sink

Putting it all together; get all data for all services 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, service -> namespace -> job ...etc:

GraphQL
|

References



Updated 01 Feb 2022
Did this page help?
Yes
No