io.dekorate.kubernetes.annotation

Annotation Type KubernetesApplication

@Target(value={CONSTRUCTOR,TYPE})
 @Retention(value=RUNTIME)
public @interface KubernetesApplication

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Annotation[]	annotations Custom annotations to add to all resources.
String[]	arguments The arguments
boolean	autoDeployEnabled Flag to trigger the registration of the deploy hook.
AwsElasticBlockStoreVolume[]	awsElasticBlockStoreVolumes
AzureDiskVolume[]	azureDiskVolumes
AzureFileVolume[]	azureFileVolumes
String[]	command The commands
ConfigMapVolume[]	configMapVolumes
Env[]	envVars Environment variables to add to all containers.
boolean	expose Controls whether the application should be exposed via Ingress
GitRepoVolume[]	gitRepoVolumes
String	group The group of the application.
boolean	headless Controls whether the generated Service will be headless.
String	host The host under which the application is going to be exposed.
ImagePullPolicy	imagePullPolicy Image pull policy.
String[]	imagePullSecrets The image pull secret
Container[]	initContainers The init containers.
Label[]	labels Custom labels to add to all resources.
Probe	livenessProbe The liveness probe.
Mount[]	mounts Mounts to add to all containers.
String	name The name of the application.
Port[]	ports The application ports.
PersistentVolumeClaimVolume[]	pvcVolumes
Probe	readinessProbe The readiness probe.
int	replicas The number of replicas to use.
SecretVolume[]	secretVolumes
String	serviceAccount The service account.
ServiceType	serviceType The type of service that will be generated for the application.
Container[]	sidecars The sidecars.
String	version The version of the application.
String	workingDir Working directory.

Element Detail

group

public abstract String group

The group of the application. This value will be use as: - docker image repo - labeling resources

Returns:

The specified group name.

Default:

""

name

public abstract String name

The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on ... If no value is specified it will attempt to determine the name using the following rules: If its a maven/gradle project use the artifact id. Else if its a bazel project use the name. Else if the system property app.name is present it will be used. Else find the project root folder and use its name (root folder detection is done by moving to the parent folder until .git is found).

Returns:

The specified application name.

Default:

""

version

public abstract String version

The version of the application. This value be used for things like: - The docker image tag. If no value specified it will attempt to determine the name using the following rules:

Returns:

The version.

Default:

""

initContainers

public abstract Container[] initContainers

The init containers.

Returns:

the init containers.

Default:

{}

labels

public abstract Label[] labels

Custom labels to add to all resources.

Returns:

The labels.

Default:

{}

annotations

public abstract Annotation[] annotations

Custom annotations to add to all resources.

Returns:

The annotations.

Default:

{}

envVars

public abstract Env[] envVars

Environment variables to add to all containers.

Returns:

The environment variables.

Default:

{}

workingDir

public abstract String workingDir

Working directory.

Returns:

The working directory if specified, else empty string.

Default:

""

command

public abstract String[] command

The commands

Returns:

The commands.

Default:

{}

arguments

public abstract String[] arguments

The arguments

Returns:

The arguments.

Default:

{}

replicas

public abstract int replicas

The number of replicas to use.

Returns:

The number of replicas.

Default:

1

serviceAccount

public abstract String serviceAccount

The service account.

Returns:

The service account or empty string if not specified.

Default:

""

host

public abstract String host

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

Returns:

The hostname.

Default:

""

ports

public abstract Port[] ports

The application ports.

Default:

{}

serviceType

public abstract ServiceType serviceType

The type of service that will be generated for the application.

Default:

io.dekorate.kubernetes.annotation.ServiceType.ClusterIP

pvcVolumes

public abstract PersistentVolumeClaimVolume[] pvcVolumes

Default:

{}

secretVolumes

public abstract SecretVolume[] secretVolumes

Default:

{}

configMapVolumes

public abstract ConfigMapVolume[] configMapVolumes

Default:

{}

gitRepoVolumes

public abstract GitRepoVolume[] gitRepoVolumes

Default:

{}

awsElasticBlockStoreVolumes

public abstract AwsElasticBlockStoreVolume[] awsElasticBlockStoreVolumes

Default:

{}

azureDiskVolumes

public abstract AzureDiskVolume[] azureDiskVolumes

Default:

{}

azureFileVolumes

public abstract AzureFileVolume[] azureFileVolumes

Default:

{}

mounts

public abstract Mount[] mounts

Mounts to add to all containers.

Returns:

The mounts.

Default:

{}

imagePullPolicy

public abstract ImagePullPolicy imagePullPolicy

Image pull policy.

Returns:

The image pull policy.

Default:

io.dekorate.kubernetes.annotation.ImagePullPolicy.IfNotPresent

imagePullSecrets

public abstract String[] imagePullSecrets

The image pull secret

Default:

{}

livenessProbe

public abstract Probe livenessProbe

The liveness probe.

Returns:

The probe.

Default:

@io.dekorate.kubernetes.annotation.Probe

readinessProbe

public abstract Probe readinessProbe

The readiness probe.

Returns:

The probe.

Default:

@io.dekorate.kubernetes.annotation.Probe

sidecars

public abstract Container[] sidecars

The sidecars.

Returns:

the sidecar containers.

Default:

{}

expose

public abstract boolean expose

Controls whether the application should be exposed via Ingress

Default:

false

headless

public abstract boolean headless

Controls whether the generated Service will be headless.

Returns:

true if headless.

Default:

false

autoDeployEnabled

public abstract boolean autoDeployEnabled

Flag to trigger the registration of the deploy hook. It's generally preferable to use `-Ddekorate.deploy=true` instead of hardcoding this here.

Returns:

True for automatic registration of the build hook.

Default:

false