Référence de l’API

Référence des champs de la ressource personnalisée Vantage vantage.abbyy.com/v1alpha1, qui régit les installations auto-hébergées de Vantage 3.0.

Le programme d’installation auto-hébergé de Vantage 3.0 repose sur une seule ressource personnalisée Kubernetes : un objet Vantage du groupe d’API vantage.abbyy.com/v1alpha1. Les champs ci-dessous constituent le contrat complet entre vous et l’opérateur.

Pour une vue d’ensemble conceptuelle de la façon dont l’opérateur utilise cette ressource, voir Architecture. Pour la procédure d’installation, choisissez Azure ou Self-Managed Kubernetes.

​

Group d’API

Group	Version	Ressource
vantage.abbyy.com	v1alpha1	Vantage

​

Vantage

La ressource Vantage de premier niveau. Le chart vantage-selfhosted contient une instance de ressource personnalisée Vantage, créée dans l’espace de noms où vous avez installé ce chart.

Champ	Type	Obligatoire	Description
apiVersion	string	Oui	vantage.abbyy.com/v1alpha1
kind	string	Oui	Vantage
metadata	object	Oui	Reportez-vous à la documentation de l’API Kubernetes pour les sous-champs de metadata.
spec	object	Oui	spec définit l’état souhaité de Vantage. Voir Vantage.spec.
status	object	Non	status définit l’état observé de Vantage. Voir Vantage.status.

​

Vantage.spec

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

Field	Type	Obligatoire	Description
databaseProvider	string	Non	Moteur de base de données utilisé par les services Vantage. Les valeurs acceptées sont SqlServer et PostgreSQL ; la valeur est sensible à la casse. Par défaut : SqlServer.
debug	boolean	Non	debug contrôle si les charges de travail sont installées en mode débogage. Par défaut : false.
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 pour les 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 fournisseur doit être spécifié. Voir secrets.
updatePolicy	object	Oui	updatePolicy contrôle la façon dont l’opérateur gère les mises à niveau de Vantage. Utilisez manual: {} ; les mises à jour automatiques ne sont pas encore prises en charge. Voir updatePolicy.
vantageVersion	string	Oui	vantageVersion est la version de Vantage à installer.
workloads	object	Oui	workloads configure la ConfigMap contenant des données sur les charts et les images. Voir workloads.
idReadingEnabled	boolean	Non	idReadingEnabled active les fonctionnalités de lecture des pièces d’identité. Par défaut : false.
keda	object	Non	keda configure la mise à l’échelle automatique basée sur KEDA. Voir keda.
minimalInstall	boolean	Non	minimalInstall configure les charges de travail pour qu’elles soient déployées avec des configurations de ressources minimales. Par défaut : false.
ociMigration	object	Non	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’elle est activée, la destination est obligatoire. Voir ociMigration.
reportingEnabled	boolean	Non	reportingEnabled active les fonctionnalités de reporting de SQL Server. Il doit rester à false lorsque databaseProvider vaut PostgreSQL. Par défaut : false.
serviceAccountName	string	Non	serviceAccountName est le nom du ServiceAccount à utiliser pour les charges de travail Vantage. Omettez-le pour utiliser le ServiceAccount par défaut. Par défaut : default. La récupération des images pour les charges de travail Vantage se configure ici : ajoutez le Secret d’extraction de votre registre à imagePullSecrets de ce ServiceAccount. Voir Azure image pull access ou self-managed registry access.
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. Par défaut, Azure Blob est utilisé (via les alias storage*ConnectionString) lorsque ce paramètre est omis. 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 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: une seule 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 la base de données et du reporting : PostgreSQL est sélectionné avec la valeur exacte PostgreSQL. Le reporting est disponible uniquement avec SQL Server ; la ressource est rejetée lorsque databaseProvider vaut PostgreSQL et reportingEnabled vaut true.

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

​

Vantage.spec.keda

keda configure la mise à l’échelle automatique basée sur KEDA pour les charges de travail Vantage prises en charge. Installez KEDA et le service Prometheus requis avant de l’activer.

Champ	Type	Obligatoire	Description
enabled	boolean	Non	Active les ressources KEDA ScaledObject pour les charges de travail prises en charge. Par défaut : false.

Les charts de charges de travail Vantage actuels nécessitent KEDA 2.17.x. Certaines ressources ScaledObject interrogent http://prometheus-operated.observability.svc.cluster.local:9090 ; voir Autoscaling with KEDA.

​

Vantage.spec.smtp

smtp configure le serveur de messagerie SMTP. Il constitue une alternative facultative à SendGrid et n’est utilisé que lorsqu’il est défini.

Champ	Type	Obligatoire	Description
host	string	Oui	host correspond au nom d’hôte du serveur SMTP
login	string	Non	login utilisé pour l’authentification SMTP
password	string	Non	mot de passe pour l’authentification SMTP
port	integer	Non	port correspond au port du serveur SMTP. Valeur par défaut : 587 · Format : int32.
useSSL	boolean	Non	useSSL active TLS pour les connexions SMTP. Valeur par défaut : false.

​

Vantage.spec.workloads

workloads configure la ConfigMap contenant des données sur les charts et les images

Field	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 qui contient le modèle de métadonnées relatif à l’installation des charts
secretsKey	string	Oui	secretsKey est la clé de la ConfigMap qui contient les métadonnées des secrets
workloadsKey	string	Oui	workloadsKey est la clé de la ConfigMap qui contient la liste des charts et des images
additionalMetadataKey	string	Non	additionalMetadataKey est la clé de la ConfigMap qui contient des métadonnées supplémentaires relatives à l’installation des charts. Voir Métadonnées supplémentaires des charges de travail.

​

Vantage.spec.secrets

secrets configure le fournisseur de secrets utilisé pour fournir aux charges de travail Vantage les secrets de l’application (chaînes de connexion à la base de données, clés API, certificats). Un seul fournisseur doit être spécifié. Voir Secrets and Key Vault pour le modèle conceptuel et l’inventaire complet des alias.

Champ	Type	Obligatoire	Description
azure	object	Non	azure configure les secrets via Azure Key Vault et le Secrets Store CSI driver. Voir azure.
kubernetes	object	Non	kubernetes utilise des ressources Kubernetes Secret préexistantes dans l’espace de noms d’installation. Voir kubernetes.

​

Vantage.spec.secrets.azure

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

Champ	Type	Obligatoire	Description
keyVaultName	string	Oui	keyVaultName est l’Azure Key Vault qui contient les secrets.
tenantId	string	Oui	tenantId est le tenant Azure AD propriétaire du Key Vault.
clientId	string	Non	clientId est l’ID client Azure AD de l’identité managée assignée par l’utilisateur qui dispose d’un accès en lecture au Key Vault. Obligatoire lorsque identityMode est workloadIdentity (valeur par défaut).
identityMode	enum	Non	identityMode détermine comment le pilote CSI s’authentifie auprès d’Azure. Par défaut : workloadIdentity · Valeurs possibles : workloadIdentity, podIdentity, vmManagedIdentity.
objects	map[string]object	Non	objects remplace éventuellement la mise en correspondance entre un alias de secret et un objet Key Vault spécifique. Lorsqu’un alias n’est pas présent dans cette map, l’alias lui-même est utilisé comme nom de l’objet Key Vault et l’objet est récupéré avec le type secret. Voir objects.
userAssignedIdentityID	string	Non	userAssignedIdentityID est l’ID client de l’identité managée assignée par l’utilisateur à utiliser lorsque identityMode est vmManagedIdentity.

​

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

AzureSecretObjectConfig décrit un objet Key Vault unique associé à 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. Par défaut : secret · Valeurs d’énumération : secret, key, cert.
objectVersion	string	Non	objectVersion fixe une version spécifique de l’objet Key Vault. Par défaut, la version la plus récente est utilisée.

​

Vantage.spec.secrets.kubernetes

kubernetes utilise des ressources Kubernetes Secret préexistantes dans l’espace de noms d’installation.

Champ	Type	Obligatoire	Description
objects	map[string]object	Non	objects définit les secrets Kubernetes utilisés, en mettant en correspondance les alias de secrets avec les noms de Secret. S’il n’est pas défini, les noms de secrets par défaut seront utilisés. Voir objects.

​

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

Chaque entrée associe un alias de secret à un nom de Secret Kubernetes.

Champ	Type	Obligatoire	Description
secretName	string	Oui	secretName est le nom du Secret Kubernetes dans l’espace de noms d’installation.

​

Vantage.spec.storage

storage configure les options avancées de stockage. S’il est omis, Vantage utilise le backend Azure Blob par défaut et lit les chaînes de connexion depuis les alias de secret storage*ConnectionString. Voir Secrets and Key Vault.

Field	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é (adossé à un PVC via une StorageClass Kubernetes).

La StorageClass Kubernetes référencée doit déjà être configurée dans le cluster avant d’installer Vantage avec un backend de stockage personnalisé. Les volumes qu’elle provisionne doivent être accessibles en écriture par un utilisateur non-root ; voir Configurer le stockage persistant.

Champ	Type	Obligatoire	Description
size	int or string	Oui	size définit la taille du PVC. Par défaut : 300Gi.
storageClass	string	Oui	storageClass définit la classe de stockage à utiliser pour les PVC afin de monter les volumes du backend de stockage personnalisé. Le storageClassName d’un PVC est immuable : pour passer une installation existante à une autre classe, il faut supprimer et recréer les PVC de l’opérateur.

​

Vantage.spec.updatePolicy

updatePolicy contrôle la façon dont l’opérateur gère les mises à niveau de Vantage.

Champ	Type	Obligatoire	Description
auto	object	Non	auto active les mises à niveau automatiques vers de nouvelles versions. Cette option n’est pas encore implémentée. Voir auto.
manual	object	Non	manual désactive les mises à niveau automatiques. Les mises à niveau sont effectuées en installant une nouvelle version du chart Helm de l’opérateur.

​

Vantage.spec.updatePolicy.auto

auto active les mises à niveau automatiques vers de nouvelles versions. Pas encore implémenté.

Field	Type	Obligatoire	Description
releaseURL	string	Oui	releaseURL est l’URL depuis laquelle récupérer le package de version Vantage. Format : uri.

​

Vantage.spec.ociMigration

ociMigration configure la copie d’artefacts depuis un registre source vers une destination avant l’installation. Omettez complètement cette section ou définissez enabled=false pour ignorer la migration. Lorsqu’elle est activée, destination est obligatoire.

Field	Type	Obligatoire	Description
concurrency	integer	Oui	concurrency correspond au nombre d’artefacts copiés en parallèle. Par défaut : 5 · Minimum : 1.
destination	object	Non	destination indique 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 à utiliser pour extraire l’image de l’opérateur servant à exécuter le job de migration OCI dans cet espace de noms. Voir imagePullSecrets.
labels	map[string]JSON	Non	labels est le jeu de labels à appliquer au job de migration OCI et au template de pod. Les valeurs non textuelles 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. Ajoutez votre secret de pull du registre à imagePullSecrets de ce ServiceAccount pour donner au job l’accès nécessaire au pull d’image.
sources	[]object	Non	sources correspond aux identifiants d’accès permettant d’accéder aux registres depuis lesquels les artefacts sont copiés (le registre source distribué par ABBYY). Longueur maximale : 20. Voir sources.

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

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

Accès au pull d’image pour le job de migration : exécutez le job avec un ServiceAccount qui porte votre secret de pull du registre (serviceAccountName), ou référencez le secret dans l’entrée source (sources[].credentialsRef.name). Sur Azure, accorder AcrPull à l’identité managée AKS est l’alternative la plus simple aux secrets de pull. L’accès d’ArgoCD à votre registre se configure séparément, comme une connexion de dépôt ArgoCD. Voir Image pull access et Connect ArgoCD to your OCI registry.

​

Vantage.spec.ociMigration.destination

destination indique où les artefacts sont copiés.

Champ	Type	Obligatoire	Description
host	string	Oui	host correspond au nom d’hôte du registre et, éventuellement, à son port (par ex., registry.example.com, registry.example.com:5000)
credentialsRef	object	Non	credentialsRef fait référence à un Secret contenant les clés de nom d’utilisateur et de mot de passe, ou à un Secret de type kubernetes.io/dockerconfigjson. Si 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 brut ; utilisez credentialsRef en production)
repository	string	Non	repository correspond au chemin/espace de noms du registre pour les artefacts (par ex., my-registry-namespace, vantage/images).
username	string	Non	nom d’utilisateur pour l’authentification auprès du registre (en texte brut ; utilisez credentialsRef en production)
workloadIdentity	object	Non	workloadIdentity définit les paramètres d’utilisation de 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 username et password, ou à un Secret de type kubernetes.io/dockerconfigjson. A priorité sur username/password s’il est spécifié.

Champ	Type	Obligatoire	Description
name	string	Oui	name correspond au 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’ID 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 permettre de localiser l’objet référencé dans le même espace de noms.

Champ	Type	Obligatoire	Description
name	string	Non	Nom de l’objet référencé. Ce champ est en pratique obligatoire, mais pour des raisons de rétrocompatibilité, il peut être laissé vide. Les instances de ce type dont cette valeur est vide sont presque certainement incorrectes. Plus d’infos : https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

​

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, avec port facultatif (par ex. : registry.example.com, registry.example.com:5000)
credentialsRef	object	Non	credentialsRef fait référence à un Secret contenant les clés de nom d’utilisateur et de mot de passe, ou à un Secret de type kubernetes.io/dockerconfigjson. Il prévaut sur username/password s’il est spécifié. Faire ici référence à un secret d’extraction constitue l’alternative à l’exécution du job de migration sous un ServiceAccount associé au secret. Voir credentialsRef.
password	string	Non	mot de passe pour l’authentification auprès du registre (en texte brut ; utilisez credentialsRef en production)
repository	string	Non	repository correspond au chemin/namespace du registre pour les artefacts (par ex. : my-registry-namespace, vantage/images).
username	string	Non	nom d’utilisateur pour l’authentification auprès du registre (en texte brut ; utilisez credentialsRef en production)
workloadIdentity	object	Non	workloadIdentity définit les paramètres d’utilisation de 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 fait référence à un Secret contenant des clés username et password, ou à un Secret de type kubernetes.io/dockerconfigjson. S’il est spécifié, il prévaut sur username/password.

Champ	Type	Obligatoire	Description
name	string	Oui	name correspond au 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.

Field	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’ID 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.techcore

techcore contient la configuration du moteur de traitement TechCore

Champ	Type	Obligatoire	Description
version	integer	Oui	version correspond à la version de TechCore à déployer (par ex. 4). Minimum : 1.
keepPreviousVersion	boolean	Non	keepPreviousVersion conserve la version précédente lors des mises à niveau. Valeur par défaut : false.
nnTrainingWorkers	object	Non	nnTrainingWorkers configure les workers d’entraînement des réseaux neuronaux. Voir nnTrainingWorkers.
previousVersion	integer	Non	previousVersion correspond à la version depuis laquelle la mise à niveau est effectuée. Obligatoire lorsque keepPreviousVersion est défini sur true. Minimum : 1.

​

Vantage.spec.techcore.nnTrainingWorkers

nnTrainingWorkers configure les workers d’entraînement des réseaux neuronaux

Field	Type	Obligatoire	Description
enabled	boolean	Non	enabled active les workers d’entraînement des réseaux neuronaux. Valeur par défaut : false.
gpu	boolean	Non	gpu active l’accélération GPU pour les workers d’entraînement. Valeur par défaut : false.

​

Vantage.status

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

Field	Type	Required	Description
availableVersions	[]string	No	availableVersions est la liste des versions disponibles depuis l’URL de publication.
conditions	[]object	No	conditions représentent l’état actuel de la ressource Vantage. Chaque condition a un type unique et reflète le statut d’un aspect spécifique de la ressource. Les types de condition standard incluent : - “Available” : la ressource est entièrement fonctionnelle - “Progressing” : la ressource est en cours de création ou de mise à jour - “Degraded” : la ressource n’est pas parvenue à atteindre ou à maintenir l’état souhaité. Le statut de chaque condition est True, False ou Unknown. Voir conditions.
degradationReasons	[]object	No	degradationReasons représentent les motifs de l’état dégradé de l’installation. Voir degradationReasons.
installedVantageVersion	string	No	installedVantageVersion est la version actuellement en cours d’exécution.
observedGeneration	integer	No	observedGeneration est la génération de la spécification qui a été « traitée » par le contrôleur. Format : int64.

L’installation du Skill s’exécute comme un job Kubernetes distinct, qui n’est pas reflété dans status.conditions[] et n’apparaît pas dans ArgoCD. Vantage reste utilisable pendant l’exécution du job. Voir Lifecycle pour les commandes de surveillance.

​

Vantage.status.conditions[index]

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

Field	Type	Obligatoire	Description
lastTransitionTime	string	Oui	lastTransitionTime correspond à la dernière fois où la condition est passée d’un statut à un autre. Cela doit correspondre au moment où la condition sous-jacente a changé. Si ce moment n’est pas connu, il est acceptable d’utiliser l’heure à laquelle le champ API a changé. Format : date-time.
message	string	Oui	message est un message compréhensible par l’utilisateur indiquant des détails sur la transition. Il peut s’agir d’une chaîne vide.
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 et les significations attendues pour ce champ, ainsi que préciser si ces valeurs sont considérées comme garanties par l’API. La valeur doit être une chaîne CamelCase. Ce champ ne peut pas être vide.
status	enum	Oui	statut de la condition : True, False ou Unknown. Enum : True, False, Unknown.
type	string	Oui	type de condition en CamelCase ou au format foo.example.com/CamelCase.
observedGeneration	integer	Non	observedGeneration représente le .metadata.generation sur la base duquel 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 pas à jour par rapport à l’état actuel de l’instance. Format : int64 · Minimum : 0.

​

Vantage.status.degradationReasons[index]

DegradationReason représente la raison pour laquelle un composant de l’installation est dégradé.

Champ	Type	Obligatoire	Description
component	string	Oui	component est la partie de l’installation qui est dégradée.
message	string	Oui	message est une description de la dégradation du composant, lisible par l’utilisateur.
reason	string	Oui	reason contient un identifiant programmatique indiquant la raison de la dégradation du composant. La valeur doit être une chaîne au format CamelCase.