Configuration Reference

Version:3.1.0

Kubernetes Client Config Properties

Table 1. Configuration Properties for ApiClientConfiguration
Property	Type	Description
`kubernetes.client.base-path`	java.util.Optional	@return kubernetes api base path
`kubernetes.client.ca-path`	java.util.Optional	@return kubernetes ca file path
`kubernetes.client.token-path`	java.util.Optional	@return kubernetes auth token file path
`kubernetes.client.kube-config-path`	java.util.Optional	@return kubernetes kube config path
`kubernetes.client.namespace`	java.util.Optional	@return kubernetes client namespace
`kubernetes.client.verify-ssl`	boolean	@return should verify ssl

Table 2. Configuration Properties for ApiDiscoveryCacheConfiguration
Property	Type	Description
`kubernetes.client.api-discovery.cache.refresh-interval`	long	Default refresh interval of API discovery. @return refresh interval in minutes

Kubernetes Discovery Client Config Properties

Table 3. Configuration Properties for KubernetesSecretsConfiguration
Property	Type	Description
`kubernetes.client.secrets`	KubernetesConfiguration$KubernetesSecretsConfiguration	the {@link KubernetesSecretsConfiguration}.
`kubernetes.client.secrets.includes`	java.util.Collection	the names to include
`kubernetes.client.secrets.excludes`	java.util.Collection	the names to exclude
`kubernetes.client.secrets.labels`	java.util.Map	labels to match
`kubernetes.client.secrets.pod-labels`	java.util.List	labels to match
`kubernetes.client.secrets.exception-on-pod-labels-missing`	boolean	If set to true an exception will be thrown if at least one of the configured pod labels is not found among the application’s pod labels. Default value ({@value #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.secrets.enabled`	boolean	enabled flag.
`kubernetes.client.secrets.paths`	java.util.Collection	where secrets are mounted
`kubernetes.client.secrets.use-api`	boolean	whether to use the API to read secrets when {@link #paths} is used.

Table 4. Configuration Properties for KubernetesServiceConfiguration
Property	Type	Description
`kubernetes.client.discovery.services.*.service-id`	java.lang.String	Set service id.
`kubernetes.client.discovery.services.*.name`	java.lang.String	Set service name.
`kubernetes.client.discovery.services.*.namespace`	java.lang.String	Service namespace.
`kubernetes.client.discovery.services.*.mode`	java.lang.String	Set service discovery mode.
`kubernetes.client.discovery.services.*.port`	java.lang.String	Sets port number. Required in case of multi-port resource.

Table 5. Configuration Properties for KubernetesDiscoveryConfiguration
Property	Type	Description
`kubernetes.client.discovery`	KubernetesConfiguration$KubernetesDiscoveryConfiguration	The discovery configuration
`kubernetes.client.discovery.enabled`	boolean
`kubernetes.client.discovery.includes`	java.util.Collection	the names to include
`kubernetes.client.discovery.excludes`	java.util.Collection	the names to exclude
`kubernetes.client.discovery.labels`	java.util.Map	labels to match
`kubernetes.client.discovery.pod-labels`	java.util.List	labels to match
`kubernetes.client.discovery.exception-on-pod-labels-missing`	boolean	If set to true an exception will be thrown if at least one of the configured pod labels is not found among the application’s pod labels. Default value ({@value #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.discovery.mode`	java.lang.String	default service discovery mode

Table 6. Configuration Properties for KubernetesConfigMapsConfiguration
Property	Type	Description
`kubernetes.client.config-maps`	KubernetesConfiguration$KubernetesConfigMapsConfiguration	The config maps configuration properties
`kubernetes.client.config-maps.enabled`	boolean
`kubernetes.client.config-maps.includes`	java.util.Collection	the names to include
`kubernetes.client.config-maps.excludes`	java.util.Collection	the names to exclude
`kubernetes.client.config-maps.labels`	java.util.Map	labels to match
`kubernetes.client.config-maps.pod-labels`	java.util.List	labels to match
`kubernetes.client.config-maps.exception-on-pod-labels-missing`	boolean	If set to true an exception will be thrown if at least one of the configured pod labels is not found among the application’s pod labels. Default value ({@value #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.config-maps.paths`	java.util.Collection	where config maps are mounted
`kubernetes.client.config-maps.use-api`	boolean	whether to use the API to read config maps when {@link #paths} is used.
`kubernetes.client.config-maps.watch`	boolean	flag to watch for the ConfigMap changes.

Table 7. Configuration Properties for KubernetesConfiguration
Property	Type	Description
`kubernetes.client.namespace`	java.lang.String	Sets the namespace.

Kubernetes Informer Config Properties

Table 8. Configuration Properties for InformerConfiguration
Property	Type	Description
`kubernetes.client.informer.sync-timeout`	long	Timout for informer to get synchronised. @return timeout in seconds
`kubernetes.client.informer.sync-step-timeout`	long	Timeout step to check whether the informer has synchronised. @return step timeout in milliseconds