Package io.quarkus.vault.runtime.config

Class DevServicesConfig

java.lang.Object

io.quarkus.vault.runtime.config.DevServicesConfig

public class DevServicesConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
boolean	enabled	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 commands
boolean	pkiEnabled	Should the PKI secret engine be enabled
OptionalInt	port	Optional fixed port the dev service will listen to.
String	serviceName	The value of the quarkus-dev-service-vault label attached to the started container.
boolean	shared	Indicates if the Vault instance managed by Quarkus Dev Services is shared.
boolean	transitEnabled	Should the Transit secret engine be enabled

Constructor Summary

Constructors

Constructor	Description
DevServicesConfig()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

enabled

@ConfigItem(defaultValue="true")
public 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

@ConfigItem
public Optional<String> imageName

The container image name to use, for container based DevServices providers.

shared

@ConfigItem(defaultValue="true")
public 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-vault label. The value is configured using the service-name property.

Container sharing is only used in dev mode.

serviceName

@ConfigItem(defaultValue="vault")
public String serviceName

The value of the quarkus-dev-service-vault 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 Vault looks for a container with the quarkus-dev-service-vault 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-vault label set to the specified value.

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

port

@ConfigItem
public OptionalInt port

Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

transitEnabled

@ConfigItem(defaultValue="false")
public boolean transitEnabled

Should the Transit secret engine be enabled

pkiEnabled

@ConfigItem(defaultValue="false")
public boolean pkiEnabled

Should the PKI secret engine be enabled

initCommands

@ConfigItem
public Optional<List<String>> initCommands

Custom container initialization commands

Constructor Detail

DevServicesConfig

public DevServicesConfig()

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object