Package io.quarkus.kubernetes.deployment

Interface OpenShiftConfig

All Superinterfaces:

EnvVarHolder, PlatformConfiguration

@ConfigMapping(prefix="quarkus.openshift")
@ConfigRoot(phase=BUILD_TIME)
public interface OpenShiftConfig
extends PlatformConfiguration

OpenShift

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OpenShiftConfig.OpenshiftFlavor

Method Summary

Modifier and Type	Method	Description
boolean	deploy()	If set to true, Quarkus will attempt to deploy the application to the target Kubernetes cluster
Optional<DeploymentResourceKind>	deploymentKind()	The kind of the deployment resource to use.
OpenShiftConfig.OpenshiftFlavor	flavor()	The OpenShift flavor / version to use.
default DeploymentResourceKind	getDeploymentResourceKind(io.quarkus.deployment.Capabilities capabilities)
static boolean	isOpenshiftBuildEnabled(io.quarkus.container.image.deployment.ContainerImageConfig containerImageConfig, io.quarkus.deployment.Capabilities capabilities)
OptionalInt	nodePort()	The nodePort to set when serviceType is set to nodePort
Integer	replicas()	The number of desired pods
RouteConfig	route()	OpenShift route configuration
default String	targetPlatformName()	Specifies which the name of the platform this EnvVarHolder targets.

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

convertToBuildItems, env

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

addBuildTimestamp, addNameToLabelSelectors, addVersionToLabelSelectors, annotations, appConfigMap, appSecret, arguments, awsElasticBlockStoreVolumes, azureDiskVolumes, azureFileVolumes, command, configMapVolumes, containerName, cronJob, deployStrategy, emptyDirVolumes, generateImagePullSecret, gitRepoVolumes, hostAliases, idempotent, imagePullPolicy, imagePullSecrets, initContainers, initTaskDefaults, initTasks, job, labels, livenessProbe, mounts, name, namespace, nodeSelector, partOf, ports, prometheus, pvcVolumes, rbac, readinessProbe, remoteDebug, resources, secretVolumes, securityContext, serviceAccount, serviceType, sidecars, startupProbe, vcsUri, version, workingDir

Method Details

targetPlatformName

default String targetPlatformName()

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:

targetPlatformName in interface EnvVarHolder

Returns:

the name of the targeted platform e.g. Constants.KUBERNETES

flavor

@WithDefault("v4")
OpenShiftConfig.OpenshiftFlavor flavor()

The OpenShift flavor / version to use. Older versions of OpenShift have minor differences in the labels and fields they support. This option allows users to have their manifests automatically aligned to the OpenShift 'flavor' they use.

deploymentKind

Optional<DeploymentResourceKind> deploymentKind()

The kind of the deployment resource to use. Supported values are 'Deployment', 'StatefulSet', 'Job', 'CronJob' and 'DeploymentConfig'. Defaults to 'DeploymentConfig' if flavor == v3, or 'Deployment' otherwise. DeploymentConfig is deprecated as of OpenShift 4.14. See https://access.redhat.com/articles/7041372 for details.

Specified by:

deploymentKind in interface PlatformConfiguration

replicas

@WithDefault("1")
Integer replicas()

The number of desired pods

nodePort

OptionalInt nodePort()

The nodePort to set when serviceType is set to nodePort

route

RouteConfig route()

OpenShift route configuration

deploy

@WithDefault("false")
boolean deploy()

If set to true, Quarkus will attempt to deploy the application to the target Kubernetes cluster

isOpenshiftBuildEnabled

static boolean isOpenshiftBuildEnabled(io.quarkus.container.image.deployment.ContainerImageConfig containerImageConfig,
 io.quarkus.deployment.Capabilities capabilities)

getDeploymentResourceKind

default DeploymentResourceKind getDeploymentResourceKind(io.quarkus.deployment.Capabilities capabilities)

Specified by:

getDeploymentResourceKind in interface PlatformConfiguration