Package io.quarkus.kubernetes.deployment

Class ContainerConfig

java.lang.Object

io.quarkus.kubernetes.deployment.ContainerConfig

All Implemented Interfaces:

EnvVarHolder

public class ContainerConfig
extends Object
implements EnvVarHolder

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Optional<List<String>>	arguments	The arguments
(package private) Optional<List<String>>	command	The commands
(package private) EnvVarsConfig	env	Environment variables to add to all containers.
(package private) Map<String,EnvConfig>	envVars	Deprecated. Use env instead using the new syntax as follows: quarkus.kubernetes.env-vars.foo.field=fieldName becomes quarkus.kubernetes.env.fields.foo=fieldName quarkus.kubernetes.env-vars.envvar.value=value becomes quarkus.kubernetes.env.vars.envvar=value quarkus.kubernetes.env-vars.bar.configmap=configName becomes quarkus.kubernetes.env.configmaps=configName quarkus.kubernetes.env-vars.baz.secret=secretName becomes quarkus.kubernetes.env.secrets=secretName
(package private) Optional<String>	host	The host under which the application is going to be exposed.
(package private) Optional<String>	image	The container image.
(package private) io.dekorate.kubernetes.annotation.ImagePullPolicy	imagePullPolicy	Image pull policy.
(package private) Optional<List<String>>	imagePullSecrets	The image pull secret
(package private) ProbeConfig	livenessProbe	The liveness probe.
(package private) Map<String,MountConfig>	mounts	Volume mounts.
(package private) Map<String,PortConfig>	ports	The application ports.
(package private) ProbeConfig	readinessProbe	The readiness probe.
(package private) ResourcesConfig	resources	Resources requirements
(package private) Optional<String>	serviceAccount	The service account.
(package private) Optional<String>	workingDir	Working directory.

Constructor Summary

Constructors

Constructor	Description
ContainerConfig()

Method Summary

Modifier and Type	Method	Description
Collection<io.dekorate.kubernetes.config.Env>	convertToEnvs()
EnvVarsConfig	getEnv()	Retrieves the definition of environment variables to add to the application's container.
Map<String,EnvConfig>	getEnvVars()	Deprecated. use getEnv() instead
String	getTargetPlatformName()	Specifies which the name of the platform this EnvVarHolder targets.

Methods inherited from class java.lang.Object

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

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

convertToBuildItems

Field Detail

image

@ConfigItem
Optional<String> image

The container image.

workingDir

@ConfigItem
Optional<String> workingDir

Working directory.

command

@ConfigItem
Optional<List<String>> command

The commands

arguments

@ConfigItem
Optional<List<String>> arguments

The arguments

serviceAccount

@ConfigItem
Optional<String> serviceAccount

The service account.

host

@ConfigItem
Optional<String> host

The host under which the application is going to be exposed.

ports

@ConfigItem
Map<String,PortConfig> ports

The application ports.

imagePullPolicy

@ConfigItem(defaultValue="Always")
io.dekorate.kubernetes.annotation.ImagePullPolicy imagePullPolicy

Image pull policy.

imagePullSecrets

@ConfigItem
Optional<List<String>> imagePullSecrets

The image pull secret

livenessProbe

@ConfigItem
ProbeConfig livenessProbe

The liveness probe.

readinessProbe

@ConfigItem
ProbeConfig readinessProbe

The readiness probe.

mounts

@ConfigItem
Map<String,MountConfig> mounts

Volume mounts.

resources

@ConfigItem
ResourcesConfig resources

Resources requirements

envVars

@ConfigItem
@Deprecated
Map<String,EnvConfig> envVars

Deprecated.

Use env instead using the new syntax as follows:

• quarkus.kubernetes.env-vars.foo.field=fieldName becomes quarkus.kubernetes.env.fields.foo=fieldName
• quarkus.kubernetes.env-vars.envvar.value=value becomes quarkus.kubernetes.env.vars.envvar=value
• quarkus.kubernetes.env-vars.bar.configmap=configName becomes quarkus.kubernetes.env.configmaps=configName
• quarkus.kubernetes.env-vars.baz.secret=secretName becomes quarkus.kubernetes.env.secrets=secretName

Environment variables to add to all containers using the old syntax.

env

@ConfigItem
EnvVarsConfig env

Environment variables to add to all containers.

Constructor Detail

ContainerConfig

public ContainerConfig()

Method Detail

getEnvVars

@Deprecated
public Map<String,EnvConfig> getEnvVars()

Deprecated.

use getEnv() instead

Specified by:

getEnvVars in interface EnvVarHolder

getEnv

public EnvVarsConfig getEnv()

Description copied from interface: EnvVarHolder

Retrieves the definition of environment variables to add to the application's container.

Specified by:

getEnv in interface EnvVarHolder

Returns:

the associated EnvVarsConfig holding the definition of which environment variables to add

getTargetPlatformName

public String getTargetPlatformName()

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:

getTargetPlatformName in interface EnvVarHolder

Returns:

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

convertToEnvs

public Collection<io.dekorate.kubernetes.config.Env> convertToEnvs()