Package io.quarkus.apicurio.registry.devservice

Interface ApicurioRegistryBuildTimeConfig.ApicurioRegistryDevServicesBuildTimeConfig

Enclosing interface:
ApicurioRegistryBuildTimeConfig
public static interface ApicurioRegistryBuildTimeConfig.ApicurioRegistryDevServicesBuildTimeConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    containerEnv()
    Environment variables that are passed to the container.
    Optional<Boolean>
    enabled()
    If Dev Services for Apicurio Registry has been explicitly enabled or disabled.
    Optional<String>
    imageName()
    The Apicurio Registry image to use.
    OptionalInt
    port()
    Optional fixed port the dev service will listen to.
    String
    serviceName()
    The value of the quarkus-dev-service-apicurio-registry label attached to the started container.
    boolean
    shared()
    Indicates if the Apicurio Registry instance managed by Quarkus Dev Services is shared.

  • Method Details

    • enabled

      Optional<Boolean> enabled()
      If Dev Services for Apicurio Registry has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Apicurio Registry, Dev Services starts a registry unless mp.messaging.connector.smallrye-kafka.apicurio.registry.url or mp.messaging.connector.smallrye-kafka.schema.registry.url is set.

    • port

      OptionalInt port()
      Optional fixed port the dev service will listen to.

      If not defined, the port will be chosen randomly.

    • imageName

      @ConfigDocDefault(value="`{apicurio-registry-image}`", escape=false) Optional<String> imageName()
      The Apicurio Registry image to use. Note that only Apicurio Registry 2.x images are supported. Specifically, the image repository must end with apicurio/apicurio-registry-mem.

    • shared

      @WithDefault("true") boolean shared()
      Indicates if the Apicurio Registry instance managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Apicurio Registry starts a new container.

      The discovery uses the quarkus-dev-service-apicurio-registry label. The value is configured using the service-name property.

      Container sharing is only used in dev mode.

    • serviceName

      @WithDefault("apicurio-registry") String serviceName()
      The value of the quarkus-dev-service-apicurio-registry label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for Apicurio Registry looks for a container with the quarkus-dev-service-apicurio-registry label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service-apicurio-registry label set to the specified value.

      This property is used when you need multiple shared Apicurio Registry instances.

    • containerEnv

      @ConfigDocMapKey("environment-variable-name") Map<String,String> containerEnv()
      Environment variables that are passed to the container.