Owner: Architect:

Francesco Ilario

Story (Required)

As a Application Developer,
I would like to have the ServiceCatalog displaying the services mountable by label
so that I can easily understand how I should label my application

Background (Required)

As of now, the ServiceCatalog just displays the Services that are Available, i.e. not claimed yet.
However, services bound by label may be bound to multiple services.
The Application Developer should be informed of this services and of the labels they should use for binding.

We want to provide a section in the ServiceCatalog in which we list the Services to which the Application Developer can bind by labelling its application.

See epic for arch document link.

Glossary

See glossary in architecture document

Out of scope

NA

In Scope

• ServiceCatalog section for Services available by label

Approach(Required)

Add a new section in the ServiceCatalog for services claimed by Labels, like the following

apiVersion: primaza.io/v1alpha1
kind: ServiceCatalog
spec: 
  services: 
  - Name: my_available_service
    ServiceClassIdentity: [type/value, provider/value, version/value]
    ServiceEndpointDefinitionKeys: [hostname, port, database, username, password]
    ....
  claimedByLabels: 
  - Name: my_claimed_by_labels_service
    ServiceClassIdentity: [type/value, provider/value, version/value]
    ServiceEndpointDefinitionKeys: [hostname, port, database, username, password]
    labels: 
    - my_label: label_value
    ...

Demo requirements(Required)

NA

Dependencies

NA

Edge Case

NA

BDD Tests

You can find BDD Test specification for this story in the "Testing Instruction" Field Tab or in the GitHub Issue linked to this story.
Click here for all BDD Tests Issues.

Acceptance Criteria

• Development
  ServiceClaim controller updates the ServiceCatalog when a ServiceClaim using labels is resolved

• QE
  There are test cases for ServiceCatalog's claimedByLabels section update

• Docs
  There is a section in our ServiceCatalog doc dedicated to explaining the claimedByLabels section
  Update architecture document with any changes while implementing

INVEST Checklist

Dependencies identified
Blockers noted and expected delivery timelines set
Design is implementable
Acceptance criteria agreed upon
Story estimated

Legend

Unknown
Verified
Unsatisfied