Package io.quarkus.vault.runtime.config

Class CredentialsProviderConfig

java.lang.Object

io.quarkus.vault.runtime.config.CredentialsProviderConfig

public class CredentialsProviderConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	credentialsMount	Mount of dynamic credentials secrets engine, for example `database` or `rabbitmq`.
String	credentialsRequestPath	Path of dynamic credentials request.
Optional<String>	credentialsRole	Dynamic credentials' role.
static String	DATABASE_DEFAULT_MOUNT
Optional<String>	databaseCredentialsRole	Deprecated. Use `credentials-role` with `credentials-mount` set to `database`
static String	DEFAULT_REQUEST_PATH
String	kvKey	Key name to search in vault path `kv-path`.
Optional<String>	kvPath	A path in vault kv store, where we will find the kv-key.
static String	RABBITMQ_DEFAULT_MOUNT

Constructor Summary

Constructors

Constructor	Description
CredentialsProviderConfig()

Method Summary

Modifier and Type	Method	Description
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DATABASE_DEFAULT_MOUNT

public static final String DATABASE_DEFAULT_MOUNT

See Also:

Constant Field Values

RABBITMQ_DEFAULT_MOUNT

public static final String RABBITMQ_DEFAULT_MOUNT

See Also:

Constant Field Values

DEFAULT_REQUEST_PATH

public static final String DEFAULT_REQUEST_PATH

See Also:

Constant Field Values

databaseCredentialsRole

@Deprecated(since="2.6")
@ConfigItem
public Optional<String> databaseCredentialsRole

Deprecated.

Use `credentials-role` with `credentials-mount` set to `database`

Database credentials role, as defined by https://www.vaultproject.io/docs/secrets/databases/index.html Only one of `database-credentials-role`, `credentials-role` or `kv-path` can be defined.

credentialsRole

@ConfigItem
public Optional<String> credentialsRole

Dynamic credentials' role. Roles are defined by the secret engine in use. For example, `database` credentials roles are defined by the database secrets engine described at https://www.vaultproject.io/docs/secrets/databases/index.html. One of `credentials-role` or `kv-path` can to be defined. not both.

credentialsMount

@ConfigItem(defaultValue="database")
public String credentialsMount

Mount of dynamic credentials secrets engine, for example `database` or `rabbitmq`. Only used when `credentials-role` is defined.

credentialsRequestPath

@ConfigItem(defaultValue="creds")
public String credentialsRequestPath

Path of dynamic credentials request. Request paths are dictated by the secret engine in use. For standard secret engines this should be left as the default of `creds`. Only used when `credentials-role` is defined.

kvPath

@ConfigItem
public Optional<String> kvPath

A path in vault kv store, where we will find the kv-key. One of `database-credentials-role` or `kv-path` needs to be defined. not both. see https://www.vaultproject.io/docs/secrets/kv/index.html

kvKey

@ConfigItem(defaultValue="password")
public String kvKey

Key name to search in vault path `kv-path`. The value for that key is the credential. `kv-key` should not be defined if `kv-path` is not. see https://www.vaultproject.io/docs/secrets/kv/index.html

Constructor Detail

CredentialsProviderConfig

public CredentialsProviderConfig()

Method Detail

toString

public String toString()

Overrides:

toString in class Object