Package io.quarkus.redis.deployment.client

Interface DevServicesConfig

public interface DevServicesConfig

  • Method Summary

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

  • Method Details

    • enabled

      @WithDefault("true") boolean enabled()
      If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

      When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.

    • imageName

      @ConfigDocDefault(value="`{redis-image}`", escape=false) Optional<String> imageName()
      The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search...), use: redis/redis-stack:latest.

    • port

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

      If not defined, the port will be chosen randomly.

    • shared

      @WithDefault("true") boolean shared()
      Indicates if the Redis server 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 Redis starts a new container.

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

      Container sharing is only used in dev mode.

    • serviceName

      @WithDefault("redis") String serviceName()
      The value of the quarkus-dev-service-redis 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 Redis looks for a container with the quarkus-dev-service-redis 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-redis label set to the specified value.

      This property is used when you need multiple shared Redis servers.

    • containerEnv

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