Add extension for Apicurio Registry Avro

quarkusio · Jun 9, 2021 · d9d50a2 · d9d50a2
1 parent 7249369
commit d9d50a2
Show file tree

Hide file tree

Showing 21 changed files with 761 additions and 189 deletions.
diff --git a/bom/application/pom.xml b/bom/application/pom.xml
@@ -209,6 +209,7 @@
         <log4j2-jboss-logmanager.version>1.0.0.Final</log4j2-jboss-logmanager.version>
         <log4j-jboss-logmanager.version>1.2.0.Final</log4j-jboss-logmanager.version>
         <avro.version>1.10.2</avro.version>
+        <apicurio-registry.version>2.0.0.Final</apicurio-registry.version>
         <jacoco.version>0.8.7</jacoco.version>
         <testcontainers.version>1.15.3</testcontainers.version>
         <docker-java.version>3.2.8</docker-java.version> <!-- must be the version Testcontainers use -->
@@ -1106,6 +1107,16 @@
                 <artifactId>quarkus-avro-deployment</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-apicurio-registry-avro</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-apicurio-registry-avro-deployment</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>io.quarkus</groupId>
                 <artifactId>quarkus-smallrye-health</artifactId>
@@ -2844,6 +2855,11 @@
                 <artifactId>agroal-pool</artifactId>
                 <version>${agroal.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.apicurio</groupId>
+                <artifactId>apicurio-registry-serdes-avro-serde</artifactId>
+                <version>${apicurio-registry.version}</version>
+            </dependency>
             <dependency>
                 <groupId>io.smallrye.reactive</groupId>
                 <artifactId>mutiny</artifactId>

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/Feature.java b/core/deployment/src/main/java/io/quarkus/deployment/Feature.java
@@ -19,6 +19,7 @@ public enum Feature {
     AMAZON_SES,
     AMAZON_KMS,
     AMAZON_SSM,
+    APICURIO_REGISTRY_AVRO,
     ARTEMIS_CORE,
     ARTEMIS_JMS,
     CACHE,

diff --git a/devtools/bom-descriptor-json/pom.xml b/devtools/bom-descriptor-json/pom.xml
@@ -318,6 +318,19 @@
                         </exclusion>
                     </exclusions>
                 </dependency>
+                <dependency>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-apicurio-registry-avro</artifactId>
+                    <version>${project.version}</version>
+                    <type>pom</type>
+                    <scope>test</scope>
+                    <exclusions>
+                        <exclusion>
+                            <groupId>*</groupId>
+                            <artifactId>*</artifactId>
+                        </exclusion>
+                    </exclusions>
+                </dependency>
                 <dependency>
                     <groupId>io.quarkus</groupId>
                     <artifactId>quarkus-arc</artifactId>

diff --git a/docs/pom.xml b/docs/pom.xml
@@ -279,6 +279,19 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-apicurio-registry-avro-deployment</artifactId>
+            <version>${project.version}</version>
+            <type>pom</type>
+            <scope>test</scope>
+            <exclusions>
+                <exclusion>
+                    <groupId>*</groupId>
+                    <artifactId>*</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-arc-deployment</artifactId>

diff --git a/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc b/docs/src/main/asciidoc/apicurio-registry-dev-services.adoc
@@ -0,0 +1,41 @@
+////
+This guide is maintained in the main Quarkus repository
+and pull requests should be submitted there:
+https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
+////
+= Dev Services for Apicurio Registry
+
+include::./attributes.adoc[]
+
+If the `quarkus-apicurio-registry-avro` extension is present, Dev Services for Apicurio Registry automatically starts an Apicurio Registry instance in dev mode and when running tests.
+Also, all Kafka channels in SmallRye Reactive Messaging are automatically configured to use this registry.
+(This automatic configuration of course only applies to serializers and deserializers from the Apicurio Registry Avro library.)
+
+== Enabling / Disabling Dev Services for Apicurio Registry
+
+Dev Services for Apicurio Registry is automatically enabled unless:
+
+- `quarkus.apicurio-registry.devservices.enabled` is set to `false`
+- `mp.messaging.connector.smallrye-kafka.apicurio.registry.url` is configured
+- all the Reactive Messaging Kafka channels have the `apicurio.registry.url` attribute set
+
+Dev Services for Apicurio Registry relies on Docker to start the registry.
+If your environment does not support Docker, you will need to start the registry manually, or use an already running registry.
+You can configure the registry URL for all Kafka channels in SmallRye Reactive Messaging with a single property:
+
+[source,properties]
+----
+mp.messaging.connector.smallrye-kafka.apicurio.registry.url=http://localhost:8081/apis/registry/v2
+----
+
+== Setting the port
+
+By default, Dev Services for Apicurio Registry picks a random port and configure the application.
+You can set the port by configuring the `quarkus.apicurio-registry.devservices.port` property.
+
+Note that the Kafka channels in SmallRye Reactive messaging are automatically configured with the chosen port.
+
+== Configuring the image
+
+By default, Dev Services for Apicurio Registry uses `apicurio/apicurio-registry-mem:2.0.0.Final`.
+Any 2.x version of Apicurio Registry can be used by setting the `quarkus.apicurio-registry.devservices.image-name` configuration property.
diff --git a/docs/src/main/asciidoc/kafka-dev-services.adoc b/docs/src/main/asciidoc/kafka-dev-services.adoc
@@ -7,11 +7,11 @@ https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
 
 include::./attributes.adoc[]
 
-Dev Services for Kafka automatically starts a Kafka broker in dev mode and when running tests.
+If any Kafka-related extension is present (e.g. `quarkus-smallrye-reactive-messaging-kafka`), Dev Services for Kafka automatically starts a Kafka broker in dev mode and when running tests.
 So, you don't have to start a broker manually.
 The application is configured automatically.
 
-IMPORTANT: Because starting a Kafka broker can be long, Dev Services for Kafka uses https://vectorized.io/redpanda[Red Panda], a Kafka compatible broker which starts in ~1 second.
+IMPORTANT: Because starting a Kafka broker can be long, Dev Services for Kafka uses https://vectorized.io/redpanda[Redpanda], a Kafka compatible broker which starts in ~1 second.
 
 == Enabling / Disabling Dev Services for Kafka
 
@@ -35,6 +35,6 @@ Note that the Kafka advertised address is automatically configured with the chos
 == Configuring the image
 
 By default, Dev Services for Kafka uses: `vectorized/redpanda:latest`.
-You can select any version from https://hub.docker.com/r/vectorized/redpanda.
+You can use any version from https://hub.docker.com/r/vectorized/redpanda by setting the `quarkus.kafka.devservices.image-name` configuration property.
 
-IMPORTANT: Dev Services for Kafka only support Red Panda.
+IMPORTANT: Dev Services for Kafka only support Redpanda.