Package io.quarkus.kubernetes.spi

Class KubernetesInitContainerBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.kubernetes.spi.KubernetesInitContainerBuildItem

All Implemented Interfaces:

Targetable

public final class KubernetesInitContainerBuildItem
extends io.quarkus.builder.item.MultiBuildItem
implements Targetable

A Build item for generating init containers. The generated container will have the specified fields and may optionally inherit env vars and volumes from the app container.

Env vars specified through this build item, will take precedence over inherited ones.

Constructor Summary

Constructors

Constructor	Description
KubernetesInitContainerBuildItem(String name, String target, String image, List<String> command, List<String> arguments, Map<String,String> envVars, boolean sharedEnvironment, boolean sharedFilesystem)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static KubernetesInitContainerBuildItem	create(String name, String image)
static KubernetesInitContainerBuildItem	create(String name, String image, String imagePullPolicy)
List<String>	getArguments()
List<String>	getCommand()
Map<String,String>	getEnvVars()
String	getImage()
String	getImagePullPolicy()
String	getName()
String	getTarget()
boolean	isSharedEnvironment()	Flag for tasks that require access to the environment variables of the application.
boolean	isSharedFilesystem()	Flag for tasks that need to share filesystem with the application.
KubernetesInitContainerBuildItem	withArguments(List<String> arguments)
KubernetesInitContainerBuildItem	withCommand(List<String> command)
KubernetesInitContainerBuildItem	withEnvVars(Map<String,String> envVars)
KubernetesInitContainerBuildItem	withImage(String image)
KubernetesInitContainerBuildItem	withImagePullPolicy(String imagePullPolicy)
KubernetesInitContainerBuildItem	withName(String name)
KubernetesInitContainerBuildItem	withSharedEnvironment(boolean sharedEnvironment)
KubernetesInitContainerBuildItem	withSharedFilesystem(boolean sharedFilesystem)
KubernetesInitContainerBuildItem	withTarget(String target)

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.spi.Targetable

isActiveFor

Constructor Details

KubernetesInitContainerBuildItem

@Deprecated(forRemoval=true,
            since="3.18")
public KubernetesInitContainerBuildItem(String name,
 String target,
 String image,
 List<String> command,
 List<String> arguments,
 Map<String,String> envVars,
 boolean sharedEnvironment,
 boolean sharedFilesystem)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

create

public static KubernetesInitContainerBuildItem create(String name,
 String image)

create

public static KubernetesInitContainerBuildItem create(String name,
 String image,
 String imagePullPolicy)

getName

public String getName()

withName

public KubernetesInitContainerBuildItem withName(String name)

getTarget

public String getTarget()

Specified by:

getTarget in interface Targetable

withTarget

public KubernetesInitContainerBuildItem withTarget(String target)

getImage

public String getImage()

withImage

public KubernetesInitContainerBuildItem withImage(String image)

getImagePullPolicy

public String getImagePullPolicy()

withImagePullPolicy

public KubernetesInitContainerBuildItem withImagePullPolicy(String imagePullPolicy)

getCommand

public List<String> getCommand()

withCommand

public KubernetesInitContainerBuildItem withCommand(List<String> command)

getArguments

public List<String> getArguments()

withArguments

public KubernetesInitContainerBuildItem withArguments(List<String> arguments)

getEnvVars

public Map<String,String> getEnvVars()

withEnvVars

public KubernetesInitContainerBuildItem withEnvVars(Map<String,String> envVars)

isSharedEnvironment

public boolean isSharedEnvironment()

Flag for tasks that require access to the environment variables of the application. Often tasks need to access resources, configured via environment variables. This flag expresses that the task should be executed using the same envrironment variables as the application.

Returns:

true when the task is meant to share environment variables with the application.

withSharedEnvironment

public KubernetesInitContainerBuildItem withSharedEnvironment(boolean sharedEnvironment)

isSharedFilesystem

public boolean isSharedFilesystem()

Flag for tasks that need to share filesystem with the application. Often tasks need to access resources, configured via filesystem (e.g. local config files, kubernetes service binding etc). In other cases, tasks may need to produce files needed by the application. This flag expresses that the task should share filesystem with the application.

Returns:

true when the task is meant to share filesystem.

withSharedFilesystem

public KubernetesInitContainerBuildItem withSharedFilesystem(boolean sharedFilesystem)