Lista de verificação de pré-requisitos
Prepare e configure os seguintes componentes externos antes de instalar o Vantage:
- Uma máquina com Docker e acesso à internet (a partir da qual o Vantage será instalado)
- Máquinas virtuais (com acesso à internet durante a instalação) para serem usadas como nós do Kubernetes
- Um registro de contêiner para armazenar imagens Docker
- Sistemas de Gerenciamento de Banco de Dados Relacionais (RDBMS) para a operação do Vantage
- Um servidor SMTP para enviar mensagens de e-mail aos usuários do Vantage
- Um certificado TLS para estabelecer comunicações criptografadas
- 2 endereços IP estáticos — um para configuração/gerenciamento do Kubernetes, outro para acesso ao Vantage
- Um registro DNS para acesso ao Vantage
- Armazenamento externo (opcional em configurações sem alta disponibilidade)
Requisitos da Máquina de Instalação
A máquina a partir da qual o Vantage está sendo instalado requer:
- Sistema operacional Linux ou Windows Subsystem for Linux (WSL)
- Docker na versão 19.03 ou posterior
- Acesso de rede a
abyvtgonprm27.azurecr.io
- Arquivos locais contendo uma chave SSH privada (sem senha/passphrase) para a conta de usuário
ansible
Todas as máquinas virtuais devem usar a mesma chave SSH.
Requisitos da Máquina Virtual
Todas as máquinas virtuais podem ser executadas em VMware ou Hyper-V e devem ter:
- Um endereço IP estático
- Uma conta de usuário chamada
ansible com:
- Acesso compartilhado por chave SSH
- Acesso sudo com a opção NOPASSWD
- Um disco/lvm_volume dedicado e expansível montado em
/opt/local-path-provisioner em cada nó worker
- Acesso à Internet durante a instalação, tanto ao registro de contêineres quanto aos repositórios de pacotes:
- Registro de contêineres com as imagens sincronizadas preparadas como pré-requisito para a instalação do Vantage. Para obter mais informações, consulte Baixando Imagens de Contêiner.
- Repositório de pacotes: Ubuntu (archive.ubuntu.com), RHEL (cdn.redhat.com). Em vez de acesso aos repositórios de pacotes, você também pode configurar o acesso ao seu próprio repositório, que deve conter todos os pacotes necessários listados abaixo.
Comum a todas as distribuições:
curl, socat, unzip, e2fsprogs, xfsprogs, ebtables, tar
Específico para o sistema operacional:
python3-apt, apt-transport-https, software-properties-common,
conntrack, libseccomp2
device-mapper-libs, nss, conntrack, container-selinux, libseccomp
Acesso à rede pós-instalação
Após a instalação do cluster, as máquinas virtuais precisam de acesso a:
https://licensing-us.abbyy.com
- Ao servidor de e-mail, para o qual as configurações de SMTP são definidas no arquivo
env_specific.yml (para envio de convites por e-mail, recuperação de senhas etc.).
- A todos os servidores de e-mail dos quais você importará seus e-mails nas Skills de Processo do Vantage. Esses devem ser os servidores de e-mail nos quais os endereços de e-mail para importação estão registrados.
Configuração de Alta Disponibilidade
É informado o número mínimo necessário de máquinas virtuais. Diferentes requisitos de desempenho podem exigir um número diferente de máquinas virtuais.
| Tipo de nó do Kubernetes | Master Nodes | Worker Nodes (Services) | Worker Nodes (Workers) |
|---|
| Sistema Operacional | Ubuntu 20.04 ou RHEL 8 | Ubuntu 20.04 ou RHEL 8 | Ubuntu 20.04 ou RHEL 8 |
| Número de VMs | 3 | 4 | 1 |
| Núcleos de CPU (para cada VM) | 2 | 12 | 12 |
| RAM, GB (para cada VM) | 4 | 48 | 48 |
| Armazenamento em disco para Kubernetes, GB (para cada VM) | 50 | 80 | 80 |
Disco/volume para o ponto de montagem /opt/local-path-provisioner, GB | Não é necessário | Mínimo 40 | Mínimo 40 |
| Largura de banda de rede, Gbps (para cada VM) | 1 | 1 | 1 |
Sem configuração de alta disponibilidade
| Tipo de nó Kubernetes | Nós master | Nós worker (Services) | Nós worker (Workers) |
|---|
| Sistema operacional | Ubuntu 20.04 ou RHEL 8 | Ubuntu 20.04 ou RHEL 8 | Ubuntu 20.04 ou RHEL 8 |
| Número de VMs | 1 | 1 | 1 |
| Núcleos de CPU (para cada VM) | 2 | 12 | 12 |
| RAM, GB (para cada VM) | 4 | 48 | 48 |
| Armazenamento em disco para Kubernetes, GB (para cada VM) | 50 | 80 | 80 |
Disco/volume para o ponto de montagem /opt/local-path-provisioner, GB | Não é necessário | Mínimo 40 | Mínimo 40 |
| Largura de banda de rede, Gbps (para cada VM) | 1 | 1 | 1 |
A versão 1.28.4 do Kubernetes será instalada durante a instalação do Vantage.
Você pode usar qualquer registro de contêiner.
Requisitos do banco de dados
É necessário um banco de dados Microsoft SQL Server com a seguinte configuração:
| Versão | SO | Núcleos de CPU | RAM, GB | Armazenamento em disco, GB | Pesquisa de texto completo |
|---|
| Enterprise 2022 | Linux | 4 | 4 | Recomendado: 400, mín.: 200 | Ativada |
Um servidor de banco de dados SQL externo deve ser configurado, e você deve ter as credenciais adequadas para criar e gerenciar o novo banco de dados.
O instalador requer o endereço IP do SQL Server, bem como um nome de usuário e senha para se conectar ao banco de dados.
O servidor deve operar por meio do protocolo SMTP.
O instalador requer o endereço IP/nome DNS e a porta do servidor SMTP, além de uma senha para se conectar ao servidor (se o servidor exigir autenticação). O servidor SMTP deve ter permissão para enviar e-mails aos usuários do Vantage.
Configure o SMTP com ou sem autenticação em env_specific.yml.
Recomendamos usar a opção com autenticação (com login e senha).
Com autenticação (recomendado)
Com login e senha. Nesse caso, a seção smtp no arquivo env_specific.yml deve ser definida da seguinte forma:
smtp:
host: X.X.X.X
login: email
password: password
port: 587
useSSL: false
secureSocketOptions: null
Sem autenticação
Sem login e senha. Nesse caso, a seção smtp no arquivo env_specific.yml deve ser configurada da seguinte forma:
mailFrom: email
smtp:
host: X.X.X.X
login: null
password: null
port: 25
useSSL: false
secureSocketOptions: None
Não se esqueça de adicionar o Parameter mailFrom à raiz.
Recomendamos usar a opção com autenticação (login e senha).
Você precisará de um certificado curinga (wildcard) ou específico para o domínio.
Se a sua instalação do Vantage vai se conectar a serviços externos usando a atividade Custom ou exportar para sistemas externos, o certificado deverá ser emitido por uma autoridade certificadora pública, por exemplo, em https://letsencrypt.org/.
1. Acesso à API do Kubernetes. Um endereço IP estático que será usado como um endereço IP virtual para acessar o endpoint do servidor da API do Kubernetes para configurar e gerenciar o cluster. O endereço IP deve ser definido no arquivo env_specific.yml da seguinte forma. Para obter mais informações, consulte a seção Configuração dos arquivos de configuração:
2. Acesso aos serviços do Vantage. Um endereço IP estático que será usado para acessar os serviços do Vantage por HTTPS. Um registro DNS A apropriado deve ser criado previamente. O endereço IP deve ser definido no arquivo env_specific.yml da seguinte forma. Para mais informações, consulte Installation:
loadbalancer:
external_ip: X.X.X.X
Registro DNS para acesso posterior ao Vantage
Sem requisitos específicos.
O instalador requer um domínio principal e um nome DNS que será usado para acessar o Vantage. O registro DNS deve apontar para o endereço IP dedicado ao acesso ao Vantage.
O armazenamento externo é um requisito opcional apenas para a configuração Sem alta disponibilidade. Os requisitos de tamanho de disco para a configuração com alta disponibilidade estão descritos no Guia de Desempenho.
ABBYY Vantage implanta armazenamento local nos discos rígidos das máquinas virtuais fornecidas, o que acelera a instalação do produto. No entanto, essa opção ainda pode ser afetada por reinicializações inesperadas e falhas das máquinas virtuais. Como isso pode resultar na perda dos dados armazenados, é recomendável usar armazenamento externo ao instalar o produto.
ABBYY Vantage permite que você defina o uso de tipos específicos de armazenamento, conforme listado abaixo.
Usando o armazenamento local em discos rígidos das máquinas virtuais fornecidas
Nesse caso, volumes com acesso ReadWriteOnce compatível com POSIX serão provisionados localmente no diretório /opt/local_path_provisioner em cada nó Kubernetes. Para tipos de volumes ReadWriteMany, o Vantage implantará um in-cluster nfs-kernel-server no primeiro nó abbyy_services (o IP desse nó é o primeiro no bloco correspondente no arquivo inventory). Os dados do servidor NFS serão armazenados no diretório /opt/local_path_provisioner, portanto, certifique-se de ter um volume/disco dedicado para esse caminho no primeiro nó abbyy_services (o primeiro nó desse grupo é definido no arquivo inventory) com pelo menos 500 GB de capacidade.
Para uma configuração de alta disponibilidade, o primeiro nó abbyy_services também hospedará o armazenamento de volume persistente local. Isso exigirá capacidade adicional de disco rígido, dependendo da carga de processamento. Para obter detalhes sobre as quantidades necessárias, consulte o Guia de desempenho.
Se o armazenamento de volume persistente local ficar sem espaço, o Vantage poderá deixar de funcionar, com possível perda de alguns dados. Recomendamos que você monitore o espaço livre e configure alertas para quando o espaço estiver acabando, para que possa adicionar mais armazenamento a tempo e evitar perda de dados.
Usando Armazenamento NFS Externo
O instalador do Vantage permite configurar automaticamente um armazenamento NFS para ser utilizado pelo Vantage em serviços específicos, como importação e exportação para uma pasta compartilhada e armazenamento dos dados coletados pelo monitoramento.
A seção no arquivo env_specific.yml terá a seguinte aparência:
k8s:
storage:
rwx:
external:
enabled: true
type: "nfs"
nfs:
address: <endereço IP do servidor nfs>
path: <compartilhamento exportado do servidor nfs>
Para que o Vantage funcione corretamente, recomendamos que o diretório raiz do servidor NFS (por exemplo, /opt/nfs) tenha as seguintes permissões e o seguinte proprietário:
drwxr-xr-x 4 65532 65532 4096 Dec 12 09:25 /opt/nfs/
A seguir, um exemplo de configuração de diretório no arquivo /etc/exports para quando uma máquina Linux é usada como servidor NFS:
/opt/nfs *(rw,sync,all_squash,insecure,no_subtree_check,anonuid=65532,anongid=65532)
Caso seja necessário conectar outro tipo de armazenamento, consulte a seção Definindo suas próprias classes de armazenamento abaixo.
Definindo suas próprias classes de armazenamento
Se você quiser usar um armazenamento externo que não seja NFS, siga as etapas abaixo:
- Durante o processo de instalação, após criar o cluster Kubernetes (etapa 4 em Execução dos scripts de instalação), implante os drivers CSI (Container Storage Interface) apropriados e crie classes de armazenamento para eles.
- Preencha a seção
k8s no arquivo env_specific.yml usando o seguinte código:
k8s:
storage:
rwo:
class_name: "<rwo posix compatible storage class>"
rwx:
class_name: "<read_write_many_storage_class>"
- Continue a instalação.
Para armazenamento NFS, configure em env_specific.yml:
k8s:
storage:
rwx:
external:
enabled: true
type: "nfs"
nfs:
address: <endereço IP do servidor NFS>
path: <compartilhamento exportado do servidor NFS>
Se o armazenamento em volumes persistentes locais ficar sem espaço em disco, o Vantage poderá parar de funcionar e ocorrer perda de dados. Monitore o espaço livre e configure alertas.