Package io.quarkus.kubernetes.client.runtime.internal

Interface KubernetesDevServicesBuildTimeConfig

public interface KubernetesDevServicesBuildTimeConfig

  • Method Details

    • 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.

    • imageName

      Optional<String> imageName()
      The kubernetes image to use.

      If not set, Dev Services for Kubernetes will use default image for the specified apiVersion() for the given flavor().

    • flavor

      Optional<KubernetesDevServicesBuildTimeConfig.Flavor> flavor()
      The flavor to use (kind, k3s or api-only).

      If not set, Dev Services for Kubernetes will set it 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.

    • manifests

      Optional<List<String>> manifests()
      A list of manifest file paths that should be applied to the Kubernetes cluster Dev Service on startup. If not set, no manifests are applied.

    • 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

      @ConfigDocMapKey("environment-variable-name") Map<String,String> containerEnv()
      Environment variables that are passed to the container.