Connected Services Filter (API only)

[danielsdeleo]

🔩 Description: What code changed, and why?

[Apps tab] A customer has requested to be able to filter on only connected services. They want to see if all supervisors that are expected to upgrade have indeed upgraded. Their estate includes systems distributed over sometimes unreliable WAN links, which can become disconnected and not expected to update. Therefore it will be helpful to filter out these disconnected systems to show only the connected ones.

This PR implements filtering by status:connected when listing services.

⛓️ Related Resources

UI Card: #4343

👍 Definition of Done

You can filter for only connected services in the Automate API

👟 How to Build and Test the Change

hab pkg install -bf core/curl
hab pkg install -bf core/jq-static

build components/applications-service
start_all_services
applications_populate_database

At first all the services are connected, so nothing is filtered out. You can see the connected services with something like (adjust the jq query as you like):

curl -fsS -k -H "api-token: ${api_token}" "https://localhost/api/v0/applications/services?filter=status:connected"  | jq '.services | .[] | .id, .disconnected '

After 5 minutes or so, all the services should be disconnected and you won't see them in the above query. At this point, if you re-run applications_populate_database you will have a mix of connected and disconnected, which you can see by flipping the filter from status:connected to status:disconnected.

[netlify]

Deploy preview for chef-automate ready!

Built with commit 0386780

https://deploy-preview-4339--chef-automate.netlify.app

[kagarmoe]

@danielsdeleo Where would we document this--in https://github.com/chef/automate/blob/master/api/external/applications/applications.proto? As a variation of the GetServices method?

[danielsdeleo]

@kagarmoe this is an extension of the status filtering, which is currently here:

automate/api/external/applications/applications.proto

Line 446 in 8535c9a

// * `status:disconnected`: returns services in a disconnected state