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

All Implemented Interfaces:: EnvVarHolder, PlatformConfiguration

@ConfigRoot
public class OpenshiftConfig
extends Object
implements PlatformConfiguration

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OpenshiftConfig.OpenshiftFlavor

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) boolean`	`addBuildTimestamp`	Whether or not 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`	`addVersionToLabelSelectors`	If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and DeploymentConfig
`(package private) Map<String,String>`	`annotations`	Custom annotations to add to all resources
`(package private) Optional<String>`	`appConfigMap`	If set, the config amp will 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
`(package private) Optional<List<String>>`	`command`	The commands
`(package private) Map<String,ConfigMapVolumeConfig>`	`configMapVolumes`	ConfigMap volumes
`(package private) Map<String,ContainerConfig>`	`containers`	Deprecated. Use the `sidecars` property instead
`(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) boolean`	`expose`	Deprecated. Use the `quarkus.openshift.route.exposition` instead
`(package private) OpenshiftConfig.OpenshiftFlavor`	`flavor`	The OpenShift flavor / version to use.
`(package private) Map<String,GitRepoVolumeConfig>`	`gitRepoVolumes`	Git Repository volumes
`(package private) Optional<String>`	`host`	Deprecated. Use the `quarkus.openshift.route.host` instead
`(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) 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) OptionalInt`	`nodePort`	The nodePort to set when serviceType is set to nodePort
`(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) Integer`	`replicas`	The number of desired pods
`(package private) ResourcesConfig`	`resources`	Resources requirements
`(package private) ExpositionConfig`	`route`	Openshift route configuration
`(package private) Map<String,SecretVolumeConfig>`	`secretVolumes`	Secret volumes
`(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,ContainerConfig>`	`sidecars`	Sidecar containers
`(package private) Optional<String>`	`version`	The version of the application.
`(package private) Optional<String>`	`workingDir`	Working directory

Constructor Summary

Constructors
Constructor Description

OpenshiftConfig()

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()`
`EnvVarsConfig`	`getEnv()`	Retrieves the definition of environment variables to add to the application's container.
`Map<String,EnvConfig>`	`getEnvVars()`	Deprecated.
`Optional<ExpositionConfig>`	`getExposition()`
`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()`
`Integer`	`getReplicas()`
`ResourcesConfig`	`getResources()`
`Map<String,SecretVolumeConfig>`	`getSecretVolumes()`
`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`	`isExpose()`

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
  - flavor
```
@ConfigItem(defaultValue="v4")
OpenshiftConfig.OpenshiftFlavor flavor
```
    The OpenShift flavor / version to use. Older versions of OpenShift have minor differrences in the labels and fields they support. This option allows users to have their manifests automatically aligned to the OpenShift 'flavor' they use.
  - 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 or not 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
```
    Deprecated.
    Use the quarkus.openshift.route.host instead
    
    The host under which the application is going to be exposed
  - ports
```
@ConfigItem
Map<String,PortConfig> ports
```
    The application ports
  - replicas
```
@ConfigItem(defaultValue="1")
Integer replicas
```
    The number of desired pods
  - serviceType
```
@ConfigItem(defaultValue="ClusterIP")
io.dekorate.kubernetes.annotation.ServiceType serviceType
```
    The type of service that will be generated for the application
  - nodePort
```
@ConfigItem
OptionalInt nodePort
```
    The nodePort to set when serviceType is set to nodePort
  - 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
  - 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
  - initContainers
```
@ConfigItem
Map<String,ContainerConfig> initContainers
```
    Init containers
  - containers
```
@ConfigItem
@Deprecated
Map<String,ContainerConfig> containers
```
    Deprecated.
    Use the sidecars property instead
    
    Sidecar containers
  - sidecars
```
@ConfigItem
Map<String,ContainerConfig> sidecars
```
    Sidecar containers
  - hostAliases
```
@ConfigItem
Map<String,HostAliasConfig> hostAliases
```
    The host aliases
  - resources
```
@ConfigItem
ResourcesConfig resources
```
    Resources requirements
  - expose
```
@ConfigItem
boolean expose
```
    Deprecated.
    Use the quarkus.openshift.route.exposition instead
    
    If true, an Openshift Route will be created
  - route
```
ExpositionConfig route
```
    Openshift route configuration
  - addVersionToLabelSelectors
```
@ConfigItem(defaultValue="true")
boolean addVersionToLabelSelectors
```
    If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and DeploymentConfig
  - 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.
  - 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 amp will mounted to the application container and its contents will be used for application configuration.
- Constructor Detail
  - OpenshiftConfig
```
public OpenshiftConfig()
```
- 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
  - 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
  - getReplicas
```
public Integer getReplicas()
```
  - 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
  - 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
  - getHostAliases
```
public Map<String,HostAliasConfig> getHostAliases()
```
    Specified by:
    
    getHostAliases in interface PlatformConfiguration
  - getResources
```
public ResourcesConfig getResources()
```
    Specified by:
    
    getResources 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
  - isExpose
```
public boolean isExpose()
```
    Specified by:
    
    isExpose 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
  - 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
  - getExposition
```
public Optional<ExpositionConfig> getExposition()
```
    Specified by:
    
    getExposition in interface PlatformConfiguration

Class OpenshiftConfig

Nested Class Summary

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

flavor

partOf

name

version

namespace

labels

annotations

addBuildTimestamp

workingDir

command

arguments

serviceAccount

host

ports

replicas

serviceType

nodePort

imagePullPolicy

imagePullSecrets

livenessProbe

readinessProbe

prometheus

mounts

secretVolumes

configMapVolumes

gitRepoVolumes

pvcVolumes

awsElasticBlockStoreVolumes

azureFileVolumes

azureDiskVolumes

initContainers

containers

sidecars

hostAliases

resources

expose

route

addVersionToLabelSelectors

envVars

env

appSecret

appConfigMap

Constructor Detail

OpenshiftConfig

Method Detail

getPartOf

getName

getVersion

getNamespace

getLabels

getAnnotations

isAddBuildTimestamp

getWorkingDir

getCommand

getArguments

getServiceAccount

getHost

getReplicas

getPorts

getServiceType

getImagePullPolicy

getImagePullSecrets

getLivenessProbe

getReadinessProbe

getPrometheusConfig

getMounts

getSecretVolumes

getConfigMapVolumes

getGitRepoVolumes

getPvcVolumes

getAwsElasticBlockStoreVolumes