KnativeApplication (Dekorate :: Annotations

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

Field Summary

Fields
Modifier and Type Fields and Description

static AutoscalingMetric DEFAULT_AUTOSCALING_METRIC

static int DEFAULT_CONTAINER_CONCURRENCY

Fields
Modifier and Type	Fields and Description
`static AutoscalingMetric`	`DEFAULT_AUTOSCALING_METRIC`
`static int`	`DEFAULT_CONTAINER_CONCURRENCY`

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.
`Env[]`	`envVars` Environment variables to add to all containers.
`boolean`	`expose` Controls whether the application should be exposed (default: true).
`GitRepoVolume[]`	`gitRepoVolumes` Git repo volumues to add to all containers.
`GlobalAutoScaling`	`globalAutoScaling` Global autoscaling configuration.
`String`	`host` The host under which the application is going to be exposed.
`HttpTransportVersion`	`httpTransportVersion` Http trasport version to use.
`ImagePullPolicy`	`imagePullPolicy` Image pull policy.
`String[]`	`imagePullSecrets` The image pull secret
`Label[]`	`labels` Custom labels to add to all resources.
`ResourceRequirements`	`limitResources` The resource limit for the application container.
`Probe`	`livenessProbe` The liveness probe.
`int`	`maxScale` This value controls the maximum number of replicas each revision should have.
`int`	`minScale` This value controls the minimum number of replicas each revision should have.
`Mount[]`	`mounts` Mounts to add to all containers.
`String`	`name` The name of the application.
`String`	`partOf` The name of the collection of componnet this component belongs to.
`Port[]`	`ports` The application ports.
`PersistentVolumeClaimVolume[]`	`pvcVolumes` PersistentVolumeClaim volumues to add to all containers.
`Probe`	`readinessProbe` The readiness probe.
`ResourceRequirements`	`requestResources` The resources that the application container requires.
`AutoScaling`	`revisionAutoScaling` Revision autoscaling configuration.
`String`	`revisionName`
`boolean`	`scaleToZeroEnabled` The scale-to-zero values control whether Knative allows revisions to scale down to zero, or stops at “1”.
`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`	`templateName` The template name to specify.
`Traffic[]`	`traffic` Traffic configuration for the application.
`String`	`version` The version of the application.
`String`	`workingDir` Working directory.

- Field Detail
  - DEFAULT_CONTAINER_CONCURRENCY
```
public static final int DEFAULT_CONTAINER_CONCURRENCY
```
- - DEFAULT_AUTOSCALING_METRIC
```
public static final AutoscalingMetric DEFAULT_AUTOSCALING_METRIC
```
- Element Detail
  - partOf
```
public abstract String partOf
```
    The name of the collection of componnet this component belongs to. This value will be use as: - 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:
    
    ""
- - labels
```
public abstract Label[] labels
```
    Custom labels to add to all resources.
    
    Returns:
    
    The labels.
    
    Default:
    
    {}
- - revisionName
```
public abstract String revisionName
```
    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:
    
    {}
- - 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:
    
    {}
- - httpTransportVersion
```
public abstract HttpTransportVersion httpTransportVersion
```
    Http trasport version to use.
    
    Default:
    
    io.dekorate.knative.config.HttpTransportVersion.HTTP1
- - 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:
    
    {}
- - 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 (default: true). Services that are not exposed with be labeled as cluster local (see https://knative.dev/docs/serving/cluster-local-route).
    
    Default:
    
    true
- - 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
- - minScale
```
public abstract int minScale
```
    This value controls the minimum number of replicas each revision should have. Knative will attempt to never have less than this number of replicas at any one point in time.
    
    Default:
    
    0
- - maxScale
```
public abstract int maxScale
```
    This value controls the maximum number of replicas each revision should have. Knative will attempt to never have more than this number of replicas running, or in the process of being created, at any one point in time.
    
    Default:
    
    0
- - scaleToZeroEnabled
```
public abstract boolean scaleToZeroEnabled
```
    The scale-to-zero values control whether Knative allows revisions to scale down to zero, or stops at “1”.
    
    Default:
    
    true
- - revisionAutoScaling
```
public abstract AutoScaling revisionAutoScaling
```
    Revision autoscaling configuration.
    
    Default:
    
    @io.dekorate.knative.annotation.AutoScaling(autoScalerClass=io.dekorate.knative.config.AutoScalerClass.kpa, metric=io.dekorate.knative.config.AutoscalingMetric.concurrency)
- - globalAutoScaling
```
public abstract GlobalAutoScaling globalAutoScaling
```
    Global autoscaling configuration.
    
    Default:
    
    @io.dekorate.knative.annotation.GlobalAutoScaling(autoScalerClass=io.dekorate.knative.config.AutoScalerClass.kpa)
- - templateName
```
public abstract String templateName
```
    The template name to specify.
    
    Default:
    
    ""
- - traffic
```
public abstract Traffic[] traffic
```
    Traffic configuration for the application.
    
    Default:
    
    {}

Annotation Type KnativeApplication

Field Summary

Optional Element Summary

Field Detail

DEFAULT_CONTAINER_CONCURRENCY

DEFAULT_AUTOSCALING_METRIC

Element Detail

partOf

name

version

labels

revisionName

annotations

envVars

workingDir

command

arguments

serviceAccount

host

ports

httpTransportVersion

serviceType

pvcVolumes

secretVolumes

configMapVolumes

gitRepoVolumes

awsElasticBlockStoreVolumes

azureDiskVolumes

azureFileVolumes

mounts

imagePullPolicy

imagePullSecrets

livenessProbe

readinessProbe

requestResources

limitResources

sidecars

expose

autoDeployEnabled

minScale

maxScale

scaleToZeroEnabled

revisionAutoScaling

globalAutoScaling

templateName

traffic