Micronaut Kubernetes Configuration Reference

Every documented configuration property of Micronaut Kubernetes, with types, descriptions, and defaults.

142 properties across 8 sections

Micronaut Kubernetes Client Config Properties

Configuration properties for ApiClientConfiguration

Property	Type	Description	Default
`kubernetes.client.base-path`	java.util.Optional	kubernetes api base path
`kubernetes.client.ca-path`	java.util.Optional	kubernetes ca file path
`kubernetes.client.token-path`	java.util.Optional	kubernetes auth token file path
`kubernetes.client.kube-config-path`	java.util.Optional	kubernetes kube config path
`kubernetes.client.namespace`	java.util.Optional	kubernetes client namespace
`kubernetes.client.verify-ssl`	boolean	should verify ssl	`true`

Configuration properties for ApiClientConfiguration$ApiDiscoveryCacheConfiguration

Property	Type	Description	Default
`kubernetes.client.api-discovery.cache.refresh-interval`	long	Default refresh interval of API discovery.	`30`

Micronaut Kubernetes Client Openapi Common Config Properties

Configuration properties for KubernetesClientConfiguration

Property	Type	Description
`kubernetes.client.kube-config-path`	java.lang.String	Sets kube config path.
`kubernetes.client.enabled`	boolean	Enable/disable kubernetes client.
`kubernetes.client.namespace`	java.lang.String	Sets kubernetes client namespace.

Configuration properties for KubernetesClientConfiguration$ServiceAccount

Property	Type	Description
`kubernetes.client.service-account.enabled`	boolean	Enable/disable service account authentication.
`kubernetes.client.service-account.certificate-authority-path`	java.lang.String	Sets path to the certificate authority file.
`kubernetes.client.service-account.token-path`	java.lang.String	Sets path to the token file.
`kubernetes.client.service-account.namespace-path`	java.lang.String	Sets path to the namespace file.
`kubernetes.client.service-account.token-reload-interval`	java.time.Duration	Sets token reload interval.

Configuration properties for KubernetesHttpClientConfiguration

Property	Type	Description
`micronaut.http.client.kubernetes.http-version`	HttpVersion
`micronaut.http.client.kubernetes.log-level`	LogLevel
`micronaut.http.client.kubernetes.event-loop-group`	java.lang.String
`micronaut.http.client.kubernetes.ssl-configuration`	SslConfiguration
`micronaut.http.client.kubernetes.follow-redirects`	boolean
`micronaut.http.client.kubernetes.exception-on-error-status`	boolean
`micronaut.http.client.kubernetes.decompression-enabled`	boolean
`micronaut.http.client.kubernetes.logger-name`	java.lang.String
`micronaut.http.client.kubernetes.redirect-always-filtered-headers`	java.util.Set
`micronaut.http.client.kubernetes.redirect-additional-non-preserve-body-filtered-headers`	java.util.Set
`micronaut.http.client.kubernetes.redirect-cross-origin-filtered-headers`	java.util.Set
`micronaut.http.client.kubernetes.max-redirects`	int
`micronaut.http.client.kubernetes.default-charset`	java.nio.charset.Charset
`micronaut.http.client.kubernetes.channel-options`	java.util.Map
`micronaut.http.client.kubernetes.read-timeout`	java.time.Duration
`micronaut.http.client.kubernetes.request-timeout`	java.time.Duration
`micronaut.http.client.kubernetes.read-idle-timeout`	java.time.Duration
`micronaut.http.client.kubernetes.connection-pool-idle-timeout`	java.time.Duration
`micronaut.http.client.kubernetes.connect-timeout`	java.time.Duration
`micronaut.http.client.kubernetes.connect-ttl`	java.time.Duration
`micronaut.http.client.kubernetes.shutdown-quiet-period`	java.time.Duration
`micronaut.http.client.kubernetes.shutdown-timeout`	java.time.Duration
`micronaut.http.client.kubernetes.num-of-threads`	java.lang.Integer
`micronaut.http.client.kubernetes.thread-factory`	java.lang.Class
`micronaut.http.client.kubernetes.max-content-length`	int
`micronaut.http.client.kubernetes.max-header-size`	int
`micronaut.http.client.kubernetes.max-initial-line-length`	int
`micronaut.http.client.kubernetes.max-chunk-size`	int
`micronaut.http.client.kubernetes.proxy-type`	java.net.Proxy$Type
`micronaut.http.client.kubernetes.proxy-address`	java.net.SocketAddress
`micronaut.http.client.kubernetes.proxy-username`	java.lang.String
`micronaut.http.client.kubernetes.proxy-password`	java.lang.String
`micronaut.http.client.kubernetes.proxy-selector`	java.net.ProxySelector
`micronaut.http.client.kubernetes.plaintext-mode`	HttpVersionSelection$PlaintextMode
`micronaut.http.client.kubernetes.alpn-modes`	java.util.List
`micronaut.http.client.kubernetes.allow-block-event-loop`	boolean
`micronaut.http.client.kubernetes.dns-resolution-mode`	HttpClientConfiguration$DnsResolutionMode
`micronaut.http.client.kubernetes.address-resolver-group-name`	java.lang.String
`micronaut.http.client.kubernetes.pcap-logging-path-pattern`	java.lang.String

Micronaut Kubernetes Client Openapi Discovery Config Properties

Configuration properties for KubernetesConfiguration

Property	Type	Description
`kubernetes.client.namespace`	java.lang.String	the namespace

Configuration properties for KubernetesConfiguration$KubernetesConfigMapsConfiguration

Property	Type	Description
`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	podLabels 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 ({@link #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.config-maps.paths`	java.util.Collection	paths where secrets are mounted
`kubernetes.client.config-maps.use-api`	boolean	whether to use the API to read secrets when {@link #paths} is used.
`kubernetes.client.config-maps.watch`	boolean	whether to enable watching for the ConfigMap changes.
`kubernetes.client.config-maps.terminate-startup-on-exception`	boolean	Flag which determines whether to terminate service startup if not able to load config from kubernetes. Default value: {@link #DEFAULT_TERMINATE_STARTUP_ON_EXCEPTION}.

Configuration properties for KubernetesConfiguration$KubernetesDiscoveryConfiguration

Property	Type	Description
`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	podLabels 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 ({@link #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.discovery.mode`	java.lang.String	default service discovery mode

Configuration properties for KubernetesServiceConfiguration

Property	Type	Description
`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.

Configuration properties for KubernetesConfiguration$KubernetesSecretsConfiguration

Property	Type	Description
`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	podLabels 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 ({@link #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.secrets.paths`	java.util.Collection	paths where secrets are mounted
`kubernetes.client.secrets.use-api`	boolean	whether to use the API to read secrets when {@link #paths} is used.
`kubernetes.client.secrets.watch`	boolean	whether to enable watching for the ConfigMap changes.
`kubernetes.client.secrets.terminate-startup-on-exception`	boolean	Flag which determines whether to terminate service startup if not able to load config from kubernetes. Default value: {@link #DEFAULT_TERMINATE_STARTUP_ON_EXCEPTION}.
`kubernetes.client.secrets.enabled`	boolean	enabled flag.

Micronaut Kubernetes Client Openapi Informer Config Properties

Configuration properties for InformerConfiguration

Property	Type	Description	Default
`kubernetes.client.informer.enabled`	boolean
`kubernetes.client.informer.sync-timeout`	java.time.Duration	Timout for informer to get synchronised.	`60s`
`kubernetes.client.informer.sync-step-timeout`	java.time.Duration	Timeout step to check whether the informer has synchronised.	`200ms`

Micronaut Kubernetes Client Openapi Operator Config Properties

Configuration properties for OperatorConfiguration

Property	Type	Description	Default
`kubernetes.client.operator.enabled`	boolean
`kubernetes.client.operator.worker-count`	int	The operator controller worker count. Default "4".	`4`
`kubernetes.client.operator.ready-timeout`	java.time.Duration	Timeout to wait on informers to be synced. Default "30s".	`30s`
`kubernetes.client.operator.ready-check-internal`	java.time.Duration	How often the informer sync status should be checked until they are ready or timeout expires. Default "1s".	`1s`

Configuration properties for LeaderElectionConfiguration

Property	Type	Description	Default
`kubernetes.client.operator.leader-election.lock.enabled`	boolean
`kubernetes.client.operator.leader-election.lock.lease-duration`	java.time.Duration	The lock lease duration. Default "10s".	`10s`
`kubernetes.client.operator.leader-election.lock.renew-deadline`	java.time.Duration	The lock renew deadline. If the leader elector fails to renew the lock within the deadline, then the controller loses the lock. Default "8s".	`8s`
`kubernetes.client.operator.leader-election.lock.retry-period`	java.time.Duration	The lock acquire retry period. Default "5s".	`5s`
`kubernetes.client.operator.leader-election.lock.resource-name`	java.util.Optional	The lock resource name. If not provided then the application name is used.
`kubernetes.client.operator.leader-election.lock.resource-namespace`	java.util.Optional	The lock resource namespace. If not provided then the application namespace is used.

Micronaut Kubernetes Discovery Client Config Properties

Configuration properties for KubernetesConfiguration

Property	Type	Description
`kubernetes.client.namespace`	java.lang.String	the namespace

Configuration properties for KubernetesConfiguration$KubernetesConfigMapsConfiguration

Property	Type	Description
`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	podLabels 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 ({@link #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.config-maps.paths`	java.util.Collection	paths where secrets are mounted
`kubernetes.client.config-maps.use-api`	boolean	whether to use the API to read secrets when {@link #paths} is used.
`kubernetes.client.config-maps.watch`	boolean	whether to enable watching for the ConfigMap changes.

Configuration properties for KubernetesConfiguration$KubernetesDiscoveryConfiguration

Property	Type	Description
`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	podLabels 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 ({@link #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.discovery.mode`	java.lang.String	default service discovery mode

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.

Configuration properties for KubernetesConfiguration$KubernetesSecretsConfiguration

Property	Type	Description
`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	podLabels 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 ({@link #DEFAULT_EXCEPTION_ON_POD_LABELS_MISSING}).
`kubernetes.client.secrets.paths`	java.util.Collection	paths where secrets are mounted
`kubernetes.client.secrets.use-api`	boolean	whether to use the API to read secrets when {@link #paths} is used.
`kubernetes.client.secrets.watch`	boolean	whether to enable watching for the ConfigMap changes.
`kubernetes.client.secrets.enabled`	boolean	enabled flag.

Micronaut Kubernetes Informer Config Properties

Configuration properties for InformerConfiguration

Property	Type	Description	Default
`kubernetes.client.informer.enabled`	boolean
`kubernetes.client.informer.sync-timeout`	long	Timout for informer to get synchronised.	`60`
`kubernetes.client.informer.sync-step-timeout`	long	Timeout step to check whether the informer has synchronised.	`500`
`kubernetes.client.informer.resync-period`	java.util.Optional	Resync period to use for all informers.

Micronaut Kubernetes Operator Config Properties

Configuration properties for OperatorConfigurationProperties

Property	Type	Description	Default
`kubernetes.client.operator.enabled`	boolean
`kubernetes.client.operator.worker-count`	int	The operator controller worker count. Default "16".	`16`
`kubernetes.client.operator.ready-timeout`	java.util.Optional	Timeout to wait before the informers are checked for readiness.

Configuration properties for LeaderElectionConfigurationProperties

Property	Type	Description
`kubernetes.client.operator.leader-election.lock.lease-duration`	java.time.Duration	Sets the lock lease duration.
`kubernetes.client.operator.leader-election.lock.renew-deadline`	java.time.Duration	Sets the lock renew deadline. If the {@link io.kubernetes.client.extended.leaderelection.LeaderElector} fails to renew the lock within the deadline then the controller looses the lock.
`kubernetes.client.operator.leader-election.lock.retry-period`	java.time.Duration	Sets the lock acquire retry period.
`kubernetes.client.operator.leader-election.lock.resource-name`	java.lang.String	Sets the lock resource name.
`kubernetes.client.operator.leader-election.lock.resource-namespace`	java.lang.String	Sets the lock resource namespace.