Package io.quarkus.kubernetes.client.runtime

Interface KubernetesDevServicesBuildTimeConfig

public interface KubernetesDevServicesBuildTimeConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	KubernetesDevServicesBuildTimeConfig.Flavor

Method Summary

Modifier and Type	Method	Description
Optional<String>	apiVersion()	The kubernetes api server version to use.
Map<String,String>	containerEnv()	Environment variables that are passed to the container.
boolean	enabled()	If Dev Services for Kubernetes should be used.
KubernetesDevServicesBuildTimeConfig.Flavor	flavor()	The flavor to use (kind, k3s or api-only).
boolean	overrideKubeconfig()	By default, if a kubeconfig is found, Dev Services for Kubernetes will not start.
String	serviceName()	The value of the quarkus-dev-service-kubernetes label attached to the started container.
boolean	shared()	Indicates if the Kubernetes cluster managed by Quarkus Dev Services is shared.

Method Detail

enabled

@WithDefault("true")
boolean enabled()

If Dev Services for Kubernetes should be used. (default to true) If this is true and kubernetes client is not configured then a kubernetes cluster will be started and will be used.

apiVersion

Optional<String> apiVersion()

The kubernetes api server version to use. If not set, Dev Services for Kubernetes will use the latest supported version of the given flavor. see https://github.com/dajudge/kindcontainer/blob/master/k8s-versions.json

flavor

@WithDefault("api-only")
KubernetesDevServicesBuildTimeConfig.Flavor flavor()

The flavor to use (kind, k3s or api-only). Default to api-only.

overrideKubeconfig

@WithDefault("false")
boolean overrideKubeconfig()

By default, if a kubeconfig is found, Dev Services for Kubernetes will not start. Set this to true to override the kubeconfig config.

shared

@WithDefault("true")
boolean shared()

Indicates if the Kubernetes cluster managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Kubernetes starts a new container.

The discovery uses the quarkus-dev-service-kubernetes label. The value is configured using the service-name property.

Container sharing is only used in dev mode.

serviceName

@WithDefault("kubernetes")
String serviceName()

The value of the quarkus-dev-service-kubernetes label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for Kubernetes looks for a container with the quarkus-dev-service-kubernetes label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service-kubernetes label set to the specified value.

This property is used when you need multiple shared Kubernetes clusters.

containerEnv

Map<String,String> containerEnv()

Environment variables that are passed to the container.