Artifact versions
The Vantage 3.0 self-hosted installer is driven by a single Kubernetes custom resource: a
Vantage object in the vantage.abbyy.com/v1alpha1 API group. The fields below are the full contract between you and the operator.
For a conceptual overview of how the operator consumes this resource, see Architecture. For an installation procedure, choose Azure or Self-Managed Kubernetes.
API group
Vantage
Vantage is the Schema for the vantages APIspec validation: !self.reportingEnabled || !has(self.databaseProvider) || self.databaseProvider == 'SqlServer': reportingEnabled requires databaseProvider ‘SqlServer’; reporting is a SQL Server-only feature and cannot be used with PostgreSQLVantage.spec
spec defines the desired state of Vantagesecrets validation: has(self.kubernetes) != has(self.azure): exactly one provider must be specifiedupdatePolicy validation: !has(self.auto): automatic updates are not yet supportedupdatePolicy validation: (has(self.auto) ? 1 : 0) + (has(self.manual) ? 1 : 0) == 1: exactly one update policy must be specifiedociMigration validation: !has(self.enabled) || self.enabled == false || has(self.destination): destination is required when ociMigration is enabledstorage validation: !has(self.s3): s3 storage is not yet supportedstorage validation: (has(self.azure) ? 1 : 0) + (has(self.s3) ? 1 : 0) + (has(self.custom) ? 1 : 0) <= 1: at most one storage provider can be specifiedVantage.spec.secrets
secrets selects and configures the secrets provider. Exactly one provider must be specified.Vantage.spec.secrets.azure
azure configures Azure Key Vault (via the Secrets Store CSI Driver) as the secrets source.Vantage.spec.secrets.azure.objects[key]
AzureSecretObjectConfig describes a single Key Vault object that backs a secret alias.Vantage.spec.secrets.kubernetes
kubernetes configures Kubernetes native Secrets as the secrets source.Vantage.spec.secrets.kubernetes.objects[key]
Vantage.spec.updatePolicy
updatePolicy controls how the operator handles Vantage upgrades.
Not yet supported. The operator rejects a resource that sets these fields.
Vantage.spec.updatePolicy.auto
auto enables automatic version upgrades. Not yet implemented.Vantage.spec.workloads
workloads configures the ConfigMap containing data about charts and imagesVantage.spec.workloads.pods
pods configures metadata added to the pods of workloads.Vantage.spec.workloads.pods.charts[key]
ChartPodsConfig defines metadata added to the pods of workloads within a single Vantage Helm chart.Vantage.spec.workloads.pods.charts[key].deployment
deployment configures the pods of the chart’s deployment.Vantage.spec.workloads.pods.charts[key].migrator
migrator configures the pods of the chart’s migrator job.Vantage.spec.workloads.pods.charts[key].statefulSet
statefulSet configures the pods of the chart’s statefulset.Vantage.spec.workloads.serviceAccounts
serviceAccounts overrides spec.serviceAccountName for specific workloads.Vantage.spec.workloads.serviceAccounts.charts[key]
ChartServiceAccountsConfig defines configuration for service accounts for workloads within a single Vantage Helm chart.Vantage.spec.workloads.serviceAccounts.charts[key].deployment
deployment configures the service account used by the chart’s deployment.Vantage.spec.workloads.serviceAccounts.charts[key].migrator
migrator configures the service account used by the chart’s migrator job.Vantage.spec.workloads.serviceAccounts.charts[key].statefulSet
statefulSet configures the service account used by the chart’s statefulset.Vantage.spec.argocd
argocd configures the Argo CD resources the operator creates to install Vantage workloads. Omit it to install into the “default” project.Vantage.spec.keda
keda configures KEDA settings. If not specified, KEDA support will be disabled.Vantage.spec.ociMigration
ociMigration configures copying artifacts from a source registry to a destintion before install. Omit entirely or set enabled=false to skip migration. When enabled, destination is required.destination validation: !self.host.contains('/'): host must not contain a path — use the repository field for the registry pathdestination validation: !self.host.contains('://'): host must not include a scheme (e.g., https://)resources validation: !has(self.claims) || size(self.claims) == 0: resources.claims is not supported by the OCI migration jobVantage.spec.ociMigration.destination
destination is where artifacts are copied to.Vantage.spec.ociMigration.destination.credentialsRef
credentialsRef references a Secret containing username and password keys or a kubernetes.io/dockerconfigjson-type Secret. Takes precedence over username/password if specified.Vantage.spec.ociMigration.destination.workloadIdentity
workloadIdentity defines settings for using the identity of the workload (Kubernetes service account) to access the registry.Vantage.spec.ociMigration.imagePullSecrets[index]
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.Vantage.spec.ociMigration.resources
resources are the compute resources of the OCI migration job’s container. The default leaves CPU unlimited so the copy can burst; set a CPU limit on clusters whose policies require one on every container. Only requests and limits are honoured: the job declares no pod-level resourceClaims, so claims are rejected.
Not yet supported. The operator rejects a resource that sets these fields.
Vantage.spec.ociMigration.resources.claims[index]
ResourceClaim references one entry in PodSpec.ResourceClaims.Vantage.spec.ociMigration.sources[index]
ContainerRegistryConfig defines container registry connection settings.Vantage.spec.ociMigration.sources[index].credentialsRef
credentialsRef references a Secret containing username and password keys or a kubernetes.io/dockerconfigjson-type Secret. Takes precedence over username/password if specified.Vantage.spec.ociMigration.sources[index].workloadIdentity
workloadIdentity defines settings for using the identity of the workload (Kubernetes service account) to access the registry.Vantage.spec.smtp
smtp configures the SMTP mail server. If not specified, Sendgrid will be used as mail provider.Vantage.spec.storage
storage configures advanced storage options.
Not yet supported. The operator rejects a resource that sets these fields.
