Configuração do registro compatível com OCI para instalações offline

Referência para configurar um registro compatível com OCI para armazenar imagens de contêiner e gráficos do Helm para instalações offline no Automation Suite.

Em instalações offline, você precisa de um registro compatível com OCI (Open Container Initiative) para armazenar as imagens do contêiner e gráficos do Helm de implantação. Se você executar uma instalação online, pule essa etapa.

Certifique-se de executar os scripts presentes no instalador de destino /opt/UiPathAutomationSuite/latest/installer.

Observação:

Você deve escolher uma das seguintes opções para configurar o registro compatível com OCI:

• Recomendada. Traga seu próprio registro. Para obter detalhes, consulte Carregamento dos artefatos do Automation Suite para o registro externo compatível com OCI nesta página.
• Se você não tiver um registro, você pode instalar temporariamente um registro compatível com OCI em uma das máquinas do servidor. Para obter detalhes, consulte Configuração do registro temporário do Docker nesta página.

Upload dos artefatos do Automation Suite para o registro externo compatível com OCI

Há duas maneiras de carregar os artefatos do Automation Suite para o registro externo compatível com OCI:

• Opção A: espelhando seu registro compatível com o OCI com o registro da UiPath®
• Opção B: populando seu registro compatível com OCI com o pacote offline

A tabela a seguir compara as duas opções para carregar os artefatos para o registro para que você possa escolher aquela que atenda às suas necessidades:

Opção A: espelhar o registro	Opção B: hidratando o registro
Copia os artefatos do registro da UiPath® para qualquer registro de destino.	Usa o tarball offline para descompactar e carregar os artefatos para o registro de destino.
Requer ferramentas do Docker e do Helm.	Requer ferramentas do Podman e do Helm.
Requer acesso à internet para copiar os artefatos do registro da UiPath® para o registro de destino.	Requer acesso à internet apenas para baixar o tarball offline para o jump server. O upload do tarball não requer acesso à internet.
Requer um espaço temporário para armazenar em cache as imagens durante o método de cópia. Esse espaço normalmente é configurado durante a instalação do Docker. O local padrão é /var/lib/docker.	Requer um espaço temporário para extrair o tarball e um espaço temporário para o Podman carregar as imagens. O local da extração do tarball deve ser fornecido durante a etapa de hidratação. O local do Podman pode ser /var/tmp, que deve ter armazenamento adequado disponível.
A capacidade de armazenamento necessária para o diretório /var/lib/docker é de cerca de 128 GB.	A capacidade de armazenamento necessária para a extração é de cerca de 200 GB, e /var/tmp deve ser de 256 GB.

Observação:

É recomendável executar a operação de espelhamento ou hidratação na máquina de gerenciamento ou na jump box, em vez de usar os nós do servidor.

Opção A: espelhamento do registro da UiPath® para seu registro

Este método requer acesso à Internet na máquina intermediária a partir da qual você carrega os artefatos do Automation Suite em seu registro compatível com OCI.

Pré-requisitos para espelhar o registro da UiPath®

Para espelhar o registro da UiPath®, você precisa do seguinte:

• uma VM executando uma distribuição Linux (recomendada) ou um laptop (não recomendado)
• um cliente Docker autenticado com o registro privado
• Helm 3.8 ou mais recente autenticado com o registro privado
• as-images.txt
• as-helm-charts.txt
• mirror-registry.sh
• conectividade de saída para registry.uipath.com
• 128 GB de espaço livre em disco para o Docker na partição /var/lib/docker na máquina a partir da qual você carrega as imagens e gráficos do contêiner

Instalando o Docker e o Helm

Você deve ter o Docker e o Helm instalados e autenticados na máquina na qual planeja carregar as imagens e gráficos do contêiner do Automation Suite para seu registro.

• Para baixar os binários do Docker, consulte a documentação oficial.

• Para autenticar o registro do Docker, consulte a documentação oficial. Como alternativa, você pode usar o seguinte comando para substituir as credenciais de amostra por suas credenciais de registro reais:

  docker login my.registry.io:443 --username "admin" --password "secret"
  

• Para baixar os binários do Helm, consulte a documentação oficial.

• Para autenticar o registro do Helm, consulte a documentação oficial. Como alternativa, você pode usar o seguinte comando para substituir as credenciais de amostra por suas credenciais de registro reais:

  helm registry login my.registry.io:443 --username "admin" --password "secret"
  

Fazendo download de as-images.txt

Para baixar as-images.txt, consulte Download de pacotes de instalação.

Baixando as-helm-charts.txt

Para baixar as-helm-charts.txt, consulte Download de pacotes de instalação.

Download dos pacotes opcionais do Document Understanding

Para baixar os pacotes opcionais do Document Understanding, consulte a documentação do Document Understanding.

Baixando mirror-registry.sh

Para baixar o script mirror-registry.sh , consulte Download dos pacotes de instalação.

Como carregar as imagens do Automation Suite para seu registro

O script mirror-registry.sh requer conectividade de saída para os registros de origem (padrão registry.uipath.com) e de destino.

Observação:

O script mirror-registry.sh não executa a autenticação para o registro. Assume-se que você já tenha se autenticado no registro.

A tabela a seguir descreve os sinalizadores e as variáveis de ambiente para o script mirror-registry.sh .

Bandeira	Variável de ambiente	Description
--images-manifest	IMAGES_MANIFEST	Obrigatório. Caminho para o arquivo de manifesto de imagem.
--helm-charts-manifest	HELM_CHARTS_MANIFEST	Obrigatório. Caminho para o arquivo de manifesto do gráfico do Helm.
--target-registry-url	TARGET_REGISTRY_URL	Obrigatório. Passe o URL para o registro de destino.
--source-registry-url	SOURCE_REGISTRY_URL	Opcional. Passe o URL para o registro de origem. O padrão é registry.uipath.com.

Para carregar as imagens do Automation Suite para seu registro:

1. Certifique-se de ter as permissões necessárias para executar o script de shell, executando o seguinte comando:

   chmod +x mirror-registry.sh
   
   

2. Carregue as imagens do Automation Suite para seu registro, executando o seguinte comando:

   ./mirror-registry.sh --target-registry-url my.registry.io:443 --source-registry-url registry.uipath.com --images-manifest /home/myuser/as-images.txt --helm-charts-manifest /home/myuser/as-helm-charts.txt
   

   Observação:

   Para registros, como o Harbor, que exigem o uso de um projeto, certifique-se de anexar o nome do projeto à URL do registro de destino que você inclui no comando, conforme mostrado no exemplo a seguir:

   ./mirror-registry.sh --target-registry-url my.registry.io:443/myproject --source-registry-url registry.uipath.com --images-manifest /home/myuser/as-images.txt --helm-charts-manifest /home/myuser/as-helm-charts.txt
   

Opção B: hidratar o registro com o pacote offline

Este método requer apenas acesso à Internet na máquina intermediária para baixar o pacote offline. Quando o pacote estiver disponível, você poderá carregar para seu registro compatível com OCI sem uma conexão com a Internet.

Observação:

Esse método também pode exigir espaço adicional na máquina para descompactar e carregar para seu registro. Além disso, esse método pode levar mais tempo que a abordagem de espelhamento.

Pré-requisitos para o preenchimento do registro

Para popular o registro, você precisa do seguinte:

• é preferível uma VM executando uma distribuição Linux a executar o script em um laptop
• capacidade de baixar e copiar ou de alguma forma propagar o pacote offline para a VM
• Helm 3.8 ou mais recente autenticado com o registro privado
• Podman instalado, configurado e autenticado com o registro privado
• 150 GB de espaço livre em disco para o Podman sob o /var/lib/containers para carregar os contêineres localmente antes de enviá-los para o registro remoto. Se você precisar alterar o caminho padrão, atualize a variável graphRoot no arquivo /etc/containers/storage.conf .

Por exemplo, você pode editar storage.conf usando sudo nano /etc/containers/storage.conf, alterar graphRoot para seu novo caminho e verificar se o caminho está atualizado usando o comando podman info .

• Defina a TMP_DIR variável de ambiente conforme descrito na documentação oficial do Podman. Essa variável especifica o armazenamento temporário para imagens de contêiner baixadas durante operações de pull e build, cruciais para evitar erros de falta de espaço se /var/tmp for limitado.
• as.tar.gz

Instalação do Podman e do Helm

Você deve se certificar de ter o Podman e o Helm instalados e autenticados na máquina na qual planeja carregar as imagens e gráficos do contêiner do Automation Suite para o seu registro.

• Para baixar os binários do Podman, consulte a documentação oficial.

• Para se autenticar no registro do Podman, consulte a documentação oficial. Como alternativa, você pode usar o seguinte comando para substituir as credenciais de amostra por suas credenciais de registro reais:

  podman login my.registry.io:443 --username "admin" --password "secret"
  

• Para baixar os binários do Helm, consulte a documentação oficial.

• Para autenticar o registro do Helm, consulte a documentação oficial. Como alternativa, você pode usar o seguinte comando para substituir as credenciais de amostra por suas credenciais de registro reais:

  helm registry login my.registry.io:443 --username "admin" --password "secret"
  

Baixando como .tar.gz

Para baixar as.tar.gz, consulte Download de pacotes de instalação.

Download dos pacotes opcionais do Document Understanding

Para baixar pacotes opcionais do Document Understanding, consulte a documentação do Document Understanding.

Baixando o hidr-registry.sh

Para baixar o script hydrate-registry.sh , consulte Download dos pacotes de instalação.

Como carregar as imagens do Automation Suite para o registro

Para carregar as imagens do Automation Suite para o registro, use o script hydrate-registry.sh .

O script hydrate-registry.sh não requer conectividade de saída, exceto com os registros de destino.

Observação:

O script hydrate-registry.sh não executa a autenticação para o registro. Assume-se que você já tenha se autenticado no registro.

A tabela a seguir descreve os sinalizadores disponíveis para o script hydrate-registry.sh .

Bandeira	Description
--offline-bundle-path	Obrigatório. Caminho para o pacote offline.
--target-registry-url	Obrigatório. Passe o URL para o registro de destino.
--extract-path	O local a ser usado para descompactar o pacote offline. Pode ser /var/lib/containers ou um local personalizado. Certifique-se de ter no mínimo 100 GB de armazenamento. É recomendável ter 256 GB de armazenamento.

Para carregar as imagens do Automation Suite para o registro:

1. Certifique-se de ter as permissões necessárias para executar o script de shell, executando o seguinte comando:

   chmod +x hydrate-registry.sh
   

2. Carregue as imagens do Automation Suite para seu registro executando o seguinte comando:

   ./hydrate-registry.sh --target-registry-url my.registry.io:443 --offline-bundle-path ./as.tar.gz --extract-path /extract/to/path
   

Observação:

Para registros, como o Harbor, que exigem o uso de um projeto, certifique-se de anexar o nome do projeto à URL do registro de destino que você inclui no comando, conforme mostrado no exemplo a seguir:

./hydrate-registry.sh --target-registry-url my.registry.io:443/myproject --offline-bundle-path ./as.tar.gz --extract-path /extract/to/path

Para pacotes offline do Document Understanding, certifique-se de incluir --extract-path no comando, conforme mostrado no exemplo a seguir:

./hydrate-registry.sh --target-registry-url my.registry.io:443 --optional-bundle-path ./dusemistructured-2023.10.0.tar.gz --extract-path /tmp

Configuração do certificado para o registro externo compatível com OCI

Para configurar corretamente seu registro externo compatível com OCI, você deve atualizar o armazenamento de confiança de todas as máquinas nas quais você planeja instalar o Automation Suite. Para obter instruções sobre como realizar essa etapa pós-instalação, consulte Gerenciamento de certificados.

Para isso, siga as seguintes etapas:

1. Adicione o arquivo CA ao local /etc/pki/ca-trust/source/anchors/.

2. Execute update-ca-trust para atualizar o armazenamento de confiança do sistema operacional. Depois que o armazenamento de confiança for atualizado, o arquivo de certificado extraído será mesclado em /etc/pki/ca-trust/extracted/ca-bundle.trust.crt.

   Observação:

   Você deve fornecer o certificado da CA durante a instalação do Automation Suite. Você deve fornecer o certificado no parâmetro registry_ca_cert no arquivo cluster_config.json. Para obter detalhes, consulte Configuração do registro externo compatível com OCI.

Configurando o registro temporário do Docker

Observação:

Essa etapa é necessária apenas para instalações offline que usam um registro no cluster. Você pode pular essa etapa se executar uma instalação offline que use um registro externo compatível com OCI ou uma instalação online. Você deve executar esta etapa apenas em um dos nós do servidor. Você deve garantir que o nó tenha uma capacidade adicional de 512 GB para ser usado como back-end para o registro. Geralmente, é recomendável estar no ponto de montagem /uipath .

O registro temporário do Docker é necessário apenas durante a instalação ou atualização. Após a instalação ou atualização ser bem-sucedida, o registro temporário não é mais necessário e deve ser desinstalado.

Pré-requisitos para configurar o registro temporário

Para configurar o registro temporário, você precisa do seguinte:

• as-fs.tar.gz — para baixá-lo, consulte Download dos pacotes de instalação.

Instalando o registro temporário

Para instalar o registro temporário do Docker em um dos nós, execute o seguinte comando:

./bin/uipathctl registry install-temp-registry -i /opt/UiPathAutomationSuite/latest/installer/cluster_config.json

• -i, --input: Mandatory. Accepts the path to the cluster_config.json.

Por padrão, o registro temporário é instalado na máquina na porta 30070 e usa o caminho do arquivo /uipath/data/registry. Você deve abrir a porta 30070 no balanceador de carga e o nó no qual você instala o registro temporário do Docker.

Observação:

O pool de backend do balanceador de carga deve segmentar exclusivamente os nós que hospedam o registro temporário do docker.

Se você quiser alterar a porta de registro temporário padrão e o caminho do arquivo, você deve atualizar o arquivo cluster_config.json conforme mostrado no seguinte exemplo:

{
  "infra": {
    "tmp_docker_registry": {
      "node_port": "<new port number>",
      "file_path": "/uipath/data/registry"
    }
  }
}

Preenchimento do registro temporário

A instalação do Podman é obrigatória antes de hidratar o registro temporário. Se você já tiver validado e instalado os pacotes RPM necessários, o Podman será instalado automaticamente. Caso contrário, é essencial instalar manualmente o Podman antes de prosseguir para a configuração do registro temporário do Docker para instalações offline.

Após instalar o registro temporário, siga os seguintes passos:

1. Hidrate o registro temporário com as imagens de contêiner e os gráficos do Helm executando o seguinte comando:

   ./bin/uipathctl registry hydrate-temp-registry --offline-bundle /uipath/as-fs.tar.gz -i /opt/UiPathAutomationSuite/latest/installer/cluster_config.json
   

2. Semeie o registro interno do registro temporário executando o seguinte comando. Se você aplicar um patch, siga as etapas descritas na observação a seguir.

   ./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/latest/installer/cluster_config.json
   

   Observação:

   Se você estiver tendo problemas --serial memória ao executar o comando acima, use a opção para evitar problemas de falta de memória:

   ./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/latest/installer/cluster_config.json --serial
   

   Observação:

   Se você aplicar um patch a uma versão existente do Automation Suite, siga as seguintes etapas. Isso não é aplicável para LTS ou CU.

   1. Baixe os arquivos docker-image.json e versions.json, em seguida, siga as seguintes etapas:

      1. Altere o diretório para a pasta do instalador:

      cd "${INSTALLER_PATH}"
      

      2. Crie um backup dos arquivos docker-image.json e helm-charts.json:

      cp versions/docker-images.json versions/docker-images.json.bak
      cp versions/helm-charts.json versions/helm-charts.json.bak
      

      3. Copie os arquivos baixados docker-images.json e versions.json para a pasta do instalador:

      cp <PATH_OF_PATCH_VERSION_docker-images.json> versions/docker-images.json
      cp <PATH_OF_PATCH_VERSION_versions.json> versions/helm-charts.json
      

   2. Semeie o registro interno a partir do registro temporário executando o seguinte comando:

      ./bin/uipathctl rke2 registry hydrate-registry /opt/UiPathAutomationSuite/latest/installer/cluster_config.json
      

   3. Reverta os arquivos docker-image.json e helm-charts.json para os arquivos originais:

      cp versions/docker-images.json.bak versions/docker-images.json
      cp versions/helm-charts.json.bak versions/helm-charts.json
      

3. Se você estiver usando projetos modernos do Document Understanding, gere o pacote dumodernexperience . Para obter detalhes, consulte Instalação de pacotes off-line.

• --offline-bundle: caminho do arquivo contendo o local do as-fs.tar.gz no nó do seu servidor.
• -i, --input: Mandatory. Accepts the path to the cluster_config.json file.