Package io.quarkus.kubernetes.deployment

Interface KubernetesConfig

All Superinterfaces:

EnvVarHolder, PlatformConfiguration

@ConfigMapping(prefix="quarkus.kubernetes")
@ConfigRoot(phase=BUILD_TIME)
public interface KubernetesConfig
extends PlatformConfiguration

Kubernetes

Method Summary

Modifier and Type	Method	Description
boolean	deploy()	If set to true, Quarkus will attempt to deploy the application to the target Kubernetes cluster
Optional<List<String>>	deploymentTarget()	The target deployment platform.
IngressConfig	ingress()	Ingress configuration
OptionalInt	nodePort()	The nodePort to set when serviceType is set to node-port.
Optional<String>	outputDirectory()	Optionally set directory generated Kubernetes resources will be written to.
Integer	replicas()	The number of desired pods
RollingUpdateConfig	rollingUpdate()	Specifies rolling update configuration.
io.dekorate.kubernetes.config.DeploymentStrategy	strategy()	Specifies the deployment strategy.
default String	targetPlatformName()	Specifies which the name of the platform this EnvVarHolder targets.

Methods inherited from interface io.quarkus.kubernetes.deployment.EnvVarHolder

convertToBuildItems, env

Methods inherited from interface io.quarkus.kubernetes.deployment.PlatformConfiguration

addBuildTimestamp, addNameToLabelSelectors, addVersionToLabelSelectors, annotations, appConfigMap, appSecret, arguments, awsElasticBlockStoreVolumes, azureDiskVolumes, azureFileVolumes, command, configMapVolumes, containerName, cronJob, deploymentKind, deployStrategy, emptyDirVolumes, generateImagePullSecret, getDeploymentResourceKind, gitRepoVolumes, hostAliases, idempotent, imagePullPolicy, imagePullSecrets, initContainers, initTaskDefaults, initTasks, job, labels, livenessProbe, mounts, name, namespace, nodeSelector, partOf, ports, prometheus, pvcVolumes, rbac, readinessProbe, remoteDebug, resources, secretVolumes, securityContext, serviceAccount, serviceType, sidecars, startupProbe, vcsUri, version, workingDir

Method Details

targetPlatformName

default String targetPlatformName()

Description copied from interface: EnvVarHolder

Specifies which the name of the platform this EnvVarHolder targets. This name, when needed, is used by dekorate to generate the descriptor associated with the targeted deployment platform.

Specified by:

targetPlatformName in interface EnvVarHolder

Returns:

the name of the targeted platform e.g. Constants.KUBERNETES

deploymentTarget

Optional<List<String>> deploymentTarget()

The target deployment platform. Defaults to kubernetes. Can be kubernetes, openshift, knative, minikube etc., or any combination of the above as comma separated list.

strategy

@WithDefault("None")
io.dekorate.kubernetes.config.DeploymentStrategy strategy()

Specifies the deployment strategy.

rollingUpdate

RollingUpdateConfig rollingUpdate()

Specifies rolling update configuration. The configuration is applied when DeploymentStrategy == RollingUpdate, or when explicit configuration has been provided. In the later case RollingUpdate is assumed.

replicas

@WithDefault("1")
Integer replicas()

The number of desired pods

nodePort

OptionalInt nodePort()

The nodePort to set when serviceType is set to node-port.

ingress

IngressConfig ingress()

Ingress configuration

outputDirectory

Optional<String> outputDirectory()

Optionally set directory generated Kubernetes resources will be written to. Default is `target/kubernetes`.

deploy

@WithDefault("false")
boolean deploy()

If set to true, Quarkus will attempt to deploy the application to the target Kubernetes cluster