Referencia de la API: 2026.06 - ABBYY Documentation

Versiones de los artefactos

Artefacto	Versión
Chart `vantage-operator`	`0.1.0`
Chart `vantage-selfhosted`	`0.1.0`

El instalador de Vantage 3.0 autoalojado se controla mediante un único recurso personalizado de Kubernetes: un objeto Vantage del grupo de API vantage.abbyy.com/v1alpha1. Los campos que se describen a continuación constituyen el contrato completo entre usted y el operador. Para obtener una visión general de cómo el operador consume este recurso, consulte Arquitectura. Para conocer el procedimiento de instalación, elija Azure o Self-Managed Kubernetes.

Grupo de API

Grupo	Versión	Recurso
`vantage.abbyy.com`	`v1alpha1`	`Vantage`

Vantage

Vantage es el esquema de la API de vantages.

Campo	Tipo	Obligatorio	Descripción
`apiVersion`	`string`	Sí	vantage.abbyy.com/v1alpha1
`kind`	`string`	Sí	Vantage
`metadata`	`object`	Sí	Consulte la documentación de la API de Kubernetes para conocer los campos de `metadata`.
`spec`	`object`	Sí	spec define el estado deseado de Vantage. Consulte `spec`.
`status`	`object`	No	status define el estado observado de Vantage. Consulte `status`.

Vantage.spec

spec define el estado deseado de Vantage

Campo	Tipo	Obligatorio	Descripción
`dnsRecord`	`string`	Sí	dnsRecord es el registro DNS de la instalación de Vantage. Formato: `hostname`.
`mailFrom`	`string`	Sí	mailFrom es la dirección de correo electrónico que se usa como remitente de los correos salientes. Formato: `email`.
`platformAdminEmail`	`string`	Sí	platformAdminEmail es la dirección de correo electrónico del administrador de la plataforma. Formato: `email`.
`secrets`	`object`	Sí	secrets selecciona y configura el proveedor de secretos. Debe especificarse exactamente un proveedor. Consulte `secrets`.
`updatePolicy`	`object`	Sí	updatePolicy controla cómo gestiona el operador las actualizaciones de Vantage. Consulte `updatePolicy`.
`vantageVersion`	`string`	Sí	vantageVersion es la versión de Vantage que se va a instalar.
`workloads`	`object`	Sí	workloads configura el ConfigMap que contiene los datos de los charts y las imágenes. Consulte `workloads`.
`idReadingEnabled`	`boolean`	No	idReadingEnabled habilita las funciones de lectura de documentos de identidad. Predeterminado: `false`.
`ociMigration`	`object`	No	ociMigration configura la copia de artefactos desde un registro de origen a otro de destino antes de la instalación. Para omitir la migración, no incluya este campo o establezca enabled=false. Si está habilitado, destination es obligatorio. Consulte `ociMigration`.
`reportingEnabled`	`boolean`	No	reportingEnabled habilita las funciones de informes de SQL Server. Predeterminado: `false`.
`serviceAccountName`	`string`	No	serviceAccountName es el nombre de la cuenta de servicio que se usará para las cargas de trabajo de Vantage. Si se omite, se usa la cuenta de servicio predeterminada. Predeterminado: `default` · Longitud mínima: `1`.
`smtp`	`object`	No	smtp configura el servidor de correo SMTP. Si no se especifica, se usará Sendgrid como proveedor de correo. Consulte `smtp`.
`storage`	`object`	No	storage configura las opciones avanzadas de almacenamiento. Consulte `storage`.
`techcore`	`object`	No	techcore contiene la configuración del motor de procesamiento de TechCore. Consulte `techcore`.

Validación de secrets: has(self.kubernetes) != has(self.azure): debe especificarse exactamente un proveedor

Validación de updatePolicy: !has(self.auto): las actualizaciones automáticas aún no se admiten

Validación de updatePolicy: (has(self.auto) ? 1 : 0) + (has(self.manual) ? 1 : 0) == 1: se debe especificar exactamente una política de actualización

Validación de ociMigration: !has(self.enabled) || self.enabled == false || has(self.destination): destination es obligatorio cuando ociMigration está habilitado

Validación de techcore: !self.keepPreviousVersion || has(self.previousVersion): previousVersion es obligatorio cuando keepPreviousVersion es true

Vantage.spec.secrets

secrets selecciona y configura el proveedor de secretos. Debe especificarse exactamente un proveedor.

Campo	Tipo	Obligatorio	Descripción
`azure`	`object`	No	azure configura Azure Key Vault (a través del controlador Secrets Store CSI) como origen de los secretos. Consulte `azure`.
`kubernetes`	`object`	No	kubernetes configura los Secrets nativos de Kubernetes como origen de los secretos. Consulte `kubernetes`.

Vantage.spec.secrets.azure

azure configura Azure Key Vault (a través del controlador Secrets Store CSI) como origen de los secretos.

Campo	Tipo	Obligatorio	Descripción
`keyVaultName`	`string`	Sí	keyVaultName es el Azure Key Vault que contiene los secretos.
`tenantId`	`string`	Sí	tenantId es el inquilino de Azure AD al que pertenece el Key Vault.
`clientId`	`string`	No	clientId es el ID de cliente de Azure AD de la identidad administrada asignada por el usuario que tiene acceso de lectura al Key Vault. Obligatorio cuando identityMode es “workloadIdentity” (el valor predeterminado).
`identityMode`	`enum`	No	identityMode determina cómo se autentica el controlador CSI en Azure. Predeterminado: `workloadIdentity` · Enum: `workloadIdentity, podIdentity, vmManagedIdentity`.
`objects`	`map[string]object`	No	objects permite anular, de forma opcional, la asignación de un alias de secreto (tal como se referencia en workloads-secrets.yml) a un objeto concreto de Key Vault. Si un alias no figura en este mapa, se utiliza el propio alias como nombre del objeto de Key Vault y el objeto se obtiene con el tipo “secret”. Consulte `objects`.
`userAssignedIdentityID`	`string`	No	userAssignedIdentityID es el ID de cliente de la identidad administrada asignada por el usuario que se usará cuando identityMode sea “vmManagedIdentity”.

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

AzureSecretObjectConfig describe un único objeto de Key Vault que respalda un alias de secreto.

Campo	Tipo	Obligatorio	Descripción
`objectName`	`string`	Sí	objectName es el nombre del objeto en Azure Key Vault.
`objectType`	`enum`	No	objectType es el tipo de objeto de Key Vault. El valor predeterminado es «secret». Valor predeterminado: `secret` · Enum: `secret, key, cert`.
`objectVersion`	`string`	No	objectVersion fija una versión concreta del objeto de Key Vault. De forma predeterminada, se usa la versión más reciente.

Vantage.spec.secrets.kubernetes

kubernetes configura los Secrets nativos de Kubernetes como origen de los secretos.

Campo	Tipo	Obligatorio	Descripción
`objects`	`map[string]object`	No	objects define los secretos de Kubernetes que se utilizarán. Si no se define, se usarán los nombres de secreto predeterminados. Consulte `objects`.

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

Campo	Tipo	Obligatorio	Descripción
`secretName`	`string`	Sí	secretName es el nombre del Secret de Kubernetes

Vantage.spec.updatePolicy

updatePolicy controla cómo gestiona el operador las actualizaciones de Vantage.

Campo	Tipo	Obligatorio	Descripción
`manual`	`object`	No	manual desactiva las actualizaciones automáticas. Las actualizaciones se realizan instalando una nueva versión del chart de Helm del operador.

Aún no se admite. El operador rechaza cualquier recurso que establezca estos campos.

Campo	Tipo	Obligatorio	Descripción
`auto`	`object`	No	auto habilita las actualizaciones automáticas de versión. Aún no se ha implementado. Consulte `auto`.

Vantage.spec.updatePolicy.auto

auto habilita las actualizaciones automáticas de versión. Todavía no está implementado.

Campo	Tipo	Obligatorio	Descripción
`releaseURL`	`string`	Sí	releaseURL es la URL desde la que se descarga el paquete de versión de Vantage. Formato: `uri`.

Vantage.spec.workloads

workloads configura el ConfigMap que contiene datos sobre los charts y las imágenes

Campo	Tipo	Obligatorio	Descripción
`configMap`	`string`	Sí	configMap es el nombre del ConfigMap que contiene los datos de las cargas de trabajo
`metadataTemplateKey`	`string`	Sí	metadataTemplateKey es la clave del ConfigMap que contiene la plantilla de metadatos para la instalación de los charts
`secretsKey`	`string`	Sí	secrets es la clave del ConfigMap que contiene los metadatos de los secretos.
`workloadsKey`	`string`	Sí	workloadsKey es la clave del ConfigMap que contiene la lista de charts e imágenes

Vantage.spec.ociMigration

ociMigration configura la copia de artefactos desde un registro de origen a un destino antes de la instalación. Omítalo por completo o establezca enabled=false para omitir la migración. Si está habilitado, el destino es obligatorio.

Campo	Tipo	Obligatorio	Descripción
`concurrency`	`integer`	Sí	concurrency es el número de artefactos que se copian en paralelo. Predeterminado: `5` · Mínimo: `1`.
`destination`	`object`	No	destination es la ubicación a la que se copian los artefactos. Consulte `destination`.
`enabled`	`boolean`	No	enabled habilita la migración de OCI. Predeterminado: `true`.
`imagePullSecrets`	`[]object`	No	imagePullSecrets es una lista opcional de referencias a secretos del mismo espacio de nombres que se usan para extraer la imagen del operador con la que se ejecuta el trabajo de migración de OCI en este espacio de nombres. Consulte `imagePullSecrets`.
`labels`	`map[string]JSON`	No	labels es el conjunto de labels que se aplicarán al trabajo de migración de OCI y a la plantilla del pod. Los valores que no sean cadenas se convertirán en cadenas con [fmt.Sprint]
`serviceAccountName`	`string`	No	serviceAccountName es el nombre de la ServiceAccount con la que se ejecuta el trabajo de migración de OCI.
`sources`	`[]object`	No	sources son las credenciales para acceder a los registros desde los que se copian los artefactos (por ejemplo, JFrog). (Longitud máxima 20) Máximo de elementos: `20`. Consulte `sources`.

Validación de destination: !self.host.contains('/'): host no debe contener una ruta; use el campo repository para indicar la ruta del registro

Validación de destination: !self.host.contains('://'): host no debe incluir un esquema (por ejemplo, https://)

Vantage.spec.ociMigration.destination

destination es la ubicación a la que se copian los artefactos.

Campo	Tipo	Obligatorio	Descripción
`host`	`string`	Sí	host es el nombre de host del registro y, opcionalmente, el puerto (p. ej., registry.example.com, registry.example.com:5000). Longitud mínima: `1`.
`credentialsRef`	`object`	No	credentialsRef hace referencia a un Secret que contiene claves de nombre de usuario y contraseña, o a un Secret de tipo kubernetes.io/dockerconfigjson. Si se especifica, tiene prioridad sobre username/password. Consulte `credentialsRef`.
`password`	`string`	No	Contraseña para la autenticación en el registro (en PlainText; en producción, use credentialsRef).
`repository`	`string`	No	repository es la ruta o el espacio de nombres del registro donde se almacenan los artefactos (p. ej., “abbyy-docker”, “vantage/images”). Patrón: `^[a-z0-9]+([._-][a-z0-9]+)(/[a-z0-9]+([._-][a-z0-9]+))*$`.
`username`	`string`	No	Nombre de usuario para la autenticación en el registro (en PlainText; en producción, use credentialsRef).
`workloadIdentity`	`object`	No	workloadIdentity define la configuración necesaria para acceder al registro mediante la identidad de la carga de trabajo (cuenta de servicio de Kubernetes). Consulte `workloadIdentity`.

Vantage.spec.ociMigration.destination.credentialsRef

credentialsRef hace referencia a un Secret que contiene claves de nombre de usuario y contraseña, o a un Secret de tipo kubernetes.io/dockerconfigjson. Si se especifica, tiene prioridad sobre username/password.

Campo	Tipo	Obligatorio	Descripción
`name`	`string`	Sí	name es el nombre del Secret

Vantage.spec.ociMigration.destination.workloadIdentity

workloadIdentity define la configuración para usar la identidad de la carga de trabajo (cuenta de servicio de Kubernetes) para acceder al registro.

Campo	Tipo	Obligatorio	Descripción
`audience`	`string`	No	audience es el endpoint que debe usarse para intercambiar el token de la cuenta de servicio por un token de acceso de OAuth.
`clientId`	`string`	No	clientId es el ID de cliente que debe usarse para intercambiar el token de la cuenta de servicio por un token de acceso de OAuth.
`tokenEndpoint`	`string`	No	tokenEndpoint es el endpoint que debe usarse para intercambiar el token de la cuenta de servicio por un token de acceso de OAuth.

Vantage.spec.ociMigration.imagePullSecrets[index]

LocalObjectReference contiene la información necesaria para localizar el objeto referenciado dentro del mismo espacio de nombres.

Campo	Tipo	Obligatorio	Descripción
`name`	`string`	No	Nombre del objeto referenciado. En la práctica, este campo es obligatorio, pero por compatibilidad con versiones anteriores se permite dejarlo vacío. Las instancias de este tipo con un valor vacío en este campo son, casi con toda seguridad, incorrectas. Más información: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Predeterminado: “.

Vantage.spec.ociMigration.sources[index]

ContainerRegistryConfig define la configuración de conexión del registro de contenedores.

Campo	Tipo	Obligatorio	Descripción
`host`	`string`	Sí	host es el nombre de host del registro y, opcionalmente, el puerto (p. ej., registry.example.com, registry.example.com:5000). Longitud mínima: `1`.
`credentialsRef`	`object`	No	credentialsRef hace referencia a un Secret que contiene las claves de nombre de usuario y contraseña, o bien a un Secret de tipo kubernetes.io/dockerconfigjson. Si se especifica, tiene prioridad sobre username/password. Consulte `credentialsRef`.
`password`	`string`	No	Contraseña para la autenticación en el registro (en PlainText; en producción, use credentialsRef).
`repository`	`string`	No	repository es la ruta o el espacio de nombres del registro donde se encuentran los artefactos (p. ej., “abbyy-docker”, “vantage/images”). Patrón: `^[a-z0-9]+([._-][a-z0-9]+)(/[a-z0-9]+([._-][a-z0-9]+))*$`.
`username`	`string`	No	Nombre de usuario para la autenticación en el registro (en PlainText; en producción, use credentialsRef).
`workloadIdentity`	`object`	No	workloadIdentity define la configuración necesaria para acceder al registro mediante la identidad de la carga de trabajo (cuenta de servicio de Kubernetes). Consulte `workloadIdentity`.

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

credentialsRef hace referencia a un Secret que contiene las claves de nombre de usuario y contraseña, o bien a un Secret de tipo kubernetes.io/dockerconfigjson. Si se especifica, tiene prioridad sobre username/password.

Campo	Tipo	Obligatorio	Descripción
`name`	`string`	Sí	name es el nombre del Secret

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

workloadIdentity define la configuración para usar la identidad de la carga de trabajo (cuenta de servicio de Kubernetes) para acceder al registro.

Campo	Tipo	Obligatorio	Descripción
`audience`	`string`	No	audience es el endpoint que se debe usar para intercambiar el token de la cuenta de servicio por un token de acceso de OAuth.
`clientId`	`string`	No	clientId es el ID de cliente que se debe usar para intercambiar el token de la cuenta de servicio por un token de acceso de OAuth.
`tokenEndpoint`	`string`	No	tokenEndpoint es el endpoint que se debe usar para intercambiar el token de la cuenta de servicio por un token de acceso de OAuth.

Vantage.spec.smtp

smtp configura el servidor de correo SMTP. Si no se especifica, se utilizará Sendgrid como proveedor de correo.

Campo	Tipo	Obligatorio	Descripción
`host`	`string`	Sí	host es el nombre de host del servidor SMTP
`login`	`string`	No	Nombre de usuario para la autenticación SMTP
`password`	`string`	No	Contraseña para la autenticación SMTP
`port`	`integer`	No	port es el puerto del servidor SMTP. Valor predeterminado: `587` · Formato: `int32`.
`useSSL`	`boolean`	No	useSSL habilita TLS en las conexiones SMTP. Valor predeterminado: `false`.

Vantage.spec.storage

storage configura las opciones avanzadas de almacenamiento.

Campo	Tipo	Obligatorio	Descripción
`custom`	`object`	No	custom configura un backend de almacenamiento personalizado. Consulte `custom`.

Vantage.spec.storage.custom

custom configura un backend de almacenamiento personalizado.

Campo	Tipo	Obligatorio	Descripción
`size`	`intorstring`	Sí	size define el tamaño del PVC. Valor predeterminado: `300Gi` · Patrón: `^(\+\|-)?(([0-9]+(\.[0-9])?)\|(\.[0-9]+))(([KMGTPE]i)\|[numkMGTPE]\|([eE](\+\|-)?(([0-9]+(\.[0-9])?)\|(\.[0-9]+))))?$`.
`storageClass`	`string`	Sí	storageClass define la clase de almacenamiento que deben usar los PVC para montar los volúmenes del backend de almacenamiento personalizado.

Vantage.spec.techcore

techcore contiene la configuración del motor de procesamiento de TechCore

Campo	Tipo	Obligatorio	Descripción
`version`	`integer`	Sí	version es la versión de TechCore que se va a implementar (p. ej., 4). Mínimo: `1`.
`keepPreviousVersion`	`boolean`	No	keepPreviousVersion conserva la versión anterior durante las actualizaciones. Predeterminado: `false`.
`nnTrainingWorkers`	`object`	No	nnTrainingWorkers configura los workers de entrenamiento de la red neuronal. Consulte `nnTrainingWorkers`.
`previousVersion`	`integer`	No	previousVersion es la versión desde la que se actualiza. Obligatorio cuando keepPreviousVersion es true. Mínimo: `1`.

Vantage.spec.techcore.nnTrainingWorkers

nnTrainingWorkers configura los workers de entrenamiento de redes neuronales

Campo	Tipo	Obligatorio	Descripción
`enabled`	`boolean`	No	enabled habilita los workers de entrenamiento de redes neuronales. Predeterminado: `false`.
`gpu`	`boolean`	No	gpu habilita la aceleración por GPU para los workers de entrenamiento. Predeterminado: `false`.

Vantage.status

status define el estado observado de Vantage

Campo	Tipo	Obligatorio	Descripción
`availableVersions`	`[]string`	No	availableVersions es la lista de versiones disponibles en la URL de versiones.
`conditions`	`[]object`	No	conditions representa el estado actual del recurso Vantage. Cada condición tiene un tipo único y refleja el estado de un aspecto concreto del recurso. Entre los tipos de condición estándar se incluyen: - “Available”: el recurso es totalmente funcional - “Progressing”: el recurso está en proceso de creación o actualización - “Degraded”: el recurso no ha podido alcanzar o mantener su estado deseado El estado de cada condición es True, False o Unknown. Consulte `conditions`.
`degradationReasons`	`[]object`	No	degradationReasons representa los motivos por los que la instalación se encuentra en estado degradado. Consulte `degradationReasons`.
`installedVantageVersion`	`string`	No	installedVantageVersion es la versión que se está ejecutando actualmente.
`observedGeneration`	`integer`	No	observedGeneration es la generación de la especificación que el controlador ha “procesado” Formato: `int64`.

Vantage.status.conditions[index]

Condition contiene detalles sobre un aspecto del estado actual de este recurso de la API.

Campo	Tipo	Obligatorio	Descripción
`lastTransitionTime`	`string`	Sí	lastTransitionTime es el último momento en que la condición pasó de un estado a otro. Debe corresponder al momento en que cambió la condición subyacente. Si no se conoce, se puede usar el momento en que cambió el campo de la API. Formato: `date-time`.
`message`	`string`	Sí	message es un mensaje legible por humanos con detalles sobre la transición. Puede ser una cadena vacía. Longitud máxima: `32768`.
`reason`	`string`	Sí	reason contiene un identificador programático que indica el motivo de la última transición de la condición. Los productores de tipos de condición específicos pueden definir los valores esperados y su significado para este campo, así como si dichos valores se consideran una API garantizada. El valor debe ser una cadena en CamelCase. Este campo no puede estar vacío. Longitud mínima: `1` · Longitud máxima: `1024` · Patrón: `^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`.
`status`	`enum`	Sí	Estado de la condición: True, False o Unknown. Enum: `True, False, Unknown`.
`type`	`string`	Sí	Tipo de condición en CamelCase o en foo.example.com/CamelCase. Longitud máxima: `316` · Patrón: `^([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`	No	observedGeneration representa el valor de .metadata.generation a partir del cual se estableció la condición. Por ejemplo, si .metadata.generation es actualmente 12, pero .status.conditions[x].observedGeneration es 9, la condición está desactualizada con respecto al estado actual de la instancia. Formato: `int64` · Mínimo: `0`.

Vantage.status.degradationReasons[index]

DegradationReason representa el motivo por el que un componente concreto de la instalación está degradado.

Campo	Tipo	Obligatorio	Descripción
`component`	`string`	Sí	component es la parte de la instalación que está degradada.
`message`	`string`	Sí	message es una descripción legible por humanos de la degradación del componente.
`reason`	`string`	Sí	reason contiene un identificador programático que indica el motivo de la degradación del componente. El valor debe ser una cadena en formato CamelCase.

​Versiones de los artefactos

​Grupo de 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]

Versiones de los artefactos

Grupo de 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]