cloudfoundry / cloudfoundry/stratos

service meta-data (labels and annotations) support: display and filter-by

Open
#4,089 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

community feature-request v3 api
Dominant language
TypeScript
Stars
267
Forks
137
Avg merge
5h 14m
Merged PRs (30d)
77

Description

Expected behaviour

As a stratos CF user, in order to display CF metadata (labels and annotations attached to a service instance, I need the services and space service view to display labels and annotations if any.

As a stratos CF user, in order to search/filter services by labels, I need the services view to offer to filter by annotation name, value and operator (see the rich selector syntax with [in]existence, [in]equality, inclusion, exclusion).

Actual behaviour

Annotations and metadata are not yet displayed in the services view
image

Annotations and metadata are not yet displayed in the space services view
image

As a workaround, users need to use the CF CLI curl command, although the /v3/service_instances/GUID is not yet available as of Jan 2020, see https://github.com/orange-cloudfoundry/osb-cmdb-spike/issues/10#issuecomment-567967267 for more detailed analysis

Context

Why is this change important to you? How would you use it?

This would be used to use stratos for osb-cmdb with meta-data attached to service instances, as a UI view complementing CF CLI usage (see also current CF CLI workaround)

How can it benefit other users?

Users want to attach metadata to service instances, such as email address to alert on when service instance fails, or billing/recharging code.

Possible Implementation

For listing and filtering by meta-data, by using the currently available /v3/service_instances?label_selector= CF V3 API endpoint , see meta-data doc

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the services and space service views and the CF V3 service-instances endpoint, including its label_selector query syntax. Done means labels and annotations are displayed where present and the services view supports the requested annotation name, value, and operator filters.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
api, cloud, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.