Service Registry

Prerequisite

  • Setup Red Hat AMQ Streams Lab

  • Stop all server in previous lab

    • type ctrl+c in each terminal (stop kafka before stop zookeeper)

    • check kafka broker and zookeeper process with jps command

      jps

  • clear old data in previous lab

    rm -rf /tmp/zookeep*
rm -rf /tmp/kaf*

  • start zookeeper

    cd ~/amq-streams-2022/4-management
./kafka/bin/zookeeper-server-start.sh ./kafka/config/zookeeper.properties

  • start kafka broker

    cd ~/amq-streams-2022/4-management
./kafka/bin/kafka-server-start.sh ./kafka/config/server.properties

Install Service Registry

Install Service Registry Operator (OpenShift Admin Task, Ready Now for This Lab)

  • Login to red hat openshift with admin user

  • In Administrator Perspective, Go to Operators -> OperatorHub menu. Enter service registry into the search box, the Red Hat Integration - Service Registry Operator will show up on the screen. Then click on it.

  • A panel with details of the operator will show up on the right. Then click Install button.

  • You can leave all options as default or change them if needed i.e. install the operator to the project you've created earlier. Then click Install button.

  • Wait until the operator gets installed successfully before proceeding to next steps.

Create OpenShift Project

  • Open your web browser, Login to red hat openshift with

    • Openshift Console URL : --> get it from your instructor

    • User Name/Password : --> get it from your instructor such as user1/openshift

    • go to developer console

  • Go to Projects menu, then click on Create Project button.

  • Enter a project name such as YOUR_USER_NAME-service-registry (such as user1-service-registry)

  • Change YOUR_USER_NAME to your user name then click on Create button.

Create Database for Service Registry

  • Service Registry support 2 type of storage, kafka & database. we select database for this lab.

  • In Developer Console, select Menu Topology from left menu. right click on panel and select Add to Project --> Database, Console will change to Database Catalog

  • In Database Catalog, select PostgreSQL

  • Click Instantiate Template

  • In Instantiate Template, leave all default value except:

    • Database Service Name : service-registry

    • PostgreSQL Conneciton Username : service-registry

    • PostgreSQL Connection Password : service-registry

    • PostgreSQL Database Name : service-registry

  • click Create and wait until database ready (circle around pod service-registry change to dark blue color)

Create Service Registry

  • In Topology View, click Add to Project Button (book icon)

  • type "registry" in search box, select "Apicurio Registry" and click Create button

  • In Create ApicurioRegistry Panel, change configure via to YAML view and copy yaml from apicurio.yml to editor

    • check username/password is "service-registry"

    • check jdc url, change user1-service-registry to your project name

    • click "Create" button

  • wait until service registry ready (change color to dark blue)

  • open service registry console by click Open URL on service registry poc icon

Managing schema and API artifacts using Service Registry REST API commands

  • create schema on service registry with REST API command line

    • chnage "user1-service-registry" to your project name before run below command!

    • change "apps.cluster-82xm2.82xm2.sandbox503.opentlc.com" to your current domain of openshift --> get it from openshift console url

    example result

  • retreive schama from service registry with REST API command line

    • change "user1-service-registry" to your project name before run below command!

    • change "apps.cluster-82xm2.82xm2.sandbox503.opentlc.com" to your current domain of openshift --> get it from openshift console url

    example result

  • Review previous schema in service registry console

Kafka Client Schema Validation with Service Registry

  • Service Registry provides client serializers/deserializers (SerDes) for Kafka producer and consumer applications written in Java. Kafka producer applications use serializers to encode messages that conform to a specific event schema. Kafka consumer applications use deserializers to validate that messages have been serialized using the correct schema, based on a specific schema ID. This ensures consistent schema use and helps to prevent data errors at runtime.

  • Review Kafka Client Schema Validation Java Client code at SimpleAvroExample.java

    • Review and Edit properties of application

      • REREGISTRY_URL : change to your service registry URL

        • change "user1-service-registry" to your project name before run below command!

        • change "apps.cluster-82xm2.82xm2.sandbox503.opentlc.com" to your current domain of openshift --> get it from openshift console url

      • SERVERS : kafka bootstrap such as localhost:9092

      • TOPIC_NAME : topic for this application

      • SCHEMA : ARVO schama of this application

    • Review properties setting in createKafkaProducer method

      • KEY_SERIALIZER_CLASS_CONFIG : Serializer for "key" of message

      • VALUE_SERIALIZER_CLASS_CONFIG : Serializer for "message"

      • REGISTRY_URL : URL of Service Registry

      • AUTO_REGISTER_ARTIFACT : set auto register schema to service registry if don't found

    • Review properties setting in createKafkaConsumer method

      • KEY_DESERIALIZER_CLASS_CONFIG : DeSerializer for "key" of message

      • VALUE_DESERIALIZER_CLASS_CONFIG : DeSerializer for "message"

      • REGISTRY_URL : URL of Service Registry

  • Try to run kafka client

    example result

  • Try again with invalid schema

    • change code in SimpleAvroExample.java

    • go to line 89, remove remark code to enable invalid schema

      to

    • run client again

      example result

More Example of Service Registry

More Detail about Advanced Red Hat Service Registry

PreviousHTTP Bridge

Last updated