java.lang.Object
- io.quarkus.kubernetes.deployment.KnativeConfig

All Implemented Interfaces:: EnvVarHolder, PlatformConfiguration

@ConfigRoot
public class KnativeConfig
extends Object
implements PlatformConfiguration

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) boolean`	`addBuildTimestamp`	Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources
`(package private) boolean`	`addNameToLabelSelectors`	If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment
`(package private) boolean`	`addVersionToLabelSelectors`	If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment
`(package private) Map<String,String>`	`annotations`	Custom annotations to add to all resources
`(package private) Optional<String>`	`appConfigMap`	If set, the config map will be mounted to the application container and its contents will be used for application configuration.
`(package private) Optional<String>`	`appSecret`	If set, the secret will mounted to the application container and its contents will be used for application configuration.
`(package private) Optional<List<String>>`	`arguments`	The arguments
`(package private) Map<String,AwsElasticBlockStoreVolumeConfig>`	`awsElasticBlockStoreVolumes`	AWS Elastic BlockStore volumes
`(package private) Map<String,AzureDiskVolumeConfig>`	`azureDiskVolumes`	Azure disk volumes
`(package private) Map<String,AzureFileVolumeConfig>`	`azureFileVolumes`	Azure file volumes
`boolean`	`clusterLocal`	Whether this service is cluster-local.
`(package private) Optional<List<String>>`	`command`	The commands
`(package private) Map<String,ConfigMapVolumeConfig>`	`configMapVolumes`	ConfigMap volumes
`(package private) Optional<String>`	`containerName`	If set, it will change the name of the container according to the configuration
`(package private) Map<String,ContainerConfig>`	`containers`	Sidecar containers
`(package private) boolean`	`deploy`	If set to true, Quarkus will attempt to deploy the application to the target knative cluster
`(package private) Optional<List<String>>`	`emptyDirVolumes`	EmptyDir volumes
`(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) Map<String,GitRepoVolumeConfig>`	`gitRepoVolumes`	Git Repository volumes
`(package private) GlobalAutoScalingConfig`	`globalAutoScaling`	Global autoscaling configuration.
`(package private) Optional<String>`	`host`	The host under which the application is going to be exposed
`(package private) Map<String,HostAliasConfig>`	`hostAliases`	The host aliases
`(package private) io.dekorate.kubernetes.annotation.ImagePullPolicy`	`imagePullPolicy`	Image pull policy
`(package private) Optional<List<String>>`	`imagePullSecrets`	The image pull secret
`(package private) Map<String,ContainerConfig>`	`initContainers`	Init containers
`(package private) Map<String,String>`	`labels`	Custom labels to add to all resources
`(package private) ProbeConfig`	`livenessProbe`	The liveness probe
`(package private) Optional<Integer>`	`maxScale`	This value controls the maximum number of replicas each revision should have.
`(package private) Optional<Integer>`	`minScale`	This value controls the minimum number of replicas each revision should have.
`(package private) Map<String,MountConfig>`	`mounts`	Volume mounts
`(package private) Optional<String>`	`name`	The name of the application.
`(package private) Optional<String>`	`namespace`	The namespace the generated resources should belong to.
`(package private) Optional<String>`	`partOf`	The name of the group this component belongs too
`(package private) Map<String,PortConfig>`	`ports`	The application ports
`(package private) PrometheusConfig`	`prometheus`	Prometheus configuration
`(package private) Map<String,PvcVolumeConfig>`	`pvcVolumes`	Persistent Volume Claim volumes
`(package private) ProbeConfig`	`readinessProbe`	The readiness probe
`(package private) ResourcesConfig`	`resources`	Resources requirements
`(package private) AutoScalingConfig`	`revisionAutoScaling`	Revision autoscaling configuration.
`(package private) Optional<String>`	`revisionName`	The name of the revision.
`(package private) boolean`	`scaleToZeroEnabled`	The scale-to-zero values control whether Knative allows revisions to scale down to zero, or stops at “1”.
`(package private) Map<String,SecretVolumeConfig>`	`secretVolumes`	Secret volumes
`(package private) SecurityContextConfig`	`securityContext`	If set, it will copy the security context configuration provided into the generated pod settings.
`(package private) Optional<String>`	`serviceAccount`	The service account
`(package private) io.dekorate.kubernetes.annotation.ServiceType`	`serviceType`	The type of service that will be generated for the application
`(package private) Map<String,TrafficConfig>`	`traffic`	Traffic configuration.
`(package private) Optional<String>`	`version`	The version of the application.
`(package private) Optional<String>`	`workingDir`	Working directory

Constructor Summary

Constructors
Constructor Description

KnativeConfig()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Map<String,String>`	`getAnnotations()`
`Optional<String>`	`getAppConfigMap()`
`Optional<String>`	`getAppSecret()`
`Optional<List<String>>`	`getArguments()`
`Map<String,AwsElasticBlockStoreVolumeConfig>`	`getAwsElasticBlockStoreVolumes()`
`Map<String,AzureDiskVolumeConfig>`	`getAzureDiskVolumes()`
`Map<String,AzureFileVolumeConfig>`	`getAzureFileVolumes()`
`Optional<List<String>>`	`getCommand()`
`Map<String,ConfigMapVolumeConfig>`	`getConfigMapVolumes()`
`Optional<String>`	`getContainerName()`
`List<String>`	`getEmptyDirVolumes()`
`EnvVarsConfig`	`getEnv()`	Retrieves the definition of environment variables to add to the application's container.
`Map<String,EnvConfig>`	`getEnvVars()`	Deprecated.
`Map<String,GitRepoVolumeConfig>`	`getGitRepoVolumes()`
`Optional<String>`	`getHost()`
`Map<String,HostAliasConfig>`	`getHostAliases()`
`io.dekorate.kubernetes.annotation.ImagePullPolicy`	`getImagePullPolicy()`
`Optional<List<String>>`	`getImagePullSecrets()`
`Map<String,ContainerConfig>`	`getInitContainers()`
`Map<String,String>`	`getLabels()`
`ProbeConfig`	`getLivenessProbe()`
`Map<String,MountConfig>`	`getMounts()`
`Optional<String>`	`getName()`
`Optional<String>`	`getNamespace()`
`Optional<String>`	`getPartOf()`
`Map<String,PortConfig>`	`getPorts()`
`PrometheusConfig`	`getPrometheusConfig()`
`Map<String,PvcVolumeConfig>`	`getPvcVolumes()`
`ProbeConfig`	`getReadinessProbe()`
`ResourcesConfig`	`getResources()`
`Map<String,SecretVolumeConfig>`	`getSecretVolumes()`
`SecurityContextConfig`	`getSecurityContext()`
`Optional<String>`	`getServiceAccount()`
`io.dekorate.kubernetes.annotation.ServiceType`	`getServiceType()`
`Map<String,ContainerConfig>`	`getSidecars()`
`String`	`getTargetPlatformName()`	Specifies which the name of the platform this EnvVarHolder targets.
`Optional<String>`	`getVersion()`
`Optional<String>`	`getWorkingDir()`
`boolean`	`isAddBuildTimestamp()`
`boolean`	`isAddNameToLabelSelectors()`
`boolean`	`isAddVersionToLabelSelectors()`

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

Methods inherited from interface io.quarkus.kubernetes.deployment.PlatformConfiguration
getConfigName

- Field Detail
  - partOf
```
@ConfigItem
Optional<String> partOf
```
    The name of the group this component belongs too
  - name
```
@ConfigItem(defaultValue="${quarkus.container-image.name}")
Optional<String> name
```
    The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on ...
  - version
```
@ConfigItem(defaultValue="${quarkus.container-image.tag}")
Optional<String> version
```
    The version of the application.
  - namespace
```
@ConfigItem
Optional<String> namespace
```
    The namespace the generated resources should belong to. If not value is set, then the 'namespace' field will not be added to the 'metadata' section of the generated manifests. This in turn means that when the manifests are applied to a cluster, the namespace will be resolved from the current Kubernetes context (see https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context for more details).
  - labels
```
@ConfigItem
Map<String,String> labels
```
    Custom labels to add to all resources
  - annotations
```
@ConfigItem
Map<String,String> annotations
```
    Custom annotations to add to all resources
  - addBuildTimestamp
```
@ConfigItem(defaultValue="true")
boolean addBuildTimestamp
```
    Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources
  - 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
  - serviceType
```
@ConfigItem(defaultValue="ClusterIP")
io.dekorate.kubernetes.annotation.ServiceType serviceType
```
    The type of service that will be generated for the application
  - 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
  - prometheus
```
@ConfigItem
PrometheusConfig prometheus
```
    Prometheus configuration
  - mounts
```
@ConfigItem
Map<String,MountConfig> mounts
```
    Volume mounts
  - secretVolumes
```
@ConfigItem
Map<String,SecretVolumeConfig> secretVolumes
```
    Secret volumes
  - configMapVolumes
```
@ConfigItem
Map<String,ConfigMapVolumeConfig> configMapVolumes
```
    ConfigMap volumes
  - emptyDirVolumes
```
@ConfigItem
Optional<List<String>> emptyDirVolumes
```
    EmptyDir volumes
  - gitRepoVolumes
```
@ConfigItem
Map<String,GitRepoVolumeConfig> gitRepoVolumes
```
    Git Repository volumes
  - pvcVolumes
```
@ConfigItem
Map<String,PvcVolumeConfig> pvcVolumes
```
    Persistent Volume Claim volumes
  - awsElasticBlockStoreVolumes
```
@ConfigItem
Map<String,AwsElasticBlockStoreVolumeConfig> awsElasticBlockStoreVolumes
```
    AWS Elastic BlockStore volumes
  - azureFileVolumes
```
@ConfigItem
Map<String,AzureFileVolumeConfig> azureFileVolumes
```
    Azure file volumes
  - azureDiskVolumes
```
@ConfigItem
Map<String,AzureDiskVolumeConfig> azureDiskVolumes
```
    Azure disk volumes
  - containerName
```
@ConfigItem
Optional<String> containerName
```
    If set, it will change the name of the container according to the configuration
  - initContainers
```
@ConfigItem
Map<String,ContainerConfig> initContainers
```
    Init containers
  - containers
```
@ConfigItem
Map<String,ContainerConfig> containers
```
    Sidecar containers
  - hostAliases
```
@ConfigItem
Map<String,HostAliasConfig> hostAliases
```
    The host aliases
  - resources
```
@ConfigItem
ResourcesConfig resources
```
    Resources requirements
  - addVersionToLabelSelectors
```
@ConfigItem(defaultValue="true")
boolean addVersionToLabelSelectors
```
    If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment
  - addNameToLabelSelectors
```
@ConfigItem(defaultValue="true")
boolean addNameToLabelSelectors
```
    If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment
  - 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.
  - clusterLocal
```
@ConfigItem
public boolean clusterLocal
```
    Whether this service is cluster-local. Cluster local services are not exposed to the outside world. More information in this link.
  - minScale
```
@ConfigItem
Optional<Integer> 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 point in time.
  - maxScale
```
@ConfigItem
Optional<Integer> 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 point in time.
  - scaleToZeroEnabled
```
@ConfigItem(defaultValue="true")
boolean scaleToZeroEnabled
```
    The scale-to-zero values control whether Knative allows revisions to scale down to zero, or stops at “1”.
  - revisionAutoScaling
```
AutoScalingConfig revisionAutoScaling
```
    Revision autoscaling configuration.
  - globalAutoScaling
```
GlobalAutoScalingConfig globalAutoScaling
```
    Global autoscaling configuration.
  - revisionName
```
Optional<String> revisionName
```
    The name of the revision.
  - traffic
```
Map<String,TrafficConfig> traffic
```
    Traffic configuration.
  - appSecret
```
@ConfigItem
Optional<String> appSecret
```
    If set, the secret will mounted to the application container and its contents will be used for application configuration.
  - appConfigMap
```
@ConfigItem
Optional<String> appConfigMap
```
    If set, the config map will be mounted to the application container and its contents will be used for application configuration.
  - securityContext
```
@ConfigItem
SecurityContextConfig securityContext
```
    If set, it will copy the security context configuration provided into the generated pod settings.
  - deploy
```
@ConfigItem(defaultValue="false")
boolean deploy
```
    If set to true, Quarkus will attempt to deploy the application to the target knative cluster
- Constructor Detail
  - KnativeConfig
```
public KnativeConfig()
```
- Method Detail
  - getPartOf
```
public Optional<String> getPartOf()
```
    Specified by:
    
    getPartOf in interface PlatformConfiguration
  - getName
```
public Optional<String> getName()
```
    Specified by:
    
    getName in interface PlatformConfiguration
  - getVersion
```
public Optional<String> getVersion()
```
    Specified by:
    
    getVersion in interface PlatformConfiguration
  - getNamespace
```
public Optional<String> getNamespace()
```
    Specified by:
    
    getNamespace in interface PlatformConfiguration
  - getLabels
```
public Map<String,String> getLabels()
```
    Specified by:
    
    getLabels in interface PlatformConfiguration
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Specified by:
    
    getAnnotations in interface PlatformConfiguration
  - isAddBuildTimestamp
```
public boolean isAddBuildTimestamp()
```
    Specified by:
    
    isAddBuildTimestamp in interface PlatformConfiguration
  - isAddNameToLabelSelectors
```
public boolean isAddNameToLabelSelectors()
```
    Specified by:
    
    isAddNameToLabelSelectors in interface PlatformConfiguration
  - isAddVersionToLabelSelectors
```
public boolean isAddVersionToLabelSelectors()
```
    Specified by:
    
    isAddVersionToLabelSelectors in interface PlatformConfiguration
  - 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
  - getWorkingDir
```
public Optional<String> getWorkingDir()
```
    Specified by:
    
    getWorkingDir in interface PlatformConfiguration
  - getCommand
```
public Optional<List<String>> getCommand()
```
    Specified by:
    
    getCommand in interface PlatformConfiguration
  - getArguments
```
public Optional<List<String>> getArguments()
```
    Specified by:
    
    getArguments in interface PlatformConfiguration
  - getServiceAccount
```
public Optional<String> getServiceAccount()
```
    Specified by:
    
    getServiceAccount in interface PlatformConfiguration
  - getHost
```
public Optional<String> getHost()
```
    Specified by:
    
    getHost in interface PlatformConfiguration
  - getContainerName
```
public Optional<String> getContainerName()
```
    Specified by:
    
    getContainerName in interface PlatformConfiguration
  - getPorts
```
public Map<String,PortConfig> getPorts()
```
    Specified by:
    
    getPorts in interface PlatformConfiguration
  - getServiceType
```
public io.dekorate.kubernetes.annotation.ServiceType getServiceType()
```
    Specified by:
    
    getServiceType in interface PlatformConfiguration
  - getImagePullPolicy
```
public io.dekorate.kubernetes.annotation.ImagePullPolicy getImagePullPolicy()
```
    Specified by:
    
    getImagePullPolicy in interface PlatformConfiguration
  - getImagePullSecrets
```
public Optional<List<String>> getImagePullSecrets()
```
    Specified by:
    
    getImagePullSecrets in interface PlatformConfiguration
  - getLivenessProbe
```
public ProbeConfig getLivenessProbe()
```
    Specified by:
    
    getLivenessProbe in interface PlatformConfiguration
  - getReadinessProbe
```
public ProbeConfig getReadinessProbe()
```
    Specified by:
    
    getReadinessProbe in interface PlatformConfiguration
  - getPrometheusConfig
```
public PrometheusConfig getPrometheusConfig()
```
    Specified by:
    
    getPrometheusConfig in interface PlatformConfiguration
  - getMounts
```
public Map<String,MountConfig> getMounts()
```
    Specified by:
    
    getMounts in interface PlatformConfiguration
  - getSecretVolumes
```
public Map<String,SecretVolumeConfig> getSecretVolumes()
```
    Specified by:
    
    getSecretVolumes in interface PlatformConfiguration
  - getConfigMapVolumes
```
public Map<String,ConfigMapVolumeConfig> getConfigMapVolumes()
```
    Specified by:
    
    getConfigMapVolumes in interface PlatformConfiguration
  - getEmptyDirVolumes
```
public List<String> getEmptyDirVolumes()
```
    Specified by:
    
    getEmptyDirVolumes in interface PlatformConfiguration
  - getGitRepoVolumes
```
public Map<String,GitRepoVolumeConfig> getGitRepoVolumes()
```
    Specified by:
    
    getGitRepoVolumes in interface PlatformConfiguration
  - getPvcVolumes
```
public Map<String,PvcVolumeConfig> getPvcVolumes()
```
    Specified by:
    
    getPvcVolumes in interface PlatformConfiguration
  - getAwsElasticBlockStoreVolumes
```
public Map<String,AwsElasticBlockStoreVolumeConfig> getAwsElasticBlockStoreVolumes()
```
    Specified by:
    
    getAwsElasticBlockStoreVolumes in interface PlatformConfiguration
  - getAzureFileVolumes
```
public Map<String,AzureFileVolumeConfig> getAzureFileVolumes()
```
    Specified by:
    
    getAzureFileVolumes in interface PlatformConfiguration
  - getAzureDiskVolumes
```
public Map<String,AzureDiskVolumeConfig> getAzureDiskVolumes()
```
    Specified by:
    
    getAzureDiskVolumes in interface PlatformConfiguration
  - getInitContainers
```
public Map<String,ContainerConfig> getInitContainers()
```
    Specified by:
    
    getInitContainers in interface PlatformConfiguration
  - getSidecars
```
public Map<String,ContainerConfig> getSidecars()
```
    Specified by:
    
    getSidecars in interface PlatformConfiguration
  - getHostAliases
```
public Map<String,HostAliasConfig> getHostAliases()
```
    Specified by:
    
    getHostAliases in interface PlatformConfiguration
  - getResources
```
public ResourcesConfig getResources()
```
    Specified by:
    
    getResources in interface PlatformConfiguration
  - getEnvVars
```
@Deprecated
public Map<String,EnvConfig> getEnvVars()
```
    Deprecated.
    
    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
  - getAppSecret
```
public Optional<String> getAppSecret()
```
    Specified by:
    
    getAppSecret in interface PlatformConfiguration
  - getAppConfigMap
```
public Optional<String> getAppConfigMap()
```
    Specified by:
    
    getAppConfigMap in interface PlatformConfiguration
  - getSecurityContext
```
public SecurityContextConfig getSecurityContext()
```
    Specified by:
    
    getSecurityContext in interface PlatformConfiguration

Class KnativeConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

partOf

name

version

namespace

labels

annotations

addBuildTimestamp

workingDir

command

arguments

serviceAccount

host

ports

serviceType

imagePullPolicy

imagePullSecrets

livenessProbe

readinessProbe

prometheus

mounts

secretVolumes

configMapVolumes

emptyDirVolumes

gitRepoVolumes

pvcVolumes

awsElasticBlockStoreVolumes

azureFileVolumes

azureDiskVolumes

containerName

initContainers

containers

hostAliases

resources

addVersionToLabelSelectors

addNameToLabelSelectors

envVars

env

clusterLocal

minScale

maxScale

scaleToZeroEnabled

revisionAutoScaling

globalAutoScaling

revisionName

traffic

appSecret

appConfigMap

securityContext

deploy

Constructor Detail

KnativeConfig

Method Detail

getPartOf

getName

getVersion

getNamespace

getLabels

getAnnotations

isAddBuildTimestamp

isAddNameToLabelSelectors

isAddVersionToLabelSelectors

getTargetPlatformName

getWorkingDir

getCommand

getArguments

getServiceAccount

getHost

getContainerName

getPorts

getServiceType

getImagePullPolicy

getImagePullSecrets