Class KubernetesAuthenticationOptions

java.lang.Object

org.springframework.vault.authentication.KubernetesAuthenticationOptions

public class KubernetesAuthenticationOptions
extends Object

Authentication options for KubernetesAuthentication.

Authentication options provide the path, role and jwt supplier. KubernetesAuthentication can be constructed using builder(). Instances of this class are immutable once constructed.

Defaults to obtain the token from /var/run/secrets/kubernetes.io/serviceaccount/token on each login.

Since:

2.0

Author:

Michal Budzyn, Mark Paluch

See Also:

• KubernetesAuthentication
• KubernetesJwtSupplier
• KubernetesServiceAccountTokenFile
• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KubernetesAuthenticationOptions.KubernetesAuthenticationOptionsBuilder	Builder for KubernetesAuthenticationOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_KUBERNETES_AUTHENTICATION_PATH

Method Summary

Modifier and Type	Method	Description
static KubernetesAuthenticationOptions.KubernetesAuthenticationOptionsBuilder	builder()
Supplier<String>	getJwtSupplier()
String	getPath()
String	getRole()

Methods inherited from class Object

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

Field Details

DEFAULT_KUBERNETES_AUTHENTICATION_PATH

public static final String DEFAULT_KUBERNETES_AUTHENTICATION_PATH

See Also:

• Constant Field Values

Method Details

builder

public static KubernetesAuthenticationOptions.KubernetesAuthenticationOptionsBuilder builder()

Returns:

a new KubernetesAuthenticationOptions.KubernetesAuthenticationOptionsBuilder.

getPath

public String getPath()

Returns:

the path of the kubernetes authentication backend mount.

getRole

public String getRole()

Returns:

name of the role against which the login is being attempted.

getJwtSupplier

public Supplier<String> getJwtSupplier()

Returns:

JSON Web Token supplier.