Configuration Reference

Version:6.2.0

Micronaut Kubernetes Client Config Properties

Table 1. Configuration Properties for ApiClientConfiguration$ApiDiscoveryCacheConfiguration
Property	Type	Description
`kubernetes.client.api-discovery.cache.refresh-interval`	long	Default refresh interval of API discovery.

Table 2. Configuration Properties for ApiClientConfiguration
Property	Type	Description
`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

Micronaut Kubernetes Client Openapi Config Properties

Table 3. Configuration Properties for KubernetesClientConfiguration$ServiceAccount
Property	Type	Description
`kubernetes.client.service-account.enabled`	boolean	Enable/disable service account authentication. Default: {@code true}.
`kubernetes.client.service-account.certificate-authority-path`	java.lang.String	Path to the certificate authority file. Default: {@code file:/var/run/secrets/kubernetes.io/serviceaccount/ca.crt}.
`kubernetes.client.service-account.token-path`	java.lang.String	Path to the token file. Default: {@code file:/var/run/secrets/kubernetes.io/serviceaccount/token}.
`kubernetes.client.service-account.token-reload-interval`	java.time.Duration	Token reload interval. Default: {@code 60s}.

Table 4. Configuration Properties for KubernetesClientConfiguration
Property	Type	Description
`kubernetes.client.kube-config-path`	java.lang.String	Path of the kube config file. Default: {@code file:$HOME/.kube/config}.
`kubernetes.client.enabled`	boolean	Enable/disable kubernetes client. Default: {@code true}.

Micronaut Kubernetes Discovery Client Config Properties

Table 5. Configuration Properties for KubernetesConfiguration$KubernetesDiscoveryConfiguration
Property	Type	Description
`kubernetes.client.discovery.enabled`	boolean
`kubernetes.client.discovery.includes`	java.util.Collection
`kubernetes.client.discovery.excludes`	java.util.Collection
`kubernetes.client.discovery.labels`	java.util.Map
`kubernetes.client.discovery.pod-labels`	java.util.List
`kubernetes.client.discovery.exception-on-pod-labels-missing`	boolean
`kubernetes.client.discovery.mode`	java.lang.String

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

Table 7. Configuration Properties for KubernetesConfiguration$KubernetesConfigMapsConfiguration
Property	Type	Description
`kubernetes.client.config-maps.enabled`	boolean
`kubernetes.client.config-maps.includes`	java.util.Collection
`kubernetes.client.config-maps.excludes`	java.util.Collection
`kubernetes.client.config-maps.labels`	java.util.Map
`kubernetes.client.config-maps.pod-labels`	java.util.List
`kubernetes.client.config-maps.exception-on-pod-labels-missing`	boolean
`kubernetes.client.config-maps.paths`	java.util.Collection
`kubernetes.client.config-maps.use-api`	boolean
`kubernetes.client.config-maps.watch`	boolean

Table 8. Configuration Properties for KubernetesServiceConfiguration
Property	Type	Description
`kubernetes.client.discovery.services.*.service-id`	java.lang.String
`kubernetes.client.discovery.services.*.name`	java.lang.String
`kubernetes.client.discovery.services.*.namespace`	java.lang.String	Namespace of service. If null then default configured namespace is used.
`kubernetes.client.discovery.services.*.mode`	java.lang.String
`kubernetes.client.discovery.services.*.port`	java.lang.String	Port configuration in case of multi-port resource.

Table 9. Configuration Properties for KubernetesConfiguration$KubernetesSecretsConfiguration
Property	Type	Description
`kubernetes.client.secrets.includes`	java.util.Collection
`kubernetes.client.secrets.excludes`	java.util.Collection
`kubernetes.client.secrets.labels`	java.util.Map
`kubernetes.client.secrets.pod-labels`	java.util.List
`kubernetes.client.secrets.exception-on-pod-labels-missing`	boolean
`kubernetes.client.secrets.paths`	java.util.Collection
`kubernetes.client.secrets.use-api`	boolean
`kubernetes.client.secrets.watch`	boolean
`kubernetes.client.secrets.enabled`	boolean	enabled flag.

Micronaut Kubernetes Informer Config Properties

Table 10. Configuration Properties for InformerConfiguration
Property	Type	Description
`kubernetes.client.informer.sync-timeout`	long	Timout for informer to get synchronised.
`kubernetes.client.informer.sync-step-timeout`	long	Timeout step to check whether the informer has synchronised.
`kubernetes.client.informer.resync-period`	java.util.Optional	Resync period to use for all informers.

Micronaut Kubernetes Operator Config Properties

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

Table 12. Configuration Properties for LeaderElectionConfigurationProperties
Property	Type	Description
`kubernetes.client.operator.leader-election.lock.lease-duration`	java.time.Duration	The lock lease duration. See {@link io.kubernetes.client.extended.leaderelection.LeaderElector}. Default {@link #DEFAULT_LEASE_DURATION_IN_SECONDS}.
`kubernetes.client.operator.leader-election.lock.renew-deadline`	java.time.Duration	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. Default {@link #DEFAULT_RENEW_DEADLINE_IN_SECONDS}.
`kubernetes.client.operator.leader-election.lock.retry-period`	java.time.Duration	The lock acquire retry period. See {@link io.kubernetes.client.extended.leaderelection.LeaderElector}. Default {@link #DEFAULT_RETRY_PERIOD_IN_SECONDS}.
`kubernetes.client.operator.leader-election.lock.resource-name`	java.lang.String	The lock resource name. If not provided then the application name is used.
`kubernetes.client.operator.leader-election.lock.resource-namespace`	java.lang.String	The lock resource namespace. If not provided then the application namespaces is used.