Apicurio Registry

About Apicurio Registry

Apicurio Registry is used by Platform Manager to store subjects for the Kafka Clients.

Docker Environment Variables

The table below provides a comprehensive overview of the Docker environment variables available for configuring the Apicurio Registry container. You can customize the environment variables to match your specific configuration.

Name Possible Values Required Description

REGISTRY_LEVEL_ROOT

string
default: "INFO"

No

Root logging level

CLIENT_CREDENTIALS_BASIC_AUTH_ENABLED

string

No

Configure Apicurio Registry to support HTTP basic authentication

KEYCLOAK_URL

string

No

The URL of the Keycloak authentication server to use. Must end with /auth.

KEYCLOAK_REALM

string

No

The Keycloak realm used for authentication.

REGISTRY_AUTH_URL_CONFIGURED

string

No

UI auth OIDC URL

REGISTRY_OIDC_UI_CLIENT_ID

string

No

UI auth OIDC client ID

REGISTRY_OIDC_UI_REDIRECT_URL

string

No

UI auth OIDC redirect URL

KAFKA_BOOTSTRAP_SERVERS

string

Yes

Kafka Bootstrap servers

REGISTRY_KAFKASQL_TOPIC

string

Yes

Kafka Topic to store the artifacts and configuration

REGISTRY_KAFKASQL_TOPIC_AUTO_CREATE

boolean
default: false

No

Allow creating the Kafka Topic to store the artifacts and configuration automatically

ENABLE_CCOMPAT_CANONICAL_HASH_MODE

boolean

No

Make ccompat use canonical hash

ENABLE_CCOMPAT_LEGACY_ID_MODE

boolean

No

Legacy mode for ccompat API

REGISTRY_UI_AUTH_TYPE

string

No

UI auth type

REGISTRY_AUTH_ANONYMOUS_READ_ACCESS_ENABLED

boolean

No

Allow anonymous users to read-only artifacts

REGISTRY_AUTH_RBAC_ENABLED

boolean

No

Enable Apicurio Registry user roles

Running the Docker Container

The following Docker run command starts the Apicurio Registry container with minimum essential environment variables and volume mounts.

Example:

docker run --rm --name example-apicurio-container \
[IMAGE_REGISTRY]/axual/apicurio-registry-kafkasql:[IMAGE_TAG]