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

Configuration property

Type

Default

Enabled the generation of Helm files.

Environment variable: QUARKUS_HELM_ENABLED

boolean

true

Name of the Helm chart. If not set, it will use the application name.

Environment variable: QUARKUS_HELM_NAME

string

Project’s home page of the Helm chart. It must be a URL.

Environment variable: QUARKUS_HELM_HOME

string

The Helm chart list of URLs to source code for this project.

Environment variable: QUARKUS_HELM_SOURCES

list of string

Version of the Helm chart. If not set, it will use the application version.

Environment variable: QUARKUS_HELM_VERSION

string

The Helm chart single-sentence description.

Environment variable: QUARKUS_HELM_DESCRIPTION

string

List of keywords to add to the chart.

Environment variable: QUARKUS_HELM_KEYWORDS

list of string

Icon of the Helm chart. It must be a URL to an SVG or PNG image.

Environment variable: QUARKUS_HELM_ICON

string

The Chart API version. The default value is v2.

Environment variable: QUARKUS_HELM_API_VERSION

string

v2

The condition to enable this chart.

Environment variable: QUARKUS_HELM_CONDITION

string

Tags of this chart.

Environment variable: QUARKUS_HELM_TAGS

string

The version of the application enclosed of this chart.

Environment variable: QUARKUS_HELM_APP_VERSION

string

Whether this chart is deprecated.

Environment variable: QUARKUS_HELM_DEPRECATED

boolean

KubeVersion is a SemVer constraint specifying the version of Kubernetes required.

Environment variable: QUARKUS_HELM_KUBE_VERSION

string

Specifies the chart type: application or library.

Environment variable: QUARKUS_HELM_TYPE

string

Alias of the root element in the generated values file.

Environment variable: QUARKUS_HELM_VALUES_ROOT_ALIAS

string

app

Notes template to be generated.

Environment variable: QUARKUS_HELM_NOTES

string

/NOTES.template.txt

Extension of the Helm tarball file. Default is tar.gz.

Environment variable: QUARKUS_HELM_EXTENSION

string

tar.gz

Classifier to be appended into the generated Helm tarball file.

Environment variable: QUARKUS_HELM_TAR_FILE_CLASSIFIER

string

If Helm tar file is generated.

Environment variable: QUARKUS_HELM_CREATE_TAR_FILE

boolean

false

Whether to generate the values.schema.json file that is used to validate the Helm Chart input values.

Environment variable: QUARKUS_HELM_CREATE_VALUES_SCHEMA_FILE

boolean

true

Whether to generate the README.md file that includes the Chart description and table with the configurable parameters and their default values.

Environment variable: QUARKUS_HELM_CREATE_README_FILE

boolean

true

The input folder in which to place the user-defined Helm files. These files will be used as inputs to populate the generated Helm files. At the moment, the supported Helm files are: README.md, LICENSE, values.schema.json, app-readme.md or app-README.md, questions.yml or questions.yaml, the "crds" directory, and requirements.yml or requirements.yaml. Moreover, you can provide a custom values.yaml or Chart.yaml and the content will be merged with the auto-generated configuration. It also supports absolute paths. By default, it will use the folder "src/main/helm".

Environment variable: QUARKUS_HELM_INPUT_DIRECTORY

string

src/main/helm

The output folder in which to place the Helm generated folder. The folder is relative to the target output directory in Quarkus that is also configurable using the property quarkus.package.output-directory. It also supports absolute paths. By default, it will be generated in the folder named "helm".

Environment variable: QUARKUS_HELM_OUTPUT_DIRECTORY

string

helm

If true, it will perform the upload to a Helm repository.

Environment variable: QUARKUS_HELM_REPOSITORY_PUSH

boolean

false

The deployment target to push. Options are: kubernetes, openshift, knative…​

Environment variable: QUARKUS_HELM_REPOSITORY_DEPLOYMENT_TARGET

string

${quarkus.kubernetes.deployment-target}

The Helm repository type. Options are: CHARTMUSEUM, ARTIFACTORY, and NEXUS.

Environment variable: QUARKUS_HELM_REPOSITORY_TYPE

chartmuseum, artifactory, nexus

The Helm repository URL.

Environment variable: QUARKUS_HELM_REPOSITORY_URL

string

The Helm repository username.

Environment variable: QUARKUS_HELM_REPOSITORY_USERNAME

string

The Helm repository password.

Environment variable: QUARKUS_HELM_REPOSITORY_PASSWORD

string

If enabled, the extension will check whether there are properties using system properties in the form of ${XXX} and if so, it will expose these properties as env-var values within the generated container resource.

Environment variable: QUARKUS_HELM_MAP_SYSTEM_PROPERTIES

boolean

true

If true, the naming validation will be disabled. The naming validation rejects property names that contain "-" characters.

Environment variable: QUARKUS_HELM_DISABLE_NAMING_VALIDATION

boolean

false

Configuration for the separator string in the filename of profile specific values files i.e. values.profile.yaml, defaults to "."

Environment variable: QUARKUS_HELM_VALUES_PROFILE_SEPARATOR

string

.

Title of the values schema json file.

Environment variable: QUARKUS_HELM_VALUES_SCHEMA_TITLE

string

Values

Name of the maintainer.

Environment variable: QUARKUS_HELM_MAINTAINERS__MAINTAINERS__NAME

string

Email of the maintainer.

Environment variable: QUARKUS_HELM_MAINTAINERS__MAINTAINERS__EMAIL

string

URL profile of the maintainer.

Environment variable: QUARKUS_HELM_MAINTAINERS__MAINTAINERS__URL

string

Annotations are additional mappings uninterpreted by Helm, made available for inspection by other applications.

Environment variable: QUARKUS_HELM_ANNOTATIONS

Map<String,String>

Name of the dependency.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__NAME

string

Version of the dependency.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__VERSION

string

required

Repository of the dependency.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__REPOSITORY

string

required

Dependency condition. If the property starts with @., then the property won’t be added under the root element in the generated values.yaml file.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__CONDITION

string

Dependency tags.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__TAGS

list of string

Whether this dependency should be loaded.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__ENABLED

boolean

Alias of the dependency.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__ALIAS

string

Instruct the application to wait for the service that should be installed as part of this Helm dependency. You can set only a service name or a combination of a service name plus the service port (service:port).

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__WAIT_FOR_SERVICE

string

If wait for service is set, it will use this image to configure the init-containers within the deployment resource.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__WAIT_FOR_SERVICE_IMAGE

string

busybox:1.34.1

If wait for service is set, it will use this command to run the init-containers within the deployment resource.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__WAIT_FOR_SERVICE_PORT_COMMAND_TEMPLATE

string

for i in $(seq 1 200); do nc -z -w3 ::service-name ::service-port && exit 0; done; exit 1

If wait for service is set, it will use this command to run the init-containers within the deployment resource.

Environment variable: QUARKUS_HELM_DEPENDENCIES__DEPENDENCIES__WAIT_FOR_SERVICE_ONLY_COMMAND_TEMPLATE

string

until nslookup ::service-name; do echo waiting for service; sleep 2; done

The name of the property that will be present in the Helm values file. If the property starts with @., then the property won’t be added under the root element in the generated values.yaml file.

Environment variable: QUARKUS_HELM_VALUES__VALUES__PROPERTY

string

A comma-separated list of YAMLPath expressions to map the Dekorate auto-generated properties to the final Helm values file.

Environment variable: QUARKUS_HELM_VALUES__VALUES__PATHS

list of string

The profile where this value reference will be mapped to. For example, if the profile is dev, then a values.dev.yml file will be created with the value.

Environment variable: QUARKUS_HELM_VALUES__VALUES__PROFILE

string

The value that the property will have in the Helm values file. If not set, the extension will resolve it from the generated artifacts.

Environment variable: QUARKUS_HELM_VALUES__VALUES__VALUE

string

The integer value that the property will have in the Helm values file. If not set, the extension will resolve it from the generated artifacts.

Environment variable: QUARKUS_HELM_VALUES__VALUES__VALUE_AS_INT

int

The boolean value that the property will have in the Helm values file. If not set, the extension will resolve it from the generated artifacts.

Environment variable: QUARKUS_HELM_VALUES__VALUES__VALUE_AS_BOOL

boolean

The map value that the property will have in the Helm values file. If not set, the extension will resolve it from the generated artifacts.

Environment variable: QUARKUS_HELM_VALUES__VALUES__VALUE_AS_MAP

Map<String,String>

A list separated by comma that the property will have in the Helm values file. If not set, the extension will resolve it from the generated artifacts.

Environment variable: QUARKUS_HELM_VALUES__VALUES__VALUE_AS_LIST

list of string

If not provided, it will use {{ .Values.. }}.

Environment variable: QUARKUS_HELM_VALUES__VALUES__EXPRESSION

string

Description of the property.

Environment variable: QUARKUS_HELM_VALUES__VALUES__DESCRIPTION

string

Minimum value allowed for this property.

Environment variable: QUARKUS_HELM_VALUES__VALUES__MINIMUM

int

Maximum value allowed for this property.

Environment variable: QUARKUS_HELM_VALUES__VALUES__MAXIMUM

int

Pattern to validate the value of this property.

Environment variable: QUARKUS_HELM_VALUES__VALUES__PATTERN

string

If true, then this property is mandatory.

Environment variable: QUARKUS_HELM_VALUES__VALUES__REQUIRED

boolean

false

The YAMLPath path where to include the template within the resource.

Environment variable: QUARKUS_HELM_EXPRESSIONS__EXPRESSIONS__PATH

string

required

The expression template to include.

Environment variable: QUARKUS_HELM_EXPRESSIONS__EXPRESSIONS__EXPRESSION

string

required

The property to use in the if statement. If the property starts with @., then the property won’t be added under the root element in the generated values.yaml file.

Environment variable: QUARKUS_HELM_ADD_IF_STATEMENT__ADD_IF_STATEMENT__PROPERTY

string

The resource kind where to include the if statement.

Environment variable: QUARKUS_HELM_ADD_IF_STATEMENT__ADD_IF_STATEMENT__ON_RESOURCE_KIND

string

The resource kind where to include the if statement.

Environment variable: QUARKUS_HELM_ADD_IF_STATEMENT__ADD_IF_STATEMENT__ON_RESOURCE_NAME

string

The default value of the property

Environment variable: QUARKUS_HELM_ADD_IF_STATEMENT__ADD_IF_STATEMENT__WITH_DEFAULT_VALUE

boolean

true

Provide custom description of the add-if-statement property.

Environment variable: QUARKUS_HELM_ADD_IF_STATEMENT__ADD_IF_STATEMENT__DESCRIPTION

string

Determine if the resource should be installed or not.

Name of the property to add or update. Example: app.replicas.

Environment variable: QUARKUS_HELM_VALUES_SCHEMA_PROPERTIES__PROPERTIES__NAME

string

Description of the property.

Environment variable: QUARKUS_HELM_VALUES_SCHEMA_PROPERTIES__PROPERTIES__DESCRIPTION

string

Type of the property.

Environment variable: QUARKUS_HELM_VALUES_SCHEMA_PROPERTIES__PROPERTIES__TYPE

string

string

Minimum value allowed for this property.

Environment variable: QUARKUS_HELM_VALUES_SCHEMA_PROPERTIES__PROPERTIES__MINIMUM

int

Maximum value allowed for this property.

Environment variable: QUARKUS_HELM_VALUES_SCHEMA_PROPERTIES__PROPERTIES__MAXIMUM

int

Pattern to validate the value of this property.

Environment variable: QUARKUS_HELM_VALUES_SCHEMA_PROPERTIES__PROPERTIES__PATTERN

string

If true, then this property is mandatory.

Environment variable: QUARKUS_HELM_VALUES_SCHEMA_PROPERTIES__PROPERTIES__REQUIRED

boolean

false