Edit this Page

Deploying on OpenShift

This guide covers generating and deploying OpenShift resources based on sane default and user supplied configuration.

Prerequisites

To complete this guide, you need:

  • Roughly 15 minutes

  • An IDE

  • JDK 17+ installed with JAVA_HOME configured appropriately

  • Apache Maven 3.9.9

  • Optionally the Quarkus CLI if you want to use it

  • Access to an OpenShift cluster (Minishift is a viable option)

  • OpenShift CLI (Optional, only required for manual deployment)

Bootstrapping the project

First, we need a new project that contains the OpenShift extension. This can be done using the following command:

CLI
quarkus create app org.acme:openshift-quickstart \
    --extension='rest,openshift'
cd openshift-quickstart

To create a Gradle project, add the --gradle or --gradle-kotlin-dsl option.

For more information about how to install and use the Quarkus CLI, see the Quarkus CLI guide.

Maven
mvn io.quarkus.platform:quarkus-maven-plugin:3.17.2:create \
    -DprojectGroupId=org.acme \
    -DprojectArtifactId=openshift-quickstart \
    -Dextensions='rest,openshift'
cd openshift-quickstart

To create a Gradle project, add the -DbuildTool=gradle or -DbuildTool=gradle-kotlin-dsl option.

For Windows users:

  • If using cmd, (don’t use backward slash \ and put everything on the same line)

  • If using Powershell, wrap -D parameters in double quotes e.g. "-DprojectArtifactId=openshift-quickstart"

Quarkus offers the ability to automatically generate OpenShift resources based on sane defaults and user supplied configuration. The OpenShift extension is actually a wrapper extension that brings configures the Kubernetes extension with sensible defaults so that it’s easier for the user to get started with Quarkus on OpenShift.

When we added the OpenShift extension to the command line invocation above, the following dependency was added to the pom.xml

pom.xml
<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-openshift</artifactId>
</dependency>
build.gradle
implementation("io.quarkus:quarkus-openshift")

Log Into the OpenShift Cluster

Before we build and deploy our application we need to log into an OpenShift cluster. You can log in via the OpenShift CLI:

Log In - OpenShift CLI Example
oc login -u myUsername (1)
1 You’ll be prompted for the required information such as server URL, password, etc.

Alternatively, you may log in using the API token:

Log In - OpenShift CLI With API Token Example
oc login --token=myToken --server=myServerUrl
You can request the token via the Copy Login Command link in the OpenShift web console.

Finally, you don’t need to use the OpenShift CLI at all. Instead, set the quarkus.kubernetes-client.api-server-url config property and authenticate with the quarkus.kubernetes-client.token, or quarkus.kubernetes-client.username and quarkus.kubernetes-client.password respectively:

CLI
quarkus build -Dquarkus.kubernetes-client.api-server-url=myServerUrl -Dquarkus.kubernetes-client.token=myToken
Maven
./mvnw install -Dquarkus.kubernetes-client.api-server-url=myServerUrl -Dquarkus.kubernetes-client.token=myToken
Gradle
./gradlew build -Dquarkus.kubernetes-client.api-server-url=myServerUrl -Dquarkus.kubernetes-client.token=myToken

Build and Deployment

You can trigger a build and deployment in a single step or build the container image first and then configure the OpenShift application manually if you need more control over the deployment configuration.

To trigger a build and deployment in a single step:

CLI
quarkus build -Dquarkus.openshift.deploy=true
Maven
./mvnw install -Dquarkus.openshift.deploy=true
Gradle
./gradlew build -Dquarkus.openshift.deploy=true
If you want to test your application immediately then set the quarkus.openshift.route.expose config property to true to expose the service automatically, e.g. add -Dquarkus.openshift.route.expose=true to the command above.
When using DeploymentConfig and Service Binding, re-deploying might remove the configuration added by OpenShift to allow service discovery. A new container image build will trigger a refresh of the Quarkus app in OpenShift: -Dquarkus.container-image.build=true which might be enough in most situations. If you need to update the OpenShift resources, you need to delete the binding first to create it again after new deployment.

This command will build your application locally, then trigger a container image build and finally apply the generated OpenShift resources automatically. The generated resources use a Kubernetes Deployment, but still make use of OpenShift specific resources like Route, BuildConfig etc.

As of OpenShift 4.14, the DeploymentConfig object has been deprecated.

Since Deployment is a Kubernetes resource and not OpenShift specific, it can’t possibly leverage ImageStream resources, as is the case with DeploymentConfig. This means that the image references need to include the container image registry that hosts the image. When the image is built, using OpenShift builds (s2i binary and docker strategy) the OpenShift internal image registry image-registry.openshift-image-registry.svc:5000 will be used, unless another registry has been explicitly specified by the user. Please note, that in the internal registry the project/namespace name is added as part of the image repository: image-registry.openshift-image-registry.svc:5000/<project name>/<name>:<tag>, so users will need to make sure that the target project/namespace name is aligned with the quarkus.container-image.group.

The deprecation document contains additional information about how to set up/use automatic rollbacks, triggers, lifecycle hooks, and custom strategies.

quarkus.container-image.group=<project/namespace name>

You can use the OpenShift web console to verify that the above command has created an image stream, a service resource and has deployed the application. Alternatively, you can run the following OpenShift CLI commands:

oc get is (1)
oc get pods (2)
oc get svc (3)
1 Lists the image streams created.
2 Get the list of pods.
3 Get the list of Kubernetes services.

Note that the service is not exposed to the outside world by default. So unless you’ve used the quarkus.openshift.route.expose config property to expose the created service automatically you’ll need to expose the service manually.

Expose The Service - OpenShift CLI Example
oc expose svc/openshift-quickstart (1)
oc get routes (2)
curl http://<route>/hello (3)
1 Expose the service.
2 Get the list of exposed routes.
3 Access your application.

Configure the OpenShift Application Manually

If you need more control over the deployment configuration you can build the container image first and then configure the OpenShift application manually.

To trigger a container image build:

./mvnw clean package -Dquarkus.container-image.build=true

The build that will be performed is a s2i binary build. The input of the build is the jar that has been built locally and the output of the build is an ImageStream that is configured to automatically trigger a deployment. The base/builder image is specified using base-jvm-image and base-native-image for jvm and native mode respectively. An ImageStream for the image is automatically generated, unless these properties are used to reference an existing ImageStreamTag in the internal openshift registry. For example:

quarkus.openshift.base-jvm-image=image-registry.openshift-image-registry.svc:5000/some-project/openjdk-11:17.1.16.

During the build you may find the Caused by: javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed exception due to self-signed certificate. To solve this, just add the following line to your application.properties:

quarkus.kubernetes-client.trust-certs=true

For more information, see deploying to Kubernetes.

Once the build is done we can create a new application from the relevant ImageStream.

oc get is (1)
oc new-app --name=greeting <project>/openshift-quickstart:1.0.0-SNAPSHOT (2)
oc get svc
oc expose svc/greeting (3)
oc get routes (4)
curl http://<route>/hello (5)
1 Lists the image streams created. The image stream of our application should be tagged as <project>/openshift-quickstart:1.0.0-SNAPSHOT.
2 Create a new application from the image source.
3 Expose the service to the outside world.
4 Get the list of exposed routes.
5 Access your application.

After this setup the next time the container image is built a deployment to OpenShift is triggered automatically. In other words, you don’t need to repeat the above steps.

Non-S2I Builds

Out of the box the OpenShift extension is configured to use container-image-s2i. However, it’s still possible to use other container image extensions like:

When a non-s2i container image extension is used, an ImageStream is created that is pointing to an external dockerImageRepository. The image is built and pushed to the registry and the ImageStream populates the tags that are available in the dockerImageRepository.

To select which extension will be used for building the image:

quarkus.container-image.builder=docker

or

quarkus.container-image.builder=jib

Customizing

All available customization options are available in the OpenShift configuration options.

Some examples are provided in the sections below:

Exposing Routes

To expose a Route for the Quarkus application:

quarkus.openshift.route.expose=true

You don’t necessarily need to add this property in the application.properties. You can pass it as a command line argument:

./mvnw clean package -Dquarkus.openshift.route.expose=true

The same applies to all properties listed below.

Securing the Route resource

To secure the incoming connections, OpenShift provides several types of TLS termination to serve certifications. You can read more information about how to secure routes in the official OpenShift guide.

Let’s see an example about how to configure a secured Route using passthrough termination by simply adding the "quarkus.openshift.route.tls" properties:

quarkus.openshift.route.expose=true
quarkus.openshift.route.target-port=https
## Route TLS configuration:
quarkus.openshift.route.tls.termination=passthrough
quarkus.openshift.route.tls.insecure-edge-termination-policy=None

Labels

To add a label in the generated resources:

quarkus.openshift.labels.foo=bar

Annotations

To add an annotation in the generated resources:

quarkus.openshift.annotations.foo=bar

Environment variables

OpenShift provides multiple ways of defining environment variables:

  • key/value pairs

  • import all values from a Secret or ConfigMap

  • interpolate a single value identified by a given field in a Secret or ConfigMap

  • interpolate a value from a field within the same resource

Environment variables from key/value pairs

To add a key/value pair as an environment variable in the generated resources:

quarkus.openshift.env.vars.my-env-var=foobar

The command above will add MY_ENV_VAR=foobar as an environment variable. Please note that the key my-env-var will be converted to uppercase and dashes will be replaced by underscores resulting in MY_ENV_VAR.

Environment variables from Secret

To add all key/value pairs of Secret as environment variables just apply the following configuration, separating each Secret to be used as source by a comma (,):

quarkus.openshift.env.secrets=my-secret,my-other-secret

which would generate the following in the container definition:

envFrom:
  - secretRef:
      name: my-secret
      optional: false
  - secretRef:
      name: my-other-secret
      optional: false

The following extracts a value identified by the keyName field from the my-secret Secret into a foo environment variable:

quarkus.openshift.env.mapping.foo.from-secret=my-secret
quarkus.openshift.env.mapping.foo.with-key=keyName

This would generate the following in the env section of your container:

- env:
  - name: FOO
    valueFrom:
      secretKeyRef:
        key: keyName
        name: my-secret
        optional: false

Environment variables from ConfigMap

To add all key/value pairs from ConfigMap as environment variables just apply the following configuration, separating each ConfigMap to be used as source by a comma (,):

quarkus.openshift.env.configmaps=my-config-map,another-config-map

which would generate the following in the container definition:

envFrom:
  - configMapRef:
      name: my-config-map
      optional: false
  - configMapRef:
      name: another-config-map
      optional: false

The following extracts a value identified by the keyName field from the my-config-map ConfigMap into a foo environment variable:

quarkus.openshift.env.mapping.foo.from-configmap=my-configmap
quarkus.openshift.env.mapping.foo.with-key=keyName

This would generate the following in the env section of your container:

- env:
  - name: FOO
    valueFrom:
      configMapKeyRef:
        key: keyName
        name: my-configmap
        optional: false

Environment variables from fields

It’s also possible to use the value from another field to add a new environment variable by specifying the path of the field to be used as a source, as follows:

quarkus.openshift.env.fields.foo=metadata.name

Changing the generated deployment resource

Beside generating a Deployment resource, you can also choose to get either a DeploymentConfig, StatefulSet, Job, or a CronJob resource instead via application.properties:

quarkus.openshift.deployment-kind=StatefulSet
Generating Job resources

If you want to generate a Job resource, you need to add the following property via the application.properties:

quarkus.openshift.deployment-kind=Job
If you are using the Picocli extension, by default the Job resource will be generated.

You can provide the arguments that will be used by the Kubernetes Job via the property quarkus.openshift.arguments. For example, adding the property quarkus.openshift.arguments=A,B.

Finally, the Kubernetes job will be launched every time that is installed in OpenShift. You can know more about how to run Kubernetes jobs in this link.

You can configure the rest of the Kubernetes Job configuration using the properties under quarkus.openshift.job.xxx (see link).

Generating CronJob resources

If you want to generate a CronJob resource, you need to add the following property via the application.properties:

quarkus.openshift.deployment-kind=CronJob
# Cron expression to run the job every hour
quarkus.openshift.cron-job.schedule=0 * * * *
CronJob resources require the Cron expression to specify when to launch the job via the property quarkus.openshift.cron-job.schedule. If not provide, the build will fail.

You can configure the rest of the Kubernetes CronJob configuration using the properties under quarkus.openshift.cron-job.xxx (see link).

Validation

A conflict between two definitions, e.g. mistakenly assigning both a value and specifying that a variable is derived from a field, will result in an error being thrown at build time so that you get the opportunity to fix the issue before you deploy your application to your cluster where it might be more difficult to diagnose the source of the issue.

Similarly, two redundant definitions, e.g. defining an injection from the same secret twice, will not cause an issue but will indeed report a warning to let you know that you might not have intended to duplicate that definition.

Backwards compatibility

Previous versions of the OpenShift extension supported a different syntax to add environment variables. The older syntax is still supported but is deprecated, and it’s advised that you migrate to the new syntax.

Table 1. Old vs. new syntax

Old

New

Plain variable

quarkus.openshift.env-vars.my-env-var.value=foobar

quarkus.openshift.env.vars.my-env-var=foobar

From field

quarkus.openshift.env-vars.my-env-var.field=foobar

quarkus.openshift.env.fields.my-env-var=foobar

All from ConfigMap

quarkus.openshift.env-vars.xxx.configmap=foobar

quarkus.openshift.env.configmaps=foobar

All from Secret

quarkus.openshift.env-vars.xxx.secret=foobar

quarkus.openshift.env.secrets=foobar

From one Secret field

quarkus.openshift.env-vars.foo.secret=foobar

quarkus.openshift.env.mapping.foo.from-secret=foobar

quarkus.openshift.env-vars.foo.value=field

quarkus.openshift.env.mapping.foo.with-key=field

From one ConfigMap field

quarkus.openshift.env-vars.foo.configmap=foobar

quarkus.openshift.env.mapping.foo.from-configmap=foobar

quarkus.openshift.env-vars.foo.value=field

quarkus.openshift.env.mapping.foo.with-key=field

If you redefine the same variable using the new syntax while keeping the old syntax, ONLY the new version will be kept, and a warning will be issued to alert you of the problem. For example, if you define both quarkus.openshift.env-vars.my-env-var.value=foobar and quarkus.openshift.env.vars.my-env-var=newValue, the extension will only generate an environment variable MY_ENV_VAR=newValue and issue a warning.

Mounting volumes

The OpenShift extension allows the user to configure both volumes and mounts for the application.

Any volume can be mounted with a simple configuration:

quarkus.openshift.mounts.my-volume.path=/where/to/mount

This will add a mount to my pod for volume my-volume to path /where/to/mount

The volumes themselves can be configured as shown in the sections below:

Secret volumes

quarkus.openshift.secret-volumes.my-volume.secret-name=my-secret

ConfigMap volumes

quarkus.openshift.config-map-volumes.my-volume.config-map-name=my-config-map

Persistent Volume Claims

quarkus.openshift.pvc-volumes.my-pvc.claim-name=my-pvc

Knative - OpenShift Serverless

OpenShift also provides the ability to use Knative via the OpenShift Serverless functionality.

The first order of business is to instruct Quarkus to generate Knative resources by setting:

quarkus.kubernetes.deployment-target=knative

In order to leverage OpenShift S2I to build the container image on the cluster and use the resulting container image for the Knative application, we need to set a couple of configuration properties:

# set the Kubernetes namespace which will be used to run the application
quarkus.container-image.group=geoand
# set the container image registry - this is the standard URL used to refer to the internal OpenShift registry
quarkus.container-image.registry=image-registry.openshift-image-registry.svc:5000

The application can then be deployed to OpenShift Serverless by enabling the standard quarkus.kubernetes.deploy=true property.

Configuration Reference

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

The optional list of Secret names to load environment variables from.

Environment variable: QUARKUS_OPENSHIFT_ENV_SECRETS

Show more

list of string

The optional list of ConfigMap names to load environment variables from.

Environment variable: QUARKUS_OPENSHIFT_ENV_CONFIGMAPS

Show more

list of string

The map associating environment variable names to their associated field references they take their value from.

Environment variable: QUARKUS_OPENSHIFT_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_

Show more

Map<String,String>

The environment variable value

Environment variable: QUARKUS_OPENSHIFT_ENV_VARS__VARS_

Show more

string

The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap.

Environment variable: QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_SECRET

Show more

string

The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret.

Environment variable: QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_CONFIGMAP

Show more

string

The key identifying the field from which the value is extracted.

Environment variable: QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__WITH_KEY

Show more

string

required

The optional prefix to use when adding the environment variable to the container.

Environment variable: QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_SECRET

Show more

string

The optional prefix to use when adding the environment variable to the container.

Environment variable: QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP

Show more

string

The name of the group this component belongs too.

Environment variable: QUARKUS_OPENSHIFT_PART_OF

Show more

string

The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on …​

Environment variable: QUARKUS_OPENSHIFT_NAME

Show more

string

The version of the application.

Environment variable: QUARKUS_OPENSHIFT_VERSION

Show more

string

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 organize-cluster-access-kubeconfig for more details).

Environment variable: QUARKUS_OPENSHIFT_NAMESPACE

Show more

string

Custom labels to add to all resources.

Environment variable: QUARKUS_OPENSHIFT_LABELS__LABEL_NAME_

Show more

Map<String,String>

Custom annotations to add to all resources.

Environment variable: QUARKUS_OPENSHIFT_ANNOTATIONS__ANNOTATION_NAME_

Show more

Map<String,String>

The type of service that will be generated for the application

Environment variable: QUARKUS_OPENSHIFT_SERVICE_TYPE

Show more

cluster-ip, node-port, load-balancer, external-name

cluster-ip

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.

Environment variable: QUARKUS_OPENSHIFT_ADD_BUILD_TIMESTAMP

Show more

boolean

true

If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment.

Environment variable: QUARKUS_OPENSHIFT_ADD_VERSION_TO_LABEL_SELECTORS

Show more

boolean

true

If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment.

Environment variable: QUARKUS_OPENSHIFT_ADD_NAME_TO_LABEL_SELECTORS

Show more

boolean

true

Working directory.

Environment variable: QUARKUS_OPENSHIFT_WORKING_DIR

Show more

string

The commands.

Environment variable: QUARKUS_OPENSHIFT_COMMAND

Show more

list of string

The arguments.

Environment variable: QUARKUS_OPENSHIFT_ARGUMENTS

Show more

list of string

The service account.

Environment variable: QUARKUS_OPENSHIFT_SERVICE_ACCOUNT

Show more

string

If set, it will change the name of the container according to the configuration.

Environment variable: QUARKUS_OPENSHIFT_CONTAINER_NAME

Show more

string

The port number. Refers to the container port.

Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__CONTAINER_PORT

Show more

int

The host port.

Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__HOST_PORT

Show more

int

The application path (refers to web application path).

Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__PATH

Show more

string

/

The protocol.

Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__PROTOCOL

Show more

tcp, udp, sctp, http, proxy

tcp

The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.

Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__NODE_PORT

Show more

int

If enabled, the port will be configured to use the schema HTTPS.

Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__TLS

Show more

boolean

false

Image pull policy.

Environment variable: QUARKUS_OPENSHIFT_IMAGE_PULL_POLICY

Show more

always, if-not-present, never

always

The image pull secret.

Environment variable: QUARKUS_OPENSHIFT_IMAGE_PULL_SECRETS

Show more

list of string

Enable generation of image pull secret, when the container image username and password are provided.

Environment variable: QUARKUS_OPENSHIFT_GENERATE_IMAGE_PULL_SECRET

Show more

boolean

false

The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT

Show more

int

The port name for selecting the port of the HTTP get action.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME

Show more

string

The http path to use for the probe. For this to work, the container port also needs to be set.

Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PATH

Show more

string

The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_SCHEME

Show more

string

The command to use for the probe.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_EXEC_ACTION

Show more

string

The tcp socket to use for the probe (the format is host:port).

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_TCP_SOCKET_ACTION

Show more

string

The gRPC port to use for the probe (the format is either port or port:service).

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION

Show more

string

If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION_ENABLED

Show more

boolean

false

The amount of time to wait before starting to probe.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_INITIAL_DELAY

Show more

Duration 

5S

The period in which the action should be called.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_PERIOD

Show more

Duration 

10S

The amount of time to wait for each action.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_TIMEOUT

Show more

Duration 

10S

The success threshold to use.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_SUCCESS_THRESHOLD

Show more

int

1

The failure threshold to use.

Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_FAILURE_THRESHOLD

Show more

int

3

The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT

Show more

int

The port name for selecting the port of the HTTP get action.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT_NAME

Show more

string

The http path to use for the probe. For this to work, the container port also needs to be set.

Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PATH

Show more

string

The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_SCHEME

Show more

string

The command to use for the probe.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_EXEC_ACTION

Show more

string

The tcp socket to use for the probe (the format is host:port).

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_TCP_SOCKET_ACTION

Show more

string

The gRPC port to use for the probe (the format is either port or port:service).

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION

Show more

string

If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION_ENABLED

Show more

boolean

false

The amount of time to wait before starting to probe.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_INITIAL_DELAY

Show more

Duration 

5S

The period in which the action should be called.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_PERIOD

Show more

Duration 

10S

The amount of time to wait for each action.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_TIMEOUT

Show more

Duration 

10S

The success threshold to use.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_SUCCESS_THRESHOLD

Show more

int

1

The failure threshold to use.

Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_FAILURE_THRESHOLD

Show more

int

3

The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT

Show more

int

The port name for selecting the port of the HTTP get action.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT_NAME

Show more

string

The http path to use for the probe. For this to work, the container port also needs to be set.

Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PATH

Show more

string

The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_SCHEME

Show more

string

The command to use for the probe.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_EXEC_ACTION

Show more

string

The tcp socket to use for the probe (the format is host:port).

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_TCP_SOCKET_ACTION

Show more

string

The gRPC port to use for the probe (the format is either port or port:service).

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION

Show more

string

If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION_ENABLED

Show more

boolean

false

The amount of time to wait before starting to probe.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_INITIAL_DELAY

Show more

Duration 

5S

The period in which the action should be called.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_PERIOD

Show more

Duration 

10S

The amount of time to wait for each action.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_TIMEOUT

Show more

Duration 

10S

The success threshold to use.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_SUCCESS_THRESHOLD

Show more

int

1

The failure threshold to use.

Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_FAILURE_THRESHOLD

Show more

int

3

When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics.

In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.

Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_ANNOTATIONS

Show more

boolean

true

When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics.

In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.

Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_GENERATE_SERVICE_MONITOR

Show more

boolean

true

Define the annotation prefix used for scrape values, this value will be used as the base for other annotation name defaults. Altering the base for generated annotations can make it easier to define re-labeling rules and avoid unexpected knock-on effects. The default value is prometheus.io See Prometheus example

Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_PREFIX

Show more

string

prometheus.io

Define the annotation used to indicate services that should be scraped. By default, /scrape will be appended to the defined prefix.

Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_SCRAPE

Show more

string

Define the annotation used to indicate the path to scrape. By default, /path will be appended to the defined prefix.

Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_PATH

Show more

string

Define the annotation used to indicate the port to scrape. By default, /port will be appended to the defined prefix.

Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_PORT

Show more

string

Define the annotation used to indicate the scheme to use for scraping By default, /scheme will be appended to the defined prefix.

Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_SCHEME

Show more

string

The name of the volumeName to mount.

Environment variable: QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__NAME

Show more

string

The path to mount.

Environment variable: QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__PATH

Show more

string

Path within the volumeName from which the container’s volumeName should be mounted.

Environment variable: QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__SUB_PATH

Show more

string

ReadOnly.

Environment variable: QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__READ_ONLY

Show more

boolean

false

The name of the secret to mount.

Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME

Show more

string

required

Default mode. When specifying an octal number, leading zero must be present.

Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE

Show more

string

0600

The path where the file will be mounted.

Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH

Show more

string

required

It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used.

Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE

Show more

int

-1

Optional

Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL

Show more

boolean

false

The name of the ConfigMap to mount.

Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME

Show more

string

required

Default mode. When specifying an octal number, leading zero must be present.

Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE

Show more

string

0600

The path where the file will be mounted.

Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH

Show more

string

required

It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used.

Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE

Show more

int

-1

Optional

Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL

Show more

boolean

false

EmptyDir volumes.

Environment variable: QUARKUS_OPENSHIFT_EMPTY_DIR_VOLUMES

Show more

list of string

Git repository URL.

Environment variable: QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY

Show more

string

required

The directory of the repository to mount.

Environment variable: QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY

Show more

string

The commit hash to use.

Environment variable: QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION

Show more

string

The name of the claim to mount.

Environment variable: QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME

Show more

string

required

Default mode. When specifying an octal number, leading zero must be present.

Environment variable: QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE

Show more

string

0600

Optional

Environment variable: QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL

Show more

boolean

false

The name of the disk to mount.

Environment variable: QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID

Show more

string

required

The partition.

Environment variable: QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION

Show more

int

Filesystem type.

Environment variable: QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE

Show more

string

ext4

Whether the volumeName is read only or not.

Environment variable: QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY

Show more

boolean

false

The share name.

Environment variable: QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME

Show more

string

required

The secret name.

Environment variable: QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME

Show more

string

required

Whether the volumeName is read only or not.

Environment variable: QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY

Show more

boolean

false

The name of the disk to mount.

Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME

Show more

string

required

The URI of the vhd blob object OR the resourceID of an Azure managed data disk if Kind is Managed

Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI

Show more

string

required

Kind of disk.

Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND

Show more

managed, shared

managed

Disk caching mode.

Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE

Show more

read-write, read-only, none

read-write

File system type.

Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE

Show more

string

ext4

Whether the volumeName is read only or not.

Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY

Show more

boolean

false

The optional list of Secret names to load environment variables from.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS

Show more

list of string

The optional list of ConfigMap names to load environment variables from.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS

Show more

list of string

The map associating environment variable names to their associated field references they take their value from.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_

Show more

Map<String,String>

The environment variable value

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_

Show more

string

The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET

Show more

string

The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP

Show more

string

The key identifying the field from which the value is extracted.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY

Show more

string

required

The optional prefix to use when adding the environment variable to the container.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET

Show more

string

The optional prefix to use when adding the environment variable to the container.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP

Show more

string

The container image.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE

Show more

string

Working directory.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR

Show more

string

The commands

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND

Show more

list of string

The arguments

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS

Show more

list of string

The service account.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT

Show more

string

The host under which the application is going to be exposed.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__HOST

Show more

string

The port number. Refers to the container port.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT

Show more

int

The host port.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT

Show more

int

The application path (refers to web application path).

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH

Show more

string

/

The protocol.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL

Show more

tcp, udp, sctp, http, proxy

tcp

The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT

Show more

int

If enabled, the port will be configured to use the schema HTTPS.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS

Show more

boolean

false

Image pull policy.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY

Show more

always, if-not-present, never

always

The image pull secret

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS

Show more

list of string

The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT

Show more

int

The port name for selecting the port of the HTTP get action.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME

Show more

string

The http path to use for the probe. For this to work, the container port also needs to be set.

Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH

Show more

string

The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME

Show more

string

The command to use for the probe.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION

Show more

string

The tcp socket to use for the probe (the format is host:port).

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION

Show more

string

The gRPC port to use for the probe (the format is either port or port:service).

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION

Show more

string

If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED

Show more

boolean

false

The amount of time to wait before starting to probe.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY

Show more

Duration 

5S

The period in which the action should be called.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD

Show more

Duration 

10S

The amount of time to wait for each action.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT

Show more

Duration 

10S

The success threshold to use.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD

Show more

int

1

The failure threshold to use.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD

Show more

int

3

The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT

Show more

int

The port name for selecting the port of the HTTP get action.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME

Show more

string

The http path to use for the probe. For this to work, the container port also needs to be set.

Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH

Show more

string

The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME

Show more

string

The command to use for the probe.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION

Show more

string

The tcp socket to use for the probe (the format is host:port).

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION

Show more

string

The gRPC port to use for the probe (the format is either port or port:service).

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION

Show more

string

If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED

Show more

boolean

false

The amount of time to wait before starting to probe.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY

Show more

Duration 

5S

The period in which the action should be called.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD

Show more

Duration 

10S

The amount of time to wait for each action.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT

Show more

Duration 

10S

The success threshold to use.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD

Show more

int

1

The failure threshold to use.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD

Show more

int

3

The name of the volumeName to mount.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME

Show more

string

The path to mount.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH

Show more

string

Path within the volumeName from which the container’s volumeName should be mounted.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH

Show more

string

ReadOnly.

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY

Show more

boolean

false

CPU Requirements

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU

Show more

string

Memory Requirements

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY

Show more

string

CPU Requirements

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU

Show more

string

Memory Requirements

Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY

Show more

string

The optional list of Secret names to load environment variables from.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_SECRETS

Show more

list of string

The optional list of ConfigMap names to load environment variables from.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_CONFIGMAPS

Show more

list of string

The map associating environment variable names to their associated field references they take their value from.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_

Show more

Map<String,String>

The environment variable value

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_VARS__VARS_

Show more

string

The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_SECRET

Show more

string

The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP

Show more

string

The key identifying the field from which the value is extracted.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__WITH_KEY

Show more

string

required

The optional prefix to use when adding the environment variable to the container.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET

Show more

string

The optional prefix to use when adding the environment variable to the container.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP

Show more

string

The container image.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE

Show more

string

Working directory.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__WORKING_DIR

Show more

string

The commands

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__COMMAND

Show more

list of string

The arguments

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ARGUMENTS

Show more

list of string

The service account.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__SERVICE_ACCOUNT

Show more

string

The host under which the application is going to be exposed.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__HOST

Show more

string

The port number. Refers to the container port.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__CONTAINER_PORT

Show more

int

The host port.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__HOST_PORT

Show more

int

The application path (refers to web application path).

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PATH

Show more

string

/

The protocol.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PROTOCOL

Show more

tcp, udp, sctp, http, proxy

tcp

The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__NODE_PORT

Show more

int

If enabled, the port will be configured to use the schema HTTPS.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__TLS

Show more

boolean

false

Image pull policy.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_POLICY

Show more

always, if-not-present, never

always

The image pull secret

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_SECRETS

Show more

list of string

The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT

Show more

int

The port name for selecting the port of the HTTP get action.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME

Show more

string

The http path to use for the probe. For this to work, the container port also needs to be set.

Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PATH

Show more

string

The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_SCHEME

Show more

string

The command to use for the probe.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_EXEC_ACTION

Show more

string

The tcp socket to use for the probe (the format is host:port).

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TCP_SOCKET_ACTION

Show more

string

The gRPC port to use for the probe (the format is either port or port:service).

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION

Show more

string

If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION_ENABLED

Show more

boolean

false

The amount of time to wait before starting to probe.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY

Show more

Duration 

5S

The period in which the action should be called.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD

Show more

Duration 

10S

The amount of time to wait for each action.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT

Show more

Duration 

10S

The success threshold to use.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_SUCCESS_THRESHOLD

Show more

int

1

The failure threshold to use.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_FAILURE_THRESHOLD

Show more

int

3

The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT

Show more

int

The port name for selecting the port of the HTTP get action.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT_NAME

Show more

string

The http path to use for the probe. For this to work, the container port also needs to be set.

Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PATH

Show more

string

The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_SCHEME

Show more

string

The command to use for the probe.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_EXEC_ACTION

Show more

string

The tcp socket to use for the probe (the format is host:port).

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TCP_SOCKET_ACTION

Show more

string

The gRPC port to use for the probe (the format is either port or port:service).

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION

Show more

string

If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION_ENABLED

Show more

boolean

false

The amount of time to wait before starting to probe.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY

Show more

Duration 

5S

The period in which the action should be called.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD

Show more

Duration 

10S

The amount of time to wait for each action.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT

Show more

Duration 

10S

The success threshold to use.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_SUCCESS_THRESHOLD

Show more

int

1

The failure threshold to use.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_FAILURE_THRESHOLD

Show more

int

3

The name of the volumeName to mount.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__NAME

Show more

string

The path to mount.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__PATH

Show more

string

Path within the volumeName from which the container’s volumeName should be mounted.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__SUB_PATH

Show more

string

ReadOnly.

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__READ_ONLY

Show more

boolean

false

CPU Requirements

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_CPU

Show more

string

Memory Requirements

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_MEMORY

Show more

string

CPU Requirements

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_CPU

Show more

string

Memory Requirements

Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_MEMORY

Show more

string

The ip address.

Environment variable: QUARKUS_OPENSHIFT_HOSTALIASES__HOST_ALIASES__IP

Show more

string

The hostnames to resolve to the ip.

Environment variable: QUARKUS_OPENSHIFT_HOSTALIASES__HOST_ALIASES__HOSTNAMES

Show more

list of string

The key of the nodeSelector.

Environment variable: QUARKUS_OPENSHIFT_NODE_SELECTOR_KEY

Show more

string

required

The value of the nodeSelector.

Environment variable: QUARKUS_OPENSHIFT_NODE_SELECTOR_VALUE

Show more

string

required

CPU Requirements

Environment variable: QUARKUS_OPENSHIFT_RESOURCES_LIMITS_CPU

Show more

string

Memory Requirements

Environment variable: QUARKUS_OPENSHIFT_RESOURCES_LIMITS_MEMORY

Show more

string

CPU Requirements

Environment variable: QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_CPU

Show more

string

Memory Requirements

Environment variable: QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_MEMORY

Show more

string

If set, the secret will mounted to the application container and its contents will be used for application configuration.

Environment variable: QUARKUS_OPENSHIFT_APP_SECRET

Show more

string

If set, the config map will be mounted to the application container and its contents will be used for application configuration.

Environment variable: QUARKUS_OPENSHIFT_APP_CONFIG_MAP

Show more

string

The name of the role.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAME

Show more

string

The namespace of the role.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAMESPACE

Show more

string

Labels to add into the Role resource.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_

Show more

Map<String,String>

API groups of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS

Show more

list of string

Non resource URLs of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS

Show more

list of string

Resource names of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES

Show more

list of string

Resources of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES

Show more

list of string

Verbs of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS

Show more

list of string

The name of the cluster role.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME

Show more

string

Labels to add into the ClusterRole resource.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_

Show more

Map<String,String>

API groups of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS

Show more

list of string

Non resource URLs of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS

Show more

list of string

Resource names of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES

Show more

list of string

Resources of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES

Show more

list of string

Verbs of the policy rule.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS

Show more

list of string

The name of the service account.

Environment variable: QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME

Show more

string

The namespace of the service account.

Environment variable: QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE

Show more

string

Labels of the service account.

Environment variable: QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_

Show more

Map<String,String>

If true, this service account will be used in the generated Deployment resource.

Environment variable: QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT

Show more

boolean

Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME

Show more

string

Labels to add into the RoleBinding resource.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_

Show more

Map<String,String>

The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it’s "view" role name.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME

Show more

string

If the Role sets in the role-name property is cluster wide or not.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE

Show more

boolean

The "name" resource to use by the Subject element in the generated Role Binding resource.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME

Show more

string

The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND

Show more

string

ServiceAccount

The "apiGroup" resource that matches with the "kind" property. By default, it’s empty.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP

Show more

string

The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources.

Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE

Show more

string

Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME

Show more

string

Labels to add into the RoleBinding resource.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_

Show more

Map<String,String>

The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME

Show more

string

required

The "name" resource to use by the Subject element in the generated Role Binding resource.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME

Show more

string

The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND

Show more

string

ServiceAccount

The "apiGroup" resource that matches with the "kind" property. By default, it’s empty.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP

Show more

string

The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources.

Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE

Show more

string

The SELinux level label that applies to the container.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL

Show more

string

The SELinux role label that applies to the container.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE

Show more

string

The SELinux type label that applies to the container.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE

Show more

string

The SELinux user label that applies to the container.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER

Show more

string

The name of the GMSA credential spec to use.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME

Show more

string

GMSACredentialSpec is where the GMSA admission webhook (windows-gsma) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC

Show more

string

The UserName in Windows to run the entrypoint of the container process.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME

Show more

string

HostProcess determines if a container should be run as a 'Host Process' container.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS

Show more

boolean

The UID to run the entrypoint of the container process.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_USER

Show more

long

The GID to run the entrypoint of the container process.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_GROUP

Show more

long

Indicates that the container must run as a non-root user.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_NON_ROOT

Show more

boolean

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS

Show more

list of long

A special supplemental group that applies to all containers in a pod.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP

Show more

long

Sysctls hold a list of namespaced sysctls used for the pod.

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_

Show more

Map<String,String>

It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always

Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY

Show more

on-root-mismatchIt indicates that volume’s ownership and permissions will be changed only when permission and ownership of root directory does not match with expected permissions on the volume., alwaysIt indicates that volume’s ownership and permissions should always be changed whenever volume is mounted inside a Pod. This the default behavior.

Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility.

Environment variable: QUARKUS_OPENSHIFT_IDEMPOTENT

Show more

boolean

false

Whether the vcs-uri annotation should be added to the generated configuration.

Environment variable: QUARKUS_OPENSHIFT_VCS_URI_ENABLED

Show more

boolean

true

Optional override of the vcs-uri annotation.

Environment variable: QUARKUS_OPENSHIFT_VCS_URI_OVERRIDE

Show more

string

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.

Environment variable: QUARKUS_OPENSHIFT_FLAVOR

Show more

v3, v4

v4

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.

Environment variable: QUARKUS_OPENSHIFT_DEPLOYMENT_KIND

Show more

deployment, deployment-config, stateful-set, job, cron-job, knative-service

The number of desired pods

Environment variable: QUARKUS_OPENSHIFT_REPLICAS

Show more

int

1

The nodePort to set when serviceType is set to nodePort

Environment variable: QUARKUS_OPENSHIFT_NODE_PORT

Show more

int

If true, the service will be exposed

Environment variable: QUARKUS_OPENSHIFT_ROUTE_EXPOSE

Show more

boolean

false

The host under which the application is going to be exposed

Environment variable: QUARKUS_OPENSHIFT_ROUTE_HOST

Show more

string

The target named port. If not provided, it will be deducted from the Service resource ports. Options are: "http" and "https".

Environment variable: QUARKUS_OPENSHIFT_ROUTE_TARGET_PORT

Show more

string

http

Custom annotations to add to exposition (route or ingress) resources

Environment variable: QUARKUS_OPENSHIFT_ROUTE_ANNOTATIONS__ANNOTATION_NAME_

Show more

Map<String,String>

Custom labels to add to exposition (route or ingress) resources

Environment variable: QUARKUS_OPENSHIFT_ROUTE_LABELS__LABEL_NAME_

Show more

Map<String,String>

The cert authority certificate contents.

Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_CA_CERTIFICATE

Show more

string

The certificate contents.

Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_CERTIFICATE

Show more

string

The contents of the ca certificate of the final destination.

Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_DESTINATION_CA_CERTIFICATE

Show more

string

The desired behavior for insecure connections to a route.

Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_INSECURE_EDGE_TERMINATION_POLICY

Show more

string

The key file contents.

Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_KEY

Show more

string

The termination type.

Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_TERMINATION

Show more

string

Specifies the maximum desired number of pods the job should run at any given time.

Environment variable: QUARKUS_OPENSHIFT_JOB_PARALLELISM

Show more

int

Specifies the desired number of successfully finished pods the job should be run with.

Environment variable: QUARKUS_OPENSHIFT_JOB_COMPLETIONS

Show more

int

CompletionMode specifies how Pod completions are tracked.

Environment variable: QUARKUS_OPENSHIFT_JOB_COMPLETION_MODE

Show more

non-indexed, indexed

non-indexed

Specifies the number of retries before marking this job failed.

Environment variable: QUARKUS_OPENSHIFT_JOB_BACKOFF_LIMIT

Show more

int

Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer.

Environment variable: QUARKUS_OPENSHIFT_JOB_ACTIVE_DEADLINE_SECONDS

Show more

long

Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted.

Environment variable: QUARKUS_OPENSHIFT_JOB_TTL_SECONDS_AFTER_FINISHED

Show more

int

Suspend specifies whether the Job controller should create Pods or not.

Environment variable: QUARKUS_OPENSHIFT_JOB_SUSPEND

Show more

boolean

false

Restart policy when the job container fails.

Environment variable: QUARKUS_OPENSHIFT_JOB_RESTART_POLICY

Show more

on-failure, never

on-failure

The schedule in Cron format, see Cron.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_SCHEDULE

Show more

string

ConcurrencyPolicy describes how the job will be handled.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_CONCURRENCY_POLICY

Show more

allow, forbid, replace

allow

Deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_STARTING_DEADLINE_SECONDS

Show more

long

The number of failed finished jobs to retain. The default value is 1.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_FAILED_JOBS_HISTORY_LIMIT

Show more

int

The number of successful finished jobs to retain. The default value is 3.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_SUCCESSFUL_JOBS_HISTORY_LIMIT

Show more

int

Specifies the maximum desired number of pods the job should run at any given time.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_PARALLELISM

Show more

int

Specifies the desired number of successfully finished pods the job should be run with.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_COMPLETIONS

Show more

int

CompletionMode specifies how Pod completions are tracked.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_COMPLETION_MODE

Show more

non-indexed, indexed

non-indexed

Specifies the number of retries before marking this job failed.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_BACKOFF_LIMIT

Show more

int

Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_ACTIVE_DEADLINE_SECONDS

Show more

long

Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_TTL_SECONDS_AFTER_FINISHED

Show more

int

Suspend specifies whether the Job controller should create Pods or not.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_SUSPEND

Show more

boolean

false

Restart policy when the job container fails.

Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_RESTART_POLICY

Show more

on-failure, never

on-failure

If true, the debug mode in pods will be enabled.

Environment variable: QUARKUS_OPENSHIFT_REMOTE_DEBUG_ENABLED

Show more

boolean

false

The transport to use.

Environment variable: QUARKUS_OPENSHIFT_REMOTE_DEBUG_TRANSPORT

Show more

string

dt_socket

If enabled, it means the JVM will wait for the debugger to attach before executing the main class. If false, the JVM will immediately execute the main class, while listening for the debugger connection.

Environment variable: QUARKUS_OPENSHIFT_REMOTE_DEBUG_SUSPEND

Show more

string

n

It specifies the address at which the debug socket will listen.

Environment variable: QUARKUS_OPENSHIFT_REMOTE_DEBUG_ADDRESS_PORT

Show more

int

5005

If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.

Environment variable: QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__ENABLED

Show more

boolean

true

The init task image to use by the init-container.

Environment variable: QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE

Show more

string

groundnuty/k8s-wait-for:no-root-v1.7

If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.

Environment variable: QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_ENABLED

Show more

boolean

true

The init task image to use by the init-container.

Environment variable: QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE

Show more

string

groundnuty/k8s-wait-for:no-root-v1.7

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

Environment variable: QUARKUS_OPENSHIFT_DEPLOY

Show more

boolean

false

If deploy is enabled, it will follow this strategy to update the resources to the target Kubernetes cluster.

Environment variable: QUARKUS_OPENSHIFT_DEPLOY_STRATEGY

Show more

create-or-update, create, replace, server-side-apply

create-or-update

About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

You can also use a simplified format, starting with a number:

  • If the value is only a number, it represents time in seconds.

  • If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

  • If the value is a number followed by h, m, or s, it is prefixed with PT.

  • If the value is a number followed by d, it is prefixed with P.

Related content