Package io.quarkus.vault.runtime.config
Interface DevServicesConfig
-
public interface DevServicesConfig
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanenabled()If DevServices has been explicitly enabled or disabled.Optional<String>imageName()The container image name to use, for container based DevServices providers.Optional<List<String>>initCommands()Custom container initialization commandsbooleanpkiEnabled()Should the PKI secret engine be enabledOptionalIntport()Optional fixed port the dev service will listen to.StringserviceName()The value of thequarkus-dev-service-vaultlabel attached to the started container.booleanshared()Indicates if the Vault instance managed by Quarkus Dev Services is shared.StringtoString()booleantransitEnabled()Should the Transit secret engine be enabled
-
-
-
Method Detail
-
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 vault instance when running in Dev or Test mode and when Docker is running.
-
imageName
Optional<String> imageName()
The container image name to use, for container based DevServices providers.
-
shared
@WithDefault("true") boolean shared()Indicates if the Vault 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 Vault starts a new container.The discovery uses the
quarkus-dev-service-vaultlabel. The value is configured using theservice-nameproperty.Container sharing is only used in dev mode.
-
serviceName
@WithDefault("vault") String serviceName()The value of thequarkus-dev-service-vaultlabel attached to the started container. This property is used whensharedis set totrue. In this case, before starting a container, Dev Services for Vault looks for a container with thequarkus-dev-service-vaultlabel 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 thequarkus-dev-service-vaultlabel set to the specified value.This property is used when you need multiple shared Vault instances.
-
port
OptionalInt port()
Optional fixed port the dev service will listen to.If not defined, the port will be chosen randomly.
-
transitEnabled
@WithDefault("false") boolean transitEnabled()Should the Transit secret engine be enabled
-
pkiEnabled
@WithDefault("false") boolean pkiEnabled()Should the PKI secret engine be enabled
-
-