Configuring your Apicurio Registry deployment

In the Keycloak Admin Console, create a Keycloak realm for Apicurio Registry. By default, Apicurio Registry expects a realm name of registry. For more details on creating realms, see Getting Started with Keycloak.

Create a Keycloak client for the Apicurio Registry API. By default, Apicurio Registry expects the following settings:

Create a Keycloak client for the Apicurio Registry web console. By default, Apicurio Registry expects the following settings:

In your Apicurio Registry deployment on OpenShift, set the following Apicurio Registry environment variables to configure authentication using Keycloak:

Set the following option to true to enable Apicurio Registry user roles in Keycloak:

When Apicurio Registry user roles are enabled, you must assign Apicurio Registry users to at least one of the following default user roles in your Keycloak realm:

Set the following to true to enable owner-only authorization for updates to schema and API artifacts in Apicurio Registry:

Use this curl command to obtain the current log level for the logger io.apicurio.registry.storage:

$ curl -i localhost:8080/apis/registry/v2/admin/loggers/io.apicurio.registry.storage
HTTP/1.1 200 OK
[...]
Content-Type: application/json
{"name":"io.apicurio.registry.storage","level":"INFO"}

Use this curl command to change the log level for the logger io.apicurio.registry.storage to DEBUG:

$ curl -X PUT -i -H "Content-Type: application/json" --data '{"level":"DEBUG"}' localhost:8080/apis/registry/v2/admin/loggers/io.apicurio.registry.storage
HTTP/1.1 200 OK
[...]
Content-Type: application/json
{"name":"io.apicurio.registry.storage","level":"DEBUG"}

Use this curl command to revert the log level for the logger io.apicurio.registry.storage to its default value:

$ curl -X DELETE -i localhost:8080/apis/registry/v2/admin/loggers/io.apicurio.registry.storage
HTTP/1.1 200 OK
[...]
Content-Type: application/json
{"name":"io.apicurio.registry.storage","level":"INFO"}

When using the HTTP protocol, set your Apicurio Registry configuration to send events to a your application as follows:

If required, you can configure multiple event consumers as follows:

When using the Kafka protocol, set your Kafka topic as follows:

You can set the configuration for the Kafka producer using the KAFKA_BOOTSTRAP_SERVERS environment variable:

If required, you can also set the Kafka topic partition to use to produce events:

In the OpenShift Container Platform web console, log in using an account with cluster administrator privileges.

Click Installed Operators > Apicurio Registry.

On the ApicurioRegistry tab, click the Operator custom resource for your deployment, for example, example-apicurioregistry.

In the main overview page, find the Deployment Name section and the corresponding DeploymentConfig name for your Apicurio Registry deployment, for example, example-apicurioregistry.

In the left navigation menu, click Workloads > Deployment Configs, and select your DeploymentConfig name.

Click the Environment tab, and enter your environment variables in the Single values env section, for example:

Click Save at the bottom.