KubernetesApplication (Dekorate :: Annotations

@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` Aws elastic block store volumes to add to all containers
`AzureDiskVolume[]`	`azureDiskVolumes` Azure disk volumes to add
`AzureFileVolume[]`	`azureFileVolumes` Azure file volumes to add
`String[]`	`command` The commands
`ConfigMapVolume[]`	`configMapVolumes` ConfigMap volumues to add to all containers.
`DeploymentStrategy`	`deploymentStrategy` Specifies the deployment strategy.
`Env[]`	`envVars` Environment variables to add to all containers.
`boolean`	`expose` Controls whether the application should be exposed via Ingress
`GitRepoVolume[]`	`gitRepoVolumes` Git repo volumues to add to all containers.
`boolean`	`headless` Controls whether the generated `Service` will be headless.
`String`	`host` The host under which the application is going to be exposed.
`HostAlias[]`	`hostAliases` The hostAliases
`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.
`ResourceRequirements`	`limitResources` The resource limit for the application container.
`Probe`	`livenessProbe` The liveness probe.
`Mount[]`	`mounts` Mounts to add to all containers.
`String`	`name` The name of the application.
`String`	`partOf` The name of the collection of component this component belongs to.
`Port[]`	`ports` The application ports.
`PersistentVolumeClaimVolume[]`	`pvcVolumes` PersistentVolumeClaim volumues to add to all containers.
`Probe`	`readinessProbe` The readiness probe.
`int`	`replicas` The number of replicas to use.
`ResourceRequirements`	`requestResources` The resources that the application container requires.
`RollingUpdate`	`rollingUpdate` Specifies rolling update configuration.
`SecretVolume[]`	`secretVolumes` Secret volumues to add to all containers.
`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
  - partOf
```
public abstract String partOf
```
    The name of the collection of component this component belongs to. 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
- - deploymentStrategy
```
public abstract DeploymentStrategy deploymentStrategy
```
    Specifies the deployment strategy.
    
    Default:
    
    io.dekorate.kubernetes.config.DeploymentStrategy.None
- - rollingUpdate
```
public abstract RollingUpdate rollingUpdate
```
    Specifies rolling update configuration. The configuration is applied when DeploymentStrategy == Rolling update, or when explicit configuration has been provided. In the later case RollingUpdate is assumed.
    
    Default:
    
    @io.dekorate.kubernetes.annotation.RollingUpdate
- - 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
```
    PersistentVolumeClaim volumues to add to all containers.
    
    Default:
    
    {}
- - secretVolumes
```
public abstract SecretVolume[] secretVolumes
```
    Secret volumues to add to all containers.
    
    Default:
    
    {}
- - configMapVolumes
```
public abstract ConfigMapVolume[] configMapVolumes
```
    ConfigMap volumues to add to all containers.
    
    Default:
    
    {}
- - gitRepoVolumes
```
public abstract GitRepoVolume[] gitRepoVolumes
```
    Git repo volumues to add to all containers.
    
    Default:
    
    {}
- - awsElasticBlockStoreVolumes
```
public abstract AwsElasticBlockStoreVolume[] awsElasticBlockStoreVolumes
```
    Aws elastic block store volumes to add to all containers
    
    Default:
    
    {}
- - azureDiskVolumes
```
public abstract AzureDiskVolume[] azureDiskVolumes
```
    Azure disk volumes to add
    
    Default:
    
    {}
- - azureFileVolumes
```
public abstract AzureFileVolume[] azureFileVolumes
```
    Azure file volumes to add
    
    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:
    
    {}
- - hostAliases
```
public abstract HostAlias[] hostAliases
```
    The hostAliases
    
    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
- - requestResources
```
public abstract ResourceRequirements requestResources
```
    The resources that the application container requires.
    
    Default:
    
    @io.dekorate.kubernetes.annotation.ResourceRequirements
- - limitResources
```
public abstract ResourceRequirements limitResources
```
    The resource limit for the application container.
    
    Default:
    
    @io.dekorate.kubernetes.annotation.ResourceRequirements
- - 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

Annotation Type KubernetesApplication

Optional Element Summary

Element Detail

partOf

name

version

initContainers

labels

annotations

envVars

workingDir

command

arguments

replicas

deploymentStrategy

rollingUpdate

serviceAccount

host

ports

serviceType

pvcVolumes

secretVolumes

configMapVolumes

gitRepoVolumes

awsElasticBlockStoreVolumes

azureDiskVolumes

azureFileVolumes

mounts

imagePullPolicy

imagePullSecrets

hostAliases

livenessProbe

readinessProbe

requestResources

limitResources

sidecars

expose

headless

autoDeployEnabled