Owner: Architect:

David Peraza

Story (Required)

As a Primaza Admin, I will like to register a service manually so that it can be claimed by OpenShift Developer working on Developer clusters.

Background (Required)

We need to implement the RegisteredService API as define in the Primaza architecture document. See Epic for link

Glossary

See Architecture document Glossary

Out of scope

Discovery, Healthcheck, Pushing Service Catalog

In Scope

The CRD definition for RegisterService and ServiceCatalog and a ServiceRegistrar controller that tracks the status

Approach(Required)

Normally a registered service state before healthcheck is run will be registered. For now if the HealthCheckImage and the HealthCheckCmd are not defined take the state to available. Healthcheck will be implemented in other story. Also, this controller will be in charge of switch to and from claimed state. It will depend on whether there is a ServiceClaim resource or not referencing this RegisteredService. If service claim CRD is no present, skip the claimed state transition. Finally, the controller will be in charge of advertising the registered services in the application clusters. All RegisteredService resources in available state will be added to the ServiceCatalog resource. The resource will also be synched to all the Application namespaces for all online RegisterdClusters of type Application or ApplicationAndService.

Demo requirements(Required)

A good demo will show a few registered services being added to the service catalog and pushed to the application namespaces

Dependencies

NA

Edge Case

NA

Acceptance Criteria

There is a controller that handles the following:
When RegisteredService is created without Healthcheck state moves to Available
When RegisteredService is create a new Item is added to the ServiceCatalog
When RegisterdService is claimed its state will change to claimed and ServiceCatalog updated to remove the claimed service.
Write test cases for above scenarios
Write Documentation explaining RegisteredServices
Update primaza architecture with changes if any

INVEST Checklist

Dependencies identified

Blockers noted and expected delivery timelines set

Design is implementable

Acceptance criteria agreed upon

Story estimated

v

Legend

Unknown

Verified

Unsatisfied