Problem:

We are implementing the Primaza Project. There is a need to register Clusters that can be used to discover services and manage claims for those services. See Primaza Architecture for details on cluster registration.

Goal:

To create a service catalog of services that can be discovered and claimed by application developers

Why is it important?

This will enable developers to be abstracted away from the details about how services are provisioned and managed. They will only have visibility to claimable service catalog and to manage claims for those services.

Use cases

• As a k8 admin, I would like Primaza to provide out of the box ServiceClass resources for popular services so that services are discovered automatically.
• As a k8 admin, I would like to register a service with all the information required for identifying and claiming the service so that I can build my catalog of Primaza services.
• As a k8 admin, I would like Primaza to discover services described by service classes available so that I can benefit from automation to create RegisterService resources.
• As a k8 admin, I would like to have a mechanism to be able to add or remove a RegisterService from the Primaza service catalog.
• As a k8 admin, I would like to be able to augment/update an existing RegisterService before making it available in the Primaza service catalog.
• As a k8 admin, I would like to have an easy way to package my RegisteredService resources as a helm chart, so that I can easily run tests (helm test) for my RegisteredService resources.

Demo requirements

A great demo for this will show two ways to register a service, e.g., manually or via discovery. It will also show those services advertised in the application clusters where claims can be created.

UI requirements

The UI for primaza will be used for demo and marketing purposes only during MVP. For GA the UI will depend on what OpenShift or StoneSoup tools we integrate with.

Acceptance criteria

• Development:
  Can register service manual
  Can create service classes
  Can discover services vi service classes
  Can update registered services
  Can delete register services.
  Can advertise registered services in application cluster environments.
  Can Track registered services metrics for the OpenShift Fleet
• QE:
  Github flow set up to execute behave test harness
  Service Registration Tests are implemented and run on PR updates
• Documentation:
  All Registration Options are documented in our primaza github project
  Discovery logic via service classes is documented
• UI:
  There is a UI that can facilitate the lifecycle of register service resources

Dependencies (External/Internal)

TBD

Design Artifacts

Primaza Architecture

Exploration

Note