Package io.quarkiverse.openfga.deployment

Interface DevServicesOpenFGAConfig

public interface DevServicesOpenFGAConfig

  • Method Details

    • enabled

      Optional<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.

    • imageName

      Optional<String> imageName()
      The container image name to use, for container based DevServices providers.

    • shared

      @WithDefault("true") boolean shared()
      Indicates if the OpenFGA instance managed by Quarkus DevServices 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, DevServices for OpenFGA starts a new container.

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

      Container sharing is only used in 'dev' mode.

    • serviceName

      @WithDefault("openfga") String serviceName()
      The value of the quarkus-dev-service-openfga label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, DevServices for OpenFGA looks for a container with the quarkus-dev-service-openfga 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-openfga label set to the specified value.

      This property is used when you need multiple shared OpenFGA instances.

    • httpPort

      OptionalInt httpPort()
      Optional fixed port the HTTP service will be bound to.

      If not defined, the port will be chosen randomly.

    • grpcPort

      OptionalInt grpcPort()
      Optional fixed port the gRPC service will be bound to.

      If not defined, the port will be chosen randomly.

    • playgroundPort

      OptionalInt playgroundPort()
      Optional fixed port the Playground service will be bound to.

      If not defined, the port will be chosen randomly.

    • storeName

      @WithDefault("dev") String storeName()
      Name of authorization store to create for DevServices.

      Defaults to "dev".

    • authorizationModel

      Optional<String> authorizationModel()
      JSON formatted authorization model to upload during DevServices initialization.

    • authorizationModelLocation

      Optional<String> authorizationModelLocation()
      Location of JSON formatted authorization model file to upload during DevServices initialization.

      The location can be prefixed with classpath: or filesystem: to specify where the file will be read from; if not prefixed, it will be read from the classpath.

    • authorizationTuples

      Optional<String> authorizationTuples()
      JSON formatted authorization tuples to upload during DevServices initialization.

    • authorizationTuplesLocation

      Optional<String> authorizationTuplesLocation()
      Location of JSON formatted authorization tuples file to upload during DevServices initialization.

      The location can be prefixed with classpath: or filesystem: to specify where the file will be read from; if not prefixed, it will be read from the classpath.

    • authentication

      DevServicesOpenFGAConfig.Authentication authentication()
      Authentication configuration to use for the DevServices OpenFGA instance.

    • tls

      Optional<DevServicesOpenFGAConfig.Tls> tls()
      TLS configuration to use for the DevServices OpenFGA instance.

    • startupTimeout

      @WithDefault("5s") Duration startupTimeout()
      Timeout while creating the store/authorizationModel