Component-Registry¶
The Component-Registry maintains a state of the deployed ODA Components and Exposed APIs of an ODA Canvas. Its purpose is to serve as an inventory which allows resolving API dependencies between ODA Components.
It is also prepared to support Multi-Canvas scenarios, where an upstream Component-Registry allows resolving dependencies between different ODA Canvas installations.
Prerequisites¶
ODA Canvas is installed with default values.
(compreg not yet released. So, install from main branch is neccessary)
Port-Forward Component-Registry UI¶
to access the UI of the Component-Registry a port-forwarding (or any other kind of ingress) has to be established to make the UI accessible:
kubectl port-forward -n canvas svc/canvas-compreg 8080:80
Now the UI can be opened in a Browser:

Deploy ODA Component r-cat¶
From the BDD tests we can deploy the Retail-Catalog “r-cat”:
helm upgrade --install r-cat -n components --create-namespace feature-definition-and-test-kit/testData/productcatalog-v1
After a few seconds the UI shows the new ODA Component r-cat together with its exposed APIs:

Exposed API Information¶
In the column “Exposed APIs” additional info for each endpoint is shown.
The name of the Exposed API is a link which can be clicked and shows the raw TMF-639 data for this endpoint in the same way as clicking on “View Details” in the endpoint list below.
| The exposed API is of format Open-Api. Clicking on the icon will open the link in a new tab. | |
| The exposed API is of format Prometheus for scraping metrics. | |
| URL to the API endpoint. Klicking the icon opens the URL in a new tab. | |
| URL to the Swagger UI. Klicking the icon opens the Swagger UI in a new tab. | |
| Shows thet the Exposed API is available. If unavailable a red icon is shown. |
As we can see, r-cat is exposing the Open-API https://raw.githubusercontent.com/tmforum-apis/TMF620_ProductCatalog/master/TMF620-ProductCatalog-v4.0.0.swagger.json.
Resolve a Dependent-API¶
Next we want to see how dependency resolution works in the ODA Canvas.
Therefore we deploy another ODA Component “f-cat” which has a dependency to the exposed API of “r-cat”:
helm upgrade --install f-cat -n components --create-namespace feature-definition-and-test-kit/testData/productcatalog-dependendent-API-v1
To see the dependency resolution we look into the logfile of the Depent-API Operator logs:
kubectl logs -n canvas deployment/canvas-depapi-op
As this is hard to read we can also use the pretty printed output of the kubectl canvaslogs plugin:
kubectl canvaslogs depapi

In the red marked block we can see that the Dependant-API Operator contacted the cluster local Component-Registry and got one matching endpoint r-cat-productcatalogmanagement.
We can see the details in the DependentAPI custom resource:
$ kubectl get DependentAPI -n components # or shorter: kubectl get depapi -n components
NAME READY AGE SVCINVID
URL
f-cat-productcatalogmanagement-downstreamproductcatalog-v4 true 38m 64c513db-2fb1-42b5-9fdb-cb60024fe2e5
https://11.22.33.44/r-cat-productcatalogmanagement/tmf-api/productCatalogManagement/v4
Multi-Canvas Support¶
Warning¶
The following description uses an unsecured installation of the central Component-Registry. This is to simplify the Use-Case and make it easy to understand. A description how a secure setup of Component-Registry can be done can be found in Secured Setup of Component-Registry
Overview¶
The Component-Registry supports replication to an upstream Component-Registry. This allows a setup where multiple ODA Canvas instances replicate there exposed APIs into a central Component-Registry. For our scenario it looks like this:

Install a Central (Standalone) Component-Registry¶
The Helm charts used for installing the cluster-local Component-Registry can also be used to install the standalon Component-Registry:
helm upgrade --install -n compreg global-compreg --create-namespace charts/component-registry --set=canvasResourceInventory=
The only difference is to unset the canvasResourceInventory value. If this canvasResourceInventory is set, then a background process is started, which listens to changes in the local cluster and replicates the data from the ResourceInventory to the Compoennt-Registry. The standalone Component-Registry should only contain replicated values.
Connect Local Component-Registry to Global Component-Registry¶
for setting up a replication each Component-Registry has a /sync endpoint which allows configuring upstream registries. The UI supports this operation “Add New Upstream Subscription”:

The only input which has to be provided is the /sync endpoint of the upstream registry (global-compreg).
The name of the downstream (local) Component-Registry is automatically set to “canvas-compreg” as this was automatically set using the default oda-canvas values.
The URL can be retrieved from the UI of the Global-Compreg UI:

After successfull registration at the upstream registry the ID “global-compreg” appears in the Event-Subscription view. Here is a comparison, how the Component-Registry looks like local (left) and global (right):

Also it is to see, that the IDs of all resources are prefixed with “self:” in the local registry, while in the golbal registry the registered name of the downstream registry is used “canvas-compreg:”. The name of the canvas registry can be overwritten when installing the canvas with the “ownRegistryName” setting:
helm upgrade --install canvas oda-canvas/canvas-oda -n canvas --create-namespace --set component-registry.ownRegistryName=compreg-canvas-a
Multi-Canvas Service Discovery¶
Using this parameter we can now test a multi-canvas service discovery.
The first cluster “canvas-a” was installed with helm value -set component-registry.ownRegistryName=compreg-canvas-a and
the second cluster “canvas-b” was installed with helm value -set component-registry.ownRegistryName=compreg-canvas-b.
Both were connected (sync) with the Global Component-Registry.
In “canvas-b” r-cat was deployed as above.
In “canvas-a” f-cat was deployed as above.
Now looking at the global-compreg we see the following data:

Both ODA Component have a different prefix. “compreg-canvas-b:” for r-cat and “compreg-canvas-a:” for f-cat.
Now we can take a look at the Dependent-API Operator logs:

And here we can see, that there was no matching Exposed API found in the canvas local Component-Registry, but looking at the upstream registry “global-compreg” the “r-cat” entry from “canvas-b” was found. The upstream Component-Registry is automatically detected from the service discovery if the local Component-Registry has an upstream subscription.
The success can also be seen in the DeppendentAPI custom resource:
[IHC-DT-A] > kubectl get depapi -A
NAMESPACE NAME READY AGE SVCINVID
URL
components f-cat-productcatalogmanagement-downstreamproductcatalog-v4 true 18m 416497a6-0285-42e2-9959-20c48d27b71a
https://22.33.44.55/r-cat-productcatalogmanagement/tmf-api/productCatalogManagement/v4