Package io.micronaut.kubernetes.configuration

Class KubernetesConfigurationClient

java.lang.Object

io.micronaut.kubernetes.configuration.KubernetesConfigurationClient

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.discovery.config.ConfigurationClient

@Singleton
@Requires(env="k8s") @Requires(property="micronaut.config-client.enabled",value="true",defaultValue="false")
public class KubernetesConfigurationClient
extends Object
implements io.micronaut.discovery.config.ConfigurationClient

A ConfigurationClient implementation that provides PropertySources read from Kubernetes ConfigMap's.

Since:

1.0.0

Author:

Álvaro Sánchez-Mariscal

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_MAP_LIST_RESOURCE_VERSION
static final String	CONFIG_MAP_RESOURCE_VERSION
static final String	KUBERNETES_CONFIG_MAP_LIST_NAME
static final String	KUBERNETES_CONFIG_MAP_NAME_SUFFIX
static final String	KUBERNETES_SECRET_NAME_SUFFIX
static final String	OPAQUE_SECRET_TYPE

Fields inherited from interface io.micronaut.discovery.config.ConfigurationClient

CONFIGURATION_PREFIX, ENABLED, READ_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
KubernetesConfigurationClient(io.micronaut.kubernetes.client.reactor.CoreV1ApiReactorClient client, KubernetesConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
static void	addPropertySourceToCache(io.micronaut.context.env.PropertySource propertySource)	Adds the given PropertySource to the cache.
@NonNull String	getDescription()	A description that describes this object.
org.reactivestreams.Publisher<io.micronaut.context.env.PropertySource>	getPropertySources(io.micronaut.context.env.Environment environment)	Retrieves all of the PropertySource registrations for the given environment.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Field Details

CONFIG_MAP_LIST_RESOURCE_VERSION

public static final String CONFIG_MAP_LIST_RESOURCE_VERSION

See Also:

• Constant Field Values

CONFIG_MAP_RESOURCE_VERSION

public static final String CONFIG_MAP_RESOURCE_VERSION

See Also:

• Constant Field Values

KUBERNETES_CONFIG_MAP_LIST_NAME

public static final String KUBERNETES_CONFIG_MAP_LIST_NAME

See Also:

• Constant Field Values

KUBERNETES_CONFIG_MAP_NAME_SUFFIX

public static final String KUBERNETES_CONFIG_MAP_NAME_SUFFIX

See Also:

• Constant Field Values

KUBERNETES_SECRET_NAME_SUFFIX

public static final String KUBERNETES_SECRET_NAME_SUFFIX

See Also:

• Constant Field Values

OPAQUE_SECRET_TYPE

public static final String OPAQUE_SECRET_TYPE

See Also:

• Constant Field Values

Constructor Details

KubernetesConfigurationClient

public KubernetesConfigurationClient(io.micronaut.kubernetes.client.reactor.CoreV1ApiReactorClient client,
 KubernetesConfiguration configuration)

Parameters:

client - An Core HTTP Client to query the Kubernetes API.

configuration - The configuration properties

Method Details

getPropertySources

public org.reactivestreams.Publisher<io.micronaut.context.env.PropertySource> getPropertySources(io.micronaut.context.env.Environment environment)

Retrieves all of the PropertySource registrations for the given environment.

Specified by:

getPropertySources in interface io.micronaut.discovery.config.ConfigurationClient

Parameters:

environment - The environment

Returns:

A Publisher that emits zero or many PropertySource instances discovered for the given environment

getDescription

@NonNull
public @NonNull String getDescription()

A description that describes this object.

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Returns:

The description

addPropertySourceToCache

public static void addPropertySourceToCache(io.micronaut.context.env.PropertySource propertySource)

Adds the given PropertySource to the cache.

Parameters:

propertySource - The property source to add