Skip to main content
Additional workloads metadata lets you pass your own Helm value overrides to individual Vantage workload charts. Use it when a specific deployment needs tuning that the Vantage custom resource does not expose, such as a fixed replica count for a single service.
This is an advanced feature intended as a last resort. Overrides target the internal values of individual Vantage component charts, which can change between Vantage versions without notice. Review your overrides on every upgrade, and prefer the supported Vantage.spec fields and KEDA autoscaling wherever they cover your need.

​
How it works

The vantage-selfhosted chart ships a workloads ConfigMap that tells the operator which charts to install and how. By default the chart adds an additional-metadata.yml key to that ConfigMap and populates it from the workloadsConfigMap.additionalMetadata chart value. The operator deep-merges this content with the rendered workloads metadata before installing each component chart. The key name is controlled by vantage.workloads.additionalMetadataKey (Vantage.spec.workloads.additionalMetadataKey). Leave it at the default unless you have a reason to rename it. See the Helm chart reference and API reference for the field contract. The schema for overrides follows the workloads metadata template stored under the workloads-metadata.yml.gotmpl key in the same ConfigMap. The chart names this ConfigMap <vantage.workloads.configMap>-<chart version>, for example vantage-workloads-3.0.0. Inspect that key to see which charts and value paths are available in your installed version.

​
Example: fix the replica count for one service

To override the deployment replica count for the mail-helm chart, pass the following values when installing or upgrading the vantage-selfhosted chart:
Add further charts under charts, each with its own values block.

​
Caveats

  • Template values win. Your additionalMetadata is deep-merged with the rendered workloads-metadata.yml.gotmpl content, and the template takes precedence on any conflict. You can add or change values the template does not set, but you cannot override values it does.
  • order is ignored. Defining an order key in additionalMetadata has no effect on the install order of charts.
  • No install-time validation. An additionalMetadata value with an invalid schema is not rejected when the chart is installed. The failure is surfaced only in the Vantage resource’s status. Check the resource conditions after applying changes; see Lifecycle.
  • Changes need a reprocess. Editing additionalMetadata without also changing the Vantage resource does not trigger the operator to apply the change. Annotate the Vantage resource with vantage.abbyy.com/reprocess to force a sync, as described in Lifecycle.

​
What’s next

Helm chart reference

All vantage-selfhosted values, including workloadsConfigMap.additionalMetadata.

Autoscaling with KEDA

The supported way to scale Vantage workloads with demand.