Référence de l’API : 2026.06 - ABBYY Documentation

Versions des artefacts

Artefact	Version
Chart `vantage-operator`	`0.1.0`
Chart `vantage-selfhosted`	`0.1.0`

Le programme d’installation de Vantage 3.0 auto-hébergé repose sur une unique ressource personnalisée Kubernetes : un objet Vantage du groupe d’API vantage.abbyy.com/v1alpha1. Les champs décrits ci-dessous constituent l’intégralité du contrat entre vous et l’operator. Pour une vue d’ensemble conceptuelle de la manière dont l’operator exploite cette ressource, voir Architecture. Pour la procédure d’installation, choisissez Azure ou Kubernetes autogéré.

Groupe d’API

Group	Version	Ressource
`vantage.abbyy.com`	`v1alpha1`	`Vantage`

Vantage

Vantage est le schéma de l’API vantages

Champ	Type	Obligatoire	Description
`apiVersion`	`string`	Oui	vantage.abbyy.com/v1alpha1
`kind`	`string`	Oui	Vantage
`metadata`	`object`	Oui	Consultez la documentation de l’API Kubernetes pour connaître les champs de `metadata`.
`spec`	`object`	Oui	spec définit l’état souhaité de Vantage. Voir `spec`.
`status`	`object`	Non	status définit l’état observé de Vantage. Voir `status`.

Vantage.spec

spec définit l’état souhaité de Vantage

Champ	Type	Obligatoire	Description
`dnsRecord`	`string`	Oui	dnsRecord est l’enregistrement DNS de l’installation Vantage. Format : `hostname`.
`mailFrom`	`string`	Oui	mailFrom est l’adresse e-mail utilisée comme expéditeur des e-mails sortants. Format : `email`.
`platformAdminEmail`	`string`	Oui	platformAdminEmail est l’adresse e-mail de l’administrateur de la plateforme. Format : `email`.
`secrets`	`object`	Oui	secrets sélectionne et configure le fournisseur de secrets. Un seul et unique fournisseur doit être spécifié. Voir `secrets`.
`updatePolicy`	`object`	Oui	updatePolicy détermine la manière dont l’operator gère les mises à niveau de Vantage. Voir `updatePolicy`.
`vantageVersion`	`string`	Oui	vantageVersion est la version de Vantage à installer.
`workloads`	`object`	Oui	workloads configure le ConfigMap contenant les données relatives aux charts et aux images. Voir `workloads`.
`idReadingEnabled`	`boolean`	Non	idReadingEnabled active les fonctionnalités de lecture de documents d’identité. Par défaut : `false`.
`ociMigration`	`object`	Non	ociMigration configure la copie des artefacts d’un registre source vers un registre de destination avant l’installation. Omettez-le entièrement ou définissez enabled=false pour ignorer la migration. S’il est activé, destination est obligatoire. Voir `ociMigration`.
`reportingEnabled`	`boolean`	Non	reportingEnabled active les fonctionnalités de reporting SQL Server. Par défaut : `false`.
`serviceAccountName`	`string`	Non	serviceAccountName est le nom du compte de service à utiliser pour les charges de travail Vantage. Omettez-le pour utiliser le compte de service par défaut. Par défaut : `default` · Longueur minimale : `1`.
`smtp`	`object`	Non	smtp configure le serveur de messagerie SMTP. S’il n’est pas spécifié, Sendgrid est utilisé comme fournisseur de messagerie. Voir `smtp`.
`storage`	`object`	Non	storage configure les options de stockage avancées. Voir `storage`.
`techcore`	`object`	Non	techcore contient la configuration du moteur de traitement TechCore. Voir `techcore`.

Validation de secrets : has(self.kubernetes) != has(self.azure) : un seul et unique fournisseur doit être spécifié

Validation de updatePolicy : !has(self.auto) : les mises à jour automatiques ne sont pas encore prises en charge

Validation de updatePolicy : (has(self.auto) ? 1 : 0) + (has(self.manual) ? 1 : 0) == 1 : exactement une stratégie de mise à jour doit être spécifiée

Validation de ociMigration : !has(self.enabled) || self.enabled == false || has(self.destination) : la destination est obligatoire lorsque ociMigration est activé

Validation de techcore : !self.keepPreviousVersion || has(self.previousVersion) : previousVersion est obligatoire lorsque keepPreviousVersion a la valeur true

Vantage.spec.secrets

secrets sélectionne et configure le fournisseur de secrets. Un seul et unique fournisseur doit être spécifié.

Champ	Type	Obligatoire	Description
`azure`	`object`	Non	azure configure Azure Key Vault (via le pilote CSI Secrets Store) comme source des secrets. Voir `azure`.
`kubernetes`	`object`	Non	kubernetes configure les Secrets natifs de Kubernetes comme source des secrets. Voir `kubernetes`.

Vantage.spec.secrets.azure

azure configure Azure Key Vault (via le pilote CSI Secrets Store) comme source des secrets.

Champ	Type	Obligatoire	Description
`keyVaultName`	`string`	Oui	keyVaultName désigne l’instance Azure Key Vault qui contient les secrets.
`tenantId`	`string`	Oui	tenantId désigne le locataire Azure AD propriétaire du Key Vault.
`clientId`	`string`	Non	clientId est l’identifiant client Azure AD de l’identité managée attribuée par l’utilisateur qui dispose d’un accès en lecture au Key Vault. Obligatoire lorsque identityMode a pour valeur « workloadIdentity » (valeur par défaut).
`identityMode`	`enum`	Non	identityMode détermine la méthode d’authentification du pilote CSI auprès d’Azure. Par défaut : `workloadIdentity` · Enum : `workloadIdentity, podIdentity, vmManagedIdentity`.
`objects`	`map[string]object`	Non	objects permet, de manière facultative, de remplacer la mise en correspondance entre un alias de secret (tel que référencé dans workloads-secrets.yml) et un objet Key Vault spécifique. Lorsqu’un alias est absent de cette table de correspondance, l’alias lui-même sert de nom d’objet Key Vault et l’objet est récupéré avec le type « secret ». Voir `objects`.
`userAssignedIdentityID`	`string`	Non	userAssignedIdentityID est l’identifiant client de l’identité managée attribuée par l’utilisateur à utiliser lorsque identityMode a pour valeur « vmManagedIdentity ».

Vantage.spec.secrets.azure.objects[key]

AzureSecretObjectConfig décrit un objet Key Vault unique sur lequel repose un alias de secret.

Champ	Type	Obligatoire	Description
`objectName`	`string`	Oui	objectName est le nom de l’objet dans Azure Key Vault.
`objectType`	`enum`	Non	objectType est le type d’objet Key Vault. Valeur par défaut : « secret ». Par défaut : `secret` · Enum : `secret, key, cert`.
`objectVersion`	`string`	Non	objectVersion épingle une version spécifique de l’objet Key Vault. Par défaut, la dernière version est utilisée.

Vantage.spec.secrets.kubernetes

kubernetes configure les Secrets Kubernetes natifs comme source des secrets.

Champ	Type	Obligatoire	Description
`objects`	`map[string]object`	Non	objects définit les secrets Kubernetes utilisés. S’il n’est pas défini, les noms de secrets par défaut sont utilisés. Voir `objects`.

Vantage.spec.secrets.kubernetes.objects[key]

Champ	Type	Obligatoire	Description
`secretName`	`string`	Oui	secretName est le nom du Secret Kubernetes

Vantage.spec.updatePolicy

updatePolicy détermine la manière dont l’operator gère les mises à niveau de Vantage.

Champ	Type	Obligatoire	Description
`manual`	`object`	Non	manual désactive les mises à niveau automatiques. Les mises à niveau s’effectuent en installant une nouvelle version du chart Helm de l’operator.

Pas encore pris en charge. L’operator rejette toute ressource qui définit ces champs.

Champ	Type	Obligatoire	Description
`auto`	`object`	Non	auto active les mises à niveau automatiques de version. Pas encore implémenté. Voir `auto`.

Vantage.spec.updatePolicy.auto

auto active les mises à niveau automatiques de version. Pas encore implémenté.

Champ	Type	Obligatoire	Description
`releaseURL`	`string`	Oui	releaseURL est l’URL à partir de laquelle récupérer le bundle de la version Vantage. Format : `uri`.

Vantage.spec.workloads

workloads configure la ConfigMap contenant les données relatives aux charts et aux images

Champ	Type	Obligatoire	Description
`configMap`	`string`	Oui	configMap est le nom de la ConfigMap contenant les données des charges de travail
`metadataTemplateKey`	`string`	Oui	metadataTemplateKey est la clé de la ConfigMap contenant le modèle de métadonnées pour l’installation des charts
`secretsKey`	`string`	Oui	secrets est la clé de la ConfigMap contenant les métadonnées des secrets.
`workloadsKey`	`string`	Oui	workloadsKey est la clé de la ConfigMap contenant la liste des charts et des images

Vantage.spec.ociMigration

ociMigration configure la copie des artefacts d’un registre source vers une destination avant l’installation. Omettez-le entièrement ou définissez enabled=false pour ignorer la migration. Lorsqu’il est activé, destination est obligatoire.

Champ	Type	Obligatoire	Description
`concurrency`	`integer`	Oui	concurrency est le nombre d’artefacts à copier en parallèle. Par défaut : `5` · Minimum : `1`.
`destination`	`object`	Non	destination est l’emplacement vers lequel les artefacts sont copiés. Voir `destination`.
`enabled`	`boolean`	Non	enabled active la migration OCI. Par défaut : `true`.
`imagePullSecrets`	`[]object`	Non	imagePullSecrets est une liste facultative de références à des secrets du même espace de noms, utilisés pour récupérer l’image de l’operator qui exécute le job de migration OCI dans cet espace de noms. Voir `imagePullSecrets`.
`labels`	`map[string]JSON`	Non	labels est l’ensemble des étiquettes à appliquer au job de migration OCI et au modèle de pod. Les valeurs qui ne sont pas de type string seront converties en string avec [fmt.Sprint]
`serviceAccountName`	`string`	Non	serviceAccountName est le nom du ServiceAccount à utiliser pour exécuter le job de migration OCI.
`sources`	`[]object`	Non	sources contient les identifiants permettant d’accéder aux registres depuis lesquels les artefacts sont copiés (par exemple, JFrog). (Longueur maximale : 20) Nombre maximal d’éléments : `20`. Voir `sources`.

Validation de destination : !self.host.contains('/') : host ne doit pas contenir de chemin — utilisez le champ repository pour indiquer le chemin du registre

Validation de destination : !self.host.contains('://') : host ne doit pas inclure de schéma (par exemple, https://)

Vantage.spec.ociMigration.destination

destination est l’emplacement vers lequel les artefacts sont copiés.

Champ	Type	Obligatoire	Description
`host`	`string`	Oui	host est le nom d’hôte du registre, suivi éventuellement d’un port (par ex. registry.example.com, registry.example.com:5000). Longueur minimale : `1`.
`credentialsRef`	`object`	Non	credentialsRef fait référence à un Secret contenant des clés de nom d’utilisateur et de mot de passe, ou à un Secret de type kubernetes.io/dockerconfigjson. Lorsqu’il est spécifié, il est prioritaire sur username/password. Voir `credentialsRef`.
`password`	`string`	Non	Mot de passe pour l’authentification auprès du registre (en texte clair ; utilisez credentialsRef en production)
`repository`	`string`	Non	repository est le chemin ou l’espace de noms du registre pour les artefacts (par ex. « abbyy-docker », « vantage/images »). Motif : `^[a-z0-9]+([._-][a-z0-9]+)(/[a-z0-9]+([._-][a-z0-9]+))*$`.
`username`	`string`	Non	Nom d’utilisateur pour l’authentification auprès du registre (en texte clair ; utilisez credentialsRef en production)
`workloadIdentity`	`object`	Non	workloadIdentity définit les paramètres permettant d’utiliser l’identité de la charge de travail (compte de service Kubernetes) pour accéder au registre. Voir `workloadIdentity`.

Vantage.spec.ociMigration.destination.credentialsRef

credentialsRef fait référence à un Secret contenant des clés de nom d’utilisateur et de mot de passe, ou à un Secret de type kubernetes.io/dockerconfigjson. S’il est spécifié, il est prioritaire sur username/password.

Champ	Type	Obligatoire	Description
`name`	`string`	Oui	name est le nom du Secret

Vantage.spec.ociMigration.destination.workloadIdentity

workloadIdentity définit les paramètres permettant d’utiliser l’identité de la charge de travail (compte de service Kubernetes) pour accéder au registre.

Champ	Type	Obligatoire	Description
`audience`	`string`	Non	audience est le point de terminaison à utiliser pour échanger le jeton du compte de service contre un jeton d’accès OAuth.
`clientId`	`string`	Non	clientId est l’identifiant client à utiliser pour échanger le jeton du compte de service contre un jeton d’accès OAuth.
`tokenEndpoint`	`string`	Non	tokenEndpoint est le point de terminaison à utiliser pour échanger le jeton du compte de service contre un jeton d’accès OAuth.

Vantage.spec.ociMigration.imagePullSecrets[index]

LocalObjectReference contient suffisamment d’informations pour localiser l’objet référencé dans le même espace de noms.

Champ	Type	Obligatoire	Description
`name`	`string`	Non	Nom du référent. Ce champ est de fait obligatoire, mais il peut être vide pour des raisons de rétrocompatibilité. Les instances de ce type dont la valeur est vide ici sont très probablement erronées. Plus d’informations : https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Par défaut : “.

Vantage.spec.ociMigration.sources[index]

ContainerRegistryConfig définit les paramètres de connexion au registre de conteneurs.

Champ	Type	Obligatoire	Description
`host`	`string`	Oui	host correspond au nom d’hôte du registre, suivi éventuellement du port (par exemple, registry.example.com, registry.example.com:5000). Longueur minimale : `1`.
`credentialsRef`	`object`	Non	credentialsRef fait référence à un Secret contenant des clés de nom d’utilisateur et de mot de passe, ou à un Secret de type kubernetes.io/dockerconfigjson. S’il est spécifié, il prévaut sur username/password. Voir `credentialsRef`.
`password`	`string`	Non	Mot de passe pour l’authentification auprès du registre (en texte clair ; utilisez credentialsRef en production)
`repository`	`string`	Non	repository correspond au chemin/espace de noms des artefacts dans le registre (par exemple, « abbyy-docker », « vantage/images »). Motif : `^[a-z0-9]+([._-][a-z0-9]+)(/[a-z0-9]+([._-][a-z0-9]+))*$`.
`username`	`string`	Non	Nom d’utilisateur pour l’authentification auprès du registre (en texte clair ; utilisez credentialsRef en production)
`workloadIdentity`	`object`	Non	workloadIdentity définit les paramètres permettant d’utiliser l’identité de la charge de travail (compte de service Kubernetes) pour accéder au registre. Voir `workloadIdentity`.

Vantage.spec.ociMigration.sources[index].credentialsRef

credentialsRef référence un Secret contenant des clés de nom d’utilisateur et de mot de passe, ou un Secret de type kubernetes.io/dockerconfigjson. S’il est spécifié, il est prioritaire sur username/password.

Champ	Type	Obligatoire	Description
`name`	`string`	Oui	name est le nom du Secret

Vantage.spec.ociMigration.sources[index].workloadIdentity

workloadIdentity définit les paramètres permettant d’utiliser l’identité de la charge de travail (compte de service Kubernetes) pour accéder au registre.

Champ	Type	Obligatoire	Description
`audience`	`string`	Non	audience est le point de terminaison à utiliser pour échanger le jeton du compte de service contre un jeton d’accès OAuth.
`clientId`	`string`	Non	clientId est l’identifiant client à utiliser pour échanger le jeton du compte de service contre un jeton d’accès OAuth.
`tokenEndpoint`	`string`	Non	tokenEndpoint est le point de terminaison à utiliser pour échanger le jeton du compte de service contre un jeton d’accès OAuth.

Vantage.spec.smtp

smtp configure le serveur de messagerie SMTP. S’il n’est pas spécifié, Sendgrid est utilisé comme fournisseur de messagerie.

Champ	Type	Obligatoire	Description
`host`	`string`	Oui	host est le nom d’hôte du serveur SMTP
`login`	`string`	Non	identifiant de connexion pour l’authentification SMTP
`password`	`string`	Non	mot de passe pour l’authentification SMTP
`port`	`integer`	Non	port est le port du serveur SMTP. Par défaut : `587` · Format : `int32`.
`useSSL`	`boolean`	Non	useSSL active TLS pour les connexions SMTP. Par défaut : `false`.

Vantage.spec.storage

storage configure les options de stockage avancées.

Champ	Type	Obligatoire	Description
`custom`	`object`	Non	`custom` configure un backend de stockage personnalisé. Voir `custom`.

Vantage.spec.storage.custom

custom configure un backend de stockage personnalisé.

Champ	Type	Obligatoire	Description
`size`	`intorstring`	Oui	size définit la taille du PVC. Par défaut : `300Gi` · Motif : `^(\+\|-)?(([0-9]+(\.[0-9])?)\|(\.[0-9]+))(([KMGTPE]i)\|[numkMGTPE]\|([eE](\+\|-)?(([0-9]+(\.[0-9])?)\|(\.[0-9]+))))?$`.
`storageClass`	`string`	Oui	storageClass définit la classe de stockage utilisée par les PVC servant à monter les volumes du backend de stockage personnalisé.

Vantage.spec.techcore

techcore contient la configuration du moteur de traitement TechCore

Champ	Type	Obligatoire	Description
`version`	`integer`	Oui	version indique la version de TechCore à déployer (par exemple, 4). Minimum : `1`.
`keepPreviousVersion`	`boolean`	Non	keepPreviousVersion conserve la version précédente lors des mises à niveau. Par défaut : `false`.
`nnTrainingWorkers`	`object`	Non	nnTrainingWorkers configure les processus de travail d’entraînement du réseau de neurones. Voir `nnTrainingWorkers`.
`previousVersion`	`integer`	Non	previousVersion indique la version à partir de laquelle la mise à niveau est effectuée. Obligatoire lorsque keepPreviousVersion vaut true. Minimum : `1`.

Vantage.spec.techcore.nnTrainingWorkers

nnTrainingWorkers configure les processus de travail d’entraînement des réseaux de neurones.

Champ	Type	Obligatoire	Description
`enabled`	`boolean`	Non	enabled active les processus de travail d’entraînement des réseaux de neurones. Par défaut : `false`.
`gpu`	`boolean`	Non	gpu active l’accélération GPU pour les processus de travail d’entraînement. Par défaut : `false`.

Vantage.status

status définit l’état observé de Vantage

Champ	Type	Obligatoire	Description
`availableVersions`	`[]string`	Non	availableVersions est la liste des versions disponibles à l’URL de publication.
`conditions`	`[]object`	Non	conditions représente l’état actuel de la ressource Vantage. Chaque condition possède un type unique et reflète le statut d’un aspect particulier de la ressource. Les types de condition standard sont notamment : - « Available » : la ressource est pleinement fonctionnelle - « Progressing » : la ressource est en cours de création ou de mise à jour - « Degraded » : la ressource n’a pas pu atteindre ou maintenir l’état souhaité Le statut de chaque condition est True, False ou Unknown. Voir `conditions`.
`degradationReasons`	`[]object`	Non	degradationReasons représente les motifs de l’état dégradé de l’installation. Voir `degradationReasons`.
`installedVantageVersion`	`string`	Non	installedVantageVersion est la version en cours d’exécution.
`observedGeneration`	`integer`	Non	observedGeneration est la génération de la spec « traitée » par le contrôleur Format : `int64`.

Vantage.status.conditions[index]

Une condition contient des détails sur un aspect de l’état actuel de cette ressource d’API.

Champ	Type	Obligatoire	Description
`lastTransitionTime`	`string`	Oui	lastTransitionTime correspond au dernier moment où la condition est passée d’un statut à un autre. Il doit s’agir du moment où la condition sous-jacente a changé. Si celui-ci est inconnu, il est acceptable d’utiliser le moment où le champ de l’API a changé. Format : `date-time`.
`message`	`string`	Oui	message est un message lisible par l’utilisateur qui fournit des détails sur la transition. Il peut s’agir d’une chaîne vide. Longueur maximale : `32768`.
`reason`	`string`	Oui	reason contient un identifiant programmatique indiquant le motif de la dernière transition de la condition. Les producteurs de types de condition spécifiques peuvent définir les valeurs attendues pour ce champ et leur signification, et indiquer si ces valeurs constituent une API garantie. La valeur doit être une string au format CamelCase. Ce champ ne peut pas être vide. Longueur minimale : `1` · Longueur maximale : `1024` · Motif : `^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`.
`status`	`enum`	Oui	statut de la condition : True, False ou Unknown. Enum : `True, False, Unknown`.
`type`	`string`	Oui	type de condition au format CamelCase ou foo.example.com/CamelCase. Longueur maximale : `316` · Motif : `^([a-z0-9]([-a-z0-9][a-z0-9])?(\.[a-z0-9]([-a-z0-9][a-z0-9])?)/)?(([A-Za-z0-9][-A-Za-z0-9_.])?[A-Za-z0-9])$`.
`observedGeneration`	`integer`	Non	observedGeneration représente la valeur de .metadata.generation à partir de laquelle la condition a été définie. Par exemple, si .metadata.generation vaut actuellement 12, mais que .status.conditions[x].observedGeneration vaut 9, la condition n’est plus à jour par rapport à l’état actuel de l’instance. Format : `int64` · Minimum : `0`.

Vantage.status.degradationReasons[index]

DegradationReason représente le motif pour lequel un composant donné de l’installation est dégradé.

Champ	Type	Obligatoire	Description
`component`	`string`	Oui	component désigne la partie de l’installation qui est dégradée.
`message`	`string`	Oui	message est une description lisible par un humain de la dégradation du composant.
`reason`	`string`	Oui	reason contient un identifiant programmatique indiquant le motif de la dégradation du composant. La valeur doit être une string au format CamelCase.

​Versions des artefacts

​Groupe d’API

​Vantage

​Vantage.spec

​Vantage.spec.secrets

​Vantage.spec.secrets.azure

​Vantage.spec.secrets.azure.objects[key]

​Vantage.spec.secrets.kubernetes

​Vantage.spec.secrets.kubernetes.objects[key]

​Vantage.spec.updatePolicy

​Vantage.spec.updatePolicy.auto

​Vantage.spec.workloads

​Vantage.spec.ociMigration

​Vantage.spec.ociMigration.destination

​Vantage.spec.ociMigration.destination.credentialsRef

​Vantage.spec.ociMigration.destination.workloadIdentity

​Vantage.spec.ociMigration.imagePullSecrets[index]

​Vantage.spec.ociMigration.sources[index]

​Vantage.spec.ociMigration.sources[index].credentialsRef

​Vantage.spec.ociMigration.sources[index].workloadIdentity

​Vantage.spec.smtp

​Vantage.spec.storage

​Vantage.spec.storage.custom

​Vantage.spec.techcore

​Vantage.spec.techcore.nnTrainingWorkers

​Vantage.status

​Vantage.status.conditions[index]

​Vantage.status.degradationReasons[index]

Versions des artefacts

Groupe d’API

Vantage

Vantage.spec

Vantage.spec.secrets

Vantage.spec.secrets.azure

Vantage.spec.secrets.azure.objects[key]

Vantage.spec.secrets.kubernetes

Vantage.spec.secrets.kubernetes.objects[key]

Vantage.spec.updatePolicy

Vantage.spec.updatePolicy.auto

Vantage.spec.workloads

Vantage.spec.ociMigration

Vantage.spec.ociMigration.destination

Vantage.spec.ociMigration.destination.credentialsRef

Vantage.spec.ociMigration.destination.workloadIdentity

Vantage.spec.ociMigration.imagePullSecrets[index]

Vantage.spec.ociMigration.sources[index]

Vantage.spec.ociMigration.sources[index].credentialsRef

Vantage.spec.ociMigration.sources[index].workloadIdentity

Vantage.spec.smtp

Vantage.spec.storage

Vantage.spec.storage.custom

Vantage.spec.techcore

Vantage.spec.techcore.nnTrainingWorkers

Vantage.status

Vantage.status.conditions[index]

Vantage.status.degradationReasons[index]