An API/Schema registry - stores and retrieves APIs and Schemas.
This project supports several build configuration options that affect the produced executables.
mvn clean install produces an executable JAR with the dev Quarkus configuration profile enabled, and in-memory persistence implementation.
Apicurio Registry supports 3 persistence implementations:
If you enable one, a separate set of artifacts is produced with the persistence implementation available.
Additionally, there are 2 main configuration profiles:
- dev - suitable for development, and
- prod - for production environment.
./mvnw clean install -DskipTests cd app/ ../mvnw quarkus:dev
This should result in Quarkus and the in-memory registry starting up, with the ui and APIs available on localhost port 8080. Here are some links you can point your browser to once registry is started:
-Pprodenables Quarkus's prod configuration profile, which uses configuration options suitable for a production environment, e.g. a higher logging level.
-Psqlenables a build of
storage/sqlmodule and produces
apicurio-registry-storage-sql-<version>-all.zip. This artifact uses
H2driver in dev mode, and
PostgreSQLdriver in prod mode.
-Pkafkasqlenables a build of the
storage/kafkasqlmodule and produces the
-Pnative(experimental) builds native executables. See Building a native executable.
-Ddocker(experimental) builds docker images. Make sure that you have the docker service enabled and running. If you get an error, try
sudo chmod a+rw /var/run/docker.sock.
The following parameters are available for executable files:
- In the dev mode, the application expects an H2 server running at
- In the prod mode, you have to provide connection configuration for a PostgreSQL server as follows:
|Option||Command argument||Env. variable|
|Data Source URL||
To see additional options, visit:
./mvnw clean install -Pprod -Pkafkasql -DskipTests builds the KafkaSQL artifact.
The newly built runner can be found in
java -jar apicurio-registry-storage-kafkasql-<version>-SNAPSHOT-runner.jar
Should result in Quarkus and the registry starting up, with the ui and APIs available on localhost port 8080.
By default, this will look for a kafka instance on
localhost:9092, see kafka-quickstart.
Alternatively this can be connected to a secured kafka instance. For example, the following command provides the runner with the necessary details to connect to a kafka instance using a PKCS12 certificate for TLS authentication and scram-sha-512 credentials for user authorisation.
java \ -Dregistry.kafka.common.bootstrap.servers=<kafka_bootstrap_server_address> \ -Dregistry.kafka.common.ssl.truststore.location=<truststore_file_location>\ -Dregistry.kafka.common.ssl.truststore.password=<truststore_file_password> \ -Dregistry.kafka.common.ssl.truststore.type=PKCS12 \ -Dregistry.kafka.common.security.protocol=SASL_SSL \ -Dregistry.kafka.common.sasl.mechanism=SCRAM-SHA-512 \ -Dregistry.kafka.common.sasl.jaas.config='org.apache.kafka.common.security.scram.ScramLoginModule required username="<username>" password="<password>";' \ -jar storage/kafkasql/target/apicurio-registry-storage-kafkasql-2.1.6-SNAPSHOT-runner.jar
This will start up the registry with the persistence managed by the external kafka cluster.
Every time a commit is pushed to
main an updated set of docker images are built and pushed to Docker
Hub. There are several docker images to choose from, one for each storage option. The images include:
Run one of the above docker images like this:
docker run -it -p 8080:8080 apicurio/apicurio-registry-mem
The same configuration options are available for the docker containers, but only in the form of environment
variables (The command line parameters are for the
java executable and at the moment it's not possible to
pass them into the container). Each docker image will support the environment variable configuration options
documented above for their respective storage type.
There are a variety of docker image tags to choose from when running the registry docker images. Each
release of the project has a specific tag associated with it. So release
1.2.0.Final has an equivalent
docker tag specific to that release. We also support the following moving tags:
latest-snapshot: represents the most recent docker image produced whenever the
mainbranch is updated
latest-release: represents the latest stable (released) build of Apicurio Registry
latest: represents the absolute newest build - essentially the newer of
Run Apicurio Registry with Postgres:
mvn clean install -DskipTests -Pprod -Psql -Ddocker
Then create a docker-compose file
version: '3.1' services: postgres: image: postgres environment: POSTGRES_USER: apicurio-registry POSTGRES_PASSWORD: password app: image: apicurio/apicurio-registry-sql:2.0.0-SNAPSHOT ports: - 8080:8080 environment: REGISTRY_DATASOURCE_URL: 'jdbc:postgresql://postgres/apicurio-registry' REGISTRY_DATASOURCE_USERNAME: apicurio-registry REGISTRY_DATASOURCE_PASSWORD: password
docker-compose -f test.yml up
You can enable authentication for the application web console and core REST API using a server based on OpenID Connect (OIDC). The same server realm and users are federated across the application web console and core REST API using Open ID Connect so that you only require one set of credentials. In order no enable this integration, you just need to set the following environment variables.
||Whether to enable authentication or not|
||The client for the api|
||The client for the ui|
Note that you will need to have everything created before starting the application, the realm and the two clients.
Some notes about using the Eclipse IDE with the Apicurio Registry codebase. Before importing the registry into your workspace, we recommend some configuration of the Eclipse IDE.
We use the Lombok code generation utility in a few places. This will cause problems
when Eclipse builds the sources unless you install the Lombok+Eclipse integration. To
do this, either download the Lombok JAR or find it in your
directory (it will be available in
.m2 if you've done a maven build of the registry).
Once you find that JAR, simply "run" it (e.g. double-click it) and using the resulting
UI installer to install Lombok support in Eclipse.
Maven Dependency Plugin (unpack, unpack-dependencies)
We use the maven-dependency-plugin in a few places to unpack a maven module in the
reactor into another module. For example, the
app module unpacks the contents of
ui module to include/embed the user interface into the running application.
Eclipse does not like this. To fix this, configure the Eclipse Maven "Lifecycle Mappings"
to ignore the usage of maven-dependency-plugin.
- Open up Window->Preferences
- Choose Maven->Lifecycle Mappings
- Click the button labeled Open workspace lifecycle mappings metadata
- This will open an XML file behind the preferences dialog. Click Cancel to close the Preferences.
- Add the following section to the file:
<pluginExecution> <pluginExecutionFilter> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <versionRange>3.1.2</versionRange> <goals> <goal>unpack</goal> <goal>unpack-dependencies</goal> </goals> </pluginExecutionFilter> <action> <ignore /> </action> </pluginExecution>
- Now go back into Maven->Lifecycle Mappings -> Maven->Lifecycle Mappings and click the Reload workspace lifecycle mappings metadata button.
- If you've already imported the Apicurio projects, select all of them and choose Maven->Update Project.
Prevent Eclipse from aggressively cleaning generated classes
We use some Google Protobuf files and a maven plugin to generate some Java classes that
get stored in various modules'
target directories. These are then recognized by m2e
but are sometimes deleted during the Eclipse "clean" phase. To prevent Eclipse from
over-cleaning these files, find the os-maven-plugin-1.6.2.jar JAR in your
.m2/repository directory and copy it into