Package io.quarkus.kubernetes.client.runtime

Class KubernetesDevServicesBuildTimeConfig

java.lang.Object

io.quarkus.kubernetes.client.runtime.KubernetesDevServicesBuildTimeConfig

public class KubernetesDevServicesBuildTimeConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KubernetesDevServicesBuildTimeConfig.Flavor

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	apiVersion	The kubernetes api server version to use.
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.

Constructor Summary

Constructors

Constructor	Description
KubernetesDevServicesBuildTimeConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

enabled

@ConfigItem(defaultValue="true")
public 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

@ConfigItem
public 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

@ConfigItem(defaultValue="API_ONLY")
public KubernetesDevServicesBuildTimeConfig.Flavor flavor

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

overrideKubeconfig

@ConfigItem(defaultValue="false")
public 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

@ConfigItem(defaultValue="true")
public 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

@ConfigItem(defaultValue="kubernetes")
public 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.

Constructor Detail

KubernetesDevServicesBuildTimeConfig

public KubernetesDevServicesBuildTimeConfig()